Update master to JupyterLab 4 examples (#232)

* Upgrade example for JupyterLab 4

Switch to extension template (#229)
Add notifications example (#230)
Add an example package for the use of metadata-form (#208)
Add codemirror extension example (#231)

Co-authored-by: Frédéric Collonval <[email protected]>
Co-authored-by: Florence Haudin <[email protected]>
Co-authored-by: Nicolas Brichet <[email protected]>

* Bump to final package version

* Upgrade documents example

* Update documents README

* Update template

* Make ICollaborativeDrive optional

* Fix tests

* Install browser for integration tests

* Fix tests

* Improve robustness for metadata form ui test
Break documents test at browser_check

* Fix documents packaging

* Remove _version.py file

* Yet another attempt to fix integration tests

* Improve test robustness and some fixes

* Update codemirror snapshot

* Finally nail the culprit in metadata form test

---------

Co-authored-by: Michał Krassowski <[email protected]>
Co-authored-by: Florence Haudin <[email protected]>
Co-authored-by: Nicolas Brichet <[email protected]>

Author: 4 people

.github/workflows/main.yml

@@ -4,36 +4,39 @@ on:
   push:
     branches: master
   pull_request:
-    branches: "*"
+    branches: '*'
 
 jobs:
   build_extensions:
     runs-on: ${{ matrix.os }}
-    
+
     strategy:
       fail-fast: false
       matrix:
         example:
-          - kernel-messaging
-          - kernel-output
-          - datagrid
-          - documents
-          - hello-world
-          - signals
+          - codemirror-extension
           - command-palette
           - commands
+          - completer
+          - contentheader
           - context-menu
-          - launcher
           - custom-log-console
+          - datagrid
+          - documents
+          - hello-world
+          - launcher
+          - kernel-messaging
+          - kernel-output
           - log-messages
           - main-menu
+          - metadata-form
+          - notifications
           - react-widget
           - settings
+          - signals
           - state
           - toolbar-button
           - widgets
-          - completer
-          - contentheader
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     defaults:
@@ -63,24 +66,23 @@ jobs:
       - name: Check config files
         if: steps.filter.outputs.extension == 'true'
         run: |
+          diff ../hello-world/setup.py setup.py
           diff ../hello-world/tsconfig.json tsconfig.json
-          diff ../hello-world/.eslintignore .eslintignore
-          diff ../hello-world/.eslintrc.js .eslintrc.js
-          diff ../hello-world/.gitignore .gitignore
-          diff ../hello-world/ui-tests/playwright.config.ts ./ui-tests/playwright.config.ts
-          diff ../hello-world/ui-tests/README.md ./ui-tests/README.md
+          diff ../hello-world/.yarnrc.yml .yarnrc.yml
+          diff ../hello-world/ui-tests/jupyter_server_test_config.py ./ui-tests/jupyter_server_test_config.py
+          diff ../hello-world/ui-tests/playwright.config.js ./ui-tests/playwright.config.js
         shell: bash
       - name: Install node
         if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-node@v3
         with:
-          node-version: "18.x"
+          node-version: '18.x'
       - name: Install Python
         if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
-          architecture: "x64"
+          python-version: '3.11'
+          architecture: 'x64'
       - name: Get pip cache dir
         if: steps.filter.outputs.extension == 'true'
         id: pip-cache
@@ -92,13 +94,18 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/environment.yml') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('environment.yml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install the Python dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
-          python -m pip install --upgrade pip jupyter_packaging~=0.10 jupyterlab~=3.1
+          python -m pip install --upgrade pip "jupyterlab>=4.0.0"
+      # This is challenging to test in collaboration;
+      # got trouble with the file ID service and the uncontrolled auto-save
+      # - if: steps.filter.outputs.extension == 'true' && matrix.example == 'documents'
+      #   run: |
+      #     python -m pip install jupyter-collaboration
       - name: Install the NPM dependencies
         if: steps.filter.outputs.extension == 'true'
         run: jlpm
@@ -111,30 +118,47 @@ jobs:
           pip install . -v
           jupyter labextension list 2>&1 | tee labextension.list
           cat labextension.list | grep -ie "@jupyterlab-examples/*.*OK"
+          # There is a JavaScript warning as jupyter-collaboration is not
+          # installed. And therefore @jupyter/docprovider is not available.
           python -m jupyterlab.browser_check
-          pip uninstall -y $(python setup.py --name)
         shell: bash
 
+      - name: Install galata
+        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
+        working-directory: ${{ matrix.example }}/ui-tests
+        env:
+          PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+        run: jlpm install
+      - name: Set up browser cache
+        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
+        uses: actions/cache@v3
+        with:
+          path: |
+            ${{ github.workspace }}/pw-browsers
+          key: ${{ runner.os }}-${{ hashFiles('yarn.lock') }}
+      - name: Install browser
+        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
+        run: jlpm playwright install chromium
+        working-directory: ${{ matrix.example }}/ui-tests
+      - name: Install kernel-output dependencies
+        if: steps.filter.outputs.extension == 'true' && matrix.example == 'kernel-output'
+        run: pip install numpy pandas
       - name: Integration tests
         if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
-        run: |
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env down || true
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env pull -q || true
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env build
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env run --rm e2e
+        working-directory: ${{ matrix.example }}/ui-tests
+        run: jlpm playwright test
       - name: Upload UI Test artifacts
         if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux') && always()
         uses: actions/upload-artifact@v3
         with:
           name: ui-test-output
           path: |
             ${{ matrix.example }}/ui-tests/test-results
-      - name: Stop containers
-        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux') && always()
+      - name: Uninstall extension
+        if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
-          # Print jupyterlab logs before removing the containers using the container name set in docker-compose file
-          docker logs jupyterlab
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env down
+          export NAME=`python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['name'])"`
+          pip uninstall -y ${NAME}
 
   build_serverextension:
     runs-on: ${{ matrix.os }}
@@ -166,22 +190,22 @@ jobs:
         if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-node@v3
         with:
-          node-version: "18.x"
+          node-version: '18.x'
       - name: Check config files
         if: steps.filter.outputs.extension == 'true'
         run: |
+          diff hello-world/setup.py server-extension/setup.py
           diff hello-world/tsconfig.json server-extension/tsconfig.json
-          diff hello-world/.eslintignore server-extension/.eslintignore
-          diff hello-world/.eslintrc.js server-extension/.eslintrc.js
-          diff hello-world/ui-tests/playwright.config.ts server-extension/ui-tests/playwright.config.ts
-          diff hello-world/ui-tests/README.md server-extension/ui-tests/README.md
+          diff hello-world/.yarnrc.yml server-extension/.yarnrc.yml
+          diff hello-world/ui-tests/jupyter_server_test_config.py server-extension/ui-tests/jupyter_server_test_config.py
+          diff hello-world/ui-tests/playwright.config.js server-extension/ui-tests/playwright.config.js
         shell: bash
       - name: Install Python
         if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
-          architecture: "x64"
+          python-version: '3.11'
+          architecture: 'x64'
       - name: Get pip cache dir
         if: steps.filter.outputs.extension == 'true'
         id: pip-cache
@@ -193,13 +217,13 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/environment.yml') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('environment.yml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install the Python dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
-          python -m pip install --upgrade pip jupyter_packaging~=0.10 jupyterlab~=3.1
+          python -m pip install --upgrade pip jupyterlab~=4.0.0 build twine hatch
       - name: Install the NPM dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
@@ -215,20 +239,20 @@ jobs:
         # Force the usage of the source distribution (good practice)
         run: |
           cd server-extension
-          python setup.py sdist
-          pip install ./dist/jlab_ext_example* --pre --find-links=dist --no-cache-dir
+          python -m build --sdist
+          pip install ./dist/jupyterlab_examples_server* --pre --find-links=dist --no-cache-dir
           python -m jupyterlab.browser_check
       - name: Check extension as dev
         if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
           jupyter server extension list 2>&1 | tee serverextension.list
-          cat serverextension.list | grep -ie "jlab_ext_example.*OK"
+          cat serverextension.list | grep -ie "jupyterlab_examples_server.*OK"
           jupyter labextension list 2>&1 | tee labextension.list
           cat labextension.list | grep -ie "@jupyterlab-examples/server-extension.*OK"
       - name: Clean extension installation
         if: steps.filter.outputs.extension == 'true'
         run: |
-          pip uninstall -y jlab_ext_example
+          pip uninstall -y jupyterlab_examples_server
           jupyter lab clean
           jupyter server extension list
           jupyter labextension list
@@ -241,33 +265,44 @@ jobs:
         if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
           jupyter server extension list 2>&1 | tee serverextension.list
-          cat serverextension.list | grep -ie "jlab_ext_example.*OK"
+          cat serverextension.list | grep -ie "jupyterlab_examples_server.*OK"
           jupyter labextension list 2>&1 | tee labextension.list
           cat labextension.list | grep -ie "@jupyterlab-examples/server-extension.*OK"
           python -m jupyterlab.browser_check
 
+      - name: Install galata
+        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
+        working-directory: server-extension/ui-tests
+        env:
+          PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+        run: jlpm install
+      - name: Set up browser cache
+        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
+        uses: actions/cache@v3
+        with:
+          path: |
+            ${{ github.workspace }}/pw-browsers
+          key: ${{ runner.os }}-${{ hashFiles('yarn.lock') }}
+      - name: Install browser
+        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
+        run: jlpm playwright install chromium
+        working-directory: server-extension/ui-tests
       - name: Integration tests
         if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
-        run: |
-          cd server-extension
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env down || true
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env pull -q || true
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env build
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env run --rm e2e
+        working-directory: server-extension/ui-tests
+        run: jlpm playwright test
       - name: Upload UI Test artifacts
         if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux') && always()
         uses: actions/upload-artifact@v3
         with:
           name: ui-test-output
           path: |
             server-extension/ui-tests/test-results
-      - name: Stop containers
-        if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux') && always()
+      - name: Uninstall extension
+        if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
-          cd server-extension
-          # Print jupyterlab logs before removing the containers using the container name set in docker-compose file
-          docker logs jupyterlab
-          docker-compose -f ../end-to-end-tests/docker-compose.yml --env-file ./ui-tests/.env down
+          export NAME=`python -c "import tomllib; print(tomllib.load(open('server-extension/pyproject.toml', 'rb'))['project']['name'])"`
+          pip uninstall -y ${NAME}
 
   build_all:
     runs-on: ${{ matrix.os }}
@@ -290,12 +325,12 @@ jobs:
       - name: Install node
         uses: actions/setup-node@v3
         with:
-          node-version: "18.x"
+          node-version: '18.x'
       - name: Install Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
-          architecture: "x64"
+          python-version: '3.11'
+          architecture: 'x64'
       - name: Get pip cache dir
         id: pip-cache
         run: |
@@ -305,17 +340,18 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/environment.yml') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('environment.yml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install the Python dependencies
-        run: python -m pip install jupyter_packaging~=0.10 jupyterlab~=3.1 pytest pytest-check-links
+        run: python -m pip install jupyterlab~=4.0.0 pytest pytest-check-links "pytest-jupyter[server]>=0.6.0"
       - name: Bootstrap the jlpm deps
         run: jlpm
       - name: Build all the extensions
         run: |
           jlpm lint:check
-          jlpm build-ext
-          jlpm install-ext
+          lerna exec --concurrency 4 -- "touch yarn.lock"
+          # Needed to generate the _version.py files
+          jlpm run lerna exec --concurrency 4 -- "pip install -e ."
           # Check links as last step as new tutorial may set links not yet valid (like file not yet in master)
-          pytest --check-links
+          jlpm run lerna exec --concurrency 4 -- "pytest --check-links"

.gitignore

@@ -7,11 +7,14 @@ node_modules/
 *.tsbuildinfo
 *.lock
 __pycache__
+.yarn/
 
 # Ensure embedme does not run ont node_modules README.md files.
 **/node_modules/**/README.md
 
 static
 labextension
 **/test-results/
+_version.py
 
+.jupyter_ystore.db

.prettierrc

@@ -1,3 +1,6 @@
 {
-  "singleQuote": true
+  "singleQuote": true,
+  "trailingComma": "none",
+  "arrowParens": "avoid",
+  "endOfLine": "auto"
 }

.yarnrc.yml

@@ -0,0 +1,3 @@
+enableImmutableInstalls: false
+
+nodeLinker: node-modules

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2020, Project Jupyter Contributors.
+Copyright (c) 2020-2023, Project Jupyter Contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without