Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(solidstart): Add sentrySolidStartVite plugin to simplify source maps upload #13493

Merged
merged 15 commits into from
Sep 5, 2024

Conversation

andreiborza
Copy link
Member

@andreiborza andreiborza commented Aug 28, 2024

This plugin simplifies source maps upload by using @sentry/vite-plugin and enabling source map generation by default.

Usage:

import { defineConfig } from '@solidjs/start/config'
import { sentrySolidStartVite } from '@sentry/solidstart'

export default defineConfig({
  vite: {
    plugins: [
      sentrySolidStartVite({
        org: process.env.SENTRY_ORG,
        project: process.env.SENTRY_PROJECT,
        authToken: process.env.SENTRY_AUTH_TOKEN,
        debug: true,
      }),
    ],
  }
})

Closes: #12553

@andreiborza andreiborza added the Package: solidstart Issues related to the Sentry SolidStart SDK label Aug 28, 2024
* Enable debug functionality of the SDK during build-time.
* Enabling this will give you, for example logs about source maps.
*/
debug?: boolean;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m/h: We seem to have two debug options saying the exact same thing. Should we unify them in some way?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is due to the way I structured the plugin. I wanted to keep the option open to have future plugins within this plugin while also passing each plugin the options they need, so they all will (would) get a debug flag passed in based on the parent options.

/**
* Options related to sourcemaps
*/
sourcemaps?: {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: I find it a bit odd that we are nesting it like sourceMapsUploadOptions.sourcemaps. Can we hoist it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found this a bit odd too but I'm following in the path of Nuxt and Sveltekit. I can change it but thought it might be better to align with the other packages, wdyt?

Copy link
Member

@lforst lforst Aug 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I completely like how we did it in those packages tbh. I'll leave it up to you. It is fine to question these things btw.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I flattened this.

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
export type SentrySolidStartPluginOptions = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: I think the structure of this object can be improved. You may want things like org, project, authToken top level, as they are not necessarily tied to source maps but to release creation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I aligned this with the Nuxt and Sveltekit package, can change but I think it's better to keep the consistency, wdyt?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly to the debug, I decided to keep it like this because this plugin could be used for more than just source maps/sentry's vite plugin in the future.

The keys would have to be passed along anyway(unless every plugin has access to the entire plugin config) ending up with repeated keys. For the sake of keeping API surface low I think we should stick with this for now and reevaluate if they do need these keys hoisted when the time comes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lforst I thought about this some more and I think you're right, I flattened this.

@@ -0,0 +1,94 @@
export type SourceMapsOptions = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: I very strongly recommend adding some sort of escape hatch for when people want to actually modify the underlying plugin options. We have seen that something like we do in Next.js works very well:

unstable_sentryWebpackPluginOptions?: SentryWebpackPluginOptions;

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 will add

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

Comment on lines 21 to 28
if (!options.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Any reason to only log this when we detect that the user hasn't manually enabled sourcemaps?

Copy link
Member Author

@andreiborza andreiborza Aug 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aligning with the other packages, aside from that I do think it's nice to see why sourcemaps are being generated and uploaded despite setting sourcemap: false.

Comment on lines 44 to 46
assets: options.sourcemaps?.assets ?? undefined,
ignore: options.sourcemaps?.ignore ?? undefined,
filesToDeleteAfterUpload: options.sourcemaps?.filesToDeleteAfterUpload ?? undefined,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h: Can we be opinionated with these options? Or rather do we need to be opinionated? I know that we struggled in Nuxt to properly detect the files.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, I removed these options except filesToDeleteAfterUpload to reduce the API surface. The source maps get auto-picked up for now and if we need this in the future we can always add it again.

Copy link
Contributor

github-actions bot commented Sep 4, 2024

size-limit report 📦

⚠️ Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

Path Size % Change Change
@sentry/browser 22.52 KB +0.02% +4 B 🔺
@sentry/browser (incl. Tracing) 34.78 KB +0.02% +4 B 🔺
@sentry/browser (incl. Tracing, Replay) 71.22 KB +0.01% +5 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 61.66 KB -4.39% -2.83 KB 🔽
@sentry/browser (incl. Tracing, Replay with Canvas) 75.57 KB +0.01% +4 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback) 88.29 KB +0.01% +5 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 90.13 KB +0.01% +6 B 🔺
@sentry/browser (incl. metrics) 26.83 KB +0.02% +4 B 🔺
@sentry/browser (incl. Feedback) 39.6 KB +0.02% +5 B 🔺
@sentry/browser (incl. sendFeedback) 27.19 KB +0.02% +5 B 🔺
@sentry/browser (incl. FeedbackAsync) 31.9 KB +0.02% +4 B 🔺
@sentry/react 25.28 KB +0.02% +5 B 🔺
@sentry/react (incl. Tracing) 37.74 KB +0.02% +6 B 🔺
@sentry/vue 26.67 KB +0.02% +5 B 🔺
@sentry/vue (incl. Tracing) 36.61 KB +0.02% +5 B 🔺
@sentry/svelte 22.65 KB +0.03% +5 B 🔺
CDN Bundle 23.77 KB +0.03% +7 B 🔺
CDN Bundle (incl. Tracing) 36.49 KB +0.02% +6 B 🔺
CDN Bundle (incl. Tracing, Replay) 70.9 KB +0.01% +7 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) 76.21 KB +0.01% +7 B 🔺
CDN Bundle - uncompressed 69.63 KB +0.02% +12 B 🔺
CDN Bundle (incl. Tracing) - uncompressed 108.21 KB +0.02% +12 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed 219.86 KB +0.01% +12 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 233.05 KB +0.01% +12 B 🔺
@sentry/nextjs (client) 37.51 KB +0.01% +3 B 🔺
@sentry/sveltekit (client) 35.35 KB +0.02% +6 B 🔺
@sentry/node 117.41 KB +0.86% +1018 B 🔺
@sentry/node - without tracing 91.1 KB +1.21% +1.08 KB 🔺
@sentry/aws-serverless 100.4 KB +0.97% +978 B 🔺
@sentry/browser - with treeshaking flags 21.3 KB added added

