Make GrpcStreamBroadcaster compatible with both grpcio and grpclib
#49
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
github-actions
bot
added
part:tests
This comment was marked as outdated.
This comment was marked as outdated.
|
Updated. Will fix up before merging. |
|
Updated. |
|
Enabled auto-merge. |
daniel-zullo-frequenz
previously approved these changes
May 8, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
|
The good news is the merge queue checks now works correctly, the bad news is I forgot 2 fixes need to be applied to fix the CI, so this PR depends now on this PR to be merged: |
daniel-zullo-frequenz
previously approved these changes
May 8, 2024
llucax
dismissed
daniel-zullo-frequenz’s stale review
The merge-base changed after approval.
This is a preparation commit to make the client base library compatible with both `grpcio` and `grpclib`. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
This module will provide a way to deal with multiple grpc libraries. For now it only handles exceptions from both libraries, but it can be extended to handle other differences in the future. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
With this change `GrpcStreamBroadcaster` can be used with both `grpcio` and `grpclib` implementations of gRPC. This is achieved by using `collections.abc.AsyncIterator` instead of `grpc.aio.UnaryStreamCall` in the `stream_method` parameter of `GrpcStreamBroadcaster` to make it more generic, and catching exceptions from both `grpcio` and `grpclib` in the `async for` loop. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
|
Rebased, it needs a new approval. |
daniel-zullo-frequenz
approved these changes
May 8, 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.
With this change
GrpcStreamBroadcastercan be used with bothgrpcioandgrpclibimplementations of gRPC.This is achieved by using
AsyncIteratorinstead ofgrpc.aio.UnaryStreamCallin thestream_methodparameter ofGrpcStreamBroadcasterto make it more generic, and catching exceptions from bothgrpcioandgrpclibin theasync forloop.To deal with any of the libraries being installed, a new module is added to handles exceptions from both libraries, by conditionally importing the exception and provide a dummy one if the library is not installed.
Now both
grpcioandgrpclibare optional, and can be installed usingfrequenz-client-base[grpcio]orfrequenz-client-base[grpclib]respectively.We also add some tests for
GrpcStreamBroadcaster.