fix(sdk-trace-base): avoid keeping non-string status.message on Span#setStatus() #4999
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
dyladan
reviewed
Sep 18, 2024
Comment on lines
+235
to
+240
| if (this.status.message != null && typeof status.message !== 'string') { | ||
| diag.warn( | ||
| `Dropping invalid status.message of type '${typeof status.message}', expected 'string'` | ||
| ); | ||
| delete this.status.message; | ||
| } |
There was a problem hiding this comment.
Is dropping the right behavior? If something is not nullish and also not a string, it may still be useful. Also, the user may be surprised to see nothing here. Maybe casting to string would be better?
There was a problem hiding this comment.
I've been going back and forth on this as well - I've ended up with this approach as dropping it here gives us the opportunity to add casting as a string later as a feature.
I'm thinking that if we can get away with not doing any magic - then that's better. It will keep complexity lower, but also we discourage users from breaking the type-contract with the API.
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?
See #4998,
Span#setStatus()is commonly used in catch blocks to set the span statusSpanStatusCode.ERROR. While doing so, it's an easy mistake to make to also pass theErroras themessage, which expects a string, as TypeScript will no complain as you assignanytostring.Therefore this PR adds a validation step to ensure we don't pass on the incorrect type downstream, which can cause OTLP/JSON export requests to be rejected.
Fixes #4998
See also renovatebot/renovate#31459
Type of change
How Has This Been Tested?