[1.1.x] Make server extension verification call during extension startup non-blocking (#480) (#486)

andrii-i · dlqqq · pre-commit-ci[bot] · web-flow · commit ca2bb89b6bd8 · 2024-02-16T13:51:58.000-08:00
* [1.x] Make server extension verification call during extension startup non-blocking (#480) (#481) * Make server extension verification call during extension startup non-blocking (#480) * remove async call, make call sync, refactor into a separate function * don't use abbreviations in the verifyServerExtension function or type naming * Update src/index.tsx Co-authored-by: david qiu <david@qiu.dev> * remove unused type * add @jupyterlab/rendermime-interfaces as a dependency * Remove async from activatePlugin function declaration (makes it not async) * set @jupyterlab/rendermime-interfaces version to ^3.8.0 to support all JLab >= 4 --------- Co-authored-by: david qiu <david@qiu.dev> * Fix translator usage, remove @jupyterlab/rendermime-interfaces dependency (#483) * update snapshots * use lowercase "es" is "es2017" as is convention in Project Jupyter * fix 1.x dependencies * fix package manifest to be compatible with JL3 * Make ErrorBoundary return JSX.Element to avoid type conflicts --------- Co-authored-by: david qiu <david@qiu.dev> * add pytest-cov dependency to pyproject.toml * update pre-commit * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: david qiu <david@qiu.dev> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,12 @@ node_modules/
 *.tsbuildinfo
 jupyter_scheduler/labextension
 
+# Yarn 3 cache
+.yarn
+
+# Pytest files
+coverage
+
 # Integration tests
 ui-tests/test-results/
 ui-tests/playwright-report/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.5.0
     hooks:
       - id: end-of-file-fixer
       - id: check-case-conflict
@@ -16,25 +16,25 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 24.2.0
     hooks:
       - id: black
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.13.2
     hooks:
       - id: isort
         args: ["--profile", "black"]
         files: \.py$
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.2.0
+    rev: v3.15.0
     hooks:
       - id: pyupgrade
         args: [--py37-plus]
 
   - repo: https://github.com/pycqa/flake8
-    rev: 5.0.4
+    rev: 7.0.0
     hooks:
       - id: flake8
         additional_dependencies:
@@ -46,7 +46,7 @@ repos:
         stages: [manual]
 
   - repo: https://github.com/sirosen/check-jsonschema
-    rev: 0.18.4
+    rev: 0.28.0
     hooks:
       - id: check-jsonschema
         name: "Check GitHub Workflows"
diff --git a/jupyter_scheduler/__init__.py b/jupyter_scheduler/__init__.py
@@ -1,4 +1,5 @@
 """Scheduling API for JupyterLab"""
+
 import json
 from pathlib import Path
 
diff --git a/package.json b/package.json
@@ -62,17 +62,17 @@
     "@jupyterlab/docmanager-extension": "^3.4.2",
     "@jupyterlab/filebrowser": "^3.4.1",
     "@jupyterlab/launcher": "^3.4.4",
+    "@jupyterlab/rendermime-interfaces": "^3",
     "@jupyterlab/services": "^6.4.2",
     "@jupyterlab/translation": "^3.4.1",
     "@jupyterlab/ui-components": "^3.4.2",
-    "@lumino/polling": "^1.9.0",
-    "@lumino/signaling": "^1.10.0",
-    "@lumino/coreutils": "^1.12.0",
-    "@lumino/widgets": "^1.32.0",
+    "@lumino/coreutils": "^1",
+    "@lumino/polling": "^1",
+    "@lumino/signaling": "^1",
+    "@lumino/widgets": "^1",
     "@mui/icons-material": "^5.10.9",
     "@mui/material": "^5.10.6",
     "@mui/system": "^5.10.6",
-    "@types/react-dom": "^18.0.5",
     "cronstrue": "^2.12.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
@@ -93,6 +93,8 @@
     "mkdirp": "^1.0.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.1.1",
+    "@types/react": "^17.0.1",
+    "@types/react-dom": "^17.0.1",
     "rimraf": "^3.0.2",
     "stylelint": "^14.3.0",
     "stylelint-config-prettier": "^9.0.3",
@@ -103,8 +105,8 @@
     "typescript": "~4.1.3"
   },
   "resolutions": {
-    "@types/react": "^17.0.1",
-    "@types/react-dom": "^18.0.5"
+    "@lumino/coreutils": "^1",
+    "@jupyterlab/rendermime-interfaces": "3.0.0 - 3.6.7"
   },
   "sideEffects": [
     "style/*.css",
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,7 +31,7 @@ dependencies = [
     "jupyter_server>=1.6,<3",
     "traitlets",
     "nbconvert",
-    "pydantic",
+    "pydantic~=1.10",
     "sqlalchemy<2",
     "croniter",
     "pytz",
@@ -43,7 +43,8 @@ dependencies = [
 [project.optional-dependencies]
 test = [
     "pytest",
-    "jupyter_server[test]>=1.6,<3"
+    "pytest-cov",
+    "jupyter_server[test]>=1.6,<3",
 ]
 dev = [
     "click"
diff --git a/src/components/error-boundary.tsx b/src/components/error-boundary.tsx
@@ -27,7 +27,7 @@ export class ErrorBoundary extends React.Component<
     this.setState({ hasError: true, error });
   }
 
-  render(): React.ReactNode {
+  render(): JSX.Element {
     let errorDetail;
     if (typeof this.state.error === 'string') {
       errorDetail = this.state.error;
@@ -53,6 +53,6 @@ export class ErrorBoundary extends React.Component<
         </div>
       );
     }
-    return this.props.children;
+    return <> {this.props.children} </>;
   }
 }
diff --git a/src/index.tsx b/src/index.tsx
@@ -3,11 +3,16 @@ import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
-import { MainAreaWidget, WidgetTracker } from '@jupyterlab/apputils';
+import {
+  Dialog,
+  MainAreaWidget,
+  showDialog,
+  WidgetTracker
+} from '@jupyterlab/apputils';
 import { FileBrowser, IFileBrowserFactory } from '@jupyterlab/filebrowser';
 import { ILauncher } from '@jupyterlab/launcher';
 import { INotebookTracker } from '@jupyterlab/notebook';
-import { Contents } from '@jupyterlab/services';
+import { Contents, ServerConnection } from '@jupyterlab/services';
 import { ITranslator } from '@jupyterlab/translation';
 
 import AdvancedOptions from './advanced-options';
@@ -20,6 +25,7 @@ import { SchedulerService } from './handler';
 import { IJobsModel, emptyCreateJobModel, JobsView } from './model';
 import { NotebookJobsPanel } from './notebook-jobs-panel';
 import { Scheduler } from './tokens';
+import { SERVER_EXTENSION_404_JSX } from './util/errors';
 import { MakeNameValid } from './util/job-name-validation';
 
 export namespace CommandIDs {
@@ -34,6 +40,32 @@ export namespace CommandIDs {
 export const NotebookJobsPanelId = 'notebook-jobs-panel';
 export { Scheduler } from './tokens';
 
+/**
+ * Call API to verify that the server extension is actually installed.
+ */
+async function verifyServerExtension(props: {
+  api: SchedulerService;
+  translator: ITranslator;
+}) {
+  const trans = props.translator.load('jupyterlab');
+  try {
+    await props.api.getJobs({ max_items: 0 });
+  } catch (e: unknown) {
+    // in case of 404, show missing server extension dialog and return
+    if (
+      e instanceof ServerConnection.ResponseError &&
+      e.response.status === 404
+    ) {
+      showDialog({
+        title: trans.__('Jupyter Scheduler server extension not found'),
+        body: SERVER_EXTENSION_404_JSX,
+        buttons: [Dialog.okButton()]
+      }).catch(console.warn);
+      return;
+    }
+  }
+}
+
 /**
  * Initialization data for the jupyterlab-scheduler extension.
  */
@@ -114,19 +146,20 @@ function getDirectoryFromPath(path: string | null): string | null {
   return directories.join('/') + (directories.length > 0 ? '/' : '');
 }
 
-async function activatePlugin(
+function activatePlugin(
   app: JupyterFrontEnd,
   browserFactory: IFileBrowserFactory,
   notebookTracker: INotebookTracker,
   translator: ITranslator,
   restorer: ILayoutRestorer,
   advancedOptions: Scheduler.IAdvancedOptions,
   launcher: ILauncher | null
-): Promise<void> {
+): void {
   const { commands } = app;
   const trans = translator.load('jupyterlab');
   const fileBrowserTracker = browserFactory.tracker;
   const api = new SchedulerService({});
+  verifyServerExtension({ api, translator });
   const widgetTracker = new WidgetTracker<MainAreaWidget<NotebookJobsPanel>>({
     namespace: 'jupyterlab-scheduler'
   });
diff --git a/src/util/errors.tsx b/src/util/errors.tsx
@@ -0,0 +1,28 @@
+import React from 'react';
+
+export const SERVER_EXTENSION_404_JSX = (
+  <div>
+    <p>
+      The Jupyter Scheduler extension is installed but it can't be activated. It
+      looks like the required Jupyter Server extension (
+      <code>jupyter_scheduler</code>) is not installed or not enabled in this
+      environment.
+    </p>
+    <h3>Why am I seeing this message?</h3>
+    <p>
+      If you installed the Jupyter Scheduler extension from the Extension
+      Manager in JupyterLab, you might have installed only the client extension
+      and not the server extension. You can install the server extension by
+      running <code>pip install jupyter_scheduler</code> in the same environment
+      in which you run JupyterLab.
+    </p>
+    <h3>How do I check if the extension is installed?</h3>
+    <p>
+      Please ensure that <code>jupyter server extension list</code> includes
+      jupyter_scheduler and that it is enabled. If it is enabled, please restart
+      JupyterLab. If the server extension is installed but not enabled, run{' '}
+      <code>jupyter server extension enable --user --py jupyter_scheduler</code>{' '}
+      and restart JupyterLab.
+    </p>
+  </div>
+);
diff --git a/tsconfig.json b/tsconfig.json
@@ -13,6 +13,7 @@
     "noUnusedLocals": true,
     "preserveWatchOutput": true,
     "resolveJsonModule": true,
+    "skipLibCheck": true,
     "outDir": "lib",
     "rootDir": "src",
     "strict": true,
diff --git a/ui-tests/jupyter_server_test_config.py b/ui-tests/jupyter_server_test_config.py
@@ -4,6 +4,7 @@
 opens the server to the world and provide access to JupyterLab
 JavaScript objects through the global window variable.
 """
+
 from tempfile import mkdtemp
 
 c.ServerApp.port = 8888
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Scheduling API for JupyterLab"""`
	`2`	`+`
`2`	`3`	`import json`
`3`	`4`	`from pathlib import Path`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export class ErrorBoundary extends React.Component<`
`27`	`27`	`this.setState({ hasError: true, error });`
`28`	`28`	`}`
`29`	`29`
`30`		`- render(): React.ReactNode {`
	`30`	`+ render(): JSX.Element {`
`31`	`31`	`let errorDetail;`
`32`	`32`	`if (typeof this.state.error === 'string') {`
`33`	`33`	`errorDetail = this.state.error;`
`@@ -53,6 +53,6 @@ export class ErrorBoundary extends React.Component<`
`53`	`53`	`</div>`
`54`	`54`	`);`
`55`	`55`	`}`
`56`		`- return this.props.children;`
	`56`	`+ return <> {this.props.children} </>;`
`57`	`57`	`}`
`58`	`58`	`}`