Bump dependencies and yarn (#151)

* Bump dep

* Clean jest config

* Switch to yarn 3

* Update yarn.lock for yarn 3

* Fix linter and doc warnings

* Exclude .yarn files from trailing pre-commit hook

* Fix testing

* More test setup fixes

* Update python on CI

* Revert "More test setup fixes"

We need to transpile as we don't use ts-jest

* Test increasing the timeout

* Wrong guess about timeout usage

* Use more reasonable timeout

Author: fcollonval

.github/workflows/test.yml

@@ -46,19 +46,18 @@ jobs:
         with:
           miniforge-variant: Mambaforge
           miniforge-version: latest
-          python-version: "3.7"
+          python-version: "3.11"
 
       - name: Install dependencies
         run: |
-          mamba install python=${{ matrix.python-version }} pip nodejs=16 yarn
-          pip install .[test]
+          mamba install pip nodejs=18
+          pip install ".[test]"
 
       - name: Build JavaScript assets
         working-directory: javascript
         run: |
           yarn
           yarn build
-          cd ../tests; npm install
 
       - name: Linter check
         if: ${{ !contains(matrix.os, 'windows') }}
@@ -78,12 +77,12 @@ jobs:
             exit 1
           fi
 
-      - name: Run Python tests
-        run: |
-          pytest -v
-
       - name: Run JS tests
         working-directory: javascript
         run: |
           yarn build:test
           yarn test:cov
+
+      - name: Run Python tests
+        run: |
+          python -m pytest -v

.gitignore

@@ -136,3 +136,12 @@ javascript/tsconfig.tsbuildinfo
 javascript/.eslintcache
 javascript/coverage/
 jupyter_ydoc/_version.py
+
+# Yarn
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.pre-commit-config.yaml

@@ -14,6 +14,7 @@ repos:
       - id: forbid-new-submodules
       - id: check-builtin-literals
       - id: trailing-whitespace
+        exclude: ^\.yarn
 
   - repo: https://github.com/psf/black
     rev: 23.1.0

.yarn/releases/yarn-3.4.1.cjs

@@ -0,0 +1,2 @@
+yarnPath: .yarn/releases/yarn-3.4.1.cjs
+nodeLinker: node-modules 

.yarnrc.yml

@@ -3,10 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 
-const esModules = ['lib0', 'y-protocols', 'y-websocket', 'yjs'].join('|');
-
 module.exports = {
   testEnvironment: 'node',
   testRegex: 'lib/test/.*.spec.js[x]?$',
-
 };

javascript/jest.config.cjs

@@ -40,10 +40,10 @@
         "watch": "tsc -b --watch"
     },
     "dependencies": {
-        "@jupyterlab/nbformat": "^3.0.0 || ^4.0.0-alpha.15",
-        "@lumino/coreutils": "^1.11.0 || ^2.0.0-alpha.6",
-        "@lumino/disposable": "^1.10.0 || ^2.0.0-alpha.6",
-        "@lumino/signaling": "^1.10.0 || ^2.0.0-alpha.6",
+        "@jupyterlab/nbformat": "^3.0.0 || ^4.0.0-alpha.21 || ^4.0.0",
+        "@lumino/coreutils": "^1.11.0 || ^2.0.0",
+        "@lumino/disposable": "^1.10.0 || ^2.0.0",
+        "@lumino/signaling": "^1.10.0 || ^2.0.0",
         "y-protocols": "^1.0.5",
         "yjs": "^13.5.40"
     },
@@ -56,12 +56,11 @@
         "eslint-plugin-jest": "^27.0.0",
         "eslint-plugin-prettier": "^4.0.0",
         "jest": "^29.0.0",
-        "prettier": "^2.6.0",
-        "process": "0.11.10",
-        "rimraf": "^3.0.0",
+        "prettier": "^2.8.4",
+        "rimraf": "^4.4.0",
+        "tsc-esm-fix": "^2.20.0",
         "typedoc": "^0.23.21",
