feat(bootstrap): Cache projects in IndexedDB #89139
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| import {createAsyncStoragePersister} from '@tanstack/query-async-storage-persister'; | ||
| import {persistQueryClient} from '@tanstack/react-query-persist-client'; | ||
| import {del as removeItem, get as getItem, set as setItem} from 'idb-keyval'; | ||
|
|
||
| import {SENTRY_RELEASE_VERSION} from 'sentry/constants'; | ||
| import {DEFAULT_QUERY_CLIENT_CONFIG, QueryClient} from 'sentry/utils/queryClient'; | ||
|
|
||
| /** | ||
| * Named it appQueryClient because we already have a queryClient in sentry/utils/queryClient | ||
| * sentry/utils/queryClient is a small wrapper around react-query's functionality for our API. | ||
| * | ||
| * appQueryClient below is the app's react-query cache and should not be imported directly. | ||
| * Instead, use `const queryClient = useQueryClient()`. | ||
| * @link https://tanstack.com/query/v5/docs/reference/QueryClient | ||
| */ | ||
| export const appQueryClient = new QueryClient(DEFAULT_QUERY_CLIENT_CONFIG); | ||
| const cacheKey = 'sentry-react-query-cache'; | ||
|
|
||
| const localStoragePersister = createAsyncStoragePersister({ | ||
| // We're using indexedDB as our storage provider because projects cache can be large | ||
| storage: {getItem, setItem, removeItem}, | ||
| // Reduce the frequency of writes to indexedDB | ||
| throttleTime: 10_000, | ||
| // The cache is stored entirely on one key | ||
| key: cacheKey, | ||
| }); | ||
|
|
||
| const isProjectsCacheEnabled = | ||
| window.indexedDB && | ||
| (window.__initialData?.features as unknown as string[])?.includes( | ||
| 'organizations:cache-projects-ui' | ||
| ); | ||
|
|
||
| /** | ||
| * Attach the persister to the query client | ||
| * @link https://tanstack.com/query/latest/docs/framework/react/plugins/persistQueryClient | ||
| */ | ||
| if (isProjectsCacheEnabled) { | ||
| persistQueryClient({ | ||
| queryClient: appQueryClient, | ||
| persister: localStoragePersister, | ||
| /** | ||
| * Clear cache on release version change | ||
| * Locally this does nothing, if you need to clear cache locally you can clear indexdb | ||
| */ | ||
| buster: SENTRY_RELEASE_VERSION ?? 'local', | ||
| dehydrateOptions: { | ||
| // Persist a subset of queries to local storage | ||
| shouldDehydrateQuery(query) { | ||
| // This could be extended later to persist other queries | ||
| return ( | ||
| // Query is not pending or failed | ||
| query.state.status === 'success' && | ||
| !query.isStale() && | ||
| Array.isArray(query.queryKey) && | ||
|
There was a problem hiding this comment. this check is unnecessary - the |
||
| // Currently only bootstrap-projects is persisted | ||
| query.queryKey[0] === 'bootstrap-projects' | ||
| ); | ||
| }, | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| export function restoreQueryCache() { | ||
| if (isProjectsCacheEnabled) { | ||
| localStoragePersister.restoreClient(); | ||
| } | ||
| } | ||
|
|
||
| export async function clearQueryCache() { | ||
| if (isProjectsCacheEnabled) { | ||
| // Mark queries as stale so they won't be recached | ||
| appQueryClient.invalidateQueries({queryKey: ['bootstrap-projects']}); | ||
|
Comment on lines
+72
to
+73
There was a problem hiding this comment. this not only marks them as stale, but also refetches them if they are still active! to avoid this, we need: |
||
| await removeItem(cacheKey); | ||
| } | ||
| } | ||
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
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.
Can we have this comment explain the difference to try and help avoid people using this one if they don't need it?