fix(tracing): Ensure you can pass null as parentSpan in startSpan*
#12928
+64
−6
Conversation
This file contains 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
size-limit report 📦
|
Lms24
reviewed
Jul 16, 2024
| @@ -157,7 +157,7 @@ export function startInactiveSpan(options: StartSpanOptions): Span { | |||
| // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan` | |||
| const wrapper = options.scope | |||
| ? (callback: () => Span) => withScope(options.scope, callback) | |||
| : customParentSpan | |||
| : customParentSpan !== undefined | |||
There was a problem hiding this comment.
hmm I'm not sure I understand the PR description correctly but to me it looks like we're changing 2 things in this PR:
- make
options.parentSpanacceptnull. This sounds fine to me, given we're aligning our public API better - call
withActiveSpan(null,...)in caseparentSpanisnull. Is this necessary? Shouldn't the behaviour be identical to simply invoking thecallback?
There was a problem hiding this comment.
no, it is important to call withActiveSpan in this case - if you pass null, the meaning is start this span as a root span without a parent, while undefined means the default behavior (the parent is the current active span). Does that make sense?
There was a problem hiding this comment.
andreiborza
approved these changes
Jul 16, 2024
Lms24
approved these changes
Jul 16, 2024
This was referenced Aug 7, 2024
This was referenced Aug 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Noticed this while writing docs, this makes this a bit harder to understand. With this change you can say that
parentSpanbehaves the same and accepts the same aswithActiveSpan.See getsentry/sentry-docs#10729