Merge pull request #151 from manics/indexpage

Optionally map requested → proxied paths

Author: ryanlovett

docs/server-process.rst

@@ -90,6 +90,13 @@ pairs.
      automatically select an unused port.
 
 
+#. **mappath**
+
+     Map request paths to proxied paths.
+     Either a dictionary of request paths to proxied paths,
+     or a callable that takes parameter ``path`` and returns the proxied path.
+
+
 #. **launcher_entry**
 
    A dictionary with options on if / how an entry in the classic Jupyter Notebook

jupyter_server_proxy/config.py

@@ -9,7 +9,7 @@
 from collections import namedtuple
 from .utils import call_with_asked_args
 
-def _make_serverproxy_handler(name, command, environment, timeout, absolute_url, port):
+def _make_serverproxy_handler(name, command, environment, timeout, absolute_url, port, mappath):
     """
     Create a SuperviseAndProxyHandler subclass with given parameters
     """
@@ -21,6 +21,7 @@ def __init__(self, *args, **kwargs):
             self.proxy_base = name
             self.absolute_url = absolute_url
             self.requested_port = port
+            self.mappath = mappath
 
         @property
         def process_args(self):
@@ -82,6 +83,7 @@ def make_handlers(base_url, server_processes):
             sp.timeout,
             sp.absolute_url,
             sp.port,
+            sp.mappath,
         )
         handlers.append((
             ujoin(base_url, sp.name, r'(.*)'), handler, dict(state={}),
@@ -93,7 +95,7 @@ def make_handlers(base_url, server_processes):
 
 LauncherEntry = namedtuple('LauncherEntry', ['enabled', 'icon_path', 'title'])
 ServerProcess = namedtuple('ServerProcess', [
-    'name', 'command', 'environment', 'timeout', 'absolute_url', 'port', 'launcher_entry'])
+    'name', 'command', 'environment', 'timeout', 'absolute_url', 'port', 'mappath', 'launcher_entry'])
 
 def make_server_process(name, server_process_config):
     le = server_process_config.get('launcher_entry', {})
@@ -104,6 +106,7 @@ def make_server_process(name, server_process_config):
         timeout=server_process_config.get('timeout', 5),
         absolute_url=server_process_config.get('absolute_url', False),
         port=server_process_config.get('port', 0),
+        mappath=server_process_config.get('mappath', {}),
         launcher_entry=LauncherEntry(
             enabled=le.get('enabled', True),
             icon_path=le.get('icon_path'),
@@ -144,6 +147,11 @@ class ServerProxy(Configurable):
           port
             Set the port that the service will listen on. The default is to automatically select an unused port.
 
+          mappath
+            Map request paths to proxied paths.
+            Either a dictionary of request paths to proxied paths,
+            or a callable that takes parameter ``path`` and returns the proxied path.
+
           launcher_entry
             A dictionary of various options for entries in classic notebook / jupyterlab launchers.
 

jupyter_server_proxy/handlers.py

@@ -16,6 +16,7 @@
 from notebook.utils import url_path_join
 from notebook.base.handlers import IPythonHandler, utcnow
 
+from .utils import call_with_asked_args
 from .websocket import WebSocketHandlerMixin, pingable_ws_connect
 from simpervisor import SupervisedProcess
 
@@ -44,7 +45,7 @@ def __init__(self, *args, **kwargs):
         self.absolute_url = kwargs.pop('absolute_url', False)
         super().__init__(*args, **kwargs)
 
-    # Support all the methods that torando does by default except for GET which
+    # Support all the methods that tornado does by default except for GET which
     # is passed to WebSocketHandlerMixin and then to WebSocketHandler.
 
     async def open(self, port, proxied_path):
@@ -340,6 +341,7 @@ class SuperviseAndProxyHandler(LocalProxyHandler):
 
     def __init__(self, *args, **kwargs):
         self.requested_port = 0
+        self.mappath = {}
         super().__init__(*args, **kwargs)
 
     def initialize(self, state):
@@ -435,6 +437,11 @@ async def ensure_process(self):
     async def proxy(self, port, path):
         if not path.startswith('/'):
             path = '/' + path
+        if self.mappath:
+            if callable(self.mappath):
+                path = call_with_asked_args(self.mappath, {'path': path})
+            else:
+                path = self.mappath.get(path, path)
 
         await self.ensure_process()
 

tests/resources/jupyter_server_config.py

@@ -1,3 +1,7 @@
+def mappathf(path):
+    p = path + 'mapped'
+    return p
+
 c.ServerProxy.servers = {
     'python-http': {
         'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
@@ -10,6 +14,16 @@
         'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
         'port': 54321,
     },
+    'python-http-mappath': {
+        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'mappath': {
+            '/': '/index.html',
+        }
+    },
+    'python-http-mappathf': {
+        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'mappath': mappathf,
+    },
 }
 
 import sys

tests/test_proxies.py

@@ -1,13 +1,18 @@
 import os
 from http.client import HTTPConnection
+import pytest
 
 PORT = os.getenv('TEST_PORT', 8888)
 TOKEN = os.getenv('JUPYTER_TOKEN', 'secret')
 
 
 def request_get(port, path, token, host='localhost'):
     h = HTTPConnection(host, port, 10)
-    h.request('GET', '{}?token={}'.format(path, token))
+    if '?' in path:
+        url = '{}&token={}'.format(path, token)
+    else:
+        url = '{}?token={}'.format(path, token)
+    h.request('GET', url)
     return h.getresponse()
 
 
@@ -58,6 +63,39 @@ def test_server_proxy_port_absolute():
     assert 'X-Forwarded-Context' not in s
     assert 'X-Proxycontextpath' not in s
 
+
+@pytest.mark.parametrize(
+    "requestpath,expected", [
+        ('/', '/index.html?token='),
+        ('/?q=1', '/index.html?q=1&token='),
+        ('/pqr?q=2', '/pqr?q=2&token='),
+    ]
+)
+def test_server_proxy_mappath_dict(requestpath, expected):
+    r = request_get(PORT, '/python-http-mappath' + requestpath, TOKEN)
+    assert r.code == 200
+    s = r.read().decode('ascii')
+    assert s.startswith('GET ' + expected)
+    assert 'X-Forwarded-Context: /python-http-mappath\n' in s
+    assert 'X-Proxycontextpath: /python-http-mappath\n' in s
+
+
+@pytest.mark.parametrize(
+    "requestpath,expected", [
+        ('/', '/mapped?token='),
+        ('/?q=1', '/mapped?q=1&token='),
+        ('/stu?q=2', '/stumapped?q=2&token='),
+    ]
+)
+def test_server_proxy_mappath_callable(requestpath, expected):
+    r = request_get(PORT, '/python-http-mappathf' + requestpath, TOKEN)
+    assert r.code == 200
+    s = r.read().decode('ascii')
+    assert s.startswith('GET ' + expected)
+    assert 'X-Forwarded-Context: /python-http-mappathf\n' in s
+    assert 'X-Proxycontextpath: /python-http-mappathf\n' in s
+
+
 def test_server_proxy_remote():
     r = request_get(PORT, '/newproxy', TOKEN, host='127.0.0.1')
     assert r.code == 200