api info file written

Author: dwsutherland

cylc/uiserver/app.py

@@ -54,7 +54,10 @@
 """
 
 from concurrent.futures import ProcessPoolExecutor
+from contextlib import suppress
 import getpass
+import json
+import os
 from pathlib import Path, PurePath
 import sys
 from typing import List
@@ -105,6 +108,9 @@
 from cylc.uiserver.workflows_mgr import WorkflowsManager
 
 
+API_INFO_FILE = f'{USER_CONF_ROOT / "api_token.json"}'
+
+
 class PathType(TraitType):
     """A pathlib traitlet type which allows string and undefined values."""
 
@@ -400,6 +406,10 @@ def initialize_settings(self):
                 for key, value in self.config['CylcUIServer'].items()
             )
         )
+        # Make API token available to server's user.
+        # Do it here to avoid overwriting via server start attempt,
+        # when server already running.
+        self.write_api_info()
         # start the async scan task running (do this on server start not init)
         ioloop.IOLoop.current().add_callback(
             self.workflows_mgr.run
@@ -505,6 +515,21 @@ def set_auth(self):
     def initialize_templates(self):
         """Change the jinja templating environment."""
 
+    def write_api_info(self):
+        api_info = self.serverapp.server_info()
+        api_token = os.environ.get("JUPYTERHUB_API_TOKEN")
+        api_url = os.environ.get("JUPYTERHUB_SERVICE_URL")
+        # Could be none, if server not launched by hub.
+        if api_token:
+            api_info['token'] = api_token
+        if api_url:
+            api_info['url'] = api_url
+        with suppress(FileNotFoundError):
+            os.unlink(API_INFO_FILE)
+        fd = os.open(API_INFO_FILE, os.O_CREAT | os.O_WRONLY, mode=0o600)
+        os.write(fd, json.dumps(api_info).encode("utf-8"))
+        os.close(fd)
+
     @classmethod
     def launch_instance(cls, argv=None, **kwargs):
         if argv is None:
@@ -514,6 +539,9 @@ def launch_instance(cls, argv=None, **kwargs):
         super().launch_instance(argv=argv, **kwargs)
 
     async def stop_extension(self):
+        # Remove API token if hub spawned
+        with suppress(FileNotFoundError):
+            os.unlink(API_INFO_FILE)
         # stop the async scan task
         await self.workflows_mgr.stop()
         for sub in self.data_store_mgr.w_subs.values():