Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[breaking] Eliminate BoardListWatchRequest Interrupt from the grpc api and make it server streaming only #2330

Conversation

alessio-perugini
Copy link
Contributor

@alessio-perugini alessio-perugini commented Sep 20, 2023

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

We removed the streaming part of the client side.

What is the current behavior?

We have bidirectional streaming of client<-> server and we leverage the use of Interrupt field to stop the communication.

What is the new behavior?

We simply make this server streaming only and we remove the Interrupt field from the API.

Does this PR introduce a breaking change, and is titled accordingly?

We removed the Interrupt field from BoardListWatchRequest message.
We removed the stream of BoardListWatchRequest in the BoardListWatch rpc:

  rpc BoardListWatch(BoardListWatchRequest)
      returns (stream BoardListWatchResponse);

Other information

@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

Patch coverage: 50.00% and project coverage change: -0.01% ⚠️

Comparison is base (29c70df) 63.08% compared to head (9268feb) 63.07%.
Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2330      +/-   ##
==========================================
- Coverage   63.08%   63.07%   -0.01%     
==========================================
  Files         200      201       +1     
  Lines       19260    19233      -27     
==========================================
- Hits        12150    12132      -18     
+ Misses       6061     6050      -11     
- Partials     1049     1051       +2     
Flag Coverage Δ
unit 63.07% <50.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
internal/cli/board/list.go 9.33% <0.00%> (+0.18%) ⬆️
commands/daemon/daemon.go 26.60% <50.00%> (-1.08%) ⬇️
commands/board/list.go 58.70% <60.00%> (ø)

... and 34 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alessio-perugini alessio-perugini force-pushed the 2283-eliminate-boardlistwatchrequestinterrupt-from-the-grpc-api-make-it-server-streaming-only branch from 9e61ef6 to 6c32a9c Compare September 20, 2023 12:20
@alessio-perugini alessio-perugini changed the title 2283 eliminate boardlistwatchrequestinterrupt from the grpc api make it server streaming only Eliminate boardlistwatchrequestinterrupt from the grpc api make it server streaming only Sep 20, 2023
@alessio-perugini alessio-perugini marked this pull request as ready for review September 21, 2023 07:42
@alessio-perugini alessio-perugini added the topic: code Related to content of the project itself label Sep 21, 2023
@alessio-perugini alessio-perugini changed the title Eliminate boardlistwatchrequestinterrupt from the grpc api make it server streaming only Eliminate BoardListWatchRequest Interrupt from the grpc api and make it server streaming only Sep 21, 2023
@umbynos
Copy link
Contributor

umbynos commented Sep 22, 2023

Remember to update the PR message and update UPGRADING.md since this is a breaking change.

@alessio-perugini alessio-perugini changed the title Eliminate BoardListWatchRequest Interrupt from the grpc api and make it server streaming only [breaking] Eliminate BoardListWatchRequest Interrupt from the grpc api and make it server streaming only Sep 22, 2023
@alessio-perugini alessio-perugini added this to the Arduino CLI 0.35.0 milestone Sep 22, 2023
@alessio-perugini
Copy link
Contributor Author

Remember to update the PR message and update UPGRADING.md since this is a breaking change.

image

@alessio-perugini alessio-perugini merged commit 5a4f48b into master Sep 25, 2023
104 checks passed
@alessio-perugini alessio-perugini deleted the 2283-eliminate-boardlistwatchrequestinterrupt-from-the-grpc-api-make-it-server-streaming-only branch September 25, 2023 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Eliminate BoardListWatchRequest#interrupt from the gRPC API, make it server-streaming only
2 participants