Merge pull request #36 from bollwyvl/fix/static-urls

Dynamically change static url, test with ssl and prefix

Author: bollwyvl

jyve/exporter.py

@@ -37,11 +37,13 @@ class JyveExporter(HTMLExporter):
             "favicon.ico",
             "api/contents/",
             "lab/api/settings/@jupyterlab/apputils-extension:themes",
+            "lab/api/settings/@jupyterlab/application-extension:sidebar",
             "lab/api/settings/@jupyterlab/codemirror-extension:commands",
             "lab/api/settings/@jupyterlab/docmanager-extension:plugin",
             "lab/api/settings/@jupyterlab/fileeditor-extension:plugin",
             "lab/api/settings/@jupyterlab/notebook-extension:tracker",
             "lab/api/settings/@jupyterlab/shortcuts-extension:plugin",
+            "lab/api/settings/@jupyterlab/extensionmanager-extension:plugin",
         ],
         help="additional notebook urls to cache",
         config=True,
@@ -55,6 +57,8 @@ class JyveExporter(HTMLExporter):
         {
             "api/sessions": [],
             "api/terminals": [],
+            "api/nbconvert": {},
+            "lab/api/workspaces": {"workspaces": []},
             "api/kernelspecs": {
                 "default": "python3",
                 "kernelspecs": {
@@ -84,32 +88,32 @@ class JyveExporter(HTMLExporter):
         {
             "buildAvailable": "False",
             "buildCheck": "False",
+            "quit_button": "False",
             "token": "",
             "devMode": "False",
             "terminalsAvailable": "False",
             "ignorePlugins": "[]",
             "serverRoot": "~/jyve",
             "mathjaxConfig": "TeX-AMS-MML_HTMLorMML-full,Safe",
-            "mathjaxUrl": "../static/components/MathJax/MathJax.js",
+            "mathjaxUrl": "static/components/MathJax/MathJax.js",
             "appName": "JupyterLab Beta",
             "appNamespace": "jupyterlab",
             "appSettingsDir": "~/jyve/settings",
             "appVersion": jupyterlab.__version__,
             "cacheFiles": "True",
-            "pageUrl": "./lab",
-            "publicUrl": "../lab/static/",
+            "pageUrl": "/lab",
+            "publicUrl": "/lab/static/",
             "schemasDir": "~/jyve/schemas/",
-            "settingsUrl": "../lab/api/settings/",
+            "settingsUrl": "/lab/api/settings/",
             "staticDir": "~/jyve/static",
             "templatesDir": "~/jyve/templates",
             "themesDir": "~/jyve/themes/",
             "themesUrl": "/lab/api/themes/",
-            "treeUrl": "../lab/tree/",
+            "treeUrl": "/lab/tree/",
             "userSettingsDir": "~/jyve/lab/user-settings",
             "workspacesDir": "~/jyve/lab/workspaces",
-            "workspacesUrl": "../lab/workspaces/",
-            "workspacesApiUrl": "../api/workspaces/",
-            "baseUrl": "../",
+            "workspacesUrl": "/lab/workspaces/",
+            "workspacesApiUrl": "/api/workspaces/",
             "wsUrl": "",
             "jyveOffline": True,
         },
@@ -291,9 +295,26 @@ def fix_index(self, output_root):
 
         list(output_root.glob("lab*token*"))[0].rename(index)
 
+        # we dynamically update the script tag with the proper base url
+        script_content = """
+        <script type="text/javascript">;(function(){
+            var config = %s;
+            config.baseUrl = window.location.pathname.replace(/lab\/$/, '');
+            config.mathjaxUrl = config.baseUrl + config.mathjaxUrl;
+            var script = document.createElement("script");
+            script.id = "jupyter-config-data";
+            script.type = "application/json";
+            script.textContent = JSON.stringify(config);
+            debugger;
+            document.head.appendChild(script);
+        })();</script>
+        """ % json.dumps(
+            self.jupyter_config_data, indent=2
+        )
+
         new_idx = re.sub(
             '(<script.*?id="jupyter-config-data".*?>).*?(</script>)',
-            "\\1\n{}\n</script>".format(json.dumps(self.jupyter_config_data, indent=2)),
+            script_content,
             index.read_text(),
             flags=re.M | re.S,
         )
@@ -354,5 +375,5 @@ def fake_home(self, output_root):
         index = Path(output_root) / "index.html"
         index.write_text(
             """<!DOCTYPE html>\n"""
-            """<meta http-equiv="refresh" content="0; URL=./lab" />"""
+            """<meta http-equiv="refresh" content="0; URL=./lab/" />"""
         )

package.json

@@ -37,11 +37,13 @@
     "bootstrap": "jlpm --no-optional && jlpm clean && jlpm lint && jlpm lerna bootstrap && jlpm build && jlpm lab:link",
     "build": "jlpm build:core && jlpm build:js && jlpm build:kyrnel && jlpm build:lyb",
     "build:core": "lerna run build --scope '@deathbeds/jyve' --stream",
-    "build:demo": "mkdir -p index_files _demo && rm -rf index_files/* && jupyter nbconvert --to=jyve index.ipynb --JyveExporter.extra_contents='[\"notebooks/*.ipynb\"]' && cp -r index_files/* _demo/",
+    "build:demo": "mkdir -p index_files demo && rm -rf {index_files,demo}/* && jupyter nbconvert --to=jyve index.ipynb --JyveExporter.extra_contents='[\"notebooks/*.ipynb\"]' && cp -r index_files/* demo/",
     "build:js": "lerna run build --scope '@deathbeds/jyve-kyrnel-js-unsafe' --stream",
     "build:kyrnel": "lerna run build --scope '@deathbeds/jyve-kyrnel-*' --stream",
     "build:lyb": "lerna run build --scope '@deathbeds/jyve-lyb-*' --stream",
     "clean": "lerna run --parallel clean --stream",
+    "demo": "jlpm build:demo && jlpm demo:serve",
+    "demo:serve": "python scripts/serve_demo.py",
     "lab:dupes": "cd $CONDA_PREFIX/share/jupyter/lab/staging/build && webpack-stats-duplicates stats.json",
     "lab:link": "lerna exec --concurrency 1 --stream -- jupyter labextension link . --no-build --debug",
     "lab:stats": "cd $CONDA_PREFIX/share/jupyter/lab/staging && mkdir -p build && ./node_modules/.bin/webpack --config webpack.prod.config.js --profile --json > stats.json && mv stats.json build/",

scripts/demo.sh renamed to scripts/build_demo.sh

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from OpenSSL import crypto
+
+from tornado import web, ioloop
+
+
+PORT = 8443
+
+
+def make_ssl_options(cert_path):
+    # create a key pair
+    key = crypto.PKey()
+    key.generate_key(crypto.TYPE_RSA, 1024)
+
+    # create a self-signed cert
+    cert = crypto.X509()
+    subj = cert.get_subject()
+    subj.C = "US"
+    subj.ST = "GA"
+    subj.L = "ATL"
+    subj.O = "Dead Pixels Collection"
+    subj.OU = "deathbeds"
+    subj.CN = "jyve"
+
+    cert.set_serial_number(1000)
+    cert.gmtime_adj_notBefore(0)
+    cert.gmtime_adj_notAfter(10 * 365 * 24 * 60 * 60)
+    cert.set_issuer(subj)
+    cert.set_pubkey(key)
+    cert.sign(key, "sha256")
+
+    certfile = cert_path / "jyve.crt"
+    keyfile = cert_path / "jyve.key"
+
+    certfile.write_bytes(crypto.dump_certificate(crypto.FILETYPE_PEM, cert))
+    keyfile.write_bytes(crypto.dump_privatekey(crypto.FILETYPE_PEM, key))
+
+    return dict(
+        certfile=str(certfile),
+        keyfile=str(keyfile)
+    )
+
+
+class IndexHandler(web.StaticFileHandler):
+    def parse_url_path(self, url_path):
+        if not url_path or url_path[-1] == "/":
+            url_path += "index.html"
+        return url_path
+
+
+if __name__ == "__main__":
+    with TemporaryDirectory() as td:
+        web.Application(
+            handlers=[
+                (r"^/d/e/m/o/(.*)", IndexHandler,
+                 dict(path="demo"))
+            ],
+            debug=True
+        ).listen(PORT, ssl_options=make_ssl_options(Path(td)))
+        print(f"Listening on https://localhost:{PORT}/d/e/m/o/")
+        ioloop.IOLoop.instance().start()

scripts/serve_demo.py

@@ -4,9 +4,9 @@ Library           Process
 Resource          Lab.robot
 
 *** Variables ***
-${DEMO_CMD}       ./scripts/demo.sh
-${HTTP_CMD}       python -m http.server --bind 127.0.0.1 19980
-${DEMO_URL}       http://127.0.0.1:19980/
+${DEMO_CMD}       ./scripts/build_demo.sh
+${HTTPS_CMD}      python ./scripts/serve_demo.py
+${DEMO_URL}       https://127.0.0.1:8443/d/e/m/o/
 
 *** Keywords ***
 Rebuild the Jyve Demo
@@ -18,7 +18,8 @@ Rebuild the Jyve Demo
 
 Start the Jyve Demo
     [Documentation]    Serve the static demo
-    Start Process    ${HTTP_CMD}    shell=true    cwd=demo
+    Start Process    ${HTTPS_CMD}    shell=true    stderr=STDOUT    stdout=${OUTPUT_DIR}/demo.log
+
 
 Open the Jyve Demo with
     [Arguments]    ${browser}

tests/resources/Jyve.robot

@@ -7,7 +7,7 @@ Library           OperatingSystem
 *** Variables ***
 ${CELL_CSS}       .jp-Notebook .jp-Cell:last-of-type .jp-InputArea-editor .CodeMirror
 ${TOKEN}          hopelesslyinsecure
-${LAB_CMD}        jupyter-lab --no-browser --NotebookApp.token=${TOKEN} --port 18888
+${LAB_CMD}        jupyter-lab --no-browser --NotebookApp.token=${TOKEN} --port 18888  --notebook-dir ${OUTPUT_DIR}${/}notebooks
 ${LAB_URL}        http://localhost:18888/lab?token=${TOKEN}
 ${SPLASH_ID}      jupyterlab-splash
 ${SPINNER}        css:.jp-Spinner
@@ -35,6 +35,7 @@ Launch a new
 
 Start JupyterLab
     [Documentation]    Start a Jupyter Notebook Server with JupyterLab
+    Create Directory    ${OUTPUT_DIR}${/}notebooks
     Start Process    ${LAB_CMD}    shell=true    stderr=STDOUT    stdout=${OUTPUT_DIR}/lab.log
 
 Click JupyterLab Menu