Improve AllureGrpc integartion for support non-blocking (streaming) stubs #1015
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
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.
Context
In gRPC, client streaming and bidirectional streaming require to use a non-blocking (async) Stubs. These stubs uses different threads for handling
sendMessage(T message)andonClose(status, trailers)events. Typically, it's not possible to create and commit a single Allure step within these methods, asAllureThreadContextinternally usesThreadLocal. However, it's possible to achieve this in a separate daemon thread.Due to the asynchronous implementation of non-blocking stubs, we cannot guarantee that the Allure daemon thread committing the step will terminate immediately upon the completion of the non-blocking stub call. Therefore, for such non-blocking calls, it will be necessary to execute
AllureGrpc.await()method after each test.This approach is explained in the README and javadocs.
There is example report for bidirectional calls:
Checklist