View base workflow run

Copy link
Member

@s1gr1d s1gr1d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work and congrats for figuring out the test situation! Had one minor question about the plugin but nothing major!

export default defineConfig({});
export default defineConfig({
vite: {
plugins: [sentrySolidStartVite({})],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l/just personal opinion: It feels a bit awkward that users need to pass an options object but can leave it empty. Should we make the options object optional? I might be missing something but technically, I could pass all required options for source maps upload as env variables, right? (project slug and auth token)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, good point! I'll make this optional.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Lms24 updated

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@andreiborza andreiborza merged commit e2213fc into develop Sep 5, 2024
130 checks passed
@andreiborza andreiborza deleted the ab/solidstart-plugin branch September 5, 2024 11:37
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Sep 12, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.26.0/8.30.0) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.26.0/8.30.0) |

---

### Release Notes

<details>
<summary>getsentry/sentry-javascript (@&#8203;sentry/node)</summary>

### [`v8.30.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8300)

[Compare Source](getsentry/sentry-javascript@8.29.0...8.30.0)

##### Important Changes

-   *feat(node): Add `kafkajs` integration ([#&#8203;13528](getsentry/sentry-javascript#13528

This release adds a new integration that instruments `kafkajs` library with spans and traces. This integration is
automatically enabled by default, but can be included with the `Sentry.kafkaIntegration()` import.

```js
Sentry.init({
  integrations: [Sentry.kafkaIntegration()],
});
```

##### Other Changes

-   feat(core): Allow adding measurements without global client ([#&#8203;13612](getsentry/sentry-javascript#13612))
-   feat(deps): Bump [@&#8203;opentelemetry/instrumentation-undici](https://github.com/opentelemetry/instrumentation-undici) from 0.5.0 to 0.6.0 ([#&#8203;13622](getsentry/sentry-javascript#13622))
-   feat(deps): Bump [@&#8203;sentry/cli](https://github.com/sentry/cli) from 2.33.0 to 2.35.0 ([#&#8203;13624](getsentry/sentry-javascript#13624))
-   feat(node): Use `@opentelemetry/instrumentation-undici` for fetch tracing ([#&#8203;13485](getsentry/sentry-javascript#13485))
-   feat(nuxt): Add server config to root folder ([#&#8203;13583](getsentry/sentry-javascript#13583))
-   feat(otel): Upgrade [@&#8203;opentelemetry/semantic-conventions](https://github.com/opentelemetry/semantic-conventions) to 1.26.0 ([#&#8203;13631](getsentry/sentry-javascript#13631))
-   fix(browser): check supportedEntryTypes before caling the function ([#&#8203;13541](getsentry/sentry-javascript#13541))
-   fix(browser): Ensure Standalone CLS span timestamps are correct ([#&#8203;13649](getsentry/sentry-javascript#13649))
-   fix(nextjs): Widen removal of 404 transactions ([#&#8203;13628](getsentry/sentry-javascript#13628))
-   fix(node): Remove ambiguity and race conditions when matching local variables to exceptions ([#&#8203;13501](getsentry/sentry-javascript#13501))
-   fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#&#8203;13640](getsentry/sentry-javascript#13640))
-   fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#&#8203;13642](getsentry/sentry-javascript#13642))
-   fix(vue): Ensure Vue `trackComponents` list matches components with or without `<>` ([#&#8203;13543](getsentry/sentry-javascript#13543))
-   ref(profiling): Conditionally shim cjs globals ([#&#8203;13267](getsentry/sentry-javascript#13267))

Work in this release was contributed by [@&#8203;Zen-cronic](https://github.com/Zen-cronic) and [@&#8203;odanado](https://github.com/odanado). Thank you for your contributions!

### [`v8.29.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8290)

[Compare Source](getsentry/sentry-javascript@8.28.0...8.29.0)

##### Important Changes

-   **Beta releases of official Solid and SolidStart Sentry SDKs**

This release marks the beta releases of the `@sentry/solid` and `@sentry/solidstart` Sentry SDKs. For details on how to
use them, check out the
[Sentry Solid SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solid) and the
[Sentry SolidStart SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solidstart)
respectively. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have
any feedback or concerns.

-   **feat(node): Option to only wrap instrumented modules ([#&#8203;13139](getsentry/sentry-javascript#13139

Adds the SDK option to only wrap ES modules with `import-in-the-middle` that specifically need to be instrumented.

```javascript
import * as Sentry from '@&#8203;sentry/node';

Sentry.init({
  dsn: '__PUBLIC_DSN__',
  registerEsmLoaderHooks: { onlyIncludeInstrumentedModules: true },
});
```

-   **feat(node): Update OpenTelemetry packages to instrumentation v0.53.0 ([#&#8203;13587](getsentry/sentry-javascript#13587

All internal OpenTelemetry instrumentation was updated to their latest version. This adds support for Mongoose v7 and v8
and fixes various bugs related to ESM mode.

##### Other Changes

-   feat(nextjs): Emit warning when using turbopack ([#&#8203;13566](getsentry/sentry-javascript#13566))
-   feat(nextjs): Future-proof Next.js config options overriding ([#&#8203;13586](getsentry/sentry-javascript#13586))
-   feat(node): Add `generic-pool` integration ([#&#8203;13465](getsentry/sentry-javascript#13465))
-   feat(nuxt): Upload sourcemaps generated by Nitro ([#&#8203;13382](getsentry/sentry-javascript#13382))
-   feat(solidstart): Add `browserTracingIntegration` by default ([#&#8203;13561](getsentry/sentry-javascript#13561))
-   feat(solidstart): Add `sentrySolidStartVite` plugin to simplify source maps upload ([#&#8203;13493](getsentry/sentry-javascript#13493))
-   feat(vue): Only start UI spans if parent is available ([#&#8203;13568](getsentry/sentry-javascript#13568))
-   fix(cloudflare): Guard `context.waitUntil` call in request handler ([#&#8203;13549](getsentry/sentry-javascript#13549))
-   fix(gatsby): Fix assets path for sourcemaps upload ([#&#8203;13592](getsentry/sentry-javascript#13592))
-   fix(nextjs): Use posix paths for sourcemap uploads ([#&#8203;13603](getsentry/sentry-javascript#13603))
-   fix(node-fetch): Use stringified origin url ([#&#8203;13581](getsentry/sentry-javascript#13581))
-   fix(node): Replace dashes in `generic-pool` span origins with underscores ([#&#8203;13579](getsentry/sentry-javascript#13579))
-   fix(replay): Fix types in WebVitalData ([#&#8203;13573](getsentry/sentry-javascript#13573))
-   fix(replay): Improve replay web vital types ([#&#8203;13602](getsentry/sentry-javascript#13602))
-   fix(utils): Keep logger on carrier ([#&#8203;13570](getsentry/sentry-javascript#13570))

Work in this release was contributed by [@&#8203;Zen-cronic](https://github.com/Zen-cronic). Thank you for your contribution!

### [`v8.28.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8280)

[Compare Source](getsentry/sentry-javascript@8.27.0...8.28.0)

##### Important Changes

-   **Beta release of official NestJS SDK**

This release contains the beta version of `@sentry/nestjs`! For details on how to use it, check out the
[README](https://github.com/getsentry/sentry-javascript/blob/master/packages/nestjs/README.md). Any feedback/bug reports
are greatly appreciated, please reach out on GitHub.

-   **fix(browser): Remove faulty LCP, FCP and FP normalization logic ([#&#8203;13502](getsentry/sentry-javascript#13502

This release fixes a bug in the `@sentry/browser` package and all SDKs depending on this package (e.g. `@sentry/react`
or `@sentry/nextjs`) that caused the SDK to send incorrect web vital values for the LCP, FCP and FP vitals. The SDK
previously incorrectly processed the original values as they were reported from the browser. When updating your SDK to
this version, you might experience an increase in LCP, FCP and FP values, which potentially leads to a decrease in your
performance score in the Web Vitals Insights module in Sentry. This is because the previously reported values were
smaller than the actually measured values. We apologize for the inconvenience!

##### Other Changes

-   feat(nestjs): Add `SentryGlobalGraphQLFilter` ([#&#8203;13545](getsentry/sentry-javascript#13545))
-   feat(nestjs): Automatic instrumentation of nestjs interceptors after route execution ([#&#8203;13264](getsentry/sentry-javascript#13264))
-   feat(nextjs): Add `bundleSizeOptimizations` to build options ([#&#8203;13323](getsentry/sentry-javascript#13323))
-   feat(nextjs): Stabilize `captureRequestError` ([#&#8203;13550](getsentry/sentry-javascript#13550))
-   feat(nuxt): Wrap config in nuxt context ([#&#8203;13457](getsentry/sentry-javascript#13457))
-   feat(profiling): Expose profiler as top level primitive ([#&#8203;13512](getsentry/sentry-javascript#13512))
-   feat(replay): Add layout shift to CLS replay data ([#&#8203;13386](getsentry/sentry-javascript#13386))
-   feat(replay): Upgrade rrweb packages to 2.26.0 ([#&#8203;13483](getsentry/sentry-javascript#13483))
-   fix(cdn): Do not mangle \_metadata ([#&#8203;13426](getsentry/sentry-javascript#13426))
-   fix(cdn): Fix SDK source for CDN bundles ([#&#8203;13475](getsentry/sentry-javascript#13475))
-   fix(nestjs): Check arguments before instrumenting with `@Injectable` ([#&#8203;13544](getsentry/sentry-javascript#13544))
-   fix(nestjs): Ensure exception and host are correctly passed on when using [@&#8203;WithSentry](https://github.com/WithSentry) ([#&#8203;13564](getsentry/sentry-javascript#13564))
-   fix(node): Suppress tracing for transport request execution rather than transport creation ([#&#8203;13491](getsentry/sentry-javascript#13491))
-   fix(replay): Consider more things as DOM mutations for dead clicks ([#&#8203;13518](getsentry/sentry-javascript#13518))
-   fix(vue): Correctly obtain component name ([#&#8203;13484](getsentry/sentry-javascript#13484))

Work in this release was contributed by [@&#8203;leopoldkristjansson](https://github.com/leopoldkristjansson), [@&#8203;mhuggins](https://github.com/mhuggins) and [@&#8203;filips123](https://github.com/filips123). Thank you for your
contributions!

### [`v8.27.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8270)

[Compare Source](getsentry/sentry-javascript@8.26.0...8.27.0)

##### Important Changes

-   **fix(nestjs): Exception filters in main app module are not being executed ([#&#8203;13278](getsentry/sentry-javascript#13278

    With this release nestjs error monitoring is no longer automatically set up after adding the `SentryModule` to your
    application, which led to issues in certain scenarios. You will now have to either add the `SentryGlobalFilter` to
    your main module providers or decorate the `catch()` method in your existing global exception filters with the newly
    released `@WithSentry()` decorator. See the [docs](https://docs.sentry.io/platforms/javascript/guides/nestjs/) for
    more details.

##### Other Changes

-   feat: Add options for passing nonces to feedback integration ([#&#8203;13347](getsentry/sentry-javascript#13347))
-   feat: Add support for SENTRY_SPOTLIGHT env var in Node ([#&#8203;13325](getsentry/sentry-javascript#13325))
-   feat(deps): bump [@&#8203;prisma/instrumentation](https://github.com/prisma/instrumentation) from 5.17.0 to 5.18.0 ([#&#8203;13327](getsentry/sentry-javascript#13327))
-   feat(feedback): Improve error message for 403 errors ([#&#8203;13441](getsentry/sentry-javascript#13441))
-   fix(deno): Don't rely on `Deno.permissions.querySync` ([#&#8203;13378](getsentry/sentry-javascript#13378))
-   fix(replay): Ensure we publish replay CDN bundles ([#&#8203;13437](getsentry/sentry-javascript#13437))

Work in this release was contributed by [@&#8203;charpeni](https://github.com/charpeni). Thank you for your contribution!

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC41NS4zIiwidXBkYXRlZEluVmVyIjoiMzguNzMuNyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->

Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/61
Reviewed-by: Alexandre Soro <code@soro.dev>
Co-authored-by: renovate <renovate@git.tristess.app>
Co-committed-by: renovate <renovate@git.tristess.app>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Package: solidstart Issues related to the Sentry SolidStart SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upload sourcemaps automatically in the SolidStart SDK
4 participants