refactor/introduce IContext

appinfo/info.xml

@@ -15,7 +15,7 @@
 - **💾 Open format:** Files are saved as [Markdown](https://en.wikipedia.org/wiki/Markdown), so you can edit them from any other text app too.
 - **✊ Strong foundation:** We use [🐈 tiptap](https://tiptap.scrumpy.io) which is based on [🦉 ProseMirror](https://prosemirror.net) – huge thanks to them!
 	]]></description>
-	<version>10.0.0-dev.0</version>
+	<version>10.0.0-dev.1</version>
 	<licence>agpl</licence>
 	<author mail="jus@bitgrid.net">Julius Härtl</author>
 	<namespace>Text</namespace>

appinfo/routes.php

@@ -28,7 +28,7 @@
 		['name' => 'Attachment#getMediaFilePreview', 'url' => '/mediaPreview', 'verb' => 'GET'],
 
 		/** @see Controller\SessionController::create() */
-		['name' => 'Session#create', 'url' => '/session/{documentId}/create', 'verb' => 'PUT'],
+		['name' => 'Session#create', 'url' => '/session/{type}/{id}/create', 'verb' => 'PUT'],
 		/** @see Controller\SessionController::save() */
 		['name' => 'Session#save', 'url' => '/session/{documentId}/save', 'verb' => 'POST'],
 		/** @see Controller\SessionController::sync() */

composer/composer/autoload_classmap.php

@@ -10,6 +10,15 @@
     'OCA\\Text\\AppInfo\\Application' => $baseDir . '/../lib/AppInfo/Application.php',
     'OCA\\Text\\Command\\ResetDocument' => $baseDir . '/../lib/Command/ResetDocument.php',
     'OCA\\Text\\ConfigLexicon' => $baseDir . '/../lib/ConfigLexicon.php',
+    'OCA\\Text\\Context\\ContextManager' => $baseDir . '/../lib/Context/ContextManager.php',
+    'OCA\\Text\\Context\\DocumentData' => $baseDir . '/../lib/Context/DocumentData.php',
+    'OCA\\Text\\Context\\FileContext' => $baseDir . '/../lib/Context/FileContext.php',
+    'OCA\\Text\\Context\\FileContextFactory' => $baseDir . '/../lib/Context/FileContextFactory.php',
+    'OCA\\Text\\Context\\IContext' => $baseDir . '/../lib/Context/IContext.php',
+    'OCA\\Text\\Context\\IContextFactory' => $baseDir . '/../lib/Context/IContextFactory.php',
+    'OCA\\Text\\Context\\NewSessionData' => $baseDir . '/../lib/Context/NewSessionData.php',
+    'OCA\\Text\\Context\\SessionInfo' => $baseDir . '/../lib/Context/SessionInfo.php',
+    'OCA\\Text\\Context\\UnauthorizedFileContext' => $baseDir . '/../lib/Context/UnauthorizedFileContext.php',
     'OCA\\Text\\Controller\\AiController' => $baseDir . '/../lib/Controller/AiController.php',
     'OCA\\Text\\Controller\\AttachmentController' => $baseDir . '/../lib/Controller/AttachmentController.php',
     'OCA\\Text\\Controller\\ISessionAwareController' => $baseDir . '/../lib/Controller/ISessionAwareController.php',
@@ -30,8 +39,10 @@
     'OCA\\Text\\Db\\StepMapper' => $baseDir . '/../lib/Db/StepMapper.php',
     'OCA\\Text\\DirectEditing\\TextDirectEditor' => $baseDir . '/../lib/DirectEditing/TextDirectEditor.php',
     'OCA\\Text\\DirectEditing\\TextDocumentCreator' => $baseDir . '/../lib/DirectEditing/TextDocumentCreator.php',
