feat: Use notify push for sync messages during editing

[juliusknorr]

Signed-off-by: Julius Härtl [email protected]

📝 Summary

• Resolves: Using notify_push for syncing #1805

This is a first PoC to make use of notify_push for syncing steps back to other editors instead of regular polling. We still poll every 30 seconds as a fallback and to ensure that the autosave requests are still triggered until #4424 is there (even with that some fallback sync might still be worth).

Can be manually enabled for now with

occ config:app:set text notify_push --type boolean --value=1

🚧 TODO

• More manual testing in different scenarios
  • Check what happens with the base doc changing externally (did we use the sync to detect the conflict?)

🏁 Checklist

• Code is properly formatted (npm run lint / npm run stylelint / composer run cs:check)
• Sign-off message is added to all commits
• Tests (unit, integration and/or end-to-end) passing and the changes are covered with tests
• Documentation (README or documentation) has been updated or is not required

[cypress]

1 flaky tests on run #11336 ↗︎

0

149

2

0

1

Details:

feat: Use notify push for sync messages during editing
Project: Text	Commit: 90c956236b
Status: Passed	Duration: 04:17 💡
Started: Jul 27, 2023 6:27 PM	Ended: Jul 27, 2023 6:32 PM

  cypress/e2e/nodes/Links.spec.js • 1 flaky test

View Output Video

Test		Artifacts
... > Link website with selection		Output Screenshots

_{This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.}

[max-nextcloud]

Thanks a lot for looking into this. I'm really curious to play with it. 😍

We still poll every 30 seconds as a fallback and to ensure that the autosave requests are still triggered until #4424 is there (even with that some fallback sync might still be worth).

Just one remark. Autosave is independent from the polling backend these days. It's triggered by

text/src/services/SyncService.js

Line 91 in 14d29b1

this.autosave = debounce(this._autosave.bind(this), AUTOSAVE_INTERVAL)

Never the less I agree that having a fallback for a start might still be worthwhile.

[juliusknorr]

This is good from my side. I did quite some testing locally with different scenarios of browsers going offline, coming back, overwriting the file externally and it seems to be quite smooth.

Nevertheless I added a feature flag to opt-in for now, so we can maybe testrun this a bit more on a daily instance.

[elzody]

I did some more reading on the notify_push app and how it's used, and with my basic understanding of the app and websockets, it looks okay to me. I will approve in case it counts here :)

[juliusknorr]

• Need to do an extra check for public share links (as I haven't yet)