Merge remote-tracking branch 'origin/main'

Author: dylex

CONTRIBUTING.md

@@ -41,7 +41,7 @@ cd jupyter-server-proxy
 # Install package in development mode, with the latest Jupyter clients
 pip install -e ".[test,lab]"
 # Link your development version of the extension with JupyterLab and Notebook
-jlpm labextension develop --overwrite .
+jupyter labextension develop --overwrite .
 # Server extension must be manually installed in develop mode
 jupyter server extension enable jupyter_server_proxy
 ```

docs/source/changelog.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 4.2
+
+### v4.2.0 - 2024-06-11
+
+This release includes an important security patch for
+[CVE-2024-35225 ](https://github.com/jupyterhub/jupyter-server-proxy/security/advisories/GHSA-fvcq-4x64-hqxr).
+
+([full changelog](https://github.com/jupyterhub/jupyter-server-proxy/compare/v4.1.2...v4.2.0))
+
+#### Maintenance and upkeep improvements
+
+- Require jupyter_server 1.24+, tornado 6.1+, traitlets 5.1+ [#467](https://github.com/jupyterhub/jupyter-server-proxy/pull/467) ([@consideRatio](https://github.com/consideRatio))
+- Test against Python 3.12 [#450](https://github.com/jupyterhub/jupyter-server-proxy/pull/450) ([@consideRatio](https://github.com/consideRatio))
+
+#### Documentation improvements
+
+- Document the correct default value for new_browser_tab. [#470](https://github.com/jupyterhub/jupyter-server-proxy/pull/470) ([@ryanlovett](https://github.com/ryanlovett))
+
+#### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-server-proxy/graphs/contributors?from=2024-03-19&to=2024-06-08&type=c))
+
+[@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-server-proxy+involves%3AconsideRatio+updated%3A2024-03-19..2024-06-08&type=Issues) | [@ryanlovett](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-server-proxy+involves%3Aryanlovett+updated%3A2024-03-19..2024-06-08&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-server-proxy+involves%3Awelcome+updated%3A2024-03-19..2024-06-08&type=Issues)
+
 ## 4.1
 
 ### 4.1.2 - 2024-03-13

docs/source/server-process.md

@@ -123,9 +123,15 @@ the following keys:
    explicit entry.
 2. **icon_path**
    Full path to an svg icon that could be used with a launcher. Currently only used by the
-   JupyterLab launcher
+   JupyterLab launcher, when category is "Notebook" (default) or "Console".
 3. **title**
    Title to be used for the launcher entry. Defaults to the name of the server if missing.
+4. **path_info**
+   The trailing path that is appended to the user's server URL to access the proxied server.
+   By default it is the name of the server followed by a trailing slash.
+5. **category**
+   The category for the launcher item. Currently only used by the JupyterLab launcher.
+   By default it is "Notebook".
 
 ### `new_browser_tab`
 
@@ -151,6 +157,16 @@ One of:
 - A callable that takes any {ref}`callable arguments <server-process:callable-arguments>`,
   and returns a dictionary of strings that are used & treated same as above.
 
+### `update_last_activity`
+
+Whether to report activity from the proxy to Jupyter Server. If _True_, Jupyter Server
+will be notified of new activity. This is primarily used by JupyterHub for idle detection and culling.
+
+Useful if you want to have a seperate way of determining activity through a
+proxied application.
+
+Defaults to _True_.
+
 (server-process:callable-arguments)=
 
 ### `websockify`

jupyter_server_proxy/api.py

@@ -22,6 +22,7 @@ async def get(self):
                     "enabled": sp.launcher_entry.enabled,
                     "title": sp.launcher_entry.title,
                     "path_info": sp.launcher_entry.path_info,
+                    "category": sp.launcher_entry.category,
                 },
                 "new_browser_tab": sp.new_browser_tab,
             }

jupyter_server_proxy/config.py

@@ -1,6 +1,7 @@
 """
 Traitlets based configuration for jupyter_server_proxy
 """
+
 import sys
 from collections import namedtuple
 from warnings import warn
@@ -25,7 +26,7 @@
 
 
 LauncherEntry = namedtuple(
-    "LauncherEntry", ["enabled", "icon_path", "title", "path_info"]
+    "LauncherEntry", ["enabled", "icon_path", "title", "path_info", "category"]
 )
 ServerProcess = namedtuple(
     "ServerProcess",
@@ -42,6 +43,7 @@
         "new_browser_tab",
         "request_headers_override",
         "rewrite_response",
+        "update_last_activity",
         "websockify",
     ],
 )
@@ -83,6 +85,7 @@ def __init__(self, *args, **kwargs):
                 self.unix_socket = sp.unix_socket
             self.mappath = sp.mappath
             self.rewrite_response = sp.rewrite_response
+            self.update_last_activity = sp.update_last_activity
 
         def get_request_headers_override(self):
             return self._realize_rendered_template(sp.request_headers_override)
@@ -101,7 +104,11 @@ def get_entrypoint_server_processes(serverproxy_config):
     sps = []
     for entry_point in entry_points(group="jupyter_serverproxy_servers"):
         name = entry_point.name
-        server_process_config = entry_point.load()()
+        try:
+            server_process_config = entry_point.load()()
+        except Exception as e:
+            warn(f"entry_point {name} was unable to be loaded: {str(e)}")
+            continue
         sps.append(make_server_process(name, server_process_config, serverproxy_config))
     return sps
 
@@ -142,6 +149,7 @@ def make_server_process(name, server_process_config, serverproxy_config):
             icon_path=le.get("icon_path"),
             title=le.get("title", name),
             path_info=le.get("path_info", name + "/"),
+            category=le.get("category", "Notebook"),
         ),
         new_browser_tab=server_process_config.get("new_browser_tab", True),
         request_headers_override=server_process_config.get(
@@ -151,6 +159,9 @@ def make_server_process(name, server_process_config, serverproxy_config):
             "rewrite_response",
             tuple(),
         ),
+        update_last_activity=server_process_config.get(
+            "update_last_activity", True
+        ),
         websockify=server_process_config.get("websockify", False),
     )
 
@@ -225,6 +236,10 @@ class ServerProxy(Configurable):
                 The trailing path that is appended to the user's server URL to access the proxied server.
                 By default it is the name of the server followed by a trailing slash.
 
+              category
+                The category for the launcher item. Currently only used by the JupyterLab launcher.
+                By default it is "Notebook".
+
           new_browser_tab
             Set to True (default) to make the proxied server interface opened as a new browser tab. Set to False
             to have it open a new JupyterLab tab. This has no effect in classic notebook.
@@ -268,6 +283,9 @@ def cats_only(response, path):
             instead of "dogs not allowed".
 
             Defaults to the empty tuple ``tuple()``.
+ 
+          update_last_activity
+            Will cause the proxy to report activity back to jupyter server.
 
           websockify
             Proxy websocket requests as a TCP (or unix socket) stream.

jupyter_server_proxy/handlers.py

@@ -117,6 +117,7 @@ def __init__(self, *args, **kwargs):
             tuple(),
         )
         self._requested_subprotocols = None
+        self.update_last_activity = kwargs.pop("update_last_activity", True)
         super().__init__(*args, **kwargs)
 
     # Support/use jupyter_server config arguments allow_origin and allow_origin_pat
@@ -234,7 +235,8 @@ def _record_activity(self):
         avoids proxied traffic being ignored by the notebook's
         internal idle-shutdown mechanism
         """
-        self.settings["api_last_activity"] = utcnow()
+        if self.update_last_activity:
+            self.settings["api_last_activity"] = utcnow()
 
     def _get_context_path(self, host, port):
         """
@@ -323,14 +325,11 @@ async def proxy(self, host, port, proxied_path):
         """
 
         if not self._check_host_allowlist(host):
-            self.set_status(403)
-            self.write(
-                "Host '{host}' is not allowed. "
-                "See https://jupyter-server-proxy.readthedocs.io/en/latest/arbitrary-ports-hosts.html for info.".format(
-                    host=host
-                )
+            raise web.HTTPError(
+                403,
+                f"Host '{host}' is not allowed. "
+                "See https://jupyter-server-proxy.readthedocs.io/en/latest/arbitrary-ports-hosts.html for info.",
             )
-            return
 
         # Remove hop-by-hop headers that don't necessarily apply to the request we are making
         # to the backend. See https://github.com/jupyterhub/jupyter-server-proxy/pull/328
@@ -391,9 +390,7 @@ async def proxy(self, host, port, proxied_path):
             # Ref: https://www.tornadoweb.org/en/stable/httpclient.html#tornado.httpclient.AsyncHTTPClient.fetch
             if err.code == 599:
                 self._record_activity()
-                self.set_status(599)
-                self.write(str(err))
-                return
+                raise web.HTTPError(599, str(err))
             else:
                 raise
 
@@ -402,8 +399,7 @@ async def proxy(self, host, port, proxied_path):
 
         # For all non http errors...
         if response.error and type(response.error) is not httpclient.HTTPError:
-            self.set_status(500)
-            self.write(str(response.error))
+            raise web.HTTPError(500, str(response.error))
         else:
             # Represent the original response as a RewritableResponse object.
             original_response = RewritableResponse(orig_response=response)

labextension/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterhub/jupyter-server-proxy",
-  "version": "4.1.3-0.dev",
+  "version": "4.2.1-0.dev",
   "description": "A JupyterLab extension accompanying the PyPI package jupyter-server-proxy adding launcher items for configured server processes.",
   "keywords": [
     "jupyter",

labextension/src/index.ts

@@ -202,7 +202,7 @@ async function activate(
       launcher.add({
         command: CommandIDs.open,
         args: argsForServer(server_process),
-        category: "Notebook",
+        category: launcher_entry.category,
         kernelIconUrl: launcher_entry.icon_url || void 0,
       });
     }

labextension/src/tokens.ts

@@ -102,4 +102,5 @@ export interface ILauncherEntry {
   path_info: string;
   // the `?` means this argument may not exist, but if it does, it must be a string
   icon_url?: string;
+  category?: string;
 }