refactor(core): add reusable rxSwr operator #7562
Merged
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
bjoerge
force-pushed
the
refactor-rx-swr
branch
from
751342b
to
c68bba8
Compare
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
This was referenced Sep 30, 2024
bjoerge
force-pushed
the
refactor-rx-swr
branch
from
75e3e83
to
21885ea
Compare
|
No changes to documentation |
bjoerge
force-pushed
the
refactor-rx-swr
branch
from
21885ea
to
f98b189
Compare
bjoerge
force-pushed
the
refactor-rx-swr
branch
from
f98b189
to
dd3efb0
Compare
|
Component Testing Report Updated Oct 6, 2024 10:55 PM (UTC) ✅ All Tests Passed -- expand for details
|
juice49
previously approved these changes
Oct 2, 2024
bjoerge
force-pushed
the
refactor-rx-swr
branch
from
dd3efb0
to
26026ac
Compare
⚡️ Editor Performance ReportUpdated Sun, 06 Oct 2024 23:07:41 GMT
Detailed information🏠 Reference resultThe performance result of
🧪 Experiment resultThe performance result of this branch
📚 Glossary
|
juice49
approved these changes
Oct 7, 2024
bjoerge
added a commit
that referenced
this pull request
Oct 7, 2024
### Description
This PR introduces a new utility function `createSWR` for implementing
stale-while-revalidate caching in RxJS observables. The `createSwr`
function lets you create an operator function that can be used with a
cache key for storing the last emitted value. Once an observable with
the same cache key is subscribed to, it will emit the cached value (if
any) immediately while waiting for the fresh value to arrive.
This PR also refactors the `listenSearchQuery` function to use this new
SWR implementation, replacing the previous LRU cache approach.
### What to review
- The new `rxSwr.ts` file in the `core/util` directory, which contains
the `createSWR` function and related types.
- The changes in `listenSearchQuery.ts`, particularly the removal of the
`memoLRU` function and the integration of the new `swr` utility.
To add SWR to any observable:
```typescript
import {createSWR} from 'sanity'
const swr = createSWR<ObservableValueType>({maxSize: 100})
// In your observable pipeline:
someObservable$.pipe(
swr('<some cacheKey identifying the observable>'),
map(({fromCache, value}) => {
// Handle cached and fresh data
// `fromCache` is true if `value` was read from cache, otherwise false.
})
)
```
### Testing
Included some basic unit tests for rxSwr
### Notes for release
n/a internal
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.
Description
This PR introduces a new utility function
createSWRfor implementing stale-while-revalidate caching in RxJS observables. ThecreateSwrfunction lets you create an operator function that can be used with a cache key for storing the last emitted value. Once an observable with the same cache key is subscribed to, it will emit the cached value (if any) immediately while waiting for the fresh value to arrive.This PR also refactors the
listenSearchQueryfunction to use this new SWR implementation, replacing the previous LRU cache approach.What to review
rxSwr.tsfile in thecore/utildirectory, which contains thecreateSWRfunction and related types.listenSearchQuery.ts, particularly the removal of thememoLRUfunction and the integration of the newswrutility.To add SWR to any observable:
Testing
Included some basic unit tests for rxSwr
Notes for release
n/a internal