refactor(preview): extract global listener, refactor preview APIs and improve typings #7360
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Aug 19, 2024 3:27 PM (UTC) ✅ All Tests Passed -- expand for details
|
bjoerge
commented
Aug 12, 2024
| '*[!(_id in path("_.**"))]', | ||
| {}, | ||
| { | ||
| events: ['welcome', 'mutation', 'reconnect'], |
There was a problem hiding this comment.
reconnect is filtered out downstream for now, but we might want to consider using this at a later point
|
|
||
| // This will keep the listener active forever and in turn reduce the number of initial fetches | ||
| // as less 'welcome' events will be emitted. | ||
| // @todo: see if we can delay unsubscribing or connect with some globally defined shared listener |
There was a problem hiding this comment.
// @todo: see if we can delay unsubscribing or connect with some globally defined shared listener
^ This has been addressed in this PR
| */ | ||
| export function createObserveFields(options: { | ||
| client: SanityClient | ||
| invalidationChannel: Observable<InvalidationChannelEvent> |
There was a problem hiding this comment.
named it invalidationChannel and stripped down types to make it clear that it's merely used to notify about need for refetching preview queries
bjoerge
force-pushed
the
chore-preview-store-cleanup
branch
from
43e817e
to
1ae5e37
Compare
RitaDias
previously approved these changes
Aug 19, 2024
rexxars
previously approved these changes
Aug 19, 2024
…PIs and improve typings
Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com>
bjoerge
force-pushed
the
chore-preview-store-cleanup
branch
from
0c3a194
to
3c8cba7
Compare
|
Did a rebase, and looks like a new approval is required |
cngonzalez
pushed a commit
that referenced
this pull request
Aug 20, 2024
… improve typings (#7360) * refactor(preview): extract global listener, refactor preview APIs and improve typings * fixup! refactor(preview): extract global listener, refactor preview APIs and improve typings * Apply suggestions from code review Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com> --------- Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com>
This was referenced Sep 20, 2024
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
Note: This originally happened as part of work in a feature branch, but the changes here are generic and standalone improvements that makes sense to merge to main already.
This extracts the global listener used by the preview system, improves consistency and readability and typings of of the core/preview code. These changes should not affect the behavior of previews in any significant way or cause any visible differences in how previews work currently.
This also includes a small improvement to the global preview listener: Currently this listener is subscribed once, and the subscription is kept active forever. This means that if the user navigates to a part of the Studio that does need to preview anything, the listener connection is still kept active. With the changes proposed here, the global preview listener is now refcount'ed, and shuts down when no longer needed. To avoid excessive unsubscribe+resubscribes, the listener teardown is delayed to two seconds after the last subscriber unsubscribes. Demo here:
Screen.Recording.2024-08-12.at.18.33.33.mov
What to review
Does the changes make sense?
Testing
Existing tests should be enough. Also improves TypeScript coverage, which helps.
Notes for release
n/a - not user facing