feat(preview): add experimental support for observing full documents #7397
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 27, 2024 9:55 AM (UTC) ❌ Failed Tests (1) -- expand for details
|
rexxars
reviewed
Aug 21, 2024
bjoerge
force-pushed
the
preview/add-observe-full-documents
branch
from
66bccc0
to
5887a68
Compare
bjoerge
force-pushed
the
preview/add-observe-full-documents
branch
from
5887a68
to
2897248
Compare
Good callout :) Added tests in 2897248 |
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
In certain cases its useful to be able to subscribe to the complete version of a document (by id) and receive updates to it as it changes in the backend. The only way to achieve this in the Studio today involves either setting up a full optimistic mutation pipeline, or setting up a "live query", both of which adds a separate listener connection per document. This doesn't scale well, so this PR proposes an alternative approach that re-uses the global listener currently use for Studio previews.
The intended use is cases where you always need the latest version of a complete document, but don't need to be able to do optimistic updates to it (i.e. you can live with a server roundtrip).
It introduces two new method to the preview store API, both unstable and marked as internal for now:
unstable_observeDocument(id: string)- returns an observable that will emit new versions of the document as it changes remotely.unstable_observeDocumentIds(ids: string[])- thin convenience wrapper over the above that supports subscribing to multiple documents in one goWhat to review
The global query listener is now set up with
effectFormat=mendozawhich makes the mutation events include a (usually compact) patch that is used to patch the local version of the document as it receives remote changes. This will add a little bit of overhead and it might be worth considering adding this only if needed. That said, we did receive regular mutations over this listener up until recently, which tends to be much larger in size than mendoza patches.Testing
These methods are only used in a feature branch for now, we'll look into some automated tests for them as we start relying on them more.
Notes for release
n/a - internal for now