+    'OCA\\Text\\Event\\DocumentContentUpdated' => $baseDir . '/../lib/Event/DocumentContentUpdated.php',
     'OCA\\Text\\Event\\LoadEditor' => $baseDir . '/../lib/Event/LoadEditor.php',
     'OCA\\Text\\Event\\MentionEvent' => $baseDir . '/../lib/Event/MentionEvent.php',
+    'OCA\\Text\\Event\\RegisterContextEvent' => $baseDir . '/../lib/Event/RegisterContextEvent.php',
     'OCA\\Text\\Exception\\AccountDisabledException' => $baseDir . '/../lib/Exception/AccountDisabledException.php',
     'OCA\\Text\\Exception\\DocumentHasUnsavedChangesException' => $baseDir . '/../lib/Exception/DocumentHasUnsavedChangesException.php',
     'OCA\\Text\\Exception\\DocumentSaveConflictException' => $baseDir . '/../lib/Exception/DocumentSaveConflictException.php',
@@ -43,12 +54,14 @@
     'OCA\\Text\\Listeners\\BeforeAssistantNotificationListener' => $baseDir . '/../lib/Listeners/BeforeAssistantNotificationListener.php',
     'OCA\\Text\\Listeners\\BeforeNodeDeletedListener' => $baseDir . '/../lib/Listeners/BeforeNodeDeletedListener.php',
     'OCA\\Text\\Listeners\\BeforeNodeRenamedListener' => $baseDir . '/../lib/Listeners/BeforeNodeRenamedListener.php',
+    'OCA\\Text\\Listeners\\DocumentContentUpdatedListener' => $baseDir . '/../lib/Listeners/DocumentContentUpdatedListener.php',
     'OCA\\Text\\Listeners\\FilesLoadAdditionalScriptsListener' => $baseDir . '/../lib/Listeners/FilesLoadAdditionalScriptsListener.php',
     'OCA\\Text\\Listeners\\FilesSharingLoadAdditionalScriptsListener' => $baseDir . '/../lib/Listeners/FilesSharingLoadAdditionalScriptsListener.php',
     'OCA\\Text\\Listeners\\LoadEditorListener' => $baseDir . '/../lib/Listeners/LoadEditorListener.php',
     'OCA\\Text\\Listeners\\LoadViewerListener' => $baseDir . '/../lib/Listeners/LoadViewerListener.php',
     'OCA\\Text\\Listeners\\NodeCopiedListener' => $baseDir . '/../lib/Listeners/NodeCopiedListener.php',
     'OCA\\Text\\Listeners\\NodeWrittenResetDocumentListener' => $baseDir . '/../lib/Listeners/NodeWrittenResetDocumentListener.php',
+    'OCA\\Text\\Listeners\\RegisterContextEventListener' => $baseDir . '/../lib/Listeners/RegisterContextEventListener.php',
     'OCA\\Text\\Listeners\\RegisterDirectEditorEventListener' => $baseDir . '/../lib/Listeners/RegisterDirectEditorEventListener.php',
     'OCA\\Text\\Listeners\\RegisterTemplateCreatorListener' => $baseDir . '/../lib/Listeners/RegisterTemplateCreatorListener.php',
     'OCA\\Text\\Listeners\\VersionRestoredListener' => $baseDir . '/../lib/Listeners/VersionRestoredListener.php',
@@ -67,6 +80,9 @@
     'OCA\\Text\\Migration\\Version040100Date20240611165300' => $baseDir . '/../lib/Migration/Version040100Date20240611165300.php',
     'OCA\\Text\\Migration\\Version070000Date20250925110024' => $baseDir . '/../lib/Migration/Version070000Date20250925110024.php',
     'OCA\\Text\\Migration\\Version080000Date20260331132113' => $baseDir . '/../lib/Migration/Version080000Date20260331132113.php',
