Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/components/CollaborativeEditor.vue
Original file line number Diff line number Diff line change
Expand Up @@ -650,6 +650,10 @@ export default defineComponent({
content,
isRichEditor: this.isRichEditor,
})
// The resulting push still needs to reach the server like any
// other step, but should not autosave a document nobody has
// edited yet.
this.saveService.skipNextAutosaveTrigger()
setInitialYjsState(this.ydoc, content, {
isRichEditor: this.isRichEditor,
})
Expand Down
4 changes: 2 additions & 2 deletions src/composables/useSaveService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ export function provideSaveService(
getSaveData,
})

syncService.bus.on('changesPushed', saveService.autosave)
syncService.bus.on('changesPushed', saveService.autosaveOnChangesPushed)
syncService.bus.on('close', saveService.clear)
onUnmounted(() => {
syncService.bus.off('changesPushed', saveService.autosave)
syncService.bus.off('changesPushed', saveService.autosaveOnChangesPushed)
syncService.bus.off('close', saveService.clear)
})

Expand Down
15 changes: 15 additions & 0 deletions src/services/SaveService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ class SaveService {
pendingAutosave = 0
getSaveData
autosave
autosaveOnChangesPushed
clear
#skipNextAutosaveTrigger = false

constructor({
connection,
Expand All @@ -54,9 +56,22 @@ class SaveService {
this.document = document
this.getSaveData = getSaveData
this.autosave = debounce(this._autosave.bind(this), AUTOSAVE_DEBOUNCE * 1000)
this.autosaveOnChangesPushed = this._autosaveOnChangesPushed.bind(this)
this.clear = this.clearAutosave.bind(this)
}

skipNextAutosaveTrigger() {
this.#skipNextAutosaveTrigger = true
}

_autosaveOnChangesPushed() {
if (this.#skipNextAutosaveTrigger) {
this.#skipNextAutosaveTrigger = false
return
}
this.autosave()
}

/**
* Save the current state
*
Expand Down
60 changes: 60 additions & 0 deletions src/tests/services/SaveService.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

import { describe, expect, it, vi } from 'vitest'
import { shallowRef } from 'vue'
import { SaveService } from '../../services/SaveService.ts'

function createSaveService() {
return new SaveService({
connection: shallowRef(undefined),
document: shallowRef(undefined),
getSaveData: vi.fn(),
})
}

describe('SaveService.autosaveOnChangesPushed', () => {
it('autosaves for a normal changesPushed trigger', () => {
const saveService = createSaveService()
const autosave = vi.spyOn(saveService, 'autosave')

saveService.autosaveOnChangesPushed()

expect(autosave).toHaveBeenCalledOnce()
})

it('does not autosave right after skipNextAutosaveTrigger', () => {
const saveService = createSaveService()
const autosave = vi.spyOn(saveService, 'autosave')

saveService.skipNextAutosaveTrigger()
saveService.autosaveOnChangesPushed()

expect(autosave).not.toHaveBeenCalled()
})

it('only skips once - the next trigger autosaves normally', () => {
const saveService = createSaveService()
const autosave = vi.spyOn(saveService, 'autosave')

saveService.skipNextAutosaveTrigger()
saveService.autosaveOnChangesPushed()
saveService.autosaveOnChangesPushed()

expect(autosave).toHaveBeenCalledOnce()
})

it('is unaffected by unrelated triggers before the skip is armed', () => {
const saveService = createSaveService()
const autosave = vi.spyOn(saveService, 'autosave')

saveService.autosaveOnChangesPushed()
saveService.skipNextAutosaveTrigger()
saveService.autosaveOnChangesPushed()
saveService.autosaveOnChangesPushed()

expect(autosave).toHaveBeenCalledTimes(2)
})
})
Loading