feat(rpc-provider): allow cacheCapacity option for WsProvider #5778
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
jacogr
requested changes
Jan 12, 2024
| @@ -108,7 +108,7 @@ export class WsProvider implements ProviderInterface { | |||
| * @param {Record<string, string>} headers The headers provided to the underlying WebSocket | |||
| * @param {number} [timeout] Custom timeout value used per request . Defaults to `DEFAULT_TIMEOUT_MS` | |||
| */ | |||
| constructor (endpoint: string | string[] = defaults.WS_URL, autoConnectMs: number | false = RETRY_DELAY, headers: Record<string, string> = {}, timeout?: number) { | |||
| constructor (endpoint: string | string[] = defaults.WS_URL, autoConnectMs: number | false = RETRY_DELAY, headers: Record<string, string> = {}, cacheCapacity: number = DEFAULT_CAPACITY, timeout?: number) { | |||
There was a problem hiding this comment.
Rather move this as the last parameter. (No breaking change - we really don't like breaking changes at all, unless very much required)
On use can do this.#callCache = new LRUCache(cacheCapacity || DEFAULT_CAPACITY); to apply defaults.
There was a problem hiding this comment.
Thanks for the feedback. I just applied the change you recommended and I agree it makes more sense.
|
@jacogr Apologies for pinging you, the PR is ready for another review whenever you have a chance. Thanks again for everything. |
jacogr
approved these changes
Jan 26, 2024
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary:
This PR aims to allow configuring the cacheCapacity for the LRUCache used in the WsProvider. It will still default to 128 if no option is passed in.
Concerns
This PR will be a breaking change for users that use the
timeoutoption. I did think about creating an options object instead and including some of the args in there but I thought I would leave it up to discussion.Feel free to close the PR if there is no intention to allow configuration of the capacity size of the LRU cache.