-        "typescript": "^4.8.0",
-        "tsc-esm-fix": "^2.20.0"
+        "typescript": "^4.9.5"
     },
     "publishConfig": {
         "access": "public"

javascript/package.json

@@ -152,7 +152,7 @@ export class YBaseCell<Metadata extends nbformat.IBaseCellMetadata>
    *
    * @param ymodel Cell map
    * @param ysource Cell source
-   * @param options { notebook?: The notebook the cell is attached to }
+   * @param options \{ notebook?: The notebook the cell is attached to \}
    * @param ymetadata Cell metadata
    */
   constructor(
@@ -705,7 +705,8 @@ export class YCodeCell
    * @param ymodel Cell map
    * @param ysource Cell source
    * @param youtputs Code cell outputs
-   * @param options { notebook?: The notebook the cell is attached to }
+   * @param options \{ notebook?: The notebook the cell is attached to \}
+   * @param ymetadata Cell metadata
    */
   constructor(
     ymodel: Y.Map<any>,

javascript/src/ycell.ts

@@ -202,7 +202,13 @@ export class YDocument<T extends DocumentChange> implements ISharedDocument {
   private _disposed = new Signal<this, void>(this);
 }
 
-namespace YDocument {
+/**
+ * YDocument namespace
+ */
+export namespace YDocument {
+  /**
+   * YDocument constructor options
+   */
   export interface IOptions {
     /**
      * The optional YJS document for YDocument.

javascript/src/ydocument.ts

@@ -485,22 +485,24 @@ export class YNotebook
             });
             break;
           case 'update':
-            const newValue = ymetadata.get(key);
-            const oldValue = change.oldValue;
-            let equal = true;
-            if (typeof oldValue == 'object' && typeof newValue == 'object') {
-              equal = JSONExt.deepEqual(oldValue, newValue);
-            } else {
-              equal = oldValue === newValue;
-            }
-
-            if (!equal) {
-              this._metadataChanged.emit({
-                key,
-                type: 'change',
-                oldValue,
-                newValue
-              });
+            {
+              const newValue = ymetadata.get(key);
+              const oldValue = change.oldValue;
+              let equal = true;
+              if (typeof oldValue == 'object' && typeof newValue == 'object') {
+                equal = JSONExt.deepEqual(oldValue, newValue);
+              } else {
+                equal = oldValue === newValue;
+              }
+
+              if (!equal) {
+                this._metadataChanged.emit({
+                  key,
+                  type: 'change',
+                  oldValue,
+                  newValue
+                });
+              }
             }
             break;
         }

javascript/src/ynotebook.ts

@@ -5,6 +5,14 @@
 import { IMapChange, YCodeCell, YNotebook } from '../src';
 
 describe('@jupyter/ydoc', () => {
+  // Fix awareness timeout open handle
+  beforeEach(() => {
+    jest.useFakeTimers();
+  });
+  afterEach(() => {
+    jest.clearAllTimers();
+  });
+
   describe('YCell standalone', () => {
     test('should set source', () => {
       const codeCell = YCodeCell.create();

javascript/test/ycell.spec.ts

@@ -5,6 +5,14 @@ import type * as nbformat from '@jupyterlab/nbformat';
 import { IMapChange, NotebookChange, YNotebook } from '../src';
 
 describe('@jupyter/ydoc', () => {
+  // Fix awareness timeout open handle
+  beforeEach(() => {
+    jest.useFakeTimers();
+  });
+  afterEach(() => {
+    jest.clearAllTimers();
+  });
+
   describe('YNotebook', () => {
     describe('#constructor', () => {
       test('should create a notebook without arguments', () => {

javascript/test/ynotebook.spec.ts

@@ -8,10 +8,8 @@
     "tests"
   ],
   "scripts": {
-    "build": "lerna run build",
-    "test": "lerna run build:test && lerna run test"
+    "build": "cd javascript && yarn run build",
+    "test": "cd javascript && yarn run build:test && yarn run test"
   },
-  "devDependencies": {
-    "lerna": "^6.3.0"
-  }
+  "packageManager": "[email protected]"
 }

package.json

@@ -42,8 +42,8 @@ def yjs_client(request):
     client_id = request.param
     p = subprocess.Popen(
         [
+            "yarn",
             "node",
-            "--experimental-specifier-resolution=node",
             f"{here / 'yjs_client_'}{client_id}.js",
         ]
     )

tests/conftest.py

@@ -1,10 +1,10 @@
 {
   "name": "@jupyter/ydoc-test",
   "version": "0.0.1",
-  "private": "true",
+  "private": true,
   "type": "module",
   "dependencies": {
-    "@jupyter/ydoc": "file:../javascript",
+    "@jupyter/ydoc": "workspace:javascript",
     "ws": "^8.5.0",
     "y-websocket": "^1.4.1"
   }

tests/package.json

@@ -57,7 +57,7 @@ async def test_ypy_yjs_0(yws_server, yjs_client):
     WebsocketProvider(ydoc, websocket)
     nb = stringify_source(json.loads((files_dir / "nb0.ipynb").read_text()))
     ynotebook.source = nb
-    ytest = YTest(ydoc)
+    ytest = YTest(ydoc, 3.0)
     await ytest.change()
     assert ytest.source == nb