feat(tanstackstart): Add @sentry/tanstackstart-react package and make @sentry/tanstackstart package a utility package (#15629)

Luca Forstner · web-flow · commit 9cae1a07d787 · 2025-03-11T13:22:18.000+01:00
diff --git a/.craft.yml b/.craft.yml
@@ -111,6 +111,9 @@ targets:
   - name: npm
     id: '@sentry/tanstackstart'
     includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
+  - name: npm
+    id: '@sentry/tanstackstart-react'
+    includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
   - name: npm
     id: '@sentry/gatsby'
     includeNames: /^sentry-gatsby-\d.*\.tgz$/
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -50,6 +50,7 @@ body:
         - '@sentry/solidstart'
         - '@sentry/svelte'
         - '@sentry/sveltekit'
+        - '@sentry/tanstackstart-react'
         - '@sentry/vue'
         - '@sentry/wasm'
         - Sentry Browser Loader
diff --git a/README.md b/README.md
@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
 - [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
 - [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
 - [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
+- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
 - [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
   for AWS Lambda Functions
 - [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
diff --git a/dev-packages/e2e-tests/verdaccio-config/config.yaml b/dev-packages/e2e-tests/verdaccio-config/config.yaml
@@ -176,6 +176,12 @@ packages:
     unpublish: $all
     # proxy: npmjs # Don't proxy for E2E tests!
 
+  '@sentry/tanstackstart-react':
+    access: $all
+    publish: $all
+    unpublish: $all
+    # proxy: npmjs # Don't proxy for E2E tests!
+
   '@sentry/types':
     access: $all
     publish: $all
diff --git a/docs/new-sdk-release-checklist.md b/docs/new-sdk-release-checklist.md
@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
 - [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
       your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.
 
+- [ ] Add the new package to the "root" README inside the repository.
+
+- [ ] Add the new package to the GitHub Issue bug template.
+
+- [ ] Create label inside the GitHub repo named "Package: foobar".
+
 ## Cutting the Release
 
 When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
diff --git a/package.json b/package.json
@@ -80,6 +80,7 @@
     "packages/svelte",
     "packages/sveltekit",
     "packages/tanstackstart",
+    "packages/tanstackstart-react",
     "packages/types",
     "packages/typescript",
     "packages/vercel-edge",
diff --git a/packages/tanstackstart-react/.eslintrc.js b/packages/tanstackstart-react/.eslintrc.js
@@ -0,0 +1,10 @@
+module.exports = {
+  env: {
+    browser: true,
+    node: true,
+  },
+  parserOptions: {
+    jsx: true,
+  },
+  extends: ['../../.eslintrc.js'],
+};
diff --git a/packages/tanstackstart-react/LICENSE b/packages/tanstackstart-react/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Functional Software, Inc. dba Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/tanstackstart-react/README.md b/packages/tanstackstart-react/README.md
@@ -0,0 +1,52 @@
+<p align="center">
+  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
+  </a>
+</p>
+
+# Official Sentry SDK for TanStack Start React (Alpha)
+
+[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
+[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
+[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
+
+> NOTICE: This package is in alpha state and may be subject to breaking changes.
+
+## Getting Started
+
+This SDK does not have docs yet. Stay tuned.
+
+## Compatibility
+
+The minimum supported version of TanStack Start is `1.111.12`.
+
+## Custom Usage
+
+To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:
+
+```ts
+import * as Sentry from '@sentry/tanstackstart-react';
+
+// Set user information, as well as tags and further extras
+Sentry.setTag('user_mode', 'admin');
+Sentry.setUser({ id: '4711' });
+Sentry.setContext('application_area', { location: 'checkout' });
+
+// Add a breadcrumb for future events
+Sentry.addBreadcrumb({
+  message: '"Add to cart" clicked',
+  // ...
+});
+
+// Capture exceptions or messages
+Sentry.captureException(new Error('Oh no.'));
+Sentry.captureMessage('Hello, world!');
+```
+
+## Links
+
+<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->
+
+- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
+- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
diff --git a/packages/tanstackstart-react/package.json b/packages/tanstackstart-react/package.json
@@ -0,0 +1,86 @@
+{
+  "name": "@sentry/tanstackstart-react",
+  "version": "9.5.0",
+  "description": "Official Sentry SDK for TanStack Start React",
+  "repository": "git://github.com/getsentry/sentry-javascript.git",
+  "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
+  "author": "Sentry",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "build/cjs/index.server.js",
+  "module": "build/esm/index.server.js",
+  "types": "build/types/index.types.d.ts",
+  "files": [
+    "/build"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./build/types/index.types.d.ts",
+      "browser": {
+        "import": "./build/esm/index.client.js",
+        "require": "./build/cjs/index.client.js"
+      },
+      "node": {
+        "import": "./build/esm/index.server.js",
+        "require": "./build/cjs/index.server.js"
+      }
+    },
+    "./import": {
+      "import": {
+        "default": "./build/import-hook.mjs"
+      }
+    },
+    "./loader": {
+      "import": {
+        "default": "./build/loader-hook.mjs"
+      }
+    }
+  },
+  "typesVersions": {
+    "<5.0": {
+      "build/npm/types/index.d.ts": [
+        "build/npm/types-ts3.8/index.d.ts"
+      ]
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/semantic-conventions": "^1.30.0",
+    "@sentry-internal/browser-utils": "9.5.0",
+    "@sentry/core": "9.5.0",
+    "@sentry/node": "9.5.0",
+    "@sentry/opentelemetry": "9.5.0",
+    "@sentry/react": "9.5.0"
+  },
+  "scripts": {
+    "build": "run-p build:transpile build:types",
+    "build:dev": "yarn build",
+    "build:transpile": "rollup -c rollup.npm.config.mjs",
+    "build:types": "run-s build:types:core build:types:downlevel",
+    "build:types:core": "tsc -p tsconfig.types.json",
+    "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
+    "build:watch": "run-p build:transpile:watch build:types:watch",
+    "build:dev:watch": "yarn build:watch",
+    "build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
+    "build:types:watch": "tsc -p tsconfig.types.json --watch",
+    "build:tarball": "npm pack",
+    "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
+    "clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
+    "fix": "eslint . --format stylish --fix",
+    "lint": "eslint . --format stylish",
+    "test": "yarn test:unit",
+    "test:unit": "vitest run",
+    "test:watch": "vitest --watch",
+    "yalc:publish": "yalc publish --push --sig"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "sideEffects": false
+}
diff --git a/packages/tanstackstart-react/rollup.npm.config.mjs b/packages/tanstackstart-react/rollup.npm.config.mjs
@@ -0,0 +1,10 @@
+import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';
+
+export default [
+  ...makeNPMConfigVariants(
+    makeBaseNPMConfig({
+      entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
+    }),
+  ),
+  ...makeOtelLoaders('./build', 'sentry-node'),
+];
diff --git a/packages/tanstackstart-react/src/client/index.ts b/packages/tanstackstart-react/src/client/index.ts
@@ -0,0 +1 @@
+export * from '@sentry/react';
diff --git a/packages/tanstackstart-react/src/common/index.ts b/packages/tanstackstart-react/src/common/index.ts
@@ -0,0 +1,23 @@
+/**
+ * A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
+ */
+export function sentryGlobalServerMiddlewareHandler() {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  return function <T>(server: { next: (...args: any[]) => T }): T {
+    return server.next();
+  };
+}
+
+/**
+ * Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
+ */
+export function wrapStreamHandlerWithSentry<H>(handler: H): H {
+  return handler;
+}
+
+/**
+ * Wraps the create root route function with Sentry for server-client tracing with SSR.
+ */
+export function wrapCreateRootRouteWithSentry<F>(createRootRoute: F): F {
+  return createRootRoute;
+}
diff --git a/packages/tanstackstart-react/src/config/index.ts b/packages/tanstackstart-react/src/config/index.ts
@@ -0,0 +1,16 @@
+/**
+ * Wraps a TanStack Start config.
+ */
+export function wrapVinxiConfigWithSentry<C>(
+  config: C,
+  // TODO: Expand this type in the future. Right now it is just so that TS doesn't complain for our users when they copy paste from the docs.
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  sentryBuildOptions: {
+    org?: string;
+    project?: string;
+    silent?: boolean;
+    authToken?: boolean;
+  } = {},
+): C {
+  return config;
+}
diff --git a/packages/tanstackstart-react/src/index.client.ts b/packages/tanstackstart-react/src/index.client.ts
@@ -0,0 +1,2 @@
+export * from './client';
+export * from './common';
diff --git a/packages/tanstackstart-react/src/index.server.ts b/packages/tanstackstart-react/src/index.server.ts
@@ -0,0 +1,3 @@
+export * from './config';
+export * from './server';
+export * from './common';
diff --git a/packages/tanstackstart-react/src/index.types.ts b/packages/tanstackstart-react/src/index.types.ts
@@ -0,0 +1,27 @@
+// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
+// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
+export * from './config';
+export * from './client';
+export * from './server';
+export * from './common';
+
+import type { Client, Integration, Options, StackParser } from '@sentry/core';
+
+import type * as clientSdk from './client';
+import type * as serverSdk from './server';
+
+/** Initializes Sentry TanStack Start SDK */
+export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;
+
+export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
+export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
+
+export declare const getDefaultIntegrations: (options: Options) => Integration[];
+export declare const defaultStackParser: StackParser;
+
+export declare function getSentryRelease(fallback?: string): string | undefined;
+
+export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
+export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
+export declare const showReportDialog: typeof clientSdk.showReportDialog;
+export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
diff --git a/packages/tanstackstart-react/src/server/index.ts b/packages/tanstackstart-react/src/server/index.ts
@@ -0,0 +1,42 @@
+export * from '@sentry/node';
+
+/**
+ * A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
+ * so they should simply be a passthrough.
+ */
+export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
+  if (!props.children) {
+    return null;
+  }
+
+  if (typeof props.children === 'function') {
+    return (props.children as () => React.ReactNode)();
+  }
+
+  return props.children;
+};
+
+/**
+ * A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
+ */
+export function createReduxEnhancer() {
+  return (createStore: unknown) => createStore;
+}
+
+/**
+ * A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
+ * SSR errors so they should simply be a passthrough.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function withErrorBoundary<P extends Record<string, any>>(
+  WrappedComponent: React.ComponentType<P>,
+): React.FC<P> {
+  return WrappedComponent as React.FC<P>;
+}
+
+/**
+ * Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
+ */
+export function showReportDialog(): void {
+  return;
+}
diff --git a/packages/tanstackstart-react/test/temp.test.ts b/packages/tanstackstart-react/test/temp.test.ts
@@ -0,0 +1,7 @@
+import { describe, it, expect } from 'vitest';
+
+describe('Basic test suite', () => {
+  it('should pass', () => {
+    expect(true).toBe(true);
+  });
+});
diff --git a/packages/tanstackstart-react/test/tsconfig.json b/packages/tanstackstart-react/test/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../tsconfig.test.json"
+}
diff --git a/packages/tanstackstart-react/tsconfig.json b/packages/tanstackstart-react/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "lib": ["es2018", "es2020.string"],
+    "module": "Node16"
+  }
+}
diff --git a/packages/tanstackstart-react/tsconfig.test.json b/packages/tanstackstart-react/tsconfig.test.json
@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["test/**/*", "vite.config.ts"],
+  "compilerOptions": {
+    "types": ["node"],
+    "lib": ["DOM", "ESNext"]
+  }
+}
diff --git a/packages/tanstackstart-react/tsconfig.types.json b/packages/tanstackstart-react/tsconfig.types.json
diff --git a/packages/tanstackstart-react/vite.config.ts b/packages/tanstackstart-react/vite.config.ts
diff --git a/packages/tanstackstart/README.md b/packages/tanstackstart/README.md
diff --git a/packages/tanstackstart/package.json b/packages/tanstackstart/package.json
diff --git a/packages/tanstackstart/rollup.npm.config.mjs b/packages/tanstackstart/rollup.npm.config.mjs
diff --git a/packages/tanstackstart/src/client/index.ts b/packages/tanstackstart/src/client/index.ts
diff --git a/packages/tanstackstart/src/common/index.ts b/packages/tanstackstart/src/common/index.ts
diff --git a/packages/tanstackstart/src/config/index.ts b/packages/tanstackstart/src/config/index.ts
diff --git a/packages/tanstackstart/src/index.types.ts b/packages/tanstackstart/src/index.types.ts
diff --git a/packages/tanstackstart/src/server/index.ts b/packages/tanstackstart/src/server/index.ts
diff --git a/yarn.lock b/yarn.lock
