Skip to content

enh/y indexeddb #7621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
max-nextcloud wants to merge 25 commits into
base: main
Choose a base branch
from
Open

enh/y indexeddb #7621

max-nextcloud wants to merge 25 commits into from
+816 −266

Conversation

@max-nextcloud
Copy link
Collaborator

@max-nextcloud max-nextcloud commented Sep 8, 2025 •
edited
Loading

TODOs

  • Think through other file operations.
  • Typing without network, closing the editor, opening it again: no content lost
  • After closing and opening the editor, undo history is empty
  • cleanup yDoc file server-side when file is deleted @mejo-
  • Add base_version_etag as custom property to IndexedDB
    • After loading document from IndexedDB, send baseVersionEtag as part of create request
    • In case of conflict, use existing manual conflict handling
    • After manual conflict handling, reset y-indexeddb provider for document
    • Fix endless reload loop when base version has been cleared:
      • Open file with version in indexed db but on a different baseVersionEtag.
      • Different versions are detected. Reload button is offered.
      • Reload does not change the indexed db content - so conflict persists.
    • migrate change mime type test to playwright
    • debug failing change mime type test.
    • make bc channel depend on base version etag.
    • Test... start editing offline, overwrite file in other tab, see what happens when getting back online @max-nextcloud
  • Handling conflicts when opening file that was changed offline
    • detect conflict
    • handle scenario with no local changes well
    • display conflict when local changes were made
    • adjust conflict dialog wording
    • test conflict resolutions work
  • Opening editor: steps from IndexedDB that didn't get sent to server yet need to get pushed
  • Opening editor: when steps from IndexedDB didn't get sent to server yet, unsaved changes should be indicated and saved
  • cleanup client side state for deleted files
  • config flag

@max-nextcloud max-nextcloud requested a review from mejo- as a code owner September 8, 2025 09:44
@codecov
Copy link

codecov bot commented Sep 8, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 50.90909% with 27 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/services/WebSocketPolyfill.ts 30.76% 9 Missing ⚠️
src/services/SyncService.ts 11.11% 7 Missing and 1 partial ⚠️
src/helpers/yjs.ts 0.00% 3 Missing and 1 partial ⚠️
src/composables/useConnection.ts 62.50% 2 Missing and 1 partial ⚠️
src/helpers/updateFromContent.ts 85.71% 2 Missing ⚠️
src/EditorFactory.ts 85.71% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

@max-nextcloud max-nextcloud force-pushed the enh/y-indexeddb branch 7 times, most recently from 6637691 to e746625 Compare October 27, 2025 20:17
@max-nextcloud max-nextcloud force-pushed the enh/y-indexeddb branch 5 times, most recently from 6d4c06b to 1ade042 Compare November 5, 2025 15:56
@max-nextcloud max-nextcloud force-pushed the enh/y-indexeddb branch 4 times, most recently from 853ca71 to 0a18ad3 Compare November 6, 2025 19:56
@max-nextcloud max-nextcloud mentioned this pull request Nov 7, 2025
Merged
@mejo- mejo- self-assigned this Dec 3, 2025
@mejo-
Copy link
Member

mejo- commented Dec 3, 2025

  • cleanup yDoc file server-side when file is deleted @mejo-

Turns out this already happens and we don't have to change anything:

text/lib/Listeners/BeforeNodeDeletedListener.php

Line 42 in ce8ca64

$this->documentService->resetDocument($node->getId(), true);

@mejo- mejo- removed their assignment Dec 3, 2025
@max-nextcloud
fix(playwright): use server master branch for unreleased version
736fbc9 
Fixed by syncing the start script with what end_to_end encryption uses.
Also renders the setup steps superfluous.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
wip: try y-indexeddb
2a8c5ce 
For now text is sometimes duplicated

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(split) useIndexedDbProvider from Editor.vue
71c8a29 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(cron): do not reset document
7f8ee3d 
Keep the baseVersionEtag and the editing session around
in case people who are offline connect again later.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
enh(yjs): store baseVersionEtag alongside doc
28a8f53 
... and use it to check if the server is still on the same session.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(offline): persist dirty state in indexed db
a1426b8 
When reopening a document that was edited offline
it will also be considered dirty now.

