Bump yjs-widgets and make changes wrt

Author: arjxn-py

python/jupytercad_lab/jupytercad_lab/notebook/cad_document.py

@@ -28,7 +28,6 @@
     ShapeMetadata,
     IAny,
 )
-from .utils import normalize_path
 
 logger = logging.getLogger(__file__)
 
@@ -72,7 +71,7 @@ def _path_to_comm(cls, filePath: Optional[str]) -> Dict:
         contentType = None
 
         if filePath is not None:
-            path = normalize_path(filePath)
+            path = filePath
             file_name = Path(path).name
             try:
                 ext = file_name.split(".")[1].lower()

python/jupytercad_lab/jupytercad_lab/notebook/utils.py

@@ -1,4 +1,3 @@
-import os
 from enum import Enum
 from urllib.parse import urljoin
 
@@ -15,10 +14,3 @@ def multi_urljoin(*parts) -> str:
         parts[0],
         "/".join(part for part in parts[1:]),
     )
-
-
-def normalize_path(path: str) -> str:
-    if os.path.isabs(path):
-        return path
-    else:
-        return os.path.abspath(os.path.join(os.getcwd(), path))

python/jupytercad_lab/package.json

@@ -68,7 +68,7 @@
     "@lumino/messaging": "^2.0.0",
     "@lumino/widgets": "^2.0.0",
     "react": "^18.0.1",
-    "yjs-widgets": "^0.3.7"
+    "yjs-widgets": "^0.4"
   },
   "devDependencies": {
     "@jupyterlab/builder": "^4.0.0",

python/jupytercad_lab/pyproject.toml

@@ -25,7 +25,7 @@ classifiers = [
 dependencies = [
   "pycrdt",
   "ypywidgets>=0.9.0,<0.10.0",
-  "yjs-widgets>=0.3.7,<0.4",
+  "yjs-widgets>=0.4,<0.5",
   "comm>=0.1.2,<0.2.0",
   "pydantic>=2,<3",
   "jupytercad_core>=3.0.0a0,<4",

python/jupytercad_lab/src/notebookrenderer.ts

@@ -15,18 +15,19 @@ import {
   JupyterCadModel
 } from '@jupytercad/schema';
 
+import { showErrorMessage } from '@jupyterlab/apputils';
 import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
 import { Contents } from '@jupyterlab/services';
 import { MessageLoop } from '@lumino/messaging';
 import { Panel, Widget } from '@lumino/widgets';
-import * as Y from 'yjs';
 import {
   IJupyterYWidget,
   IJupyterYWidgetManager,
-  JupyterYModel
+  JupyterYModel,
+  JupyterYDoc
 } from 'yjs-widgets';
 import { Toolbar } from '@jupyterlab/ui-components';
 import { ConsolePanel } from '@jupyterlab/console';
@@ -94,10 +95,6 @@ export class YJupyterCADLuminoWidget extends Panel {
   private _buildWidget = (options: IOptions) => {
     const { commands, workerRegistry, model, externalCommands, tracker } =
       options;
-    // Ensure the model filePath is relevant with the shared model path.
-    if (model.sharedModel.getState('path')) {
-      model.filePath = model.sharedModel.getState('path') as string;
-    }
     const content = new JupyterCadPanel({
       model: model,
       workerRegistry: workerRegistry as IJCadWorkerRegistry
@@ -153,17 +150,57 @@ export const notebookRenderePlugin: JupyterFrontEndPlugin<void> = {
       console.error('Missing IJupyterYWidgetManager token!');
       return;
     }
-    if (!drive) {
-      console.error('Missing ICollaborativeDrive token!');
-      return;
-    }
+
     class YJupyterCADModelFactory extends YJupyterCADModel {
-      ydocFactory(commMetadata: ICommMetadata): Y.Doc {
+      protected async initialize(commMetadata: {
+        [key: string]: any;
+      }): Promise<void> {
         const { path, format, contentType } = commMetadata;
         const fileFormat = format as Contents.FileFormat;
 
+        if (!drive) {
+          showErrorMessage(
+            'Error using the JupyterCAD Python API',
+            'You cannot use the JupyterCAD Python API without a collaborative drive. You need to install a package providing collaboration features (e.g. jupyter-collaboration).'
+          );
+          throw new Error(
+            'Failed to create the YDoc without a collaborative drive'
+          );
+        }
+
+        // The path of the project is relative to the path of the notebook
+        let currentWidgetPath = '';
+        const currentWidget = app.shell.currentWidget;
+        if (
+          currentWidget instanceof NotebookPanel ||
+          currentWidget instanceof ConsolePanel
+        ) {
+          currentWidgetPath = currentWidget.sessionContext.path;
+        }
+
+        let localPath = '';
+        if (path) {
+          localPath = PathExt.join(PathExt.dirname(currentWidgetPath), path);
+
+          // If the file does not exist yet, create it
+          try {
+            await app.serviceManager.contents.get(localPath);
+          } catch (e) {
+            await app.serviceManager.contents.save(localPath, {
+              content: btoa('{}'),
+              format: 'base64'
+            });
+          }
+        } else {
+          // If the user did not provide a path, do not create
+          localPath = PathExt.join(
+            PathExt.dirname(currentWidgetPath),
+            'unsaved_project'
+          );
+        }
+
         const sharedModel = drive!.sharedModelFactory.createNew({
-          path,
+          path: localPath,
           format: fileFormat,
           contentType,
           collaborative: true
@@ -174,28 +211,10 @@ export const notebookRenderePlugin: JupyterFrontEndPlugin<void> = {
         });
 
         this.jupyterCADModel.contentsManager = app.serviceManager.contents;
+        this.jupyterCADModel.filePath = localPath;
 
-        if (!sharedModel) {
-          // The path of the project is set to the path of the notebook, to be able to
-          // add local geoJSON/shape file in a "file-less" project.
-          let currentWidgetPath: string | undefined = undefined;
-          const currentWidget = app.shell.currentWidget;
-          if (
-            currentWidget instanceof NotebookPanel ||
-            currentWidget instanceof ConsolePanel
-          ) {
-            currentWidgetPath = currentWidget.sessionContext.path;
-          }
-
-          if (currentWidgetPath) {
-            this.jupyterCADModel.filePath = PathExt.join(
-              PathExt.dirname(currentWidgetPath),
-              'unsaved_project'
-            );
-          }
-        }
-
-        return this.jupyterCADModel.sharedModel.ydoc;
+        this.ydoc = this.jupyterCADModel.sharedModel.ydoc;
+        this.sharedModel = new JupyterYDoc(commMetadata, this.ydoc);
       }
     }
 

yarn.lock

@@ -937,7 +937,7 @@ __metadata:
     rimraf: ^3.0.2
     typescript: ^5
     yjs: ^13.5.0
-    yjs-widgets: ^0.3.7
+    yjs-widgets: ^0.4
   languageName: unknown
   linkType: soft
 
@@ -13048,6 +13048,28 @@ __metadata:
   languageName: node
   linkType: hard
 
+"yjs-widgets@npm:^0.4":
+  version: 0.4.0
+  resolution: "yjs-widgets@npm:0.4.0"
+  dependencies:
+    "@jupyter/ydoc": ^2.0.0 || ^3.0.0-a3
+    "@jupyterlab/application": ^4.0.0
+    "@jupyterlab/apputils": ^4.0.0
+    "@jupyterlab/console": ^4.2.4
+    "@jupyterlab/coreutils": ^6.0.0
+    "@jupyterlab/notebook": ^4.0.0
+    "@jupyterlab/services": ^7.0.0
+    "@lumino/coreutils": ^2.1.1
+    "@lumino/signaling": ^2.1.1
+    "@lumino/widgets": ^2.1.1
+    lib0: ^0.2.76
+    uuid: ^9.0.0
+    webpack: ^5.77.0
+    webpack-cli: ^5.0.1
+  checksum: 147fc7ae1c3d13fd591d434af33d439bc20d23494ded601dd8da5986426c6c896d7ff2a6296e24bda8d5ee17921c5c390c3b095f14fd5195506c0f891747e2fd
+  languageName: node
+  linkType: hard
+
 "yjs@npm:^13.5.0, yjs@npm:^13.5.40":
   version: 13.6.21
   resolution: "yjs@npm:13.6.21"