WIP: Merge ENSApi /api/config endpoint into /api/indexing-status endpoint
#1671
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import { useQuery } from "@tanstack/react-query"; | ||
|
|
||
| import { useEnsApiProviderOptions } from "@ensnode/ensnode-react"; | ||
|
|
||
| import { useIndexingStatusWithSwr } from "@/components/indexing-status"; | ||
|
|
||
| export function useEnsApiConfig() { | ||
| const ensApiProviderOptions = useEnsApiProviderOptions(); | ||
| const indexingStatus = useIndexingStatusWithSwr(); | ||
|
|
||
| return useQuery({ | ||
| enabled: indexingStatus.isSuccess, | ||
| queryKey: ["swr", ensApiProviderOptions.client.url.href, "config"], | ||
| queryFn: async () => indexingStatus.data?.config, // enabled flag ensures this is only called when indexingStatus.data is available | ||
vercel[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }); | ||
| } | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,75 +7,92 @@ import { useCallback, useMemo } from "react"; | |
| import { | ||
| createIndexingStatusQueryOptions, | ||
| QueryParameter, | ||
| useEnsApiProviderOptions, | ||
| type useIndexingStatus, | ||
| useSwrQuery, | ||
| WithEnsApiProviderOptions, | ||
| } from "@ensnode/ensnode-react"; | ||
|
Comment on lines
7
to
14
There was a problem hiding this comment.
|
||
| import { | ||
| CrossChainIndexingStatusSnapshotOmnichain, | ||
| createRealtimeIndexingStatusProjection, | ||
| Duration, | ||
| EnsApiIndexingStatusRequest, | ||
| EnsApiIndexingStatusResponseCodes, | ||
| EnsApiIndexingStatusResponseOk, | ||
| EnsApiPublicConfig, | ||
| } from "@ensnode/ensnode-sdk"; | ||
|
|
||
| const DEFAULT_REFETCH_INTERVAL = secondsToMilliseconds(10); | ||
|
|
||
| const REALTIME_PROJECTION_REFRESH_RATE: Duration = 1; | ||
|
|
||
| interface CachableIndexingStatus { | ||
| crossChainIndexingStatusSnapshot: CrossChainIndexingStatusSnapshotOmnichain; | ||
| config: EnsApiPublicConfig; | ||
| } | ||
|
|
||
| interface UseIndexingStatusParameters | ||
| extends EnsApiIndexingStatusRequest, | ||
| QueryParameter<CachableIndexingStatus> {} | ||
|
|
||
| /** | ||
| * A proxy hook for {@link useIndexingStatus} which applies | ||
| * stale-while-revalidate cache for successful responses. | ||
| */ | ||
| export function useIndexingStatusWithSwr( | ||
| parameters: WithEnsApiProviderOptions & UseIndexingStatusParameters = {}, | ||
| ) { | ||
| const { options, query = {} } = parameters; | ||
| const providerOptions = useEnsApiProviderOptions(options); | ||
| const now = useNow({ timeToRefresh: REALTIME_PROJECTION_REFRESH_RATE }); | ||
|
|
||
| const queryOptions = useMemo( | ||
| () => createIndexingStatusQueryOptions(providerOptions), | ||
| [providerOptions], | ||
| ); | ||
| const queryKey = useMemo(() => ["swr", ...queryOptions.queryKey], [queryOptions.queryKey]); | ||
| const queryFn = useCallback( | ||
| async () => | ||
| queryOptions.queryFn().then(async (response) => { | ||
| // An indexing status response was successfully fetched, | ||
| // but the response code contained within the response was not 'ok'. | ||
| // Therefore, throw an error to avoid caching this response. | ||
| if (response.responseCode !== EnsApiIndexingStatusResponseCodes.Ok) { | ||
| throw new Error( | ||
| "Received Indexing Status response with responseCode other than 'ok' which will not be cached.", | ||
| ); | ||
| } | ||
|
|
||
| // The indexing status snapshot, including ENSApi public config, | ||
| // has been fetched and successfully validated for caching. | ||
| // Therefore, return it so that query cache for `queryOptions.queryKey` will: | ||
| // - Replace the currently cached value (if any) with this new value. | ||
| // - Return this non-null value. | ||
| return { | ||
| crossChainIndexingStatusSnapshot: response.realtimeProjection.snapshot, | ||
| config: response.config, | ||
| } satisfies CachableIndexingStatus; | ||
| }), | ||
| [queryOptions.queryFn], | ||
| ); | ||
|
|
||
| // Call select function to `createRealtimeIndexingStatusProjection` each time | ||
| // `now` is updated. | ||
| const select = useCallback( | ||
| (cachedResult: CachableIndexingStatus): EnsApiIndexingStatusResponseOk => { | ||
| const realtimeProjection = createRealtimeIndexingStatusProjection( | ||
| cachedResult.crossChainIndexingStatusSnapshot, | ||
| now, | ||
| ); | ||
|
|
||
| // Maintain the original response shape of `EnsApiIndexingStatusResponseOk` | ||
| // for the consumers. Creating a new projection from the cached snapshot | ||
| // each time `now` is updated should be implementation detail. | ||
| return { | ||
| responseCode: EnsApiIndexingStatusResponseCodes.Ok, | ||
| realtimeProjection, | ||
| config: cachedResult.config, | ||
| } satisfies EnsApiIndexingStatusResponseOk; | ||
| }, | ||
| [now], | ||
| ); | ||
|
|
||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
queryFncan currently returnundefinedbecause of the optional chain (indexingStatus.data?.config). Sinceenabledgates onindexingStatus.isSuccess, you can (and should) returnindexingStatus.data.configdirectly (or throw if unexpectedly missing) to keep the query typed as always returning a config object.