feat: await fetchRootKey calls while making API calls #963
Conversation
move fetchRootKey calls from constructor to API calls BREAKING CHANGE:
| this.#rootKey = options.rootKey ?? fromHex(IC_ROOT_KEY); | ||
| this.#shouldFetchRootKey = options.shouldFetchRootKey ?? false; | ||
| // kick off the fetchRootKey process asynchronously, if needed | ||
| (async () => await this.fetchRootKey())(); |
There was a problem hiding this comment.
We start fetching the root key as soon as possible, in practice this should mean that there are no further delays compared to creating the agent with an async constructor and waiting for this task to complete before making API calls.
| @@ -245,19 +253,21 @@ other computations so that this class can stay as simple as possible while | |||
| allowing extensions. | |||
| */ | |||
| export class HttpAgent implements Agent { | |||
| public rootKey: ArrayBuffer; | |||
There was a problem hiding this comment.
I've removed the public rootKey property in favor of the async getRootKey, since we cannot guarantee availability of the correct root key when fetchRootKey is set to true.
| this.#rootKeyFetched = true; | ||
| if (!this.#shouldFetchRootKey) { | ||
| return this.#rootKey; | ||
| } |
There was a problem hiding this comment.
If we should not fetch the root key, we return the existing root key, which is either a hard coded root key provided by the consumer or the mainnet root key.
| } | ||
|
|
||
| if (this.#fetchRootKeyPromise === null) { | ||
| this.#fetchRootKeyPromise = this.#fetchRootKey(); |
There was a problem hiding this comment.
If we should fetch the root key, and this is the first time this function is called, we create the promise to fetch the root key. On subsequent calls to this function, the promise will have already been made so we will skip this.
| } | ||
| return this.rootKey; | ||
|
|
||
| return await this.#fetchRootKeyPromise; |
There was a problem hiding this comment.
Finally we await the promise and return the resulting root key. If the promise has already resolved, we can just continue reusing the resolved promise.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
Fixes # (issue)
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
Checklist: