Add integration test and dependencies for Binder setup

.github/workflows/build.yml

@@ -109,7 +109,7 @@ jobs:
     - name: Install the extension
       run: |
         set -eux
-        python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_nebari_mode*.whl
+        python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_nebari_mode*.whl[integration-test]
 
     - name: Install dependencies
       working-directory: ui-tests

.github/workflows/update-integration-tests.yml

@@ -40,7 +40,7 @@ jobs:
         run: |
           set -eux
           jlpm
-          python -m pip install .
+          python -m pip install .[integration-test]
 
       - uses: jupyterlab/maintainer-tools/.github/actions/update-snapshots@v1
         with:

binder/environment.yml

@@ -17,5 +17,6 @@ dependencies:
   - nodejs >=18,<19
   - pip
   - wheel
-  # additional packages for demos
-  # - ipywidgets
+  - pip:
+    - jupyter-server-proxy
+    - jupyter-vscode-proxy

binder/postBuild

@@ -42,6 +42,8 @@ _("jupyter", "server", "extension", "list")
 # initially list installed extensions to determine if there are any surprises
 _("jupyter", "labextension", "list")
 
+_("mkdir", "-p", "$NB_PYTHON_PREFIX/share/jupyter/lab/settings/")
+_("cp", "binder/overrides.json", "$NB_PYTHON_PREFIX/share/jupyter/lab/settings/")
 
 print("JupyterLab with jupyterlab_nebari_mode is ready to run with:\n")
 print("\tjupyter lab\n")

pyproject.toml

@@ -26,6 +26,12 @@ dependencies = [
 ]
 dynamic = ["version", "description", "authors", "urls", "keywords"]
 
+[project.optional-dependencies]
+integration-test = [
+    "jupyter-server-proxy",
+    "jupyter-vscode-proxy"
+]
+
 [tool.hatch.version]
 source = "nodejs"
 

src/index.ts

@@ -110,7 +110,7 @@ const commandsPlugin: JupyterFrontEndPlugin<void> = {
           window.location.href = url;
         }
       },
-      isVisible: (args: IOpenProxyArgs) => {
+      isEnabled: (args: IOpenProxyArgs) => {
         const processs = findProcess(args.name);
         return !!processs;
       },

ui-tests/tests/jupyterlab_nebari_mode.spec.ts

@@ -26,3 +26,23 @@ test('should swap Jupyter logo with clickable Nebari logo', async ({
   await link.focus();
   expect(await link.screenshot()).toMatchSnapshot('nebari-logo-focus.png');
 });
+
+test('should register custom commands', async ({ page }) => {
+  const openVScodeProxy = await page.evaluate(async () => {
+    const registry = window.jupyterapp.commands;
+    const id = 'nebari:open-proxy';
+    const args = { name: 'vscode' };
+
+    return {
+      id,
+      label: registry.label(id, args),
+      isEnabled: registry.isEnabled(id, args)
+    };
+  });
+
+  // Should set correct label for given command
+  expect(openVScodeProxy.label).toBe('Open VS Code');
+
+  // Should be enabled when `jupyter-vscode-proxy` is installed
+  expect(openVScodeProxy.isEnabled).toBe(true);
+});