Merge pull request #7062 from nextcloud/backport/6798/stable31

[stable31] feat(session): Send save request via `sendBeacon` at `beforeunload`

Author: mejo-

src/components/Editor.vue

@@ -344,6 +344,13 @@ export default {
 				this.updateEditorWidth(newWidth)
 			},
 		},
+		dirty(val) {
+			if (val) {
+				window.addEventListener('beforeunload', this.saveBeforeUnload)
+			} else {
+				window.removeEventListener('beforeunload', this.saveBeforeUnload)
+			}
+		},
 	},
 	mounted() {
 		if (this.active && (this.hasDocumentParameters)) {
@@ -669,7 +676,7 @@ export default {
 				this.emit('ready')
 			}
 			if (Object.prototype.hasOwnProperty.call(state, 'dirty')) {
-				// ignore initial loading and other automated changes
+				// ignore initial loading and other automated changes before first user change
 				if (this.$editor
 					&& (this.$editor.can().undo() || this.$editor.can().redo())
 				) {
@@ -884,6 +891,10 @@ export default {
 		updateEditorWidth(newWidth) {
 			document.documentElement.style.setProperty('--text-editor-max-width', newWidth)
 		},
+
+		saveBeforeUnload() {
+			this.$syncService?.saveViaSendBeacon()
+		},
 	},
 }
 </script>

src/components/Editor/Status.vue

@@ -89,22 +89,19 @@ export default {
 			return this.dirtyStateIndicator ? t('text', 'Saving …') : t('text', 'Saved')
 		},
 		dirtyStateIndicator() {
-			return this.dirty || this.hasUnsavedChanges
+			return this.dirty
 		},
 		lastSavedStatusTooltip() {
 			let message = t('text', 'Last saved {lastSave}', { lastSave: this.lastSavedString })
 			if (this.hasSyncCollission) {
 				message = t('text', 'The document has been changed outside of the editor. The changes cannot be applied.')
 			}
-			if (this.dirty || this.hasUnsavedChanges) {
+			if (this.dirty) {
 				message += ' - ' + t('text', 'Unsaved changes')
 			}
 			return message
 		},
 
-		hasUnsavedChanges() {
-			return this.document && this.document.lastSavedVersion < this.document.currentVersion
-		},
 		hasSyncCollission() {
 			return this.syncError && this.syncError.type === ERROR_TYPE.SAVE_COLLISSION
 		},

src/services/SessionApi.js

@@ -3,6 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 import axios from '@nextcloud/axios'
+import { getRequestToken } from '@nextcloud/auth'
 import { generateUrl } from '@nextcloud/router'
 
 export class ConnectionClosedError extends Error {
@@ -106,17 +107,30 @@ export class Connection {
 		})
 	}
 
-	save({ version, autosaveContent, documentState, force, manualSave }) {
-		return this.#post(this.#url(`session/${this.#document.id}/save`), {
+	save(data) {
+		const url = this.#url(`session/${this.#document.id}/save`)
+		const postData = {
 			...this.#defaultParams,
 			filePath: this.#options.filePath,
 			baseVersionEtag: this.#document.baseVersionEtag,
-			version,
-			autosaveContent,
-			documentState,
-			force,
-			manualSave,
-		})
+			...data,
+		}
+
+		return this.#post(url, postData)
+	}
+
+	saveViaSendBeacon(data) {
+		const url = this.#url(`session/${this.#document.id}/save`)
+		const postData = {
+			...this.#defaultParams,
+			filePath: this.#options.filePath,
+			baseVersionEtag: this.#document.baseVersionEtag,
+			...data,
+			requestToken: getRequestToken() ?? '',
+		}
+
+		const blob = new Blob([JSON.stringify(postData)], { type: 'application/json' })
+		return navigator.sendBeacon(url, blob)
 	}
 
 	push({ steps, version, awareness }) {

src/services/SyncService.js

@@ -218,6 +218,7 @@ class SyncService {
 						this.emit('error', { type: ERROR_TYPE.PUSH_FORBIDDEN, data: {} })
 					}
 					// TODO: does response.data ever have a document? maybe for errors?
+					// TODO: `currentVersion` is always 0 nowadays. Check if this is still needed.
 					// Only emit conflict event if we have synced until the latest version
 					if (response.data.document?.currentVersion === this.version) {
 						this.emit('error', { type: ERROR_TYPE.PUSH_FAILURE, data: {} })
@@ -299,6 +300,17 @@ class SyncService {
 		}
 	}
 
+	saveViaSendBeacon() {
+		this.#connection.saveViaSendBeacon({
+			version: this.version,
+			autosaveContent: this._getContent(),
+			documentState: this.getDocumentState(),
+			force: false,
+			manualSave: true,
+		})
+		logger.debug('[SyncService] saved using sendBeacon')
+	}
+
 	forceSave() {
 		return this.save({ force: true })
 	}