fix(node): Include `debug_meta` with ANR events #14203

timfish · 2024-11-07T11:28:14Z

Ref: ANR Events not Symbolicating sentry-electron#1011

Sends a map of filename -> debug ids to the ANR worker thread and sends an updated list every time more modules are loaded. These are then used and included with events so they can be symbolicated

codecov · 2024-11-07T11:37:45Z

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
241	1	240	8

View the full list of 1 ❄️ flaky tests

sse.test.ts Waits for sse streaming when sse has been explicitly aborted
Flake rate in main: 48.57% (Passed 54 times, Failed 51 times)
Stack Traces | 1.27s run time
sse.test.ts:37:5 Waits for sse streaming when sse has been explicitly aborted

To view more test analytics, go to the Test Analytics Dashboard
Got feedback? Let us know on Github

AbhiPrasad · 2024-11-11T15:32:38Z

packages/node/src/integrations/anr/index.ts

+  let debugImages: Record<string, string> = getFilenameToDebugIdMap(initOptions.stackParser);
+
+  onModuleLoad(() => {
+    debugImages = getFilenameToDebugIdMap(initOptions.stackParser);


Isn't this potentially called every require/import? That means we re-calculate this every time. That feels like a lot of work.

We could debounce the require/import but any delay sending the debug ids to the worker could result in missing debug ids.

If global._sentryDebugIds is undefined, getFilenameToDebugIdMap returns immediately so this only impacts those with injected debug id polyfills. getFilenameToDebugIdMap already caches a lot. If there have been no additions to global._sentryDebugIds, no stack parsing occurs. There is still scope for it to cache more though and simplify the work done on each call. That would probably be a good start 🤔

Alright let's proceed for now, we should re-visit this though.

AbhiPrasad · 2024-11-11T15:33:09Z

packages/node/src/integrations/anr/index.ts

+  // eslint-disable-next-line deprecation/deprecation
+  diagnosticsChannel.channel('module.require.end').subscribe(() => callback());
+  // eslint-disable-next-line deprecation/deprecation
+  diagnosticsChannel.channel('module.import.asyncEnd').subscribe(() => callback());


Why are these deprecated?

There's a new API in diagnostics_channel to subscribe to a channel but we need to support older Node versions where this doesn't exist so we rely on the deprecated API.

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.37.1` -> `8.40.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.37.1/8.40.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.37.1` -> `8.40.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.37.1/8.40.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.40.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8400) [Compare Source](getsentry/sentry-javascript@8.39.0...8.40.0) ##### Important Changes - **feat(angular): Support Angular 19 ([#14398](getsentry/sentry-javascript#14398 The `@sentry/angular` SDK can now be used with Angular 19. If you're upgrading to the new Angular version, you might want to migrate from the now deprecated `APP_INITIALIZER` token to `provideAppInitializer`. In this case, change the Sentry `TraceService` initialization in `app.config.ts`: ```ts // Angular 18 export const appConfig: ApplicationConfig = { providers: [ // other providers { provide: TraceService, deps: [Router], }, { provide: APP_INITIALIZER, useFactory: () => () => {}, deps: [TraceService], multi: true, }, ], }; // Angular 19 export const appConfig: ApplicationConfig = { providers: [ // other providers { provide: TraceService, deps: [Router], }, provideAppInitializer(() => { inject(TraceService); }), ], }; ``` - **feat(core): Deprecate `debugIntegration` and `sessionTimingIntegration` ([#14363](getsentry/sentry-javascript#14363 The `debugIntegration` was deprecated and will be removed in the next major version of the SDK. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...). The `sessionTimingIntegration` was deprecated and will be removed in the next major version of the SDK. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`). - **feat(nestjs): Deprecate `@WithSentry` in favor of `@SentryExceptionCaptured` ([#14323](getsentry/sentry-javascript#14323 The `@WithSentry` decorator was deprecated. Use `@SentryExceptionCaptured` instead. This is a simple renaming and functionality stays identical. - **feat(nestjs): Deprecate `SentryTracingInterceptor`, `SentryService`, `SentryGlobalGenericFilter`, `SentryGlobalGraphQLFilter` ([#14371](getsentry/sentry-javascript#14371 The `SentryTracingInterceptor` was deprecated. If you are using `@sentry/nestjs` you can safely remove any references to the `SentryTracingInterceptor`. If you are using another package migrate to `@sentry/nestjs` and remove the `SentryTracingInterceptor` afterwards. The `SentryService` was deprecated and its functionality was added to `Sentry.init`. If you are using `@sentry/nestjs` you can safely remove any references to the `SentryService`. If you are using another package migrate to `@sentry/nestjs` and remove the `SentryService` afterwards. The `SentryGlobalGenericFilter` was deprecated. Use the `SentryGlobalFilter` instead which is a drop-in replacement. The `SentryGlobalGraphQLFilter` was deprecated. Use the `SentryGlobalFilter` instead which is a drop-in replacement. - **feat(node): Deprecate `nestIntegration` and `setupNestErrorHandler` in favor of using `@sentry/nestjs` ([#14374](getsentry/sentry-javascript#14374 The `nestIntegration` and `setupNestErrorHandler` functions from `@sentry/node` were deprecated and will be removed in the next major version of the SDK. If you're using `@sentry/node` in a NestJS application, we recommend switching to our new dedicated `@sentry/nestjs` package. ##### Other Changes - feat(browser): Send additional LCP timing info ([#14372](getsentry/sentry-javascript#14372)) - feat(replay): Clear event buffer when full and in buffer mode ([#14078](getsentry/sentry-javascript#14078)) - feat(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is merged ([#14315](getsentry/sentry-javascript#14315)) - feat(core): Hoist everything from `@sentry/utils` into `@sentry/core` ([#14382](getsentry/sentry-javascript#14382)) - fix(core): Do not throw when trying to fill readonly properties ([#14402](getsentry/sentry-javascript#14402)) - fix(feedback): Fix `__self` and `__source` attributes on feedback nodes ([#14356](getsentry/sentry-javascript#14356)) - fix(feedback): Fix non-wrapping form title ([#14355](getsentry/sentry-javascript#14355)) - fix(nextjs): Update check for not found navigation error ([#14378](getsentry/sentry-javascript#14378)) ### [`v8.39.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8390) [Compare Source](getsentry/sentry-javascript@8.38.0...8.39.0) ##### Important Changes - **feat(nestjs): Instrument event handlers ([#14307](getsentry/sentry-javascript#14307 The `@sentry/nestjs` SDK will now capture performance data for [NestJS Events (`@nestjs/event-emitter`)](https://docs.nestjs.com/techniques/events) ##### Other Changes - feat(nestjs): Add alias `@SentryExceptionCaptured` for `@WithSentry` ([#14322](getsentry/sentry-javascript#14322)) - feat(nestjs): Duplicate `SentryService` behaviour into `@sentry/nestjs` SDK `init()` ([#14321](getsentry/sentry-javascript#14321)) - feat(nestjs): Handle GraphQL contexts in `SentryGlobalFilter` ([#14320](getsentry/sentry-javascript#14320)) - feat(node): Add alias `childProcessIntegration` for `processThreadBreadcrumbIntegration` and deprecate it ([#14334](getsentry/sentry-javascript#14334)) - feat(node): Ensure request bodies are reliably captured for http requests ([#13746](getsentry/sentry-javascript#13746)) - feat(replay): Upgrade rrweb packages to 2.29.0 ([#14160](getsentry/sentry-javascript#14160)) - fix(cdn): Ensure `_sentryModuleMetadata` is not mangled ([#14344](getsentry/sentry-javascript#14344)) - fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` ([#14251](getsentry/sentry-javascript#14251)) - fix(mongo): rewrite Buffer as ? during serialization ([#14071](getsentry/sentry-javascript#14071)) - fix(replay): Remove replay id from DSC on expired sessions ([#14342](getsentry/sentry-javascript#14342)) - ref(profiling) Fix electron crash ([#14216](getsentry/sentry-javascript#14216)) - ref(types): Deprecate `Request` type in favor of `RequestEventData` ([#14317](getsentry/sentry-javascript#14317)) - ref(utils): Stop setting `transaction` in `requestDataIntegration` ([#14306](getsentry/sentry-javascript#14306)) - ref(vue): Reduce bundle size for starting application render span ([#14275](getsentry/sentry-javascript#14275)) ### [`v8.38.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8380) [Compare Source](getsentry/sentry-javascript@8.37.1...8.38.0) - docs: Improve docstrings for node otel integrations ([#14217](getsentry/sentry-javascript#14217)) - feat(browser): Add moduleMetadataIntegration lazy loading support ([#13817](getsentry/sentry-javascript#13817)) - feat(core): Add trpc path to context in trpcMiddleware ([#14218](getsentry/sentry-javascript#14218)) - feat(deps): Bump [@opentelemetry/instrumentation-amqplib](https://github.com/opentelemetry/instrumentation-amqplib) from 0.42.0 to 0.43.0 ([#14230](getsentry/sentry-javascript#14230)) - feat(deps): Bump [@sentry/cli](https://github.com/sentry/cli) from 2.37.0 to 2.38.2 ([#14232](getsentry/sentry-javascript#14232)) - feat(node): Add `knex` integration ([#13526](getsentry/sentry-javascript#13526)) - feat(node): Add `tedious` integration ([#13486](getsentry/sentry-javascript#13486)) - feat(utils): Single implementation to fetch debug ids ([#14199](getsentry/sentry-javascript#14199)) - fix(browser): Avoid recording long animation frame spans starting before their parent span ([#14186](getsentry/sentry-javascript#14186)) - fix(node): Include `debug_meta` with ANR events ([#14203](getsentry/sentry-javascript#14203)) - fix(nuxt): Fix dynamic import rollup plugin to work with latest nitro ([#14243](getsentry/sentry-javascript#14243)) - fix(react): Support wildcard routes on React Router 6 ([#14205](getsentry/sentry-javascript#14205)) - fix(spotlight): Export spotlightBrowserIntegration from the main browser package ([#14208](getsentry/sentry-javascript#14208)) - ref(browser): Ensure start time of interaction root and child span is aligned ([#14188](getsentry/sentry-javascript#14188)) - ref(nextjs): Make build-time value injection turbopack compatible ([#14081](getsentry/sentry-javascript#14081)) Work in this release was contributed by [@grahamhency](https://github.com/grahamhency), [@Zen-cronic](https://github.com/Zen-cronic), [@gilisho](https://github.com/gilisho) and [@phuctm97](https://github.com/phuctm97). Thank you for your contributions! </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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/317 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>

timfish added 2 commits November 7, 2024 12:16

fix(node): Include debug_meta with ANR events

2d91524

oh linting

94d7f5b

timfish added 2 commits November 8, 2024 12:37

Merge branch 'develop' into timfish/fix/node-anr-debug-meta

2eb5a05

Merge branch 'develop' into timfish/fix/node-anr-debug-meta

079d6b5

timfish marked this pull request as ready for review November 11, 2024 10:27

AbhiPrasad reviewed Nov 11, 2024

View reviewed changes

AbhiPrasad approved these changes Nov 11, 2024

View reviewed changes

AbhiPrasad merged commit fac7209 into develop Nov 11, 2024
133 checks passed

AbhiPrasad deleted the timfish/fix/node-anr-debug-meta branch November 11, 2024 17:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(node): Include `debug_meta` with ANR events #14203

fix(node): Include `debug_meta` with ANR events #14203

timfish commented Nov 7, 2024 •

edited

Loading

codecov bot commented Nov 7, 2024 •

edited

Loading

AbhiPrasad Nov 11, 2024

timfish Nov 11, 2024

AbhiPrasad Nov 11, 2024

AbhiPrasad Nov 11, 2024

timfish Nov 11, 2024 •

edited

Loading

fix(node): Include debug_meta with ANR events #14203

fix(node): Include debug_meta with ANR events #14203

Conversation

timfish commented Nov 7, 2024 • edited Loading

codecov bot commented Nov 7, 2024 • edited Loading

❌ 1 Tests Failed:

AbhiPrasad Nov 11, 2024

Choose a reason for hiding this comment

timfish Nov 11, 2024

Choose a reason for hiding this comment

AbhiPrasad Nov 11, 2024

Choose a reason for hiding this comment

AbhiPrasad Nov 11, 2024

Choose a reason for hiding this comment

timfish Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

fix(node): Include `debug_meta` with ANR events #14203

fix(node): Include `debug_meta` with ANR events #14203

timfish commented Nov 7, 2024 •

edited

Loading

codecov bot commented Nov 7, 2024 •

edited

Loading

timfish Nov 11, 2024 •

edited

Loading