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

fix(node): Don't overwrite local variables for re-thrown errors #13644

Merged
merged 4 commits into from
Sep 13, 2024

Conversation

timfish
Copy link
Collaborator

@timfish timfish commented Sep 10, 2024

Closes #13416

Another way to fix this issue would be to check via the debugger if the property exists already on the error object and bail early before we have local variables. However, this would add an extra round trip call via the debugger for every error. Since re-thrown errors are far less likely, I decided instead to just not overwrite existing local variables.

This PR also adds a Debugger.resume call in the catch case to ensure that they debugger will always resume even if we get errors while debugging.

It's worth noting that this only fixes the issue in Node v20+ where we use the async debugging interface.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

size-limit report 📦

Path Size % Change Change
@sentry/browser 22.52 KB - -
@sentry/browser - with treeshaking flags 21.3 KB - -
@sentry/browser (incl. Tracing) 34.79 KB - -
@sentry/browser (incl. Tracing, Replay) 71.25 KB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 61.69 KB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 75.59 KB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 88.32 KB - -
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 90.16 KB - -
@sentry/browser (incl. metrics) 26.83 KB - -
@sentry/browser (incl. Feedback) 39.6 KB - -
@sentry/browser (incl. sendFeedback) 27.19 KB - -
@sentry/browser (incl. FeedbackAsync) 31.9 KB - -
@sentry/react 25.28 KB - -
@sentry/react (incl. Tracing) 37.75 KB - -
@sentry/vue 26.72 KB - -
@sentry/vue (incl. Tracing) 36.66 KB - -
@sentry/svelte 22.66 KB - -
CDN Bundle 23.77 KB - -
CDN Bundle (incl. Tracing) 36.49 KB - -
CDN Bundle (incl. Tracing, Replay) 70.95 KB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 76.26 KB - -
CDN Bundle - uncompressed 69.65 KB - -
CDN Bundle (incl. Tracing) - uncompressed 108.23 KB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 220.01 KB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 233.21 KB - -
@sentry/nextjs (client) 37.51 KB - -
@sentry/sveltekit (client) 35.36 KB - -
@sentry/node 120.53 KB +0.03% +32 B 🔺
@sentry/node - without tracing 92.81 KB +0.04% +31 B 🔺
@sentry/aws-serverless 102.51 KB +0.03% +27 B 🔺

View base workflow run

@timfish timfish marked this pull request as draft September 10, 2024 10:10
Comment on lines +161 to +164
async _ => {
if (isPaused) {
await session.post('Debugger.resume');
}

Choose a reason for hiding this comment

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

good idea to add some more resiliency.

Comment on lines +121 to +123
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = this.${LOCAL_VARIABLES_KEY} || ${JSON.stringify(
frames,
)}; }`,

Choose a reason for hiding this comment

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

I love how simple this change is now after the redesign.
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Shame it doesn't appear to work now I'm adding a test for it!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah no, I forgot the recent changes only fix this issue in Node v20+ 🤦🏻‍♂️

@timfish timfish marked this pull request as ready for review September 10, 2024 10:41
@AbhiPrasad AbhiPrasad merged commit bcd2a17 into develop Sep 13, 2024
112 checks passed
@AbhiPrasad AbhiPrasad deleted the timfish/fix/dont-overwrite-local-variables branch September 13, 2024 08:42
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Sep 23, 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.30.0` -> `8.31.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.30.0/8.31.0) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.30.0` -> `8.31.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.30.0/8.31.0) |

---

### Release Notes

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

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

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

##### Important Changes

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

This release adds a new integration for the [`dataloader` package](https://www.npmjs.com/package/dataloader). The Node
SDK (and all SDKs that depend on it) will now automatically instrument `dataloader` instances. You can also add it
manually:

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

##### Other Changes

-   feat(browser): Add navigation `activationStart` timestamp to pageload span ([#&#8203;13658](getsentry/sentry-javascript#13658))
-   feat(gatsby): Add optional `deleteSourcemapsAfterUpload` ([#&#8203;13610](getsentry/sentry-javascript#13610))
-   feat(nextjs): Give app router prefetch requests a `http.server.prefetch` op ([#&#8203;13600](getsentry/sentry-javascript#13600))
-   feat(nextjs): Improve Next.js serverside span data quality ([#&#8203;13652](getsentry/sentry-javascript#13652))
-   feat(node): Add `disableInstrumentationWarnings` option ([#&#8203;13693](getsentry/sentry-javascript#13693))
-   feat(nuxt): Adding `experimental_basicServerTracing` option to Nuxt module ([#&#8203;13643](getsentry/sentry-javascript#13643))
-   feat(nuxt): Improve logs about adding Node option 'import' ([#&#8203;13726](getsentry/sentry-javascript#13726))
-   feat(replay): Add `onError` callback + other small improvements to debugging ([#&#8203;13721](getsentry/sentry-javascript#13721))
-   feat(replay): Add experimental option to allow for a checkout every 6 minutes ([#&#8203;13069](getsentry/sentry-javascript#13069))
-   feat(wasm): Unconditionally parse instruction addresses ([#&#8203;13655](getsentry/sentry-javascript#13655))
-   fix: Ensure all logs are wrapped with `consoleSandbox` ([#&#8203;13690](getsentry/sentry-javascript#13690))
-   fix(browser): Try multiple options for `lazyLoadIntegration` script parent element lookup ([#&#8203;13717](getsentry/sentry-javascript#13717))
-   fix(feedback): Actor color applies to feedback icon ([#&#8203;13702](getsentry/sentry-javascript#13702))
-   fix(feedback): Fix form width on mobile devices ([#&#8203;13068](getsentry/sentry-javascript#13068))
-   fix(nestjs): Preserve original function name on `SentryTraced` functions ([#&#8203;13684](getsentry/sentry-javascript#13684))
-   fix(node): Don't overwrite local variables for re-thrown errors ([#&#8203;13644](getsentry/sentry-javascript#13644))
-   fix(normalize): Treat Infinity as NaN both are non-serializable numbers ([#&#8203;13406](getsentry/sentry-javascript#13406))
-   fix(nuxt): Use correct server output file path ([#&#8203;13725](getsentry/sentry-javascript#13725))
-   fix(opentelemetry): Always use active span in `Propagator.inject` ([#&#8203;13381](getsentry/sentry-javascript#13381))
-   fix(replay): Fixes potential out-of-order segments ([#&#8203;13609](getsentry/sentry-javascript#13609))

Work in this release was contributed by [@&#8203;KyGuy2002](https://github.com/KyGuy2002), [@&#8203;artzhookov](https://github.com/artzhookov), and [@&#8203;julianCast](https://github.com/julianCast). 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.

---

 - [ ] <!-- 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:eyJjcmVhdGVkSW5WZXIiOiIzOC45My41IiwidXBkYXRlZEluVmVyIjoiMzguOTMuNSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->

Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/149
Reviewed-by: Alexandre Soro <[email protected]>
Co-authored-by: renovate <[email protected]>
Co-committed-by: renovate <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

LocalVariables integration - re-thrown errors can completely mess up frame variables
3 participants