Include endpointUrl in RpcService event listener data#5225
Merged
Conversation
0fb406d to
3ef16d9
Compare
Modify RpcService so that when it emits the `onRetry`, `onBreak`, or `onDegraded` event, it passes the URL of the endpoint it is requesting to the respective event listener. This will be useful when we add the ability to create a chain of RPC service objects, where we start out hitting a primary node and then keep failing over to successive nodes in the chain until the request succeeds. By including the endpoint URL in the event listener data, we are able to identify which RPC service was active when the event occurred.
3ef16d9 to
c9c747f
Compare
mcmire
commented
Jan 30, 2025
| global: { | ||
| branches: 78.12, | ||
| functions: 80.7, | ||
| functions: 80.35, |
Contributor
Author
There was a problem hiding this comment.
I've checked the coverage report and all of the lines I added are tested.
mcmire
commented
Jan 30, 2025
| const onBreak = circuitBreakerPolicy.onBreak.bind(circuitBreakerPolicy); | ||
|
|
||
| const onDegradedListeners: (() => void)[] = []; | ||
| const onDegradedEventEmitter = new CockatielEventEmitter<void>(); |
Contributor
Author
There was a problem hiding this comment.
Here we are reusing the Cockatiel built-in EventEmitter class instead of implementing the EventEmitter pattern ourselves. We do this because we want the signature of the onDegraded method to match the signatures for onRetry and onBreak (onDegraded is a custom hook we add, whereas onRetry and onBreak essentially come directly from Cockatiel).
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
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.
Explanation
Modify RpcService so that when it emits the
onRetry,onBreak, oronDegradedevent, it passes the URL of the endpoint it is requesting to the respective event listener.This will be useful when we add the ability to create a chain of RPC service objects, where we start out hitting a primary node and then keep failing over to successive nodes in the chain until the request succeeds. By including the endpoint URL in the event listener data, we are able to identify which RPC service was active when the event occurred.
References
Progresses #5222.
Changelog
(Updated in PR.)
Checklist