Wait for the document to be synced (#148)

* Wait for the document to be synced

* Automatic application of license header

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: fcollonval

docs/source/developer/contributing.rst

@@ -1,3 +1,6 @@
+.. Copyright (c) Jupyter Development Team.
+.. Distributed under the terms of the Modified BSD License.
+
 Developer documentation
 =======================
 

jupyter_collaboration/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
 from typing import Any, Dict, List
 
 from ._version import __version__  # noqa

jupyter_collaboration/loaders.py

@@ -1,3 +1,6 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
 from __future__ import annotations
 
 import asyncio

jupyter_collaboration/rooms.py

@@ -1,3 +1,6 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
 from __future__ import annotations
 
 import asyncio

jupyter_collaboration/utils.py

@@ -1,3 +1,6 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
 import pathlib
 from enum import Enum
 from typing import Tuple

packages/collaboration-extension/src/filebrowser.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
 import {
   ILabShell,
   IRouter,

packages/docprovider/src/requests.ts

@@ -12,10 +12,25 @@ import { ServerConnection, Contents } from '@jupyterlab/services';
  */
 const DOC_SESSION_URL = 'api/collaboration/session';
 
+/**
+ * Document session model
+ */
 export interface ISessionModel {
+  /**
+   * Document format; 'text', 'base64',...
+   */
   format: Contents.FileFormat;
+  /**
+   * Document type
+   */
   type: Contents.ContentType;
+  /**
+   * File unique identifier
+   */
   fileId: string;
+  /**
+   * Server session identifier
+   */
   sessionId: string;
 }
 

packages/docprovider/src/yprovider.ts

@@ -16,7 +16,7 @@ import { DocumentChange, YDocument } from '@jupyter/ydoc';
 import { Awareness } from 'y-protocols/awareness';
 import { WebsocketProvider as YWebsocketProvider } from 'y-websocket';
 
-import { ISessionModel, requestDocSession } from './requests';
+import { requestDocSession } from './requests';
 
 /**
  * An interface for a document provider.
@@ -60,7 +60,7 @@ export class WebSocketProvider implements IDocumentProvider {
       .catch(e => console.error(e));
     user.userChanged.connect(this._onUserChanged, this);
 
-    this._connect();
+    this._connect().catch(e => console.warn(e));
   }
 
   /**
@@ -86,31 +86,31 @@ export class WebSocketProvider implements IDocumentProvider {
     }
     this._isDisposed = true;
     this._yWebsocketProvider?.off('connection-close', this._onConnectionClosed);
+    this._yWebsocketProvider?.off('sync', this._onSync);
     this._yWebsocketProvider?.destroy();
     Signal.clearData(this);
   }
 
-  private _connect(): void {
-    requestDocSession(this._format, this._contentType, this._path)
-      .then((session: ISessionModel) => {
-        this._yWebsocketProvider = new YWebsocketProvider(
-          this._serverUrl,
-          `${session.format}:${session.type}:${session.fileId}`,
-          this._sharedModel.ydoc,
-          {
-            disableBc: true,
-            params: { sessionId: session.sessionId },
-            awareness: this._awareness
-          }
-        );
-
-        this._yWebsocketProvider.on(
-          'connection-close',
-          this._onConnectionClosed
-        );
-      })
-      .then(r => this._ready.resolve())
-      .catch(e => console.warn(e));
+  private async _connect(): Promise<void> {
+    const session = await requestDocSession(
+      this._format,
+      this._contentType,
+      this._path
+    );
+
+    this._yWebsocketProvider = new YWebsocketProvider(
+      this._serverUrl,
+      `${session.format}:${session.type}:${session.fileId}`,
+      this._sharedModel.ydoc,
+      {
+        disableBc: true,
+        params: { sessionId: session.sessionId },
+        awareness: this._awareness
+      }
+    );
+
+    this._yWebsocketProvider.on('sync', this._onSync);
+    this._yWebsocketProvider.on('connection-close', this._onConnectionClosed);
   }
 
   private _onUserChanged(user: User.IManager): void {
@@ -141,6 +141,14 @@ export class WebSocketProvider implements IDocumentProvider {
     }
   };
 
+  private _onSync = (isSynced: boolean) => {
+    console.log(`_onSync ${isSynced}`);
+    if (isSynced) {
+      this._ready.resolve();
+      this._yWebsocketProvider?.off('sync', this._onSync);
+    }
+  };
+
   private _awareness: Awareness;
   private _contentType: string;
   private _format: string;

pyproject.toml

@@ -1,3 +1,6 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
 [build-system]
 build-backend = "hatchling.build"
 requires = ["hatchling>=1.4.0", "hatch-nodejs-version", "jupyterlab>=4.0.0rc0"]

setup.py

@@ -1,2 +1,5 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
 # setup.py shim for use with applications that require it.
 __import__("setuptools").setup()