Add basic failover functionality #9
Closed
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
vikinatora
reviewed
Dec 7, 2023
| @@ -333,6 +333,19 @@ export class JsonRpcProvider extends Provider { | |||
| return await this.sendJsonRpc('gas_price', [blockId]); | |||
| } | |||
|
|
|||
| /** | |||
| * Part of the RPC failover design. | |||
| * Changing current (first) rpc server and moves it to the and of the queue. | |||
There was a problem hiding this comment.
Suggested change
| * Changing current (first) rpc server and moves it to the and of the queue. | |
| * Changing current (first) rpc server and moves it to the end of the queue. |
Comment on lines
+191
to
+205
| test('JsonRpc rotateRpcServers', async () => { | ||
| const SERVER_1 = 'server1'; | ||
| const SERVER_2 = 'server2'; | ||
| const SERVER_3 = 'server3'; | ||
| const provider = new JsonRpcProvider({ url: [SERVER_1, SERVER_2, SERVER_3] }); | ||
| expect(provider.connection.url.length).toEqual(3); | ||
| expect(provider.connection.url[0]).toMatch(SERVER_1); | ||
| expect(provider.connection.url[1]).toMatch(SERVER_2); | ||
| expect(provider.connection.url[2]).toMatch(SERVER_3); | ||
| provider.rotateRpcServers(); | ||
| expect(provider.connection.url.length).toEqual(3); | ||
| expect(provider.connection.url[0]).toMatch(SERVER_2); | ||
| expect(provider.connection.url[1]).toMatch(SERVER_3); | ||
| expect(provider.connection.url[2]).toMatch(SERVER_1); | ||
| }); |
There was a problem hiding this comment.
Add a bad case test which contains bad configuration. The error should be caught at construction time I believe.
packages/wallet-account/src/near.ts
Outdated
| /** | ||
| * RPC API Keys. Used to authenticate users on RPC Server. | ||
| */ | ||
| apiKeys: string; |
There was a problem hiding this comment.
Shouldn't this be { [url: string]: string };
vikinatora
reviewed
Dec 8, 2023
vikinatora
reviewed
Dec 8, 2023
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.
Pre-flight checklist
pnpm changesetto create achangesetJSON document appropriate for this change.Motivation
Added support for multiple API Keys (since we can have multiple RPC Servers)
Added basic failover functionality
With this design of failover, we will change (rotate) our server when needed and stick to this new server for our next calls. It will help to avoid long responses when first (or more) servers are down.
For now, server rotation is happening only on Timeout error.
Also, check this comment: near#733 (comment)
Test Plan
Added unit tests.
Related issues/PRs
near#733
near#760