+    'OCA\\Text\\Migration\\Version090000Date20260817110024' => $baseDir . '/../lib/Migration/Version090000Date20260817110024.php',
+    'OCA\\Text\\Migration\\Version090000Date20260819110024' => $baseDir . '/../lib/Migration/Version090000Date20260819110024.php',
+    'OCA\\Text\\Migration\\Version090000Date20260820132113' => $baseDir . '/../lib/Migration/Version090000Date20260820132113.php',
     'OCA\\Text\\Notification\\Notifier' => $baseDir . '/../lib/Notification/Notifier.php',
     'OCA\\Text\\Service\\AiTagService' => $baseDir . '/../lib/Service/AiTagService.php',
     'OCA\\Text\\Service\\ApiService' => $baseDir . '/../lib/Service/ApiService.php',

composer/composer/autoload_static.php

@@ -25,6 +25,15 @@ class ComposerStaticInitText
         'OCA\\Text\\AppInfo\\Application' => __DIR__ . '/..' . '/../lib/AppInfo/Application.php',
         'OCA\\Text\\Command\\ResetDocument' => __DIR__ . '/..' . '/../lib/Command/ResetDocument.php',
         'OCA\\Text\\ConfigLexicon' => __DIR__ . '/..' . '/../lib/ConfigLexicon.php',
+        'OCA\\Text\\Context\\ContextManager' => __DIR__ . '/..' . '/../lib/Context/ContextManager.php',
+        'OCA\\Text\\Context\\DocumentData' => __DIR__ . '/..' . '/../lib/Context/DocumentData.php',
+        'OCA\\Text\\Context\\FileContext' => __DIR__ . '/..' . '/../lib/Context/FileContext.php',
+        'OCA\\Text\\Context\\FileContextFactory' => __DIR__ . '/..' . '/../lib/Context/FileContextFactory.php',
+        'OCA\\Text\\Context\\IContext' => __DIR__ . '/..' . '/../lib/Context/IContext.php',
+        'OCA\\Text\\Context\\IContextFactory' => __DIR__ . '/..' . '/../lib/Context/IContextFactory.php',
+        'OCA\\Text\\Context\\NewSessionData' => __DIR__ . '/..' . '/../lib/Context/NewSessionData.php',
+        'OCA\\Text\\Context\\SessionInfo' => __DIR__ . '/..' . '/../lib/Context/SessionInfo.php',
+        'OCA\\Text\\Context\\UnauthorizedFileContext' => __DIR__ . '/..' . '/../lib/Context/UnauthorizedFileContext.php',
         'OCA\\Text\\Controller\\AiController' => __DIR__ . '/..' . '/../lib/Controller/AiController.php',
         'OCA\\Text\\Controller\\AttachmentController' => __DIR__ . '/..' . '/../lib/Controller/AttachmentController.php',
         'OCA\\Text\\Controller\\ISessionAwareController' => __DIR__ . '/..' . '/../lib/Controller/ISessionAwareController.php',
@@ -45,8 +54,10 @@ class ComposerStaticInitText
         'OCA\\Text\\Db\\StepMapper' => __DIR__ . '/..' . '/../lib/Db/StepMapper.php',
         'OCA\\Text\\DirectEditing\\TextDirectEditor' => __DIR__ . '/..' . '/../lib/DirectEditing/TextDirectEditor.php',
         'OCA\\Text\\DirectEditing\\TextDocumentCreator' => __DIR__ . '/..' . '/../lib/DirectEditing/TextDocumentCreator.php',
+        'OCA\\Text\\Event\\DocumentContentUpdated' => __DIR__ . '/..' . '/../lib/Event/DocumentContentUpdated.php',
         'OCA\\Text\\Event\\LoadEditor' => __DIR__ . '/..' . '/../lib/Event/LoadEditor.php',
         'OCA\\Text\\Event\\MentionEvent' => __DIR__ . '/..' . '/../lib/Event/MentionEvent.php',
+        'OCA\\Text\\Event\\RegisterContextEvent' => __DIR__ . '/..' . '/../lib/Event/RegisterContextEvent.php',
         'OCA\\Text\\Exception\\AccountDisabledException' => __DIR__ . '/..' . '/../lib/Exception/AccountDisabledException.php',
         'OCA\\Text\\Exception\\DocumentHasUnsavedChangesException' => __DIR__ . '/..' . '/../lib/Exception/DocumentHasUnsavedChangesException.php',
         'OCA\\Text\\Exception\\DocumentSaveConflictException' => __DIR__ . '/..' . '/../lib/Exception/DocumentSaveConflictException.php',
@@ -58,12 +69,14 @@ class ComposerStaticInitText
         'OCA\\Text\\Listeners\\BeforeAssistantNotificationListener' => __DIR__ . '/..' . '/../lib/Listeners/BeforeAssistantNotificationListener.php',
         'OCA\\Text\\Listeners\\BeforeNodeDeletedListener' => __DIR__ . '/..' . '/../lib/Listeners/BeforeNodeDeletedListener.php',
         'OCA\\Text\\Listeners\\BeforeNodeRenamedListener' => __DIR__ . '/..' . '/../lib/Listeners/BeforeNodeRenamedListener.php',
+        'OCA\\Text\\Listeners\\DocumentContentUpdatedListener' => __DIR__ . '/..' . '/../lib/Listeners/DocumentContentUpdatedListener.php',
         'OCA\\Text\\Listeners\\FilesLoadAdditionalScriptsListener' => __DIR__ . '/..' . '/../lib/Listeners/FilesLoadAdditionalScriptsListener.php',
         'OCA\\Text\\Listeners\\FilesSharingLoadAdditionalScriptsListener' => __DIR__ . '/..' . '/../lib/Listeners/FilesSharingLoadAdditionalScriptsListener.php',
         'OCA\\Text\\Listeners\\LoadEditorListener' => __DIR__ . '/..' . '/../lib/Listeners/LoadEditorListener.php',
         'OCA\\Text\\Listeners\\LoadViewerListener' => __DIR__ . '/..' . '/../lib/Listeners/LoadViewerListener.php',
         'OCA\\Text\\Listeners\\NodeCopiedListener' => __DIR__ . '/..' . '/../lib/Listeners/NodeCopiedListener.php',
         'OCA\\Text\\Listeners\\NodeWrittenResetDocumentListener' => __DIR__ . '/..' . '/../lib/Listeners/NodeWrittenResetDocumentListener.php',
+        'OCA\\Text\\Listeners\\RegisterContextEventListener' => __DIR__ . '/..' . '/../lib/Listeners/RegisterContextEventListener.php',
         'OCA\\Text\\Listeners\\RegisterDirectEditorEventListener' => __DIR__ . '/..' . '/../lib/Listeners/RegisterDirectEditorEventListener.php',
         'OCA\\Text\\Listeners\\RegisterTemplateCreatorListener' => __DIR__ . '/..' . '/../lib/Listeners/RegisterTemplateCreatorListener.php',
         'OCA\\Text\\Listeners\\VersionRestoredListener' => __DIR__ . '/..' . '/../lib/Listeners/VersionRestoredListener.php',
@@ -82,6 +95,9 @@ class ComposerStaticInitText
         'OCA\\Text\\Migration\\Version040100Date20240611165300' => __DIR__ . '/..' . '/../lib/Migration/Version040100Date20240611165300.php',
         'OCA\\Text\\Migration\\Version070000Date20250925110024' => __DIR__ . '/..' . '/../lib/Migration/Version070000Date20250925110024.php',
         'OCA\\Text\\Migration\\Version080000Date20260331132113' => __DIR__ . '/..' . '/../lib/Migration/Version080000Date20260331132113.php',
