Make jupyter_server_proxy optional, auto-install jupyter extension

Author: jonmmease

MANIFEST.in

@@ -1,2 +1,3 @@
 recursive-include jupyter_dash/nbextension *.json
 recursive-include jupyter_dash/nbextension *.js
+recursive-include extensions/jupyterlab/*.tgz

extensions/jupyterlab/lib/index.js

@@ -10,7 +10,7 @@ class DashIFrameWidget extends widgets_1.Widget {
     /**
      * Construct a new DashIFrameWidget.
      */
-    constructor(port) {
+    constructor(port, url) {
         super();
         this.id = port;
         this.title.label = `Dash (port: ${port})`;
@@ -20,8 +20,7 @@ class DashIFrameWidget extends widgets_1.Widget {
         // See https://github.com/phosphorjs/phosphor/issues/305
         // See https://github.com/jupyterlab/jupyterlab/blob/master/packages/apputils/style/iframe.css#L17-L35
         this.addClass('jp-IFrame');
-        const baseUrl = coreutils_1.PageConfig.getBaseUrl();
-        const serviceUrl = `${baseUrl}proxy/${port}`;
+        const serviceUrl = url;
         const iframeElement = document.createElement('iframe');
         iframeElement.setAttribute('baseURI', serviceUrl);
         this.iframe = iframeElement;
@@ -67,7 +66,7 @@ function registerCommTarget(kernel, widgets, app) {
                 let widget;
                 if (!widgets.has(msgData.port)) {
                     // Create a new widget
-                    widget = new DashIFrameWidget(msgData.port);
+                    widget = new DashIFrameWidget(msgData.port, msgData.url);
                     widget.update();
                     widgets.set(msgData.port, widget);
                     // Add instance tracker stuff

extensions/jupyterlab/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-dash",
-  "version": "0.2.0-alpha.1",
+  "version": "0.2.0-alpha.2",
   "description": "A JupyterLab extensions for rendering Plotly Dash apps",
   "keywords": [
     "jupyter",

extensions/jupyterlab/src/index.ts

@@ -22,7 +22,7 @@ class DashIFrameWidget extends Widget {
   /**
    * Construct a new DashIFrameWidget.
    */
-  constructor(port: string) {
+  constructor(port: string, url: string) {
     super();
 
     this.id = port;
@@ -35,8 +35,7 @@ class DashIFrameWidget extends Widget {
     // See https://github.com/jupyterlab/jupyterlab/blob/master/packages/apputils/style/iframe.css#L17-L35
     this.addClass('jp-IFrame');
 
-    const baseUrl = PageConfig.getBaseUrl();
-    const serviceUrl = `${baseUrl}proxy/${port}`;
+    const serviceUrl = url;
     const iframeElement = document.createElement('iframe');
     iframeElement.setAttribute('baseURI', serviceUrl);
     this.iframe = iframeElement;
@@ -62,6 +61,7 @@ class DashIFrameWidget extends Widget {
 interface DashMessageData {
   type: string;
   port: string;
+  url: string;
 }
 
 function activate(
@@ -110,7 +110,7 @@ function registerCommTarget(
           let widget: DashIFrameWidget;
           if (!widgets.has(msgData.port)) {
             // Create a new widget
-            widget = new DashIFrameWidget(msgData.port);
+            widget = new DashIFrameWidget(msgData.port, msgData.url);
             widget.update();
             widgets.set(msgData.port, widget);
 

jupyter_dash/__init__.py

@@ -11,3 +11,6 @@ def _jupyter_nbextension_paths():
             "require": "jupyter_dash/main",
         }
     ]
+
+
+__labextension_version__ = "v0.2.0-alpha.2"

jupyter_dash/comms.py

@@ -30,7 +30,7 @@ def _jupyter_comm_response_received():
     return bool(_jupyter_config)
 
 
-def _request_jupyter_proxy_config(timeout=2):
+def _request_jupyter_config(timeout=2):
     # Heavily inspired by implementation of CaptureExecution in the
     if _dash_comm.kernel is None:
         # Not in jupyter server setting
@@ -61,7 +61,7 @@ def capture_event(stream, ident, parent):
             # give up
             raise EnvironmentError(
                 "Unable to communicate with the jupyter_dash notebook or JupyterLab \n"
-                "extension required to infer proxy configuration."
+                "extension required to infer Jupyter configuration."
             )
         if _jupyter_comm_response_received():
             break

jupyter_dash/jupyter_app.py

@@ -8,20 +8,13 @@
 
 
 from IPython.display import IFrame, display
-from .comms import _dash_comm, _jupyter_config, _request_jupyter_proxy_config
+from .comms import _dash_comm, _jupyter_config, _request_jupyter_config
 
 
 class JupyterDash(dash.Dash):
     @classmethod
-    def infer_jupyter_proxy_config(cls):
-        try:
-            import jupyter_server_proxy
-        except Exception:
-            raise ImportError(
-                "The infer_jupyter_proxy_config function requires the "
-                "jupyter_server_proxy Python package"
-            )
-        _request_jupyter_proxy_config()
+    def infer_jupyter_config(cls):
+        _request_jupyter_config()
 
     def __init__(self, server_url=None, **kwargs):
 
@@ -30,12 +23,19 @@ def __init__(self, server_url=None, **kwargs):
         self.default_requests_pathname_prefix = None
         self.default_mode = 'external'
 
-        if 'base_subpath' in _jupyter_config:
+        # See if jupyter_server_proxy is installed
+        try:
+            import jupyter_server_proxy
+            self._server_proxy = True
+        except Exception:
+            self._server_proxy = False
+
+        if 'base_subpath' in _jupyter_config and self._server_proxy:
             self.default_requests_pathname_prefix = (
                 _jupyter_config['base_subpath'].rstrip('/') + '/proxy/{port}/'
             )
 
-        if 'server_url' in _jupyter_config:
+        if 'server_url' in _jupyter_config and self._server_proxy:
             self.default_server_url = _jupyter_config['server_url']
 
         if 'frontend' in _jupyter_config:
@@ -206,7 +206,8 @@ def wait_for_app():
             # Update front-end extension
             _dash_comm.send({
                 'type': 'show',
-                'port': port
+                'port': port,
+                'url': dashboard_url,
             })
 
     @classmethod

setup.py

@@ -1,5 +1,7 @@
 from setuptools import setup
 
+from jupyter_dash import __labextension_version__
+
 setup(
     name='jupyter-dash',
     version='0.0.1a1',
@@ -13,9 +15,15 @@
         ("share/jupyter/nbextensions/jupyter_dash", [
             "jupyter_dash/nbextension/main.js",
         ]),
-         # like `jupyter nbextension enable --sys-prefix`
+        # like `jupyter nbextension enable --sys-prefix`
         ("etc/jupyter/nbconfig/notebook.d", [
             "jupyter_dash/nbextension/jupyter_dash.json"
         ]),
+        # Place jupyterlab extension in extension directory
+        ("share/jupyter/lab/extensions", [
+            "extensions/jupyterlab/jupyterlab-dash-{ver}.tgz".format(
+                ver=__labextension_version__
+            )
+        ]),
     ]
 )