fix(rpc): remove use of magic numbers in JSON service #673
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
…ptional parameters to set them
mtsitrin
reviewed
Apr 15, 2024
mtsitrin
reviewed
Apr 15, 2024
mtsitrin
reviewed
Apr 15, 2024
rpc/json/service.go
Outdated
| defer cancel() | ||
|
|
||
| sub, err := s.client.EventBus.Subscribe(ctx, addr, q, subBufferSize) | ||
| sub, err := s.client.EventBus.Subscribe(ctx, addr, q, s.subscribeBufferSize) |
There was a problem hiding this comment.
- why is
Subscribecalled directly on theEventBusand nots.client.Subscribe? - why we adding timeout only on the
Subscribeinteract and not on all other queries?
There was a problem hiding this comment.
I wouldn't know, I was just replacing the magic numbers.
There was a problem hiding this comment.
now looking at the code,
s.client.Subscribeis not exactly the same ass.client.EventBus.Subscribe. The former has a different signature and does a bit more (publish events and whatnot)- you suggest we add it to
UnsubscribeandUnsubscribeAll? Apart from them, onlyTxSearch,BlockSearch,BroadcastTxCommitandBroadcastTxSyncactually use the passed context
There was a problem hiding this comment.
- I think all APIs should use
req.Context()and notcontext.Background() - not sure why the
Subscribemethod got it's own additional timeout timer. I would remove it whatsoever and apply global timeout on the RPC server
wdyt
There was a problem hiding this comment.
I just wish the implementation didn't rely so heavily on reflection
zale144
force-pushed
the
zale144/668-remove-use-of-magic-numbers
branch
from
21459c8
to
9c7a321
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #673 +/- ##
==========================================
+ Coverage 44.04% 44.48% +0.43%
==========================================
Files 120 120
Lines 16531 16562 +31
==========================================
+ Hits 7281 7367 +86
+ Misses 8219 8165 -54
+ Partials 1031 1030 -1 ☔ View full report in Codecov by Sentry. |
…e-of-magic-numbers
danwt
approved these changes
Apr 16, 2024
Comment on lines
+32
to
36
| func WithSubscribeBufferSize(size int) option { | ||
| return func(s *service) { | ||
| s.subscribeBufferSize = size | ||
| } | ||
| } |
There was a problem hiding this comment.
Ah I see it's just for later
| // build the base response | ||
| resultEvent := &ctypes.ResultEvent{Query: args.Query, Data: msg.Data(), Events: msg.Events()} | ||
| var resp rpctypes.RPCResponse |
There was a problem hiding this comment.
Do you know why the old code made a new instance resultEvent?
| @@ -166,7 +160,7 @@ func (s *service) Unsubscribe(req *http.Request, args *unsubscribeArgs) (*emptyR | |||
|
|
|||
| func (s *service) UnsubscribeAll(req *http.Request, args *unsubscribeAllArgs) (*emptyResult, error) { | |||
| s.logger.Debug("unsubscribe from all queries", "remote", req.RemoteAddr) | |||
| err := s.client.UnsubscribeAll(context.Background(), req.RemoteAddr) | |||
| err := s.client.UnsubscribeAll(req.Context(), req.RemoteAddr) | |||
| defer cancel() | ||
| if err := s.server.Shutdown(ctx); err != nil { | ||
| s.Logger.Error("while shuting down RPC server", "error", err) | ||
| s.Logger.Error("while shutting down RPC server", "error", err) |
danwt
changed the title
mtsitrin
approved these changes
Apr 16, 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.
Use default values for subscribe timeout and buffer size, but leave optional parameters to set them
PR Standards
Opening a pull request should be able to meet the following requirements
Close #668
<-- Briefly describe the content of this pull request -->
For Author:
godoccommentsFor Reviewer:
After reviewer approval: