Decompose SyncService

cypress/e2e/api/SessionApi.spec.js

@@ -42,7 +42,7 @@ describe('The session Api', function() {
 				cy.wrap(connection)
 					.its('document.id')
 					.should('equal', fileId)
-				connection.close()
+				cy.destroySession(connection)
 			})
 		})
 
@@ -51,7 +51,7 @@ describe('The session Api', function() {
 				cy.wrap(connection)
 					.its('state.documentSource')
 					.should('eql', '## Hello world\n')
-				connection.close()
+				cy.destroySession(connection)
 			})
 		})
 
@@ -81,7 +81,7 @@ describe('The session Api', function() {
 		})
 
 		afterEach(function() {
-			connection.close()
+			cy.destroySession(connection)
 		})
 
 		// Echoes all message types but queries
@@ -180,7 +180,7 @@ describe('The session Api', function() {
 		})
 
 		afterEach(function() {
-			connection.close()
+			cy.destroySession(connection)
 		})
 	})
 
@@ -212,7 +212,7 @@ describe('The session Api', function() {
 		})
 
 		afterEach(function() {
-			connection.close()
+			cy.destroySession(connection)
 		})
 
 		it('starts empty public', function() {
@@ -276,22 +276,6 @@ describe('The session Api', function() {
 			})
 		})
 
-		it('signals closing connection', function() {
-			cy.then(() => {
-				return new Promise((resolve, reject) => {
-					// Create a promise that resolves when close completes
-					connection.close()
-						.then(() => {
-							connection.push({ steps: [messages.update], version, awareness: '' })
-								.then(
-									() => reject(new Error('Push should have thrown ConnectionClosed()')),
-									resolve,
-								)
-						})
-				})
-			})
-		})
-
 		it('does not send initial content if other session is alive but did not push any steps', function() {
 			let joining
 			cy.createTextSession(undefined, { filePath: '', shareToken })
@@ -301,8 +285,8 @@ describe('The session Api', function() {
 				})
 				.its('state.documentSource')
 				.should('eql', '## Hello world\n')
-				.then(() => joining.close())
-				.then(() => connection.close())
+				.then(() => cy.destroySession(joining))
+			cy.destroySession(connection)
 		})
 
 		it('does not send initial content if session is alive even without saved state', function() {
@@ -317,16 +301,17 @@ describe('The session Api', function() {
 				})
 				.its('state.documentSource')
 				.should('eql', '## Hello world\n')
-				.then(() => joining.close())
-				.then(() => connection.close())
+				.then(() => cy.destroySession(joining))
+			cy.destroySession(connection)
 		})
 
 		it('refuses create,push,sync,save with non-matching baseVersionEtag', function() {
-			cy.failToCreateTextSession(undefined, 'wrongBaseVersionEtag', { filePath: '', shareToken })
+			cy.failToCreateTextSession(undefined, 'wrongBaseVersionEtag', { filePath: '', token: shareToken })
 				.its('status')
 				.should('eql', 412)
 
 			connection.setBaseVersionEtag('wrongBaseVersionEtag')
+			connection.connection.baseVersionEtag = 'wrongBaseVersionEtag'
 
 			cy.failToPushSteps({ connection, steps: [messages.update], version })
 				.its('status')
@@ -340,7 +325,7 @@ describe('The session Api', function() {
 				.its('status')
 				.should('equal', 412)
 
-			cy.then(() => connection.close())
+			cy.destroySession(connection)
 		})
 
 		it('recovers session even if last person leaves right after create', function() {
@@ -355,7 +340,7 @@ describe('The session Api', function() {
 					joining = con
 				})
 			cy.log('Initial user closes session')
-				.then(() => connection.close())
+			cy.destroySession(connection)
 			cy.log('Other user still finds the steps')
 				.then(() => {
 					cy.syncSteps(joining, {

cypress/e2e/api/SyncServiceProvider.spec.js

@@ -4,8 +4,8 @@
  */
 
 import { randUser } from '../../utils/index.js'
-import SessionApi from '../../../src/services/SessionApi.js'
-import { SyncService } from '../../../src/services/SyncService.js'
+import { provideConnection } from '../../../src/composables/useConnection.ts'
+import { provideSyncService  } from '../../../src/composables/useSyncService.ts'
 import createSyncServiceProvider from '../../../src/services/SyncServiceProvider.js'
 import { Doc } from 'yjs'
 
@@ -39,13 +39,10 @@ describe('Sync service provider', function() {
 	 * @param {object} ydoc Yjs document
 	 */
 	function createProvider(ydoc) {
+		const relativePath = '.'
+		const { connection, openConnection, baseVersionEtag } = provideConnection({ fileId, relativePath })
+		const { syncService } = provideSyncService( connection, openConnection, baseVersionEtag )
 		const queue = []
-		const api = new SessionApi()
-		const syncService = new SyncService({
-			serialize: () => 'Serialized',
-			getDocumentState: () => null,
-			api,
-		})
 		syncService.on('opened', () => syncService.startSync())
 		return createSyncServiceProvider({
 			ydoc,

cypress/e2e/api/UsersApi.spec.js

@@ -44,7 +44,7 @@ describe('The user mention API', function() {
 	})
 
 	it('rejects closed sessions', function() {
-		cy.then(() => this.connection.close())
+		cy.destroySession(this.connection)
 		cy.sessionUsers(this.connection)
 			.its('status').should('eq', 403)
 	})

cypress/support/sessions.js

@@ -4,33 +4,44 @@
  */
 
 import axios from '@nextcloud/axios'
-import SessionApi from '../../src/services/SessionApi.js'
+import { SessionConnection } from '../../src/services/SessionConnection.js'
+import { open, close } from '../../src/apis/Connect.ts'
+import { push } from '../../src/apis/Sync.ts'
 
 const url = Cypress.config('baseUrl').replace(/\/index.php\/?$/g, '')
 
-Cypress.Commands.add('createTextSession', (fileId, options = {}) => {
-	const api = new SessionApi(options)
-	return api.open({ fileId })
+Cypress.Commands.add('createTextSession', async (fileId, options = {}) => {
+	const { connection, data } = await open({ fileId, token: options.shareToken, ...options })
+	return new SessionConnection(data, connection)
+})
+
+Cypress.Commands.add('destroySession', async (sessionConnection) => {
+	const { documentId, id, token } = sessionConnection.session
+	await close({ documentId, sessionId: id, sessionToken: token })
+	sessionConnection.close()
 })
 
 Cypress.Commands.add('failToCreateTextSession', (fileId, baseVersionEtag = null, options = {}) => {
-	const api = new SessionApi(options)
-	return api.open({ fileId, baseVersionEtag })
-		.then((response) => {
+	return open({ fileId, ...options, baseVersionEtag })
+		.then((_response) => {
 			throw new Error('Expected request to fail - but it succeeded!')
 		}, (err) => err.response)
 })
 
-Cypress.Commands.add('pushSteps', ({ connection, steps, version, awareness = '' }) => {
-	return connection.push({ steps, version, awareness })
-		.then(response => response.data)
+Cypress.Commands.add('pushSteps', ({ connection: sessionConnection, steps, version, awareness = '' }) => {
+	return push(
+		sessionConnection.connection,
+		{ steps, version, awareness }
+	).then(response => response.data)
 })
 
-Cypress.Commands.add('failToPushSteps', ({ connection, steps, version, awareness = '' }) => {
-	return connection.push({ steps, version, awareness })
-		.then((response) => {
-			throw new Error('Expected request to fail - but it succeeded!')
-		}, (err) => err.response)
+Cypress.Commands.add('failToPushSteps', ({ connection: sessionConnection, steps, version, awareness = '' }) => {
+	return push(
+		sessionConnection.connection,
+		{ steps, version, awareness }
+	).then((_response) => {
+		throw new Error('Expected request to fail - but it succeeded!')
+	}, (err) => err.response)
 })
 
 Cypress.Commands.add('syncSteps', (connection, options = { version: 0 }) => {

src/EditorFactory.js

@@ -41,17 +41,9 @@ const createRichEditor = ({ extensions = [], connection, relativePath, isEmbedde
 	return new Editor({
 		editorProps,
 		extensions: [
-			RichText.configure({
-				relativePath,
-				isEmbedded,
-				component: this,
-				extensions: [
-					Mention.configure({
-						suggestion: MentionSuggestion({
-							connection,
-						}),
-					}),
-				],
+			RichText.configure({ relativePath, isEmbedded }),
+			Mention.configure({
+				suggestion: MentionSuggestion({ connection }),
 			}),
 			FocusTrap,
 			...extensions,

src/apis/Connect.ts

@@ -0,0 +1,58 @@
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import axios from '@nextcloud/axios'
+import { generateUrl } from '@nextcloud/router'
+import type { Connection } from '../composables/useConnection.js'
+
+export interface OpenParams {
+	fileId?: number
+	baseVersionEtag?: string
+	filePath: string
+	token?: string
+	guestName?: string
+}
+
+export interface OpenData {
+	document: { baseVersionEtag: string }
+}
+
+/**
+ * Open editing connection to the document
+ * @param params Parameters identifying the document
+ */
+export async function open(
+	params: OpenParams,
+): Promise<{ connection: Connection; data: OpenData }> {
+	const _baseUrl = params.token
+		? generateUrl('/apps/text/public')
+		: generateUrl('/apps/text')
+	const url = `${_baseUrl}/session/${params.fileId}/create`
+	const response = await axios.put(url, params)
+	const { document, session } = response.data
+	const connection = {
+		documentId: document.id,
+		sessionId: session.id,
+		sessionToken: session.token,
+		baseVersionEtag: document.baseVersionEtag,
+		filePath: params.filePath,
+		shareToken: params.token,
+	}
+	return { connection, data: response.data }
+}
+
+/**
+ * Close the connection
+ * @param connection connection to close
+ */
+export async function close(connection: Connection) {
+	const id = connection.documentId
+	const url = generateUrl(`/apps/text/session/${id}/close`)
+	const response = await axios.post(url, {
+		documentId: connection.documentId,
+		sessionId: connection.sessionId,
+		sessionToken: connection.sessionToken,
+	})
+	return response.data
+}

src/apis/Mention.ts

@@ -0,0 +1,67 @@
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import axios from '@nextcloud/axios'
+import { generateUrl } from '@nextcloud/router'
+import type { Connection } from '../composables/useConnection.js'
+import { unref, type ShallowRef } from 'vue'
+
+/**
+ * Let Nextcloud know someone was mentioned
+ * @param mention user id of the person that was mentioned
+ * @param scope scope the user was mentioned in
+ * @param options options
+ * @param options.connection connection to the text editing session
+ */
+export function emitMention(
+	mention: string,
+	scope: object,
+	{ connection }: { connection: ShallowRef<Connection> | Connection },
+): Promise<void> {
+	// TODO: Require actual connection - handle disconnected state early on
+	const con = unref(connection)
+	if (!con) {
+		const err = new Error('Disconnected. Could not notify user about mention.')
+		console.warn(err.message, { err, mention })
+		return Promise.resolve()
+	}
+	const url = generateUrl(`apps/text/session/${con.documentId}/mention`)
+	return axios.put(url, {
+		documentId: con.documentId,
+		sessionId: con.sessionId,
+		sessionToken: con.sessionToken,
+		mention,
+		scope,
+	})
+	// TODO: handle errors:
+	// * signal something is wrong with the connection
+	// * wait for reconnect and fetch again
+}
+
+const USERS_LIST_ENDPOINT_URL = generateUrl('apps/text/api/v1/users')
+
+/**
+ * Look up user names to mention
+ * @param filter string to look for in the user names
+ * @param options options
+ * @param options.connection connection to the text editing session
+ */
+export async function getUsers(
+	filter: string,
+	{ connection }: { connection: ShallowRef<Connection> },
+): Promise<Record<string, string>> {
+	// TODO: Require actual connection - handle disconnected state early on
+	const con = unref(connection)
+	if (!con) {
+		const err = new Error('Disconnected. Could not lookup users to mention.')
+		console.warn(err.message, { err })
+		return Promise.resolve({})
+	}
+	const response = await axios.post(USERS_LIST_ENDPOINT_URL, { ...con, filter })
+	// TODO: handle errors:
+	// * signal something is wrong with the connection
+	// * wait for reconnect and fetch again
+	return JSON.parse(JSON.stringify(response.data))
+}