feat(bootstrap): Cache projects in IndexedDB #89139
Merged
Conversation
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
Implements the caching part of https://www.notion.so/sentry/Tech-Spec-Frontend-Bootstrap-Cache-Project-Loading-Performance-1748b10e4b5d80759127c15d3772e063 Went with IndexedDB because some organizations have multiple megabytes of projects to cache. This helps bandaid the entire app waiting for projects to load by storing them in the cache and revalidating.
github-actions
bot
added
the
Scope: Frontend
❌ 919 Tests Failed:
View the top 3 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
scttcper
commented
Apr 11, 2025
static/app/appQueryClient.tsx
Outdated
| } | ||
|
|
||
| export function restoreQueryCache() { | ||
| if (!isProjectsCacheEnabled) { |
| import {DEFAULT_QUERY_CLIENT_CONFIG, QueryClient} from 'sentry/utils/queryClient'; | ||
|
|
||
| /** | ||
| * Named it appQueryClient because we already have a queryClient in sentry/utils/queryClient |
There was a problem hiding this comment.
Can we have this comment explain the difference to try and help avoid people using this one if they don't need it?
static/app/appQueryClient.tsx
Outdated
| return ( | ||
| // Query is not pending or failed | ||
| query.state.status === 'success' && | ||
| // Query is not stale |
There was a problem hiding this comment.
can drop this comment I think, since it literally reads not query is stale
evanpurkhiser
approved these changes
Apr 14, 2025
TkDodo
reviewed
Apr 16, 2025
| // 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 queryKey is always an Array.
Comment on lines
+72
to
+73
| // Mark queries as stale so they won't be recached | ||
| appQueryClient.invalidateQueries({queryKey: ['bootstrap-projects']}); |
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:
appQueryClient.invalidateQueries({
queryKey: ['bootstrap-projects'],
refetchType: 'none',
});
| @@ -30,7 +25,7 @@ function Main() { | |||
| const [router] = useState(buildRouter); | |||
|
|
|||
| return ( | |||
| <QueryClientProvider client={queryClient}> | |||
| <QueryClientProvider client={appQueryClient}> | |||
There was a problem hiding this comment.
we really want to use the PersistQueryClientProvider here if we use persistence. It will handle restoring and subscriptions to the storage, and avoids race conditions between queries that mount while we are still restoring from indexDB.
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
andrewshie-sentry
pushed a commit
that referenced
this pull request
Apr 22, 2025
Implements the caching part of https://www.notion.so/sentry/Tech-Spec-Frontend-Bootstrap-Cache-Project-Loading-Performance-1748b10e4b5d80759127c15d3772e063 Went with IndexedDB because some organizations have multiple megabytes of projects to cache. This helps bandaid the entire app waiting for projects to load by storing them in the cache and revalidating.
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.
Implements the caching part of https://www.notion.so/sentry/Tech-Spec-Frontend-Bootstrap-Cache-Project-Loading-Performance-1748b10e4b5d80759127c15d3772e063
Went with IndexedDB because some organizations have multiple megabytes of projects to cache.
This helps bandaid the entire app waiting for projects to load by storing them in the cache and revalidating.