Skip to content

enh/y indexeddb#7621

Open
max-nextcloud wants to merge 55 commits intomainfrom
enh/y-indexeddb
Open

enh/y indexeddb#7621
max-nextcloud wants to merge 55 commits intomainfrom
enh/y-indexeddb

Conversation

@max-nextcloud
Copy link
Copy Markdown
Collaborator

@max-nextcloud max-nextcloud commented Sep 8, 2025 •
edited by mejo-
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
  • Reconnecting: saved unsaved changes:
    • indicate dirty state
    • autosave when opening dirty file
    • autosave when reconnecting with editing session open
    • push steps that have not been pushed yet
  • make "no conflict when uploading identical content" work again (@mejo-)
  • cleanup client side state for deleted files (possibly a follow-up)
  • improve wording for conflict resolution buttons (@silverkszlo, possibly a follow-up if too complex)
    • check if the distinction in readerSource property for CollissionResolveDialog is still needed (see here)
  • test in private browser tab and research whether indexeddb is supported there (@silverkszlo)
  • keep editor editable when connection issue got detected (@mejo-)

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

codecov Bot commented Sep 8, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 56.33803% with 31 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/services/WebSocketPolyfill.ts 33.33% 10 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/services/y-websocket.js 0.00% 2 Missing ⚠️
src/EditorFactory.ts 85.71% 1 Missing ⚠️
src/services/PollingBackend.ts 0.00% 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
Copy Markdown
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
silverkszlo and others added 9 commits April 23, 2026 10:18
@silverkszlo @mejo-
chore(cleanup): remove obsolete imports after rebase
b607495 
Signed-off-by: silver <s.szmajduch@posteo.de>
@silverkszlo @mejo-
chore(lint): npm run prettier and lint
ee3d816 
Signed-off-by: silver <s.szmajduch@posteo.de>
@silverkszlo @mejo-
fix(test): destroy editor after use
58cddcc 
Signed-off-by: silver <s.szmajduch@posteo.de>
@silverkszlo @mejo-
fix(Editor.js): forward slots to inner Editor component (ai code)
92b254f 
Signed-off-by: silver <s.szmajduch@posteo.de>
@mejo-
fix(useIndexedDbProvider): don't write on closed connection
20d0eca 
There might still be dangling async functions trying to write to
IndexedDB after `clearIndexedDB()` was called. Guard against these race
conditions.

Generated with the help of AI but verified and implemented manually.

Signed-off-by: Jonas <jonas@freesources.org>
@mejo-
fix(conflict): persist local state in local storage
a1661c5 
Needed so local changes don't get lost when editor is closed in
case of conflict.

Signed-off-by: Jonas <jonas@freesources.org>
@mejo-
fix(documentStatus): display document status on conflict
a40a23b 
Signed-off-by: Jonas <jonas@freesources.org>
@mejo-
test(playwright): migrate conflict tests from Cypress
9eb8933 
Signed-off-by: Jonas <jonas@freesources.org>
@silverkszlo @mejo-
fix: catch IDB error while sync
fa44e88 
Signed-off-by: silver <s.szmajduch@posteo.de>
@mejo- mejo- force-pushed the enh/y-indexeddb branch 4 times, most recently from f4a20a8 to ca0bda6 Compare April 23, 2026 12:21
silverkszlo
silverkszlo reviewed Apr 23, 2026
View reviewed changes
Comment thread lib/Listeners/NodeWrittenResetDocumentListener.php Outdated
@mejo- mejo- force-pushed the enh/y-indexeddb branch from ca0bda6 to d83ce8a Compare April 23, 2026 12:57
mejo- and others added 3 commits April 23, 2026 15:01
@mejo-
fix(document): don't reset document when uploading same content
839827a 
Fixes 'no conflict when uploading identical content with unsaved
changes'

Signed-off-by: Jonas <jonas@freesources.org>
@silverkszlo @mejo-
refactor(CollisionResolveDialog): rephrase btns in CollisionResolveDi…
bb7cd31 
…alog

Rename buttons to hopefully make them more understandable.

Signed-off-by: silver <s.szmajduch@posteo.de>
@mejo-
chore(test): move useDelayedFlag test to tests directory
a10e336 
Signed-off-by: Jonas <jonas@freesources.org>
@mejo- mejo- force-pushed the enh/y-indexeddb branch 2 times, most recently from 2513156 to f34e31f Compare April 23, 2026 20:48
mejo- added 3 commits April 23, 2026 23:02
@mejo-
feat(offline): customizable delay before read-only, default 5 minutes
9b989d4 
Signed-off-by: Jonas <jonas@freesources.org>
@mejo-
chore(editor): remove unused property from Wrapper component
c98c919 
Signed-off-by: Jonas <jonas@freesources.org>
@mejo-
test(playwright): enable sharding to run tests in parallel in CI
3b28b09 
Signed-off-by: Jonas <jonas@freesources.org>
@mejo- mejo- force-pushed the enh/y-indexeddb branch from f34e31f to e831ac2 Compare April 23, 2026 21:02
mejo- added 2 commits April 23, 2026 23:05
@mejo-
test(playwright): longer timeout for first conflict UI check
22a6d56 
Requests might take a few seconds before getting triggered once the
conflicting file got uploaded, so let's use a timeout of 10 seconds for
the first conflict resolution UI check in each test.

Signed-off-by: Jonas <jonas@freesources.org>
@mejo-
test(playwright): improve selector for viewer close button
21deb81 
Prevents failing tests when a toast with close button appears at the
same time.

Signed-off-by: Jonas <jonas@freesources.org>
@mejo- mejo- force-pushed the enh/y-indexeddb branch from e831ac2 to 21deb81 Compare April 23, 2026 21:18
@mejo-
fix(WebSocketPolyfill): run onopen callback on initialization
930bd9c 
After a long offline period (>70 seconds), y-websocket's internal
watchdog closes the WebSocketPolyfill instance because no messages have
been received.

After going back online, y-websocket creates a new WebSocketPolyfill
instance to reconnect. In the new instance, syncService.open() is
called — but it returns early because the HTTP session is still alive.

This results in `wsconnected` staying false, which means that new steps
never get pushed to the server.

The fix is to run onopen callback explicitly in WebSocketPolyfill's
constructor.

Signed-off-by: Jonas <jonas@freesources.org>
@mejo- mejo- force-pushed the enh/y-indexeddb branch from 48f56ea to 930bd9c Compare April 23, 2026 22:08
@mejo-
fix(PollingBackend): increase poll interval on repeated network errors
032ed99 
When returning to a backgrounded tab, `visibilitychange` resets the fetch
interval to the minimum (300ms). Network errors never called
`increaseRefetchTimer()`, so the aggressive rate persisted indefinitely
while offline, causing ~3 sync requests per second.

Signed-off-by: Jonas <jonas@freesources.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mejo- mejo- mejo- left review comments

@silverkszlo silverkszlo silverkszlo left review comments

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

Assignees

@silverkszlo silverkszlo

@max-nextcloud max-nextcloud

Labels

None yet

Projects

📝 Productivity team
Status: 🏗️ In progress

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Persist document state in browser IndexedDB storage

4 participants

@max-nextcloud @mejo- @silverkszlo @blizzz