feat(preview): add unstable_observeDocument(s) to preview store
#7176
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 |
bjoerge
force-pushed
the
corel
branch
2 times, most recently
from
8cbc89d
to
c5254fe
Compare
bjoerge
added a commit
that referenced
this pull request
Jul 30, 2024
bjoerge
added a commit
that referenced
this pull request
Jul 30, 2024
bjoerge
added a commit
that referenced
this pull request
Jul 30, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
bjoerge
added a commit
that referenced
this pull request
Jul 30, 2024
bjoerge
added a commit
that referenced
this pull request
Jul 30, 2024
bjoerge
added a commit
that referenced
this pull request
Jul 30, 2024
bjoerge
added a commit
that referenced
this pull request
Aug 2, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
bjoerge
added a commit
that referenced
this pull request
Aug 2, 2024
bjoerge
added a commit
that referenced
this pull request
Aug 2, 2024
bjoerge
added a commit
that referenced
this pull request
Aug 2, 2024
juice49
pushed a commit
that referenced
this pull request
Aug 4, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
juice49
pushed a commit
that referenced
this pull request
Aug 4, 2024
juice49
pushed a commit
that referenced
this pull request
Aug 4, 2024
juice49
pushed a commit
that referenced
this pull request
Aug 4, 2024
juice49
pushed a commit
that referenced
this pull request
Aug 6, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
juice49
pushed a commit
that referenced
this pull request
Aug 6, 2024
juice49
pushed a commit
that referenced
this pull request
Aug 6, 2024
juice49
pushed a commit
that referenced
this pull request
Aug 6, 2024
bjoerge
added a commit
that referenced
this pull request
Aug 7, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
bjoerge
added a commit
that referenced
this pull request
Aug 16, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
bjoerge
added a commit
that referenced
this pull request
Aug 20, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
bjoerge
added a commit
that referenced
this pull request
Aug 20, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
bjoerge
added a commit
that referenced
this pull request
Aug 20, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
RitaDias
pushed a commit
that referenced
this pull request
Aug 23, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
RitaDias
pushed a commit
that referenced
this pull request
Aug 26, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
juice49
pushed a commit
that referenced
this pull request
Sep 3, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
RitaDias
pushed a commit
that referenced
this pull request
Oct 3, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
juice49
pushed a commit
that referenced
this pull request
Oct 4, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
juice49
pushed a commit
that referenced
this pull request
Oct 7, 2024
) * chore: remove futile circular dependency workaround * refactor(core): lift global listener out of preview store * fix(preview): cleanup code so it matches current conventions + add some docs * feat(preview): add unstable_observeDocument + unstable_observeDocuments to preview store * fix: use includeMutations: false * fix: expect ts error on includeMutations: false for now
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 adds two new methods to the preview store:
These will emit full documents as opposed to the other methods in the preview store that takes in a list of path selectors and returns partial documents with only the given paths selected.
The reason it's part of the preview store is so that we can re-use the global listener connection we currently use for previews - philosophically it makes sense to keep them here as well, since they update with a higher latency than documents that has realtime editing capabilities, and is therefore better suited for "previewing" purposes.
Since we do have the full document in these cases, we can apply the patches as they arrive from the backend, and doesn't need to do the ordinary refetching that we do for regular previews where only partial documents are kept locally.
These methods are useful for cases where you don't need the optimistic patching logic provided by the document store, but still require the full document to be loaded. The use case at hand is to load a list of documents and show their validation status in a view that doesn't support editing, but still needs to receive realtime updates in case they are being edited by other collaborators.
These are only meant for internal use (for now)
What to review
excludeMutationsflag to the listener request to save bandwith. This will be supported by the client once fix: add support for includeMutations listen parameter client#872 landsTesting
Notes for release
n/a - internal