jupyter-server / jupyter_server_terminals Goto Github PK

Problem

If we're switching to use this extension, it needs the authorizer support added in jupyter-server/jupyter_server#165

Proposed Solution

Add the auth handling here as well.

Description

We weren't able to publish 0.2.0

 WARNING  Error during upload. Retry with the --verbose option for more details.
ERROR    HTTPError: 400 Bad Request from https://upload.pypi.org/legacy/
         Invalid value for requires_dist. Error: Can't have direct dependency:
         "jupyter-server[test] @ git+https://github.com/Zsailer/jupyter_server.g
         it@jupyter_server_terminals ; extra == 'test'"

Description

Terminals not working when using version 0.5.0 or 0.5.1, after downgrading to 0.4.4 it works fine.
below is the error.
TypeError: object NoneType can't be used in 'await' expression

Reproduce

jupyter --versoin screenshot below. should be able to reproduce with jupyter-servier-terminals > 0.4.4
Selected Jupyter core packages...
IPython : 8.4.0
ipykernel : 6.28.0
ipywidgets : not installed
jupyter_client : 8.6.0
jupyter_core : 5.6.0
jupyter_server : 2.12.1
jupyterlab : 4.0.9
nbclient : 0.8.0
nbconvert : 7.13.1
nbformat : 5.9.2
notebook : not installed
qtconsole : not installed
traitlets : 5.14.0

Expected behavior

Termianls should work, without any issues.

Context

• Operating System and version: RHEL 7.9
• Browser and version: Chrome
• Jupyter Server version:
• Selected Jupyter core packages...
  IPython : 8.4.0
  ipykernel : 6.28.0
  ipywidgets : not installed
  jupyter_client : 8.6.0
  jupyter_core : 5.6.0
  jupyter_server : 2.12.1
  jupyterlab : 4.0.9
  nbclient : 0.8.0
  nbconvert : 7.13.1
  nbformat : 5.9.2
  notebook : not installed
  qtconsole : not installed
  traitlets : 5.14.0

Description

I reran https://github.com/jupyter-server/jupyter_server_terminals/runs/4960949698?check_suite_focus=true, which had originally passed. It might be related to the 2.0.1 pywinpty release.

I confirmed that pinning to pywintpy<2 allows us to cull again. Merging #6 with a workaround for now.

Problem

When creating terminals via the REST api (i.e. a POST request to /api/terminals) the terminal name/id is an incrementing integer. For my use case I would like to control the names/ids of the terminals for organizational purposes.

Proposed Solution

I believe the solution is would be an easy update to the /api/terminals POST request by adding the ability to override the terminal name/id in the body of the request. Alternatively you could provide a /api/terminals/{terminal id} POST endpoint for creating named terminals.

Description

The jupyter server terminal is not disabled on jupyterhub after setting the jupyter_server_config.py like so:

c.ServerApp.terminals_enabled = False

I can confirm that the configuration is acknowledged by the jupyter server by executing the following command jupyter server --show-config which outputs:

...
Loaded config files:
  /Users/rprater/.jupyter/jupyter_server_config.py

ServerApp
  .jpserver_extensions = <LazyConfigValue value={'jupyter_lsp': True, 'jupyter_server_terminals': True, 'jupyterlab': True, 'nbclassic': True, 'notebook_shim': True}>
  .terminals_enabled = False # <--- acknowledged 

Reproduce

python -m venv venv
source venv/bin/activate
pip install jupyterhub jupyterlab notebook
jupyter server --generate-config
# Edit jupyter_server_config file as described above
jupyterhub

Context

I can confirm this issue does not occur if I pin the jupyter_server package to less than version 2.

Looking at the source code this may make sense, the value gets hard coded here.