Creates document session (#108)

* Creates document session * Uses translator * Update jupyter_collaboration/handlers.py * Create a new endpoint for document sessions, changes tranlator property and deprecates old endpoints --------- Co-authored-by: David Brochart <[email protected]>
jupyterlab · Mar 1, 2023 · 9d57e8b · 9d57e8b
1 parent d8481ce
commit 9d57e8b
Show file tree

Hide file tree

Showing 6 changed files with 179 additions and 49 deletions.
diff --git a/jupyter_collaboration/app.py b/jupyter_collaboration/app.py
@@ -5,7 +5,12 @@
 from traitlets import Float, Int, Type
 from ypy_websocket.ystore import BaseYStore
 
-from .handlers import SQLiteYStore, YDocRoomIdHandler, YDocWebSocketHandler
+from .handlers import (
+    DocSessionHandler,
+    SQLiteYStore,
+    YDocRoomIdHandler,
+    YDocWebSocketHandler,
+)
 
 
 class YDocExtension(ExtensionApp):
@@ -57,7 +62,11 @@ def initialize_settings(self):
     def initialize_handlers(self):
         self.handlers.extend(
             [
+                # Deprecated - to remove for 1.0.0
                 (r"/api/yjs/roomid/(.*)", YDocRoomIdHandler),
+                # Deprecated - to remove for 1.0.0
                 (r"/api/yjs/(.*)", YDocWebSocketHandler),
+                (r"/api/collaboration/room/(.*)", YDocWebSocketHandler),
+                (r"/api/collaboration/session/(.*)", DocSessionHandler),
             ]
         )
diff --git a/jupyter_collaboration/handlers.py b/jupyter_collaboration/handlers.py
@@ -3,6 +3,7 @@
 
 import asyncio
 import json
+import uuid
 from logging import Logger
 from pathlib import Path
 from typing import Any, Dict, Optional, Set, Tuple
@@ -24,6 +25,8 @@
 
 YFILE = YDOCS["file"]
 
+SERVER_SESSION = str(uuid.uuid4())
+
 
 class TempFileYStore(_TempFileYStore):
     prefix_dir = "jupyter_ystore_"
@@ -201,6 +204,11 @@ async def open(self, path):
         self.websocket_server.background_tasks.add(task)
         task.add_done_callback(self.websocket_server.background_tasks.discard)
 
+        # Close the connection if the document session expired
+        session_id = self.get_query_argument("sessionId", "")
+        if isinstance(self.room, DocumentRoom) and SERVER_SESSION != session_id:
+            self.close(1003, f"Document session {session_id} expired")
+
         # cancel the deletion of the room if it was scheduled
         if isinstance(self.room, DocumentRoom) and self.room.cleaner is not None:
             self.room.cleaner.cancel()
@@ -227,6 +235,7 @@ async def open(self, path):
                     # if YStore updates and source file are out-of-sync, resync updates with source
                     if self.room.document.source != model["content"]:
                         read_from_source = True
+
                 if read_from_source:
                     self.room.document.source = model["content"]
                     if self.room.ystore:
@@ -409,3 +418,39 @@ async def put(self, path):
         ws_url += str(idx)
         self.log.info("Request for Y document '%s' with room ID: %s", path, ws_url)
         return self.finish(ws_url)
+
+
+class DocSessionHandler(APIHandler):
+    auth_resource = "contents"
+
+    @web.authenticated
+    @authorized
+    async def put(self, path):
+        body = json.loads(self.request.body)
+        format = body["format"]
+        content_type = body["type"]
+        file_id_manager = self.settings["file_id_manager"]
+
+        idx = file_id_manager.get_id(path)
+        if idx is not None:
+            # index already exists
+            self.log.info("Request for Y document '%s' with room ID: %s", path, idx)
+            data = json.dumps(
+                {"format": format, "type": content_type, "fileId": idx, "sessionId": SERVER_SESSION}
+            )
+            self.set_status(200)
+            return self.finish(data)
+
+        # try indexing
+        idx = file_id_manager.index(path)
+        if idx is None:
+            # file does not exists
+            raise web.HTTPError(404, f"File {path!r} does not exist")
+
+        # index successfully created
+        self.log.info("Request for Y document '%s' with room ID: %s", path, idx)
+        data = json.dumps(
+            {"format": format, "type": content_type, "fileId": idx, "sessionId": SERVER_SESSION}
+        )
+        self.set_status(201)
+        return self.finish(data)
diff --git a/packages/collaboration-extension/src/filebrowser.ts b/packages/collaboration-extension/src/filebrowser.ts
@@ -9,6 +9,7 @@ import {
   IDefaultFileBrowser,
   IFileBrowserFactory
 } from '@jupyterlab/filebrowser';
+import { ITranslator } from '@jupyterlab/translation';
 
 import { CommandRegistry } from '@lumino/commands';
 
@@ -27,11 +28,12 @@ namespace CommandIDs {
 export const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser> = {
   id: '@jupyter/collaboration-extension:defaultFileBrowser',
   provides: IDefaultFileBrowser,
-  requires: [IFileBrowserFactory],
+  requires: [IFileBrowserFactory, ITranslator],
   optional: [IRouter, JupyterFrontEnd.ITreeResolver, ILabShell],
   activate: async (
     app: JupyterFrontEnd,
     fileBrowserFactory: IFileBrowserFactory,
+    translator: ITranslator,
     router: IRouter | null,
     tree: JupyterFrontEnd.ITreeResolver | null,
     labShell: ILabShell | null
@@ -41,7 +43,8 @@ export const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser> = {
     );
     const { commands } = app;
 
-    const drive = new YDrive(app.serviceManager.user);
+    const trans = translator.load('jupyter_collaboration');
+    const drive = new YDrive(app.serviceManager.user, trans);
     app.serviceManager.contents.addDrive(drive);
 
     // Manually restore and load the default file browser.

diff --git a/packages/docprovider/src/requests.ts b/packages/docprovider/src/requests.ts
@@ -0,0 +1,47 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+import { URLExt } from '@jupyterlab/coreutils';
+import { ServerConnection, Contents } from '@jupyterlab/services';
+
+/**
+ * Document session endpoint provided by `jupyter_collaboration`
+ * See https://github.com/jupyterlab/jupyter_collaboration
+ */
+const DOC_SESSION_URL = 'api/collaboration/session';
+
+export interface ISessionModel {
+  format: Contents.FileFormat;
+  type: Contents.ContentType;
+  fileId: string;
+  sessionId: string;
+}
+
+export async function requestDocSession(
+  format: string,
+  type: string,
+  path: string
+): Promise<ISessionModel> {
+  const { makeSettings, makeRequest, ResponseError } = ServerConnection;
+
+  const settings = makeSettings();
+  const url = URLExt.join(
+    settings.baseUrl,
+    DOC_SESSION_URL,
+    encodeURIComponent(path)
+  );
+  const data = {
+    method: 'PUT',
+    body: JSON.stringify({ format, type })
+  };
+
+  const response = await makeRequest(url, data, settings);
+
+  if (response.status !== 200 && response.status !== 201) {
+    throw new ResponseError(response);
+  }
+
+  return response.json();
+}
diff --git a/packages/docprovider/src/ydrive.ts b/packages/docprovider/src/ydrive.ts
@@ -9,13 +9,14 @@ import {
   YNotebook
 } from '@jupyter/ydoc';
 import { URLExt } from '@jupyterlab/coreutils';
+import { TranslationBundle } from '@jupyterlab/translation';
 import { Contents, Drive, User } from '@jupyterlab/services';
 import { WebSocketProvider } from './yprovider';
 
 /**
  * The url for the default drive service.
  */
-const Y_DOCUMENT_PROVIDER_URL = 'api/yjs';
+const DOCUMENT_PROVIDER_URL = 'api/collaboration/room';
 
 /**
  * A Collaborative implementation for an `IDrive`, talking to the
@@ -27,9 +28,10 @@ export class YDrive extends Drive {
    *
    * @param user - The user manager to add the identity to the awareness of documents.
    */
-  constructor(user: User.IManager) {
+  constructor(user: User.IManager, translator: TranslationBundle) {
     super({ name: 'YDrive' });
     this._user = user;
+    this._trans = translator;
     this._providers = new Map<string, WebSocketProvider>();
 
     this.sharedModelFactory = new SharedModelFactory(this._onCreate);
@@ -85,7 +87,7 @@ export class YDrive extends Drive {
     options?: Contents.IFetchOptions
   ): Promise<Contents.IModel> {
     if (options && options.format && options.type) {
-      const key = `${options.type}:${options.format}:${localPath}`;
+      const key = `${options.format}:${options.type}:${localPath}`;
       const provider = this._providers.get(key);
 
       if (provider) {
@@ -150,15 +152,16 @@ export class YDrive extends Drive {
     }
     try {
       const provider = new WebSocketProvider({
-        url: URLExt.join(this.serverSettings.wsUrl, Y_DOCUMENT_PROVIDER_URL),
+        url: URLExt.join(this.serverSettings.wsUrl, DOCUMENT_PROVIDER_URL),
         path: options.path,
         format: options.format,
         contentType: options.contentType,
         model: sharedModel,
-        user: this._user
+        user: this._user,
+        translator: this._trans
       });
 
-      const key = `${options.contentType}:${options.format}:${options.path}`;
+      const key = `${options.format}:${options.contentType}:${options.path}`;
       this._providers.set(key, provider);
 
       sharedModel.disposed.connect(() => {
@@ -178,6 +181,7 @@ export class YDrive extends Drive {
   };
 
   private _user: User.IManager;
+  private _trans: TranslationBundle;
   private _providers: Map<string, WebSocketProvider>;
 }