chore: improve naming of span related context APIs #1749
Merged
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
Rename [gs]etActiveSpan() to [gs]etSpan() as the span is not active anywhere, it's just referenced by the context. Rename setExtractedSpanContext() to setSpanContext() because any SpanContext may be set not only extracted ones. Rename getParentSpanContext() to getSpanContext() because it retrieves the context of the span which can be any span not only a parent.
Codecov Report
@@ Coverage Diff @@
## master #1749 +/- ##
==========================================
+ Coverage 92.07% 92.11% +0.03%
==========================================
Files 166 166
Lines 5593 5591 -2
Branches 1199 1198 -1
==========================================
Hits 5150 5150
+ Misses 443 441 -2
|
obecny
reviewed
Dec 14, 2020
MSNev
reviewed
Dec 16, 2020
vmarchaud
approved these changes
Dec 17, 2020
dyladan
approved these changes
Dec 17, 2020
There was a problem hiding this comment.
I think they are heavy debate on the PR about the namespacing which belong to its issue. I'm fine with renaming the helpers and decide later where to export them
I agree with @vmarchaud the debate has not much to do with the substance of this PR and the name change is in general good.
|
@obecny i see you 👍 the comment but no approval yet |
obecny
approved these changes
Dec 17, 2020
I thought I approved |
dyladan
pushed a commit
to dyladan/opentelemetry-js
that referenced
this pull request
Sep 9, 2022
dyladan
pushed a commit
to dyladan/opentelemetry-js
that referenced
this pull request
Sep 9, 2022
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.
Which problem is this PR solving?
Short description of the changes
Rename
[gs]etActiveSpan()to[gs]etSpan()as the span is not active anywhere, it's just referenced by the context.Rename
setExtractedSpanContext()tosetSpanContext()because anySpanContextmay be set not only extracted ones.Rename
getParentSpanContext()to getSpanContext()` because it retrieves the context of the span which can be any span not only a parent.[sg]etSpanContext()are quite simple wrappers and could be removed to reduce API surface if preferred. But I see not that much maintenance pain of keeping them so I left them in for now.