(feat) Disable most automatic revalidations by default #1157
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
|
Size Change: -84.6 kB (-1.46%) Total Size: 5.72 MB
ℹ️ View Unchanged
|
ibacher
approved these changes
Sep 20, 2024
| // only revalidate once every 10 minutes | ||
| focusThrottleInterval: 600000, | ||
| // disable automatic revalidations by default | ||
| revalidateIfStale: false, |
There was a problem hiding this comment.
I'm a little more hesitant about turning on revalidateIfStale. Maybe we leave that out for now?
There was a problem hiding this comment.
I agree. If revalidateIfStale, revalidateOnFocus, revalidateOnReconnect are all set to false, there is no longer a distinction between useSWR and useSWRInfinite.
https://swr.vercel.app/docs/revalidation#disable-automatic-revalidations
Side note: Should we have a convention where the SWRConfig values are override-able on a per-app basis? Maybe an edge case, but I'm thinking about multiple clinician using the queues / appointments / ward app and we might want faster re-validate internals.
There was a problem hiding this comment.
Yeah, @chibongho. As I mentioned here, SWRConfig merges the configuration from the parent context. This means that alternative configurations provided further down the line will override the parent values. I've linked to an example video there showing SWRConfig overriding the global configuration at the ESM-level in the Active Visits app.
There was a problem hiding this comment.
Tbh, actually, using SWR configuration instead of useSWRImmutable actually has some advantages (the global mutate() function cannot invalidate content loaded with either useSWRInfinite() or useSWRImmutable() and we've tended to use Immutable in a few inappropriate places).
Should we have a convention where the SWRConfig values are override-able on a per-app basis?
I mean, those decisions are always possible to make, but I'd rather focus on doing so locally where it makes sense to explore whether some kind of app-wide configuration even makes sense (these sort of technical details definitely shouldn't be part of the standard configuration system).
These changes to the global SWR config disable automatic revalidations by default. The idea is to set up a conservative caching strategy that minimizes automatic data revalidations. In practice, it is very unlikely that the data in a chart will change frequently, so it makes sense to limit the number of revalidations to a bare minimum. Note that the SWRConfig component merges the configuration from the parent context. This means that alternative configurations provided further down the line will override the parent values.
denniskigen
force-pushed
the
feat/disable-automatic-revalidations
branch
from
36d18dc to
c990889
Compare
chibongho
approved these changes
Sep 20, 2024
denniskigen
changed the title
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.
Requirements
feat,fix, orchore, among others). See existing PR titles for inspiration.For changes to apps
If applicable
Summary
These changes to the global SWR config disable automatic revalidations by default. The idea is to set up a conservative caching strategy that minimizes automatic data revalidations. In practice, it is very unlikely that the data in a chart will change frequently, so it makes sense to limit the number of revalidations to a bare minimum.
Note that the SWRConfig component merges the configuration from the parent context. This means that alternative configurations provided further down the line will override the parent values.
One potential benefit of this approach is a quieter network tab in developer tools, making it easier to identify when a request is actually being made, and to spot any unnecessary requests. It also reduces the likelihood of pending network requests slowing down the UI during mutations.
Screenshots
Related Issue
https://openmrs.atlassian.net/browse/O3-4012
Other