fix: ensures BaseMiddleware creates a new span instead of returning the current span #492
+25
−6
Conversation
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
…rning the current span Updated _create_observability_span to create a new span with the middleware's parent_span context or current context if needed. Updated BaseMiddleware tests to be more accurate and ensure BaseMiddleware does not end outer spans.
|
Author
|
@microsoft-github-policy-service agree |
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.
Overview
Previously, the _create_observability_span method in the BaseMiddleware would return the current span if no parent_span was given in the request options. Since everything that uses this method treats the returned value as a newly created span, this led to unintentionally modifying and/or ending outside spans that are not directly a part of the middleware/kiota.
I updated this method to, in the event no parent_span is given in the request, create a new span with the middleware's parent_span context or with the current context if needed. This ensures the returned span was created by the method no matter the context.
I also added another test for BaseMiddleware that ensures BaseMiddleware does not end outer spans.
Related Issue
N/A
Testing Instructions