Merge pull request #8223 from meeseeksmachine/auto-backport-of-pr-821…

…8-on-1.2.x

Backport PR #8218 on branch 1.2.x (Expose global app instance with command-line option)

dev_mode/index.js

@@ -156,9 +156,12 @@ function main() {
   register.forEach(function(item) { lab.registerPluginModule(item); });
   lab.start({ ignorePlugins: ignorePlugins });
 
-  // Expose global lab instance when in dev mode.
-  if ((PageConfig.getOption('devMode') || '').toLowerCase() === 'true') {
-    window.lab = lab;
+  // Expose global app instance when in dev mode or when toggled explicitly.
+  var exposeAppInBrowser = (PageConfig.getOption('exposeAppInBrowser') || '').toLowerCase() === 'true';
+  var devMode = (PageConfig.getOption('devMode') || '').toLowerCase() === 'true';
+
+  if (exposeAppInBrowser || devMode) {
+    window.jupyterlab = lab;
   }
 
   // Handle a browser test.

jupyterlab/extension.py

@@ -147,6 +147,7 @@ def load_jupyter_server_extension(nbapp):
     # Client-side code assumes notebookVersion is a JSON-encoded string
     # TODO: fix this when we can make such a change
     page_config['notebookVersion'] = dumps(version_info)
+    page_config['exposeAppInBrowser'] = getattr(nbapp, 'expose_app_in_browser', False)
 
     if nbapp.file_to_run and type(nbapp).__name__ == "LabApp":
         relpath = os.path.relpath(nbapp.file_to_run, nbapp.notebook_dir)

jupyterlab/labapp.py

@@ -320,6 +320,10 @@ def start(self):
     {'LabApp': {'watch': True}},
     "Start the app in watch mode."
 )
+lab_flags['expose-app-in-browser'] = (
+    {'LabApp': {'expose_app_in_browser': True}},
+    "Expose the global app instance to browser via window.jupyterlab"
+)
 
 
 class LabApp(NotebookApp):
@@ -400,6 +404,9 @@ class LabApp(NotebookApp):
     watch = Bool(False, config=True,
         help="Whether to serve the app in watch mode")
 
+    expose_app_in_browser = Bool(False, config=True,
+        help="Whether to expose the global app instance to browser via window.jupyterlab")
+
     def init_webapp(self, *args, **kwargs):
         super().init_webapp(*args, **kwargs)
         settings = self.web_app.settings