add url property to DescribeWorkflow and DescribeWorkflowDefinition

Author: andrii-i

jupyter_scheduler/extension.py

@@ -45,27 +45,27 @@ class SchedulerApp(ExtensionApp):
         (r"scheduler/job_definitions/%s/jobs" % JOB_DEFINITION_ID_REGEX, JobFromDefinitionHandler),
         (r"scheduler/runtime_environments", RuntimeEnvironmentsHandler),
         (r"scheduler/config", ConfigHandler),
-        (r"scheduler/worklows", WorkflowsHandler),
-        (rf"scheduler/worklows/{WORKFLOW_ID_REGEX}", WorkflowsHandler),
+        (r"scheduler/workflows", WorkflowsHandler),
+        (rf"scheduler/workflows/{WORKFLOW_ID_REGEX}", WorkflowsHandler),
         (
-            rf"scheduler/worklows/{WORKFLOW_ID_REGEX}/run",
+            rf"scheduler/workflows/{WORKFLOW_ID_REGEX}/run",
             WorkflowsRunHandler,
         ),
         (
-            rf"scheduler/worklows/{WORKFLOW_ID_REGEX}/tasks",
+            rf"scheduler/workflows/{WORKFLOW_ID_REGEX}/tasks",
             WorkflowsTasksHandler,
         ),
-        (r"scheduler/worklow_definitions", WorkflowDefinitionsHandler),
+        (r"scheduler/workflow_definitions", WorkflowDefinitionsHandler),
         (
-            rf"scheduler/worklow_definitions/{WORKFLOW_DEFINITION_ID_REGEX}",
+            rf"scheduler/workflow_definitions/{WORKFLOW_DEFINITION_ID_REGEX}",
             WorkflowDefinitionsHandler,
         ),
         (
-            rf"scheduler/worklow_definitions/{WORKFLOW_DEFINITION_ID_REGEX}/deploy",
+            rf"scheduler/workflow_definitions/{WORKFLOW_DEFINITION_ID_REGEX}/deploy",
             WorkflowDefinitionsDeploymentHandler,
         ),
         (
-            rf"scheduler/worklow_definitions/{WORKFLOW_DEFINITION_ID_REGEX}/tasks",
+            rf"scheduler/workflow_definitions/{WORKFLOW_DEFINITION_ID_REGEX}/tasks",
             WorkflowDefinitionsTasksHandler,
         ),
     ]

jupyter_scheduler/workflows.py

@@ -22,6 +22,8 @@
     UpdateJobDefinition,
 )
 from jupyter_scheduler.pydantic_v1 import BaseModel, ValidationError
+from urllib.parse import urlunparse
+from jupyter_server.utils import url_path_join
 
 
 class WorkflowsHandler(ExtensionHandlerMixin, JobHandlersMixin, APIHandler):
@@ -32,6 +34,13 @@ async def post(self):
             workflow_id = await ensure_async(
                 self.scheduler.create_workflow(CreateWorkflow(**payload))
             )
+
+            protocol = self.request.protocol
+            host = self.request.host
+            base_url = self.base_url
+            resource_path = url_path_join(base_url, "scheduler", "workflows", workflow_id)
+            full_url = urlunparse((protocol, host, resource_path, "", "", ""))
+
         except ValidationError as e:
             self.log.exception(e)
             raise HTTPError(500, str(e)) from e
@@ -48,7 +57,7 @@ async def post(self):
             self.log.exception(e)
             raise HTTPError(500, "Unexpected error occurred during creation of a workflow.") from e
         else:
-            self.finish(json.dumps(dict(workflow_id=workflow_id)))
+            self.finish(json.dumps(dict(workflow_id=workflow_id, url=full_url)))
 
     @authenticated
     async def get(self, workflow_id: str = None):
@@ -192,6 +201,13 @@ async def post(self):
             workflow_definition_id = await ensure_async(
                 self.scheduler.create_workflow_definition(CreateWorkflowDefinition(**payload))
             )
+            protocol = self.request.protocol
+            host = self.request.host
+            base_url = self.base_url
+            resource_path = url_path_join(
+                base_url, "scheduler", "workflow_definitions", workflow_definition_id
+            )
+            full_url = urlunparse((protocol, host, resource_path, "", "", ""))
         except ValidationError as e:
             self.log.exception(e)
             raise HTTPError(500, str(e)) from e
@@ -210,7 +226,9 @@ async def post(self):
                 500, "Unexpected error occurred during creation of a workflow definition."
             ) from e
         else:
-            self.finish(json.dumps(dict(workflow_definition_id=workflow_definition_id)))
+            self.finish(
+                json.dumps(dict(workflow_definition_id=workflow_definition_id, url=full_url))
+            )
 
     @authenticated
     async def get(self, workflow_definition_id: str = None):