Plan for moving Jupyter Hub support to a separate extension

[DonJayamanne]

Refs: #13973, #13894

• anyOS: @rebornix
• anyOS: @joyceerhl

(please do not use Web, this will not work in vscode.dev)
Complexity: 5

Authors: @DonJayamanne

Create Issue

---

Note

This test plan is only used to verify the following hypothesis:

• We can connect to the latest version of Jupyter Hub
• 3rd party extension can use the Jupyter API to contribute Jupyter Servers
• We can move Jupyter Hub into a separate extension

Pre-Requisites

• Install VS Code insiders
• Jupyter pre-relese extension
• Install this following VSIX
  ms-toolsai-jupyter-hub-insiders.vsix.zip

Install and launch Jupyter Hub

https://jupyterhub.readthedocs.io/en/1.2.0/installation-guide-hard.html

1. Create a new folder
2. Create a file named jupyterhub_config.py and paste the below contents into that file
   1. Custom config to make auth easier, else you need use your login creds, which I guess you don't want to use.

# Configuration file for jupyterhub.

c = get_config()  #noqa
c.JupyterHub.authenticator_class = 'jupyterhub.auth.DummyAuthenticator'
c.DummyAuthenticator.password = "pwd" # Feel free to change the default password
c.Spawner.args = ['--NotebookApp.allow_origin=*']
from jupyterhub.spawner import SimpleLocalProcessSpawner
c.JupyterHub.spawner_class = SimpleLocalProcessSpawner

2. Create a virtual env in this folder using Python extension
3. Install Jupyterhub using the CLI python -m pip install jupyterlab jupyterhub
4. Install the npm package configurable-http-proxy globally via the cli npm i -g configurable-http-proxy
5. Now start Jupyter Hub using the cli jupyterhub (ensuring the cwd in the terminal is the same folder in step 1 and your virtual env is in the same folder under .venv)
6. In the browser navigate to Jupyter Hub login page, genrally http://localhost:8000
7. Enter any user name and password as pwd
8. You will be take to Jupyter Lab page
   This will take a few seconds, as Jupyter Hub will start a Jupyter Lab server on your machine
9. Verify you have Jupyter Lab running

Steps to test

1. Go into VS Code, open a notebook
2. From the kernel picker select Existing JupyterHub Server...
3. Enter the Jupyter Hub Url http://localhost:8000 (that shouldbe all)
4. Verify you are prompted for your user name and password (remember password is pwd)
   Note: Remember to use the same user name (else it will not work, these are things to be ironed out later)
5. Verify you now get a list of Kernels in the kernel picker
6. Verify you can select a kernel and run code against this kernel

[rebornix]

It's working great, my custom config is

c.JupyterHub.authenticator_class = "dummy"
c.DummyAuthenticator.password = "pwd" # Feel free to change the default password
c.Spawner.args = ['--NotebookApp.allow_origin=*']
c.Spawner.default_url = '/lab'
from jupyterhub.spawner import SimpleLocalProcessSpawner
c.JupyterHub.spawner_class = SimpleLocalProcessSpawner

I got error "username/password not correct" at the first time but turns out that I'm using wrong url 127.0.0.1:8081 other than 127.0.0.1:8000. After trying that in the browser, I figured this out as in the browser it's a 5xx error. It would be great if the error message we present is more accurate but I guess it's a corner case as usually users already have jupyter hub running successfully.

[joyceerhl]

I hit this on Windows

preexec_fn is not supported on Windows platforms
    Traceback (most recent call last):
    NoneType: None

I uninstalled WSL earlier today for another TPI, trying Dev Box now

[joyceerhl]

As far as I can tell, this does not work on Windows, but it worked in a codespace