Autosave will not kick in yet... As no steps are pushed.
But when closing the file it will be saved.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(test): explore empty changesets
84439a5 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(rename): use privateMethods for emitError and emitDocumentState…
4007a94 
…Step

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(cleanup): _getContent alias for serialize
8b8f2b5 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(refactor): handle open data in websocket polyfill
c0f8e0a 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(sync): only accept sync protocol and return sync step 2
e249165 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
enh(sync): recover automatically from outdated / renamed doc
1b8c8d8 
If no changes have been made offline
clear the indexedDb cache
and reload Editor.vue
to load the latest editing session from the server.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(sync): ensure dirty is updated when saving in onDestroy
9e562d7 
Use a setter function that remains functional
even if the component has already been destroyed
and reactivity does not work anymore.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(logging): some optional debug logging
59650d5 
yjs and editor update logging can be very verbose.
Uncomment it but keep it disabled by default.

Can be enabled by setting the corresponding key in OCA.Text - i.e.
`window.OCA.Text.logWebSocketPolyfill = true`
in the browser console.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(sync): actually disable browser broadcast
73daead 
It was still enabled as we mistyped the `disableBc` option.

We cannot use it right now as the y-websocket room name
does not include the base version etag.

Therefore different tabs may be in different sessions
and would risk syncing never the less.

Observed this when reloading the editor on an outdated session:
* Cleaning up the old yjs document took a while in the beforeDestroy callback.
* The new document was already created.
* The new y-websocket provider issued a sync step 1 via browser broadcast.
* The old y-websocket provider responded and send its full state.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(test): conflict and sync with autoreload
360843c 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(type) a few more files
911346d 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(test): add initial test for indexed db
a1a4e3e 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(sync): Cleanup sessions even with unsaved changes
4bb4b22 
Otherwise the old session would get mixed with the new content
when people come back with old state in indexed-db.
( Run playwright/e2e/indexed-db.spec.ts for an example. )

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(type): EditorFactory and setInitialYjsState
7ab596b 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
enh(sync): updateFromContent()
b355517 
This could be the basis for automatically merging
changes from an offline editing session
and changes by overwriting the doc.

Signed-off-by: Max <max@nextcloud.com>
max-nextcloud
max-nextcloud commented Jan 7, 2026
View reviewed changes
src/components/ViewerComponent.vue
Comment on lines +17 to +18
@reload="onReload"
@resolved="localChange = ''" />
Copy link
Collaborator Author

@max-nextcloud max-nextcloud Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we are not handling these in other uses of the editor component yet. Namely direct editing and createEditor

@max-nextcloud
fix(indexedDB): handle conflict with local change
ac68248 
Reconnect to a new session but remember the local change.
Show a conflict between the remote session and the local change.

Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
chore(log): debug log when attempting to open sync service twice
0c1c9fc 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(conflict): handle conflict when opening initial session
9e50301 
Signed-off-by: Max <max@nextcloud.com>
@max-nextcloud
fix(conflict): label buttons properly for unsaved local changes
5051e03 
Conflicts with unsaved changes in indexed db work differently.
When the file is overwritten on the server while editing
the editing session keeps going and the new file version is shown read only.

When opening the file and a conflicting version is found in indexed db
that local version is shown read only allowing to connect to a new session.

Signed-off-by: Max <max@nextcloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mejo- mejo- Awaiting requested review from mejo- mejo- is a code owner

@silverkszlo silverkszlo Awaiting requested review from silverkszlo silverkszlo is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@max-nextcloud max-nextcloud

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Persist document state in browser IndexedDB storage

3 participants

@max-nextcloud @mejo-