+        'OCA\\Text\\Migration\\Version090000Date20260817110024' => __DIR__ . '/..' . '/../lib/Migration/Version090000Date20260817110024.php',
+        'OCA\\Text\\Migration\\Version090000Date20260819110024' => __DIR__ . '/..' . '/../lib/Migration/Version090000Date20260819110024.php',
+        'OCA\\Text\\Migration\\Version090000Date20260820132113' => __DIR__ . '/..' . '/../lib/Migration/Version090000Date20260820132113.php',
         'OCA\\Text\\Notification\\Notifier' => __DIR__ . '/..' . '/../lib/Notification/Notifier.php',
         'OCA\\Text\\Service\\AiTagService' => __DIR__ . '/..' . '/../lib/Service/AiTagService.php',
         'OCA\\Text\\Service\\ApiService' => __DIR__ . '/..' . '/../lib/Service/ApiService.php',

cypress/e2e/api/SessionApi.spec.js

@@ -36,14 +36,17 @@ describe('The session Api', function() {
 		})
 
 		it('returns connection', function() {
-			cy.openConnection({ fileId }).then(({ connection }) => {
-				cy.wrap(connection).its('documentId').should('equal', fileId)
+			cy.openFileConnection({ fileId }).then(({ connection }) => {
+				cy.wrap(connection)
+					.its('documentId')
+					.then((id) => Number.parseInt(id))
+					.should('be.greaterThan', 1_000_000) // snowflake ids have more than 20 bit.
 				cy.closeConnection(connection)
 			})
 		})
 
 		it('provides initial content', function() {
-			cy.openConnection({ fileId, filePath }).then(({ connection, data }) => {
+			cy.openFileConnection({ fileId, filePath }).then(({ connection, data }) => {
 				cy.wrap(data).its('content').should('eql', '## Hello world\n')
 				cy.closeConnection(connection)
 			})
@@ -54,7 +57,7 @@ describe('The session Api', function() {
 		})
 
 		it('handles missing file id', function() {
-			cy.failToCreateTextSession().its('status').should('equal', 412)
+			cy.failToCreateTextSession().its('status').should('equal', 404)
 		})
 	})
 
@@ -63,7 +66,7 @@ describe('The session Api', function() {
 
 		beforeEach(function() {
 			cy.uploadTestFile()
-				.then((fileId) => cy.openConnection({ fileId }))
+				.then((fileId) => cy.openFileConnection({ fileId }))
 				.then(({ connection: con }) => {
 					connection = con
 				})
@@ -116,7 +119,7 @@ describe('The session Api', function() {
 			cy.uploadTestFile()
 				.then((id) => {
 					fileId = id
-					return cy.openConnection({ fileId, filePath })
+					return cy.openFileConnection({ fileId, filePath })
 				})
 				.then(({ connection: con }) => {
 					connection = con
@@ -151,7 +154,7 @@ describe('The session Api', function() {
 				documentState,
 				manualSave: true,
 			})
-			cy.openConnection({ fileId, filePath })
+			cy.openFileConnection({ fileId, filePath })
 				.as('joining')
 				.its('data.documentState')
 				.should('eql', documentState)
@@ -183,7 +186,7 @@ describe('The session Api', function() {
 				.then(() => cy.clearCookies())
 				.then(() => {
 					return cy
-						.openConnection({ filePath: '', token: shareToken })
+						.openShareConnection({ filePath: '', token: shareToken })
 						.then(({ connection: con }) => {
 							connection = con
 						})
@@ -223,7 +226,7 @@ describe('The session Api', function() {
 				documentState,
 				manualSave: true,
 			})
-			cy.openConnection({ filePath: '', token: shareToken })
+			cy.openShareConnection({ filePath: '', token: shareToken })
 				.as('joining')
 				.its('data.documentState')
 				.should('eql', documentState)
@@ -247,15 +250,15 @@ describe('The session Api', function() {
 					cy.log(token)
 					shareToken = token
 					cy.clearCookies()
-					cy.openConnection({ filePath: '', token: shareToken }).then(({ connection: con }) => {
+					cy.openShareConnection({ filePath: '', token: shareToken }).then(({ connection: con }) => {
 						connection = con
 					})
 				})
 		})
 
 		it('does not send initial content if other session is alive but did not push any steps', function() {
 			let joining
-			cy.openConnection({ filePath: '', token: shareToken })
+			cy.openShareConnection({ filePath: '', token: shareToken })
 				.then(({ connection: con, data }) => {
 					joining = con
 					return data
@@ -271,7 +274,7 @@ describe('The session Api', function() {
 			cy.pushSteps({ connection, steps: [messages.update], version })
 				.its('version')
 				.should('eql', 0)
-			cy.openConnection({ filePath: '', token: shareToken })
+			cy.openShareConnection({ filePath: '', token: shareToken })
 				.then(({ connection: con, data }) => {
 					joining = con
 					return data
@@ -283,9 +286,8 @@ describe('The session Api', function() {
 		})
 
 		it('refuses create,push,sync,save with non-matching baseVersionEtag', function() {
-			cy.failToCreateTextSession(undefined, 'wrongBaseVersionEtag', {
+			cy.failToCreateTextShareSession(shareToken, 'wrongBaseVersionEtag', {
 				filePath: '',
-				token: shareToken,
 			})
 				.its('status')
 				.should('eql', 412)
@@ -312,7 +314,7 @@ describe('The session Api', function() {
 				.its('version')
 				.should('eql', 0)
 			cy.log('Other user creates session')
-			cy.openConnection({ filePath: '', token: shareToken }).then(({ connection: con }) => {
+			cy.openShareConnection({ filePath: '', token: shareToken }).then(({ connection: con }) => {
 				joining = con
 			})
 			cy.log('Initial user closes session')
@@ -330,7 +332,7 @@ describe('The session Api', function() {
 		// Skipped for now since the behaviour chanced by not cleaning up the state on close/create
 		it.skip('ignores steps stored after close cleaned up', function() {
 			cy.pushAndClose({ connection, steps: [messages.update], version })
-			cy.openConnection({ filePath: '', token: shareToken })
+			cy.openShareConnection({ filePath: '', token: shareToken })
 				.then(({ connection: con, data }) => {
 					connection = con
 					return data

cypress/e2e/api/SyncServiceProvider.spec.js

@@ -42,6 +42,7 @@ describe('Sync service provider', function() {
 	 * @param {object} ydoc Yjs document
 	 */
 	function createProvider(ydoc) {
+		const context = { type: 'file', id: fileId }
 		const relativePath = '.'
 		let baseVersionEtag
 		const setBaseVersionEtag = (val) => {
@@ -50,21 +51,18 @@ describe('Sync service provider', function() {
 		const getBaseVersionEtag = () => baseVersionEtag
 		const { connection, openConnection } = provideConnection(
 			{
-				fileId,
+				context,
 				relativePath,
 			},
 			getBaseVersionEtag,
 			setBaseVersionEtag,
 		)
 		const { syncService } = provideSyncService(connection, openConnection)
-		const queue = []
 		syncService.bus.on('opened', () => syncService.startSync())
 		return createSyncServiceProvider({
 			ydoc,
 			syncService,
-			fileId,
-			initialSession: null,
-			queue,
+			context,
 			disableBc: true,
 		})
 	}

cypress/e2e/api/UsersApi.spec.js

@@ -16,13 +16,16 @@ describe('The user mention API', function() {
 		cy.login(user)
 		cy.uploadTestFile('test.md')
 			.as('fileId')
-			.then((fileId) => cy.openConnection({ fileId }))
+			.then((fileId) => cy.openFileConnection({ fileId }))
 			.its('connection')
 			.as('connection')
 	})
 
 	it('has a valid connection', function() {
-		cy.get('@connection').its('documentId').should('equal', this.fileId)
+		cy.get('@connection')
+			.its('documentId')
+			.then((id) => Number.parseInt(id))
+			.should('be.greaterThan', 1_000_000) // snowflake ids have more than 20 bit.
 		cy.closeConnection(this.connection)
 	})