Add logger for file editor (#145)

* Add file editor tracker

* Upgrade to 4.0.0-rc.1

* Update to lab 4

* Lint

---------

Co-authored-by: Carlos Herrero <[email protected]>

Author: fcollonval

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
         uses: actions/setup-python@v4
       - name: Install dependencies
         run: |
-          pip install jupyterlab --pre
+          pip install jupyterlab
           pip install -e .
           jlpm
       - name: Run pre-commit
@@ -51,7 +51,7 @@ jobs:
         uses: actions/setup-python@v4
       - name: Install dependencies
         run: |
-          pip install --pre jupyterlab
+          pip install jupyterlab
           pip install -e .
           jlpm
       - name: Run Tests
@@ -79,7 +79,7 @@ jobs:
       - name: Install the Python dependencies
         run: |
           pip install -e ".[test]" codecov
-          python -m pip install --pre jupyterlab
+          python -m pip install jupyterlab
       - name: List installed packages
         run: |
           pip freeze
@@ -171,7 +171,7 @@ jobs:
           tar --strip-components=1 -zxvf *.tar.gz -C ./test
           cd test
           python -m pip install ".[test]"
-          python -m pip install --pre jupyterlab
+          python -m pip install jupyterlab
           echo "::endgroup::"
       - name: Run Test
         shell: bash

binder/environment.yml

@@ -4,7 +4,7 @@ channels:
   - conda-forge/label/jupyterlab_rc
   - nodefaults
 dependencies:
-  - jupyterlab >=4.0.0rc0
+  - jupyterlab >=4.0.0
   - jupyterlab-link-share >=0.2
   - nodejs >=18,<19
   - python >=3.11,<3.12

packages/collaboration-extension/package.json

@@ -55,27 +55,29 @@
   "dependencies": {
     "@jupyter/collaboration": "^1.0.0-alpha.8",
     "@jupyter/docprovider": "^1.0.0-alpha.8",
-    "@jupyterlab/application": "^4.0.0-rc.0",
-    "@jupyterlab/apputils": "^4.0.0-rc.0",
-    "@jupyterlab/codemirror": "^4.0.0-rc.0",
-    "@jupyterlab/coreutils": "^6.0.0-rc.0",
-    "@jupyterlab/filebrowser": "^4.0.0-rc.0",
-    "@jupyterlab/logconsole": "^4.0.0-rc.0",
-    "@jupyterlab/notebook": "^4.0.0-rc.0",
-    "@jupyterlab/services": "^7.0.0-rc.0",
-    "@jupyterlab/settingregistry": "^4.0.0-rc.0",
-    "@jupyterlab/statedb": "^4.0.0-rc.0",
-    "@jupyterlab/translation": "^4.0.0-rc.0",
-    "@jupyterlab/ui-components": "^4.0.0-rc.0",
+    "@jupyterlab/application": "^4.0.0",
+    "@jupyterlab/apputils": "^4.0.0",
+    "@jupyterlab/codemirror": "^4.0.0",
+    "@jupyterlab/coreutils": "^6.0.0",
+    "@jupyterlab/docregistry": "^4.0.0",
+    "@jupyterlab/filebrowser": "^4.0.0",
+    "@jupyterlab/fileeditor": "^4.0.0",
+    "@jupyterlab/logconsole": "^4.0.0",
+    "@jupyterlab/notebook": "^4.0.0",
+    "@jupyterlab/services": "^7.0.0",
+    "@jupyterlab/settingregistry": "^4.0.0",
+    "@jupyterlab/statedb": "^4.0.0",
+    "@jupyterlab/translation": "^4.0.0",
+    "@jupyterlab/ui-components": "^4.0.0",
     "@lumino/commands": "^2.1.0",
     "@lumino/widgets": "^2.1.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "^4.0.0-rc.0",
-    "@types/react": "^18.0.27",
+    "@jupyterlab/builder": "^4.0.0",
+    "@types/react": "~18.0.26",
     "npm-run-all": "^4.1.5",
     "rimraf": "^4.1.2",
     "typescript": "~5.0.4"

packages/collaboration-extension/src/filebrowser.ts

@@ -9,26 +9,24 @@ import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
+import { Dialog, showDialog } from '@jupyterlab/apputils';
+import { IDocumentWidget } from '@jupyterlab/docregistry';
 import {
   FileBrowser,
   IDefaultFileBrowser,
   IFileBrowserFactory
 } from '@jupyterlab/filebrowser';
-import { showDialog, Dialog } from '@jupyterlab/apputils';
-import { ITranslator, nullTranslator } from '@jupyterlab/translation';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { IEditorTracker } from '@jupyterlab/fileeditor';
 import { ILogger, ILoggerRegistry } from '@jupyterlab/logconsole';
 import { INotebookTracker } from '@jupyterlab/notebook';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 
 import { CommandRegistry } from '@lumino/commands';
 
 import { YFile, YNotebook } from '@jupyter/ydoc';
 
-import {
-  ICollaborativeDrive,
-  SharedDocumentFactory,
-  YDrive
-} from '@jupyter/docprovider';
+import { ICollaborativeDrive, YDrive } from '@jupyter/docprovider';
 
 /**
  * The command IDs used by the file browser plugin.
@@ -68,7 +66,7 @@ export const yfile: JupyterFrontEndPlugin<void> = {
   requires: [ICollaborativeDrive],
   optional: [],
   activate: (app: JupyterFrontEnd, drive: ICollaborativeDrive): void => {
-    const yFileFactory: SharedDocumentFactory = () => {
+    const yFileFactory = () => {
       return new YFile();
     };
     drive.sharedModelFactory.registerDocumentFactory('file', yFileFactory);
@@ -112,7 +110,7 @@ export const ynotebook: JupyterFrontEndPlugin<void> = {
         });
     }
 
-    const yNotebookFactory: SharedDocumentFactory = () => {
+    const yNotebookFactory = () => {
       return new YNotebook({
         disableDocumentWideUndoRedo
       });
@@ -175,11 +173,12 @@ export const logger: JupyterFrontEndPlugin<void> = {
   id: '@jupyter/collaboration-extension:logger',
   description: 'A logging plugin for debugging purposes.',
   autoStart: true,
-  optional: [ILoggerRegistry, INotebookTracker, ITranslator],
+  optional: [ILoggerRegistry, IEditorTracker, INotebookTracker, ITranslator],
   activate: (
     app: JupyterFrontEnd,
     loggerRegistry: ILoggerRegistry | null,
-    nbtracker: INotebookTracker | null,
+    fileTracker: IEditorTracker | null,
+    nbTracker: INotebookTracker | null,
     translator: ITranslator | null
   ): void => {
     const trans = (translator ?? nullTranslator).load('jupyter_collaboration');
@@ -213,15 +212,21 @@ export const logger: JupyterFrontEndPlugin<void> = {
 
     const loggers: Map<string, ILogger> = new Map();
 
-    if (nbtracker) {
-      nbtracker.widgetAdded.connect((sender, nb) => {
-        const logger = loggerRegistry.getLogger(nb.context.path);
-        loggers.set(nb.context.localPath, logger);
+    const addLogger = (sender: unknown, document: IDocumentWidget) => {
+      const logger = loggerRegistry.getLogger(document.context.path);
+      loggers.set(document.context.localPath, logger);
 
-        nb.disposed.connect(nb => {
-          loggers.delete(nb.context.localPath);
-        });
+      document.disposed.connect(document => {
+        loggers.delete(document.context.localPath);
       });
+    };
+
+    if (fileTracker) {
+      fileTracker.widgetAdded.connect(addLogger);
+    }
+
+    if (nbTracker) {
+      nbTracker.widgetAdded.connect(addLogger);
     }
 
     void (async () => {

packages/collaboration/package.json

@@ -41,10 +41,10 @@
   "dependencies": {
     "@codemirror/state": "^6.2.0",
     "@codemirror/view": "^6.7.0",
-    "@jupyterlab/apputils": "^4.0.0-rc.0",
-    "@jupyterlab/coreutils": "^6.0.0-rc.0",
-    "@jupyterlab/services": "^7.0.0-rc.0",
-    "@jupyterlab/ui-components": "^4.0.0-rc.0",
+    "@jupyterlab/apputils": "^4.0.0",
+    "@jupyterlab/coreutils": "^6.0.0",
+    "@jupyterlab/services": "^7.0.0",
+    "@jupyterlab/ui-components": "^4.0.0",
     "@lumino/coreutils": "^2.1.0",
     "@lumino/virtualdom": "^2.0.0",
     "@lumino/widgets": "^2.1.0",

packages/docprovider/package.json

@@ -42,8 +42,8 @@
   },
   "dependencies": {
     "@jupyter/ydoc": "^1.0.2",
-    "@jupyterlab/coreutils": "^6.0.0-rc.0",
-    "@jupyterlab/services": "^7.0.0-rc.0",
+    "@jupyterlab/coreutils": "^6.0.0",
+    "@jupyterlab/services": "^7.0.0",
     "@lumino/coreutils": "^2.1.0",
     "@lumino/disposable": "^2.1.0",
     "@lumino/signaling": "^2.1.0",
@@ -52,7 +52,7 @@
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.0.0-rc.0",
+    "@jupyterlab/testing": "^4.0.0",
     "@types/jest": "^29.2.0",
     "jest": "^29.5.0",
     "rimraf": "^4.1.2",

pyproject.toml

@@ -3,7 +3,7 @@
 
 [build-system]
 build-backend = "hatchling.build"
-requires = ["hatchling>=1.4.0", "hatch-nodejs-version", "jupyterlab>=4.0.0rc0"]
+requires = ["hatchling>=1.4.0", "hatch-nodejs-version", "jupyterlab>=4.0.0"]
 
 [project]
 name = "jupyter_collaboration"
@@ -48,7 +48,7 @@ test = [
     "pytest-cov",
 ]
 docs = [
-    "jupyterlab>=4.0.0rc0",
+    "jupyterlab>=4.0.0",
     "sphinx",
     "myst-parser",
     "pydata-sphinx-theme"
@@ -114,7 +114,7 @@ before-build-python = [
     "jlpm clean:lib"
 ]
 before-bump-version = [
-    "python -m pip install --pre -U jupyterlab",
+    "python -m pip install -U jupyterlab",
     "jlpm"
 ]
 

tests/__init__.py

@@ -1,3 +1,2 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
-

tests/test_ydoc.py

@@ -1,5 +1,6 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+
 def test_ydoc():
     pass