Respect autosave setting in RTC backend

packages/docprovider-extension/src/filebrowser.ts

@@ -55,12 +55,13 @@ export const rtcContentProvider: JupyterFrontEndPlugin<ICollaborativeContentProv
     description: 'The RTC content provider',
     provides: ICollaborativeContentProvider,
     requires: [ITranslator],
-    optional: [IGlobalAwareness],
-    activate: (
+    optional: [IGlobalAwareness, ISettingRegistry],
+    activate: async (
       app: JupyterFrontEnd,
       translator: ITranslator,
-      globalAwareness: Awareness | null
-    ): ICollaborativeContentProvider => {
+      globalAwareness: Awareness | null,
+      settingRegistry: ISettingRegistry | null
+    ): Promise<ICollaborativeContentProvider> => {
       const trans = translator.load('jupyter_collaboration');
       const defaultDrive = (app.serviceManager.contents as ContentsManager)
         .defaultDrive;
@@ -75,12 +76,21 @@ export const rtcContentProvider: JupyterFrontEndPlugin<ICollaborativeContentProv
           'Cannot initialize content provider: no content provider registry.'
         );
       }
+      const docmanagerSettings = settingRegistry
+        ? await settingRegistry.load('@jupyterlab/docmanager-extension:plugin')
+        : null;
+
+      // Force autosave to be true by default initially
+      if (docmanagerSettings) {
+        void docmanagerSettings.set('autosave', true);
+      }
       const rtcContentProvider = new RtcContentProvider({
         apiEndpoint: '/api/contents',
         serverSettings: defaultDrive.serverSettings,
         user: app.serviceManager.user,
         trans,
-        globalAwareness
+        globalAwareness,
+        docmanagerSettings
       });
       registry.register('rtc', rtcContentProvider);
       return rtcContentProvider;

packages/docprovider/src/ydrive.ts

@@ -21,6 +21,7 @@ import {
   ISharedModelFactory
 } from '@jupyter/collaborative-drive';
 import { Awareness } from 'y-protocols/awareness';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 const DISABLE_RTC =
   PageConfig.getOption('disableRTC') === 'true' ? true : false;
@@ -42,6 +43,7 @@ namespace RtcContentProvider {
     user: User.IManager;
     trans: TranslationBundle;
     globalAwareness: Awareness | null;
+    docmanagerSettings: ISettingRegistry.ISettings | null;
   }
 }
 
@@ -57,6 +59,7 @@ export class RtcContentProvider
     this._serverSettings = options.serverSettings;
     this.sharedModelFactory = new SharedModelFactory(this._onCreate);
     this._providers = new Map<string, WebSocketProvider>();
+    this._docmanagerSettings = options.docmanagerSettings;
   }
 
   /**
@@ -123,7 +126,7 @@ export class RtcContentProvider
       const provider = this._providers.get(key);
 
       if (provider) {
-        // Save is done from the backend
+        provider.wsProvider?.ws?.send('save_to_disc');
         const fetchOptions: Contents.IFetchOptions = {
           type: options.type,
           format: options.format,
@@ -150,6 +153,19 @@ export class RtcContentProvider
     if (typeof options.format !== 'string') {
       return;
     }
+    // Set initial autosave value, used to determine backend autosave (default: true)
+    const autosave =
+      (this._docmanagerSettings?.composite?.['autosave'] as boolean) ?? true;
+
+    sharedModel.awareness.setLocalStateField('autosave', autosave);
+
+    // Watch for changes in settings
+    this._docmanagerSettings?.changed.connect(() => {
+      const newAutosave =
+        (this._docmanagerSettings?.composite?.['autosave'] as boolean) ?? true;
+      sharedModel.awareness.setLocalStateField('autosave', newAutosave);
+    });
+
     try {
       const provider = new WebSocketProvider({
         url: URLExt.join(this._serverSettings.wsUrl, DOCUMENT_PROVIDER_URL),
@@ -235,6 +251,7 @@ export class RtcContentProvider
   private _providers: Map<string, WebSocketProvider>;
   private _ydriveFileChanged = new Signal<this, Contents.IChangedArgs>(this);
   private _serverSettings: ServerConnection.ISettings;
+  private _docmanagerSettings: ISettingRegistry.ISettings | null;
 }
 
 /**

projects/jupyter-server-ydoc/jupyter_server_ydoc/handlers.py

@@ -290,8 +290,15 @@ async def on_message(self, message):
         """
         On message receive.
         """
-        message_type = message[0]
+        if message == "save_to_disc":
+            try:
+                self.room._saving_document = asyncio.create_task(
+                    self.room._maybe_save_document(self.room._saving_document)
+                )
+            except Exception:
+                self.log.error("Couldn't save content from room: %s", self._room_id)
 
+        message_type = message[0]
         if message_type == MessageType.CHAT:
             msg = message[2:].decode("utf-8")
 
@@ -321,7 +328,7 @@ def on_close(self) -> None:
         """
         # stop serving this client
         self._message_queue.put_nowait(b"")
-        if isinstance(self.room, DocumentRoom) and self.room.clients == [self]:
+        if isinstance(self.room, DocumentRoom) and self.room.clients == {self}:
             # no client in this room after we disconnect
             # keep the document for a while in case someone reconnects
             self.log.info("Cleaning room: %s", self._room_id)

projects/jupyter-server-ydoc/jupyter_server_ydoc/rooms.py

@@ -247,6 +247,18 @@ def _on_document_change(self, target: str, event: Any) -> None:
             document. This tasks are debounced (60 seconds by default) so we
             need to cancel previous tasks before creating a new one.
         """
+        # Collect autosave values from all clients
+        autosave_states = [
+            state.get("autosave", True)
+            for state in self.awareness.states.values()
+            if state  # skip empty states
+        ]
+
+        # Enable autosave if at least one client has it turned on
+        autosave = any(autosave_states)
+
+        if not autosave:
+            return
         if self._update_lock.locked():
             return
 
@@ -265,7 +277,6 @@ async def _maybe_save_document(self, saving_document: asyncio.Task | None) -> No
         """
         if self._save_delay is None:
             return
-
         if saving_document is not None and not saving_document.done():
             # the document is being saved, cancel that
             saving_document.cancel()