Get deployment status with request user's id token (#735)

Should fix Ready status updates for tool deployments

Author: andyhd

controlpanel/api/cluster.py

@@ -395,9 +395,9 @@ def deploy_tool(tool, user, **kwargs):
         raise ToolDeploymentError(error)
 
 
-def list_tool_deployments(user, search_name=None, search_version=None):
+def list_tool_deployments(user, id_token=None, search_name=None, search_version=None):
     deployments = []
-    k8s = KubernetesClient()
+    k8s = KubernetesClient(id_token=id_token)
     results = k8s.AppsV1Api.list_namespaced_deployment(user.k8s_namespace)
     for deployment in results.items:
         app_name = deployment.metadata.labels["app"]
@@ -410,11 +410,12 @@ def list_tool_deployments(user, search_name=None, search_version=None):
     return deployments
 
 
-def get_tool_deployment(tool_deployment):
+def get_tool_deployment(tool_deployment, **kwargs):
     deployments = list_tool_deployments(
         tool_deployment.user,
         search_name=tool_deployment.tool.chart_name,
         # search_version=tool_deployment.tool.version,
+        **kwargs,
     )
 
     if not deployments:
@@ -427,17 +428,17 @@ def get_tool_deployment(tool_deployment):
     return deployments[0]
 
 
-def delete_tool_deployment(tool_deployment):
-    deployment = get_tool_deployment(tool_deployment)
+def delete_tool_deployment(tool_deployment, **kwargs):
+    deployment = get_tool_deployment(tool_deployment, **kwargs)
     helm.delete(
         deployment.metadata.name,
         f"--namespace={tool_deployment.user.k8s_namespace}",
     )
 
 
-def get_tool_deployment_status(tool_deployment):
+def get_tool_deployment_status(tool_deployment, **kwargs):
     try:
-        deployment = get_tool_deployment(tool_deployment)
+        deployment = get_tool_deployment(tool_deployment, **kwargs)
 
     except ObjectDoesNotExist:
         log.warning(f"{tool_deployment} not found")
@@ -470,8 +471,8 @@ def get_tool_deployment_status(tool_deployment):
     )
     return TOOL_STATUS_UNKNOWN
 
-def restart_tool_deployment(tool_deployment):
-    k8s = KubernetesClient()
+def restart_tool_deployment(tool_deployment, id_token=None):
+    k8s = KubernetesClient(id_token=id_token)
     return k8s.AppsV1Api.delete_collection_namespaced_replica_set(
         tool_deployment.user.k8s_namespace,
         label_selector=(

controlpanel/api/models/tool.py

@@ -74,6 +74,7 @@ class ToolDeployment:
     objects = ToolDeploymentManager()
 
     def __init__(self, tool, user):
+        self._id_token = None
         self._subprocess = None
         self.tool = tool
         self.user = user
@@ -95,6 +96,7 @@ def save(self, *args, **kwargs):
         """
         Deploy the tool to the cluster (asynchronous)
         """
+        self._id_token = kwargs.get('id_token')
         self._subprocess = cluster.deploy_tool(self.tool, self.user)
 
     @property
@@ -109,7 +111,10 @@ def status(self):
             if status:
                 return status
 
-        return cluster.get_tool_deployment_status(self)
+        return cluster.get_tool_deployment_status(
+            self,
+            id_token=self._id_token,
+        )
 
     def _poll(self):
         """
@@ -129,9 +134,13 @@ def _poll(self):
     def url(self):
         return f"https://{self.host}/"
 
-    def restart(self):
+    def restart(self, **kwargs):
         """
         Restart the tool deployment
         """
-        cluster.restart_tool_deployment(self)
+        self._id_token = kwargs.get('id_token')
+        cluster.restart_tool_deployment(
+            self,
+            id_token=self._id_token,
+        )
 

controlpanel/frontend/consumers.py

@@ -106,16 +106,13 @@ def tool_deploy(self, message):
         Expects a message with `tool_name`, `version` and `user_id` values
         """
 
-        tool = Tool.objects.get(
-            chart_name=message['tool_name'],
-            # version=message['version'],
-        )
-        user = User.objects.get(auth0_id=message['user_id'])
+        tool, user = self.get_tool_and_user(message)
 
         update_tool_status(user, tool, TOOL_DEPLOYING)
 
         try:
-            deployment = ToolDeployment.objects.create(tool, user)
+            deployment = ToolDeployment(tool, user)
+            deployment.save(id_token=message.get('id_token'))
 
         except ToolDeployment.Error as err:
             update_tool_status(user, tool, TOOL_DEPLOY_FAILED)
@@ -130,16 +127,15 @@ def tool_deploy(self, message):
             log.debug(f"Deployed {tool.name} for {user}")
 
     def tool_restart(self, message):
-        tool = Tool.objects.get(
-            chart_name=message['tool_name'],
-            # version=message['version'],
-        )
-        user = User.objects.get(auth0_id=message['user_id'])
+        """
+        Restart the named tool for the specified user
+        """
+        tool, user = self.get_tool_and_user(message)
 
         update_tool_status(user, tool, "Restarting")
 
         deployment = ToolDeployment(tool, user)
-        deployment.restart()
+        deployment.restart(id_token=message.get('id_token'))
 
         status = wait_for_deployment(user, tool, deployment)
 
@@ -148,6 +144,14 @@ def tool_restart(self, message):
         else:
             log.debug(f"Restarted {tool.name} for {user}")
 
+    def get_tool_and_user(self, message):
+        tool = Tool.objects.get(
+            chart_name=message['tool_name'],
+            # version=message['version'],
+        )
+        user = User.objects.get(auth0_id=message['user_id'])
+        return tool, user
+
 
 def send_sse(user_id, event):
     """

controlpanel/frontend/static/javascripts/modules/tool-status.js

@@ -38,10 +38,10 @@ moj.Modules.toolStatus = {
           break;
         case 'READY':
         case 'IDLED':
-          this.showActions(listener, ['open', 'remove']);
+          this.showActions(listener, ['open', 'restart', 'remove']);
           break;
         case 'FAILED':
-          this.showActions(listener, ['reset', 'remove']);
+          this.showActions(listener, ['restart', 'remove']);
           break;
       }
     };

controlpanel/frontend/views/tool.py

@@ -46,6 +46,7 @@ def get_redirect_url(self, *args, **kwargs):
             'tool_name': name,
             # 'version': self.request.POST['version'],
             'user_id': self.request.user.id,
+            'id_token': self.request.user.get_id_token(),
         })
 
         messages.success(
@@ -64,6 +65,7 @@ def get_redirect_url(self, *args, **kwargs):
         start_background_task('tool.restart', {
             'tool_name': name,
             'user_id': self.request.user.id,
+            'id_token': self.request.user.get_id_token(),
         })
 
         messages.success(