enh/y indexeddb

cypress/e2e/api/SessionApi.spec.js

@@ -73,34 +73,33 @@ describe('The session Api', function () {
 			cy.closeConnection(connection)
 		})
 
-		// Echoes all message types but queries
-		Object.entries(messages)
-			.filter(([key, _value]) => key !== 'query')
-			.forEach(([type, sample]) => {
-				it(`echos ${type} messages`, function () {
-					const steps = [sample]
-					const version = 0
-					cy.pushSteps({ connection, steps, version })
-						.its('version')
-						.should('eql', 0)
-					cy.syncSteps(connection)
-						.its('steps[0].data')
-						.should('eql', steps)
-				})
+		// Echoes updates and responses
+		;['update', 'response'].forEach((type) => {
+			it(`echos ${type} messages`, function () {
+				const steps = [messages[type]]
+				const version = 0
+				cy.pushSteps({ connection, steps, version })
+					.its('version')
+					.should('eql', 0)
+				cy.syncSteps(connection).its('steps[0].data').should('eql', steps)
 			})
+		})
 
-		it('responds to queries', function () {
+		it('responds to queries with updates and responses', function () {
 			const version = 0
 			Object.entries(messages).forEach(([type, sample]) => {
 				cy.pushSteps({ connection, steps: [sample], version })
 			})
 			cy.pushSteps({ connection, steps: [messages.query], version }).then(
 				(response) => {
 					cy.wrap(response).its('version').should('eql', 0)
-					cy.wrap(response).its('steps.length').should('eql', 1)
+					cy.wrap(response).its('steps.length').should('eql', 2)
 					cy.wrap(response)
 						.its('steps[0].data')
 						.should('eql', [messages.update])
+					cy.wrap(response)
+						.its('steps[1].data')
+						.should('eql', [messages.response])
 				},
 			)
 		})
@@ -111,7 +110,6 @@ describe('The session Api', function () {
 		let connection
 		let fileId
 		let filePath
-		let joining
 
 		beforeEach(function () {
 			cy.testName().then((name) => {
@@ -156,13 +154,10 @@ describe('The session Api', function () {
 				manualSave: true,
 			})
 			cy.openConnection({ fileId, filePath })
-				.then(({ connection: con, data }) => {
-					joining = con
-					return data
-				})
-				.its('documentState')
+				.as('joining')
+				.its('data.documentState')
 				.should('eql', documentState)
-			cy.closeConnection(joining)
+			cy.get('@joining').its('connection').then(cy.closeConnection)
 		})
 
 		afterEach(function () {
@@ -175,7 +170,6 @@ describe('The session Api', function () {
 		let connection
 		let filePath
 		let shareToken
-		let joining
 
 		beforeEach(function () {
 			cy.testName().then((name) => {
@@ -232,13 +226,10 @@ describe('The session Api', function () {
 				manualSave: true,
 			})
 			cy.openConnection({ filePath: '', token: shareToken })
-				.then(({ connection: con, data }) => {
-					joining = con
-					return data
-				})
-				.its('documentState')
+				.as('joining')
+				.its('data.documentState')
 				.should('eql', documentState)
-			cy.closeConnection(joining)
+			cy.get('@joining').its('connection').then(cy.closeConnection)
 		})
 	})
 

cypress/e2e/api/SyncServiceProvider.spec.js

@@ -43,15 +43,20 @@ describe('Sync service provider', function () {
 	 */
 	function createProvider(ydoc) {
 		const relativePath = '.'
-		const { connection, openConnection, baseVersionEtag } = provideConnection({
-			fileId,
-			relativePath,
-		})
-		const { syncService } = provideSyncService(
-			connection,
-			openConnection,
-			baseVersionEtag,
+		let baseVersionEtag
+		const setBaseVersionEtag = (val) => {
+			baseVersionEtag = val
+		}
+		const getBaseVersionEtag = () => baseVersionEtag
+		const { connection, openConnection } = provideConnection(
+			{
+				fileId,
+				relativePath,
+			},
+			getBaseVersionEtag,
+			setBaseVersionEtag,
 		)
+		const { syncService } = provideSyncService(connection, openConnection)
 		const queue = []
 		syncService.bus.on('opened', () => syncService.startSync())
 		return createSyncServiceProvider({

cypress/e2e/conflict.spec.js

@@ -36,14 +36,9 @@ variants.forEach(function ({ fixture, mime }) {
 				cy.getContent().should('contain', 'Heading')
 
 				cy.uploadFile(fileName, mime, testName + '/' + fileName)
-				cy.get('#editor-container .document-status', {
-					timeout: 40000,
-				}).should('contain', 'session has expired')
-
-				// Reload button works
-				cy.get('#editor-container .document-status button')
-					.contains('Reload')
-					.click()
+				cy.intercept({ method: 'POST', url: '**/session/*/push' }).as('push')
+				cy.wait('@push', { timeout: 20_000 })
+				// Autoreload works
 				getWrapper().should('not.exist')
 				cy.getContent().should('contain', 'Hello world')
 				cy.getContent().should('not.contain', 'Heading')
@@ -78,10 +73,10 @@ variants.forEach(function ({ fixture, mime }) {
 				cy.openFile(fileName)
 				cy.intercept({ method: 'POST', url: '**/session/*/push' }).as('push')
 				cy.wait('@push')
-				cy.get('[data-cy="resolveThisVersion"]').click()
+				cy.get('[data-cy="useEditorVersion"]').click()
 
 				getWrapper().should('not.exist')
-				cy.get('[data-cy="resolveThisVersion"]').should('not.exist')
+				cy.get('[data-cy="useEditorVersion"]').should('not.exist')
 				cy.getContent().should('contain', 'cruel conflicting')
 			},
 		)
@@ -90,11 +85,11 @@ variants.forEach(function ({ fixture, mime }) {
 			createConflict(fileName, 'edited-' + fileName, mime)
 
 			cy.openFile(fileName)
-			cy.get('[data-cy="resolveServerVersion"]').click()
+			cy.get('[data-cy="useReaderVersion"]').click()
 
 			getWrapper().should('not.exist')
-			cy.get('[data-cy="resolveThisVersion"]').should('not.exist')
-			cy.get('[data-cy="resolveServerVersion"]').should('not.exist')
+			cy.get('[data-cy="useEditorVersion"]').should('not.exist')
+			cy.get('[data-cy="useReaderVersion"]').should('not.exist')
 			cy.getContent().should('contain', 'Hello world')
 			cy.getContent().should('not.contain', 'cruel conflicting')
 		})

cypress/e2e/sync.spec.js

@@ -108,7 +108,10 @@ describe('Sync', () => {
 			'contain',
 			'The document could not be loaded.',
 		)
+		cy.intercept('**/apps/text/session/*/create').as('create')
 		cy.get('#editor-container .document-status').find('button').click()
+		// let first attempt fail
+		cy.wait('@create', { timeout: 10000 })
 		cy.get('#editor-container .document-status', { timeout: 30000 }).should(
 			'contain',
 			'The document could not be loaded.',
@@ -117,13 +120,13 @@ describe('Sync', () => {
 		cy.intercept('**/apps/text/session/*/*', (req) => {
 			req.continue()
 		}).as('alive')
-		cy.intercept('**/apps/text/session/*/create').as('create')
 		cy.get('#editor-container .document-status').find('button').click()
+		// this is the create request... - now with the alive alias
 		cy.wait('@alive', { timeout: 30000 })
-		cy.wait('@create', { timeout: 10000 })
 			.its('request.body')
 			.should('have.property', 'baseVersionEtag')
 			.should('not.be.empty')
+		cy.getContent().should('contain', 'Hello world')
 	})
 
 	it('recovers from a lost and closed connection', () => {
@@ -176,18 +179,9 @@ describe('Sync', () => {
 		cy.wait('@save')
 		cy.uploadTestFile('test.md')
 
-		cy.get('#editor-container .document-status', { timeout: 30000 }).should(
-			'contain',
-			'Editing session has expired.',
-		)
-
-		// Reload button works
-		cy.get('#editor-container .document-status button')
-			.contains('Reload')
-			.click()
-
-		cy.getContent()
-		cy.get('#editor-container .document-status .notecard').should('not.exist')
+		cy.getContent().should('not.exist')
+		cy.getContent().find('h2').should('contain', 'Hello world')
+		cy.getContent().find('li').should('not.exist') // was overwritten after the save
 	})
 
 	it('passes the doc content from one session to the next', () => {

lib/Cron/Cleanup.php

@@ -11,7 +11,6 @@
 
 namespace OCA\Text\Cron;
 
-use OCA\Text\Exception\DocumentHasUnsavedChangesException;
 use OCA\Text\Service\AttachmentService;
 use OCA\Text\Service\DocumentService;
 use OCA\Text\Service\SessionService;
@@ -42,11 +41,6 @@ protected function run($argument): void {
 				// Inactive sessions will get removed further down and will trigger a reset next time
 				continue;
 			}
-
-			try {
-				$this->documentService->resetDocument($document->getId());
-			} catch (DocumentHasUnsavedChangesException) {
-			}
 			$this->attachmentService->cleanupAttachments($document->getId());
 		}
 

lib/Listeners/BeforeNodeWrittenListener.php

@@ -40,12 +40,12 @@ public function handle(Event $event): void {
 		}
 		// Reset document session to avoid manual conflict resolution if there's no unsaved steps
 		try {
-			$this->documentService->resetDocument($node->getId());
+			$this->documentService->resetDocument($node->getId(), true);
 		} catch (DocumentHasUnsavedChangesException|NotFoundException $e) {
 			// Do not throw during event handling in this is expected to happen
 			// DocumentHasUnsavedChangesException: A document editing session is likely ongoing, someone can resolve the conflict
 			// NotFoundException: The event was called oin a file that was just created so a NonExistingFile object is used that has no id yet
-			$this->logger->debug('Reset document skipped in BeforeNodeWrittenEvent', ['exception' => $e]);
+			$this->logger->warning('Reset document skipped in BeforeNodeWrittenEvent', ['exception' => $e]);
 		}
 	}
 }

lib/Service/DocumentService.php

@@ -208,8 +208,12 @@ public function addStep(Document $document, Session $session, array $steps, int
 			if ($readOnly && $message->isUpdate()) {
 				continue;
 			}
+			// Only accept sync protocol
+			if ($message->getYjsMessageType() !== YjsMessage::YJS_MESSAGE_SYNC) {
+				continue;
+			}
 			// Filter out query steps as they would just trigger clients to send their steps again
-			if ($message->getYjsMessageType() === YjsMessage::YJS_MESSAGE_SYNC && $message->getYjsSyncType() === YjsMessage::YJS_MESSAGE_SYNC_STEP1) {
+			if ($message->getYjsSyncType() === YjsMessage::YJS_MESSAGE_SYNC_STEP1) {
 				$stepsIncludeQuery = true;
 			} else {
 				$stepsToInsert[] = $step;
@@ -249,7 +253,7 @@ public function addStep(Document $document, Session $session, array $steps, int
 		$stepsToReturn = [];
 		foreach ($allSteps as $step) {
 			$message = YjsMessage::fromBase64($step->getData());
-			if ($message->getYjsMessageType() === YjsMessage::YJS_MESSAGE_SYNC && $message->getYjsSyncType() === YjsMessage::YJS_MESSAGE_SYNC_UPDATE) {
+			if ($message->isUpdate()) {
 				$stepsToReturn[] = $step;
 			}
 		}

package.json

@@ -102,6 +102,7 @@
     "vue-click-outside": "^1.1.0",
     "vue-material-design-icons": "^5.3.1",
     "webdav": "^5.9.0",
+    "y-indexeddb": "^9.0.12",
     "y-prosemirror": "^1.3.7",
     "y-protocols": "^1.0.7",
     "yjs": "^13.6.30"

playwright/e2e/autosave.spec.ts

@@ -0,0 +1,65 @@
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { expect, mergeTests } from '@playwright/test'
+import { test as editorTest } from '../support/fixtures/editor'
+import { test as offlineTest } from '../support/fixtures/offline'
+import { test as uploadFileTest } from '../support/fixtures/upload-file'
+
+const test = mergeTests(editorTest, offlineTest, uploadFileTest)
+
+// As we switch on and off the network
+// we cannot run tests in parallel.
+test.describe.configure({ mode: 'serial' })
+
+test.beforeEach(async ({ open }) => {
+	await open()
+})
+
+test('saves after 30 seconds', async ({ editor, page }) => {
+	await page.clock.install()
+	await expect(editor.el).toBeVisible()
+	await editor.typeHeading('Hello world')
+	await expect(editor.saveIndicator).toHaveAccessibleName(/Unsaved changes/)
+	await page.clock.fastForward(30_000)
+	await expect(editor.saveIndicator).not.toHaveAccessibleName(/Unsaved changes/)
+	// TODO: Why does this not work? await expect(await file.getContent()).toBe('## Hello world')
+})
+
+test('saves after being disconnected for 20 sec.', async ({
+	editor,
+	page,
+	setOffline,
+	setOnline,
+}) => {
+	await page.clock.install()
+	await expect(editor.el).toBeVisible()
+	await editor.typeHeading('Hello world')
+	await expect(editor.saveIndicator).toHaveAccessibleName(/Unsaved changes/)
+	setOffline()
+	await page.clock.fastForward(20_000)
+	setOnline()
+	await page.clock.fastForward(20_000)
+	await expect(editor.saveIndicator).not.toHaveAccessibleName(/Unsaved changes/)
+	// TODO: Why does this not work? await expect(await file.getContent()).toBe('## Hello world')
+})
+
+test('saves after being disconnected for 2 minutes', async ({
+	editor,
+	page,
+	setOffline,
+	setOnline,
+}) => {
+	await page.clock.install()
+	await expect(editor.el).toBeVisible()
+	await editor.typeHeading('Hello world')
+	await expect(editor.saveIndicator).toHaveAccessibleName(/Unsaved changes/)
+	setOffline()
+	await page.clock.fastForward(120_000)
+	setOnline()
+	await page.clock.fastForward(40_000)
+	await expect(editor.saveIndicator).not.toHaveAccessibleName(/Unsaved changes/)
+	// TODO: Why does this not work? await expect(await file.getContent()).toBe('## Hello world')
+})