From 8c4000d4341b9fe08124bfb04fde0e2b3f7054ac Mon Sep 17 00:00:00 2001 From: Andrei Borza Date: Wed, 28 Aug 2024 19:06:18 +0200 Subject: [PATCH 1/4] ref(solidstart): Overhaul solidstart options and sourcemap uploading --- .../getting-started-config/javascript.solidstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/platform-includes/getting-started-config/javascript.solidstart.mdx b/platform-includes/getting-started-config/javascript.solidstart.mdx index dc2f797109457..8b7fc13982e5c 100644 --- a/platform-includes/getting-started-config/javascript.solidstart.mdx +++ b/platform-includes/getting-started-config/javascript.solidstart.mdx @@ -53,7 +53,7 @@ The Sentry SDK provides [middleware lifecycle](https://docs.solidjs.com/solid-st Complete the setup by adding `sentryBeforeResponseMiddleware` to your `src/middleware.ts` file. If you don't have a `src/middleware.ts` file yet, create one: ```typescript {filename:src/middleware.ts} -import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware'; +import { sentryBeforeResponseMiddleware } from '@sentry/solidstart'; import { createMiddleware } from '@solidjs/start/middleware'; export default createMiddleware({ From 434c42cc474e0b4a700c4744bce3ba325c3f8172 Mon Sep 17 00:00:00 2001 From: Andrei Borza Date: Wed, 28 Aug 2024 19:24:41 +0200 Subject: [PATCH 2/4] Update sourcemap section --- .../javascript.solidstart.mdx | 46 ++++++++----------- 1 file changed, 19 insertions(+), 27 deletions(-) diff --git a/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx b/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx index c9d582346b284..263c5d8cb4ef8 100644 --- a/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx +++ b/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx @@ -1,24 +1,14 @@ ## Add Readable Stack Traces to Errors -To generate and upload source maps of your Solid Start app use our Vite bundler plugin. +To upload source maps, use the `sentrySolidStartVite` plugin from `@sentry/solidstart` and configure an auth token. +Auth tokens can be passed to the plugin explicitly with the `authToken` option with a +`SENTRY_AUTH_TOKEN` environment variable or with an `.env.sentry-build-plugin` file in the working directory when +building your project. -### Install +We recommend you add the auth token to your CI/CD environment as an environment variable. -```bash {tabTitle:npm} -npm install --save-dev @sentry/vite-plugin -``` - -```bash {tabTitle:yarn} -yarn add --dev @sentry/vite-plugin -``` - -```bash {tabTitle:pnpm} -pnpm add --save-dev @sentry/vite-plugin -``` - -### Config - -To get readable stack traces in your production builds, set the `SENTRY_AUTH_TOKEN` environment variable in your build environment. You can also add the environment variable to a `.env.sentry-build-plugin` file in the root of your project. +Learn more about configuring the plugin in our +[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin). @@ -28,26 +18,28 @@ SENTRY_PROJECT="___PROJECT_SLUG___" SENTRY_AUTH_TOKEN="___ORG_AUTH_TOKEN___" ``` -Finally, add the plugin in `app.config.ts` and enable sourcemaps. +Add the plugin to your `app.config.ts`. + ```TypeScript {filename:app.config.ts} +// app.config.ts import { defineConfig } from '@solidjs/start/config'; -import { sentryVitePlugin } from '@sentry/vite-plugin'; +import { sentrySolidStartVite } from '@sentry/solidstart'; export default defineConfig({ - // rest of your config // ... + vite: { - build: { - sourcemap: true, - }, plugins: [ - sentryVitePlugin({ - org: process.env.SENTRY_ORG, - project: process.env.SENTRY_PROJECT, - authToken: process.env.SENTRY_AUTH_TOKEN, + sentrySolidStartVite({ + sourceMapsUploadOptions: { + org: process.env.SENTRY_ORG, + project: process.env.SENTRY_PROJECT, + authToken: process.env.SENTRY_AUTH_TOKEN, + }, }), ], }, + // ... }); ``` From 39c20258de9f625a16e64855b4d5418ca2a609c1 Mon Sep 17 00:00:00 2001 From: Andrei Borza Date: Thu, 29 Aug 2024 10:29:11 +0200 Subject: [PATCH 3/4] Update options structure to reflect the latest changes --- .../getting-started-sourcemaps/javascript.solidstart.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx b/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx index 263c5d8cb4ef8..f237ff70cd84d 100644 --- a/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx +++ b/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx @@ -32,11 +32,9 @@ export default defineConfig({ vite: { plugins: [ sentrySolidStartVite({ - sourceMapsUploadOptions: { - org: process.env.SENTRY_ORG, - project: process.env.SENTRY_PROJECT, - authToken: process.env.SENTRY_AUTH_TOKEN, - }, + org: process.env.SENTRY_ORG, + project: process.env.SENTRY_PROJECT, + authToken: process.env.SENTRY_AUTH_TOKEN, }), ], }, From 9a073f3dc01b0c18423fd298a44959312c01d0b7 Mon Sep 17 00:00:00 2001 From: Andrei <168741329+andreiborza@users.noreply.github.com> Date: Tue, 3 Sep 2024 02:58:02 +0200 Subject: [PATCH 4/4] Update platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- .../getting-started-sourcemaps/javascript.solidstart.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx b/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx index f237ff70cd84d..2bfcd9b3bf8ab 100644 --- a/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx +++ b/platform-includes/getting-started-sourcemaps/javascript.solidstart.mdx @@ -1,8 +1,8 @@ ## Add Readable Stack Traces to Errors To upload source maps, use the `sentrySolidStartVite` plugin from `@sentry/solidstart` and configure an auth token. -Auth tokens can be passed to the plugin explicitly with the `authToken` option with a -`SENTRY_AUTH_TOKEN` environment variable or with an `.env.sentry-build-plugin` file in the working directory when +Auth tokens can be passed to the plugin explicitly with the `authToken` option. You can use the +`SENTRY_AUTH_TOKEN` environment variable or have an `.env.sentry-build-plugin` file in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.