Merge pull request #355 from bollwyvl/update-labextension

consideRatio · web-flow · commit 3c991117c57f · 2022-11-10T21:20:12.000+01:00
Update labextension build
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -47,7 +47,6 @@ jobs:
           python-version: "${{ matrix.python-version }}"
 
       - name: Build Python package
-        id: build-package
         run: |
           pip install jupyter_packaging wheel jupyterlab
           python setup.py sdist bdist_wheel
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,11 @@
 # Manually added entries
 #
-jsdist
-jupyter_server_proxy/labextension
-node_modules
+jsdist/
+jupyter_server_proxy/labextension/
+node_modules/
 package-lock.json
-
+.yarn-packages/
+*.tsbuildinfo
 
 
 # Copy pasted entries from:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,6 +14,7 @@ pip install -e .[test]
 
 # explicit install needed with editable mode (-e) jupyter
 jupyter serverextension enable --sys-prefix jupyter_server_proxy
+jupyter server extension enable --sys-prefix jupyter_server_proxy
 ```
 
 Before running tests, you need a server that we can test against.
@@ -42,6 +43,7 @@ pip install -e .[test,acceptance]
 ```
 
 In addition, compatible versions of:
+
 - `geckodriver`
 - `firefox`
 
@@ -59,36 +61,24 @@ browser logs, server logs, and report HTML in `build/robot`.
 ### JupyterLab extension
 
 The `jlpm` command is JupyterLab's pinned version of `yarn` that is
-installed with JupyterLab. You may use `yarn` or `npm` instead of `jlpm`
-below.
-
-```bash
-cd jupyterlab-server-proxy
-
-# Install dependencies
-jlpm
-
-# Build Typescript source
-jlpm build
+installed with JupyterLab.
 
-# Link your development version of the extension with JupyterLab
-jupyter labextension link .
+> You may use `yarn` or `npm run` instead of `jlpm` below.
 
-# Rebuild Typescript source after making changes
-jlpm build
-
-# Rebuild JupyterLab after making any changes
-jupyter lab build
+```bash
+cd jupyterlab-server-proxy # Change to the root of the labextension
+jlpm                       # Install dependencies (or `npm i`)
+jlpm build:prod            # Build:
+                           # - `jupyterlab-server-proxy/lib`
+                           # - `jupyter_server_proxy/labextension`
+jlpm install:extension     # Symlink into `{sys.prefix}/share/jupyter/labextensions`
 ```
 
-You can watch the source directory and run JupyterLab in watch mode to
-watch for changes in the extension's source and automatically rebuild
-the extension and application.
+You can watch the source directory and automatically rebuild the `lib` folder:
 
 ```bash
-# Watch the source directory in another terminal tab
-jlpm watch
-
-# Run jupyterlab in watch mode in one terminal tab
-jupyter lab --watch
+jlpm watch   # ... watch the source directory in another terminal tab
 ```
+
+However, the built-in `jupyter labextension watch` does _not_ work with this repo,
+as the `package.json` and `setup.py` would need to be at the same level.
diff --git a/jupyterlab-server-proxy/.yarnrc b/jupyterlab-server-proxy/.yarnrc
@@ -0,0 +1,6 @@
+disable-self-update-check true
+ignore-optional true
+network-timeout "300000"
+registry "https://registry.npmjs.org/"
+yarn-offline-mirror "../build/.yarn-packages"
+yarn-offline-mirror-pruning true
diff --git a/jupyterlab-server-proxy/LICENSE b/jupyterlab-server-proxy/LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017, Data Science 8
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/jupyterlab-server-proxy/README.md b/jupyterlab-server-proxy/README.md
@@ -2,31 +2,39 @@
 
 Launcher icons for proxied applications
 
-
 ## Prerequisites
 
-* JupyterLab
+- JupyterLab >=2,<4
 
 ## Installation
 
+For JupyterLab 3, use your preferred Python package manager to install `jupyter-server-proxy`:
+
 ```bash
-jupyter labextension install @jupyterlab/server-proxy
+pip install jupyter-server-proxy
 ```
 
-## Development
-
-For a development install (requires npm version 4 or later), do the following in the repository directory:
+or
 
 ```bash
-npm install
-npm run build
-jupyter labextension link .
+conda install jupyter-server-proxy
 ```
 
-To rebuild the package and the JupyterLab app:
+> As a _prebuilt_ extension, it will "just work," only a simple page reload should be required
+> to see launcher items. However, a full restart of `jupyter_server` or `notebook` is required 
+> to reload the `jupyter_server_proxy` serverextension which provides most of the functionality.
+
+### JupyterLab 2
+
+For JupyterLab 2, ensure `nodejs` is installed and available on `$PATH` and run:
 
 ```bash
-npm run build
-jupyter lab build
+jupyter labextension install @jupyterlab/server-proxy
 ```
 
+> This will cause:
+>
+> - a download of a great deal of build assets from `npmjs.org`
+> - a large `webpack` build that may exhaust memory and open files handles
+>
+> **Please** consider upgrading to JupyterLab 3 before reporting issues.
diff --git a/jupyterlab-server-proxy/package.json b/jupyterlab-server-proxy/package.json
@@ -17,8 +17,8 @@
     "email": "rylo@berkeley.edu"
   },
   "files": [
-    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
-    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
+    "LICENSE",
+    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}"
   ],
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -28,29 +28,33 @@
   },
   "scripts": {
     "build": "jlpm run build:lib && jlpm run build:labextension:dev",
-    "build:prod": "jlpm run build:lib && jlpm run build:labextension",
+    "build:prod": "jlpm clean && jlpm run build:lib && jlpm run build:labextension",
     "build:labextension": "jupyter labextension build .",
     "build:labextension:dev": "jupyter labextension build --development True .",
-    "build:lib": "tsc",
+    "build:lib": "tsc -b",
     "clean": "jlpm run clean:lib",
     "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
     "clean:labextension": "rimraf jupyter_server_proxy/labextension",
     "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
-    "eslint": "eslint . --ext .ts,.tsx --fix",
-    "eslint:check": "eslint . --ext .ts,.tsx",
     "install:extension": "jupyter labextension develop --overwrite .",
     "watch": "run-p watch:src watch:labextension",
-    "watch:src": "tsc -w",
-    "watch:labextension": "jupyter labextension watch ."
+    "watch:src": "jlpm build:lib -w",
+    "watch:labextension": "jupyter labextension watch .",
+    "deduplicate": "yarn-deduplicate -s fewer --fail"
   },
   "dependencies": {
     "@jupyterlab/application": "^2.0 || ^3.0",
     "@jupyterlab/launcher": "^2.0 || ^3.0"
   },
+  "resolutions": {
+    "loader-utils": ">=2.0.3"
+  },
   "devDependencies": {
     "@jupyterlab/builder": "^3.2.4",
-    "rimraf": "^2.6.1",
-    "typescript": "~3.7.0"
+    "rimraf": "^3.0.2",
+    "typescript": "~4.8.4",
+    "yarn-deduplicate": "^6.0.0",
+    "npm-run-all": "^4.1.5"
   },
   "jupyterlab": {
     "extension": true,
diff --git a/jupyterlab-server-proxy/tsconfig.json b/jupyterlab-server-proxy/tsconfig.json
@@ -1,17 +1,24 @@
 {
   "compilerOptions": {
     "allowSyntheticDefaultImports": true,
+    "composite": true,
     "declaration": true,
-    "lib": ["es2015", "dom"],
-    "module": "commonjs",
+    "esModuleInterop": true,
+    "incremental": true,
+    "jsx": "react",
+    "module": "esnext",
     "moduleResolution": "node",
     "noEmitOnError": true,
+    "noImplicitAny": true,
     "noUnusedLocals": true,
-    "outDir": "lib",
-    "rootDir": "src",
+    "preserveWatchOutput": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
     "strict": true,
-    "strictNullChecks": false,
-    "target": "es2015",
+    "strictNullChecks": true,
+    "target": "es2019",
+    "outDir": "./lib",
+    "rootDir": "./src",
     "types": []
   },
   "include": ["src/*"]
diff --git a/jupyterlab-server-proxy/yarn.lock b/jupyterlab-server-proxy/yarn.lock
