Add async starlark logs

kurtosis-tech · Nov 29, 2023 · ade15b7 · ade15b7
1 parent f46d4b9
commit ade15b7
Show file tree

Hide file tree

Showing 9 changed files with 557 additions and 229 deletions.
diff --git a/api/golang/http_rest/api_types/api_types.gen.go b/api/golang/http_rest/api_types/api_types.gen.go
diff --git a/api/golang/http_rest/core_rest_api/api_container_server.gen.go b/api/golang/http_rest/core_rest_api/api_container_server.gen.go
diff --git a/api/golang/http_rest/websocket_api/websocket_server.gen.go b/api/golang/http_rest/websocket_api/websocket_server.gen.go
diff --git a/api/openapi/specs/api_types.yaml b/api/openapi/specs/api_types.yaml
@@ -41,6 +41,14 @@ components:
       description: The service identifier of the container that the command should be executed in
       required: true
 
+    starlark_execution_uuid:
+      name: starlark_execution_uuid
+      in: path
+      schema:
+        type: string
+      description: The unique identifier to track the execution of a Starlark script or package
+      required: true
+
     service_uuid_set:
       name: service_uuid_set
       in: query
@@ -49,6 +57,14 @@ components:
         type: array
         items:
           type: string
+
+    retrieve_logs_async:
+      name: retrieve_logs_async
+      in: query
+      required: false
+      description: If false, block http response until all logs are available. Default is true
+      schema:
+        type: boolean
 
     remove_all:
       name: remove_all
@@ -537,6 +553,13 @@ components:
       description: |-
         0 - NO_INSTRUCTIONS_CACHING
 
+    StarlarkRunLogs:
+      type: array
+      items:
+        $ref: "#/components/schemas/StarlarkRunResponseLine"
+      description: |-
+        Starlark Execution Logs
+
     StarlarkRunResponseLine:
       oneOf: 
         - $ref: "#/components/schemas/StarlarkInstruction"
@@ -729,10 +752,29 @@ components:
               type: string
           required:
             - is_run_successful
-            - serialized_output
       required:
         - run_finished_event
 
+    AsyncStarlarkExecutionLogs:
+      type: object
+      properties:
+        async_starlark_execution_logs: 
+          type: object
+          properties:
+            starlark_execution_uuid:
+              type: string
+          description: Execution UUID to asynchronously retrieve the execution logs
+          required:
+            - starlark_execution_uuid
+      description: Use it to asynchronously retrieve the execution logs via Websockets or http streaming 
+      required:
+        - async_starlark_execution_logs
+
+    StarlarkRunResponse:
+      oneOf:
+        - $ref: "#/components/schemas/AsyncStarlarkExecutionLogs"
+        - $ref: "#/components/schemas/StarlarkRunLogs"
+
     ServiceIdentifiers:
       type: object
       properties:

diff --git a/api/openapi/specs/core_service.yaml b/api/openapi/specs/core_service.yaml
@@ -41,6 +41,7 @@ paths:
       parameters:
         - $ref: './api_types.yaml#/components/parameters/enclave_identifier'
         - $ref: './api_types.yaml#/components/parameters/package_id'
+        - $ref: './api_types.yaml#/components/parameters/retrieve_logs_async'
       requestBody:
         content:
           application/json:
@@ -53,21 +54,16 @@ paths:
         "200":
           description: Successful request
           content:
-            application/octet-stream:
-              schema:
-                type: string
-                format: binary
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: "./api_types.yaml#/components/schemas/StarlarkRunResponseLine"
+                $ref: "./api_types.yaml#/components/schemas/StarlarkRunResponse"
 
   /enclaves/{enclave_identifier}/starlark/scripts:
     post:
       description: Executes a Starlark script on the user's behalf
       parameters:
         - $ref: './api_types.yaml#/components/parameters/enclave_identifier'
+        - $ref: './api_types.yaml#/components/parameters/retrieve_logs_async'
       requestBody:
         content:
           application/json:
@@ -80,15 +76,9 @@ paths:
         "200":
           description: Successful request
           content:
-            application/octet-stream:
-              schema:
-                type: string
-                format: binary
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: "./api_types.yaml#/components/schemas/StarlarkRunResponseLine"
+                $ref: "./api_types.yaml#/components/schemas/StarlarkRunResponse"
 
   /enclaves/{enclave_identifier}/services/{service_identifier}:
     get:

diff --git a/api/openapi/specs/websocket_service.yaml b/api/openapi/specs/websocket_service.yaml
@@ -40,3 +40,33 @@ paths:
             application/json:
               schema:
                 $ref: "./api_types.yaml#/components/schemas/ServiceLogs"
+
+  /enclaves/{enclave_identifier}/starlark/executions/{starlark_execution_uuid}/logs:
+    get:
+      description: Executes a Starlark script on the user's behalf
+      parameters:
+        - $ref: './api_types.yaml#/components/parameters/enclave_identifier'
+        - $ref: './api_types.yaml#/components/parameters/starlark_execution_uuid'
+      responses:
+        default:
+          $ref: '#/components/responses/NotOk'
+        "200":
+          description: Successful request
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./api_types.yaml#/components/schemas/StarlarkRunResponseLine"
+
+components:
+
+  responses:
+
+    NotOk:
+      description: Unexpected error
+      content:
+        application/json:
+          schema:
+            $ref: './api_types.yaml#/components/schemas/ResponseInfo'
+            required: true