fix(opentelemetry): Use WeakRef for context stored on scope to prevent memory leak#20328
Merged
fix(opentelemetry): Use WeakRef for context stored on scope to prevent memory leak#20328
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 1142bec. Configure here.
| expect(storedRef).toBeDefined(); | ||
| expect(typeof (storedRef as { deref?: unknown }).deref).toBe('function'); | ||
| } | ||
| }); |
There was a problem hiding this comment.
Test conditional makes assertions silently skippable
Low Severity
The test "uses WeakRef when available" wraps all its expect assertions inside if (typeof WeakRef !== 'undefined'). If WeakRef were ever unavailable in the test environment, the test would pass silently without asserting anything. Per the project review rules, conditionals in a single test are discouraged — this could be split into two separate tests (one for when WeakRef is available, one for when it isn't) to ensure assertions always run.
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 1142bec. Configure here.
Contributor
size-limit report 📦
|
…t memory leak When using pooled connections (e.g., pg) with OTel instrumentation, patched callbacks can retain references to contexts. Previously, contexts held strong references to scopes, and scopes held strong references back to contexts, creating a circular reference that prevented garbage collection. This change: - Adds a shared WeakRef utility (makeWeakRef/derefWeakRef) in @sentry/core - Uses WeakRef for the context stored on scope, breaking the circular reference - Refactors tracing/utils.ts to use the shared utility - Adds comprehensive unit tests for the WeakRef utility Fixes #20174 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Tests for getScopesFromContext, setScopesOnContext, setContextOnScope, and getContextFromScope including WeakRef behavior verification. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
JPeer264
force-pushed
the
jp/fastify-oom
branch
from
1142bec to
e4c6473
Compare
46 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #20174
closes JS-2106
When using pooled connections (e.g., pg) with OTel instrumentation, patched callbacks can retain references to contexts. Previously, contexts held strong references to scopes, and scopes held strong references back to contexts, creating a circular reference that prevented garbage collection.
This change:
Load tests with Artillery ran against the reproduction s1gr1d/sentry-js-20174-fastify-memory before and after the fix. With reusing the
makeWeakRefandderefWeakRefthe memory leak is gone. If it makes more sense to split this up into two PRs (1. exportingmakeWeakRefandderefWeakRefand 2. the actual fix, I'm happy to do it)