feat: make run logs recuperation call argo

with the run logs removed from loki, we now have to go through argo to get the active run logs in kubernetes and the finished run logs in seaweed

Author: Leopold-Cramer

api/src/integrationTest/kotlin/com/cosmotech/api/home/run/RunControllerTests.kt

@@ -76,6 +76,7 @@ import org.springframework.test.context.ActiveProfiles
 import org.springframework.test.util.ReflectionTestUtils
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*
 import org.springframework.test.web.servlet.result.MockMvcResultHandlers
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.content
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
 
@@ -345,30 +346,20 @@ class RunControllerTests : ControllerTestBase() {
   @WithMockOauth2User
   fun get_run_logs() {
 
-    val lineOne = "This is a log entry"
-    val lineTwo = "This is another log entry"
-    val lineThree = "This is the last log entry"
+    val logs =
+        """This is the first line of a log entry
+      |This is the second line of a log entry
+      |This is the third line of a log entry"""
+            .trimMargin()
 
-    every { workflowService.getRunLogs(any()) } returns
-        RunLogs(
-            runId = runId,
-            logs =
-                mutableListOf(
-                    RunLogsEntry(lineOne),
-                    RunLogsEntry(lineTwo),
-                    RunLogsEntry(lineThree),
-                ))
+    every { workflowService.getRunningLogs(any()) } returns logs
 
     mvc.perform(
             get(
                     "/organizations/$organizationId/workspaces/$workspaceId/runners/$runnerId}/runs/$runId/logs")
-                .contentType(MediaType.APPLICATION_JSON)
-                .accept(MediaType.APPLICATION_JSON))
+                .accept(MediaType.TEXT_PLAIN))
         .andExpect(status().is2xxSuccessful)
-        .andExpect(jsonPath("$.runId").value(runId))
-        .andExpect(jsonPath("$.logs[0].line").value(lineOne))
-        .andExpect(jsonPath("$.logs[1].line").value(lineTwo))
-        .andExpect(jsonPath("$.logs[2].line").value(lineThree))
+        .andExpect(content().string(logs))
         .andDo(MockMvcResultHandlers.print())
         .andDo(
             document(

doc/.openapi-generator/FILES

@@ -43,8 +43,6 @@ Models/Run.md
 Models/RunContainer.md
 Models/RunData.md
 Models/RunDataQuery.md
-Models/RunLogs.md
-Models/RunLogsEntry.md
 Models/RunResourceRequested.md
 Models/RunState.md
 Models/RunStatus.md

doc/Apis/RunApi.md

@@ -71,7 +71,7 @@ Get the details of a run
 
 <a name="getRunLogs"></a>
 # **getRunLogs**
-> RunLogs getRunLogs(organization\_id, workspace\_id, runner\_id, run\_id)
+> String getRunLogs(organization\_id, workspace\_id, runner\_id, run\_id)
 
 get the logs for the Run
 
@@ -86,7 +86,7 @@ get the logs for the Run
 
 ### Return type
 
-[**RunLogs**](../Models/RunLogs.md)
+**String**
 
 ### Authorization
 
@@ -95,7 +95,7 @@ get the logs for the Run
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, application/yaml
+- **Accept**: text/plain
 
 <a name="getRunStatus"></a>
 # **getRunStatus**

doc/Models/RunLogs.md

@@ -168,8 +168,6 @@ All URIs are relative to *http://localhost*
  - [RunContainer](./Models/RunContainer.md)
  - [RunData](./Models/RunData.md)
  - [RunDataQuery](./Models/RunDataQuery.md)
- - [RunLogs](./Models/RunLogs.md)
- - [RunLogsEntry](./Models/RunLogsEntry.md)
  - [RunResourceRequested](./Models/RunResourceRequested.md)
  - [RunState](./Models/RunState.md)
  - [RunStatus](./Models/RunStatus.md)

doc/Models/RunLogsEntry.md

@@ -253,15 +253,6 @@ entity RunDataQuery {
     * query: String
 }
 
-entity RunLogs {
-    * runId: String
-    * logs: List<RunLogsEntry>
-}
-
-entity RunLogsEntry {
-    * line: String
-}
-
 entity RunResourceRequested {
     cpu: Long
     memory: Long
@@ -668,7 +659,6 @@ DatasetSecurity -- "0..*" DatasetAccessControl : accessControlList
 ContainerResourceSizing -- ContainerResourceSizeInfo : requests
 ContainerResourceSizing -- ContainerResourceSizeInfo : limits
 SolutionSecurity -- "0..*" SolutionAccessControl : accessControlList
-RunLogs -- "0..*" RunLogsEntry : logs
 WorkspaceSecurity -- "0..*" WorkspaceAccessControl : accessControlList
 WorkspaceCreateRequest -- WorkspaceSolution : solution
 WorkspaceCreateRequest -- WorkspaceWebApp : webApp

doc/README.md

@@ -29,6 +29,7 @@ import com.cosmotech.run.config.existTable
 import com.cosmotech.run.config.toDataTableName
 import com.cosmotech.run.domain.Run
 import com.cosmotech.run.domain.RunDataQuery
+import com.cosmotech.run.domain.RunStatus
 import com.cosmotech.run.domain.SendRunDataRequest
 import com.cosmotech.run.workflow.WorkflowService
 import com.cosmotech.runner.RunnerApiServiceInterface
@@ -66,19 +67,22 @@ import org.json.JSONObject
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Nested
 import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertDoesNotThrow
 import org.junit.jupiter.api.assertThrows
 import org.junit.jupiter.api.extension.ExtendWith
 import org.junit.runner.RunWith
 import org.postgresql.util.PSQLException
 import org.slf4j.LoggerFactory
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.http.HttpStatus
 import org.springframework.jdbc.core.JdbcTemplate
 import org.springframework.jdbc.datasource.DriverManagerDataSource
 import org.springframework.test.context.ActiveProfiles
 import org.springframework.test.context.junit.jupiter.SpringExtension
 import org.springframework.test.context.junit4.SpringRunner
 import org.springframework.test.util.ReflectionTestUtils
+import org.springframework.web.client.RestClientResponseException
 
 @ActiveProfiles(profiles = ["run-test"])
 @ExtendWith(MockKExtension::class)
@@ -104,7 +108,8 @@ class RunServiceIntegrationTest : CsmRunTestBase() {
   @Autowired lateinit var solutionApiService: SolutionApiServiceInterface
   @Autowired lateinit var workspaceApiService: WorkspaceApiServiceInterface
   @SpykBean @Autowired lateinit var runnerApiService: RunnerApiServiceInterface
-  @Autowired lateinit var runApiService: RunApiServiceInterface
+  @SpykBean @Autowired lateinit var runServiceImpl: RunServiceImpl
+  @SpykBean @Autowired lateinit var runApiService: RunApiServiceInterface
   @Autowired lateinit var eventPublisher: com.cosmotech.api.events.CsmEventPublisher
 
   @Autowired lateinit var adminRunStorageTemplate: JdbcTemplate
@@ -397,6 +402,83 @@ class RunServiceIntegrationTest : CsmRunTestBase() {
     }
   }
 
+  @Test
+  fun `test get running logs`() {
+    runSavedId =
+        mockStartRun(organizationSaved.id, workspaceSaved.id, runnerSaved.id, solutionSaved.id)
+    val run = mockk<Run>()
+    every { runApiService.getRun(any(), any(), any(), any()) } returns run
+    every { run.id } returns "id"
+    every { runServiceImpl.getRunStatus(any(), any(), any(), any()) } returns
+        RunStatus(endTime = null)
+    every { workflowService.getRunningLogs(any()) } returns
+        "first line of result" + "|second line of result" + "|third line of result"
+    every { workflowService.getArchivedLogs(any()) } throws Exception()
+
+    assertEquals(
+        "first line of result" + "|second line of result" + "|third line of result",
+        runApiService.getRunLogs(
+            organizationSaved.id, workspaceSaved.id, runnerSaved.id, runSavedId))
+  }
+
+  @Test
+  fun `test get archived logs`() {
+    runSavedId =
+        mockStartRun(organizationSaved.id, workspaceSaved.id, runnerSaved.id, solutionSaved.id)
+    val run = mockk<Run>()
+    every { runApiService.getRun(any(), any(), any(), any()) } returns run
+    every { run.id } returns "id"
+    every { runServiceImpl.getRunStatus(any(), any(), any(), any()) } returns
+        RunStatus(endTime = "endTime")
+    logger.info("should get archived logs")
+    every { workflowService.getRunningLogs(any()) } throws
+        RestClientResponseException("message", HttpStatus.NOT_FOUND, "statusTest", null, null, null)
+    every { workflowService.getArchivedLogs(any()) } returns
+        "first line of result" + "|second line of result" + "|third line of result"
+    assertEquals(
+        "first line of result" + "|second line of result" + "|third line of result",
+        runApiService.getRunLogs(
+            organizationSaved.id, workspaceSaved.id, runnerSaved.id, runSavedId))
+  }
+
+  @Test
+  fun `test should get archived logs after a status change`() {
+    runSavedId =
+        mockStartRun(organizationSaved.id, workspaceSaved.id, runnerSaved.id, solutionSaved.id)
+    val run = mockk<Run>()
+    every { runApiService.getRun(any(), any(), any(), any()) } returns run
+    every { run.id } returns "id"
+    every { runServiceImpl.getRunStatus(any(), any(), any(), any()) } returns
+        RunStatus(endTime = null)
+    logger.info("should get logs even with a status change after assertion")
+    every { workflowService.getRunningLogs(any()) } throws
+        RestClientResponseException("message", HttpStatus.NOT_FOUND, "statusTest", null, null, null)
+    every { workflowService.getArchivedLogs(any()) } returns
+        "first line of result" + "|second line of result" + "|third line of result"
+    assertDoesNotThrow {
+      runApiService.getRunLogs(organizationSaved.id, workspaceSaved.id, runnerSaved.id, runSavedId)
+    }
+    assertEquals(
+        "first line of result" + "|second line of result" + "|third line of result",
+        runApiService.getRunLogs(
+            organizationSaved.id, workspaceSaved.id, runnerSaved.id, runSavedId))
+  }
+
+  @Test
+  fun `test should fail after exception other than not_found`() {
+    runSavedId =
+        mockStartRun(organizationSaved.id, workspaceSaved.id, runnerSaved.id, solutionSaved.id)
+    val run = mockk<Run>()
+    every { runApiService.getRun(any(), any(), any(), any()) } returns run
+    every { runServiceImpl.getRunStatus(any(), any(), any(), any()) } returns
+        RunStatus(endTime = null)
+    logger.info("should throw an error outside of status change error")
+    every { workflowService.getRunningLogs(any()) } throws Exception()
+    assertThrows<Exception> {
+      runApiService.getRunLogs(organizationSaved.id, workspaceSaved.id, runnerSaved.id, runSavedId)
+    }
+  }
+
   @Nested
   inner class RunServicePostgresIntegrationTest {
 

openapi/plantuml/schemas.plantuml

@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 package com.cosmotech.run.exceptions
 
+import io.argoproj.workflow.ApiException
 import java.net.URI
 import java.sql.SQLException
 import org.springframework.http.HttpStatus
@@ -24,4 +25,16 @@ class RunExceptionHandling {
 
     return response
   }
+
+  @ExceptionHandler(ApiException::class)
+  fun handleApiException(exception: ApiException): ProblemDetail {
+    var response = ProblemDetail.forStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+    val internalServerError = HttpStatus.INTERNAL_SERVER_ERROR
+    response.type = URI.create(httpStatusCodeTypePrefix + internalServerError.value())
+    response.title =
+        "Argo Workflows has encountered a problem. Please check Argo logs for more details."
+    response.detail = exception.message
+
+    return response
+  }
 }

run/src/integrationTest/kotlin/com/cosmotech/run/service/RunServiceIntegrationTest.kt

@@ -29,7 +29,6 @@ import com.cosmotech.run.domain.QueryResult
 import com.cosmotech.run.domain.Run
 import com.cosmotech.run.domain.RunData
 import com.cosmotech.run.domain.RunDataQuery
-import com.cosmotech.run.domain.RunLogs
 import com.cosmotech.run.domain.RunState
 import com.cosmotech.run.domain.RunStatus
 import com.cosmotech.run.domain.RunTemplateParameterValue
@@ -53,9 +52,11 @@ import org.springframework.beans.factory.annotation.Value
 import org.springframework.context.event.EventListener
 import org.springframework.data.domain.PageRequest
 import org.springframework.data.domain.Pageable
+import org.springframework.http.HttpStatus
 import org.springframework.jdbc.core.JdbcTemplate
 import org.springframework.jdbc.datasource.DriverManagerDataSource
 import org.springframework.stereotype.Service
+import org.springframework.web.client.RestClientResponseException
 
 internal const val WORKFLOW_TYPE_RUN = "container-run"
 internal const val WORKFLOW_TYPE_TWIN_GRAPH_IMPORT = "twin-graph-import"
@@ -473,8 +474,17 @@ class RunServiceImpl(
       workspaceId: String,
       runnerId: String,
       runId: String
-  ): RunLogs {
-    return workflowService.getRunLogs(getRun(organizationId, workspaceId, runnerId, runId))
+  ): String {
+    val run = getRun(organizationId, workspaceId, runnerId, runId)
+    val status = getRunStatus(run)
+    if (status.endTime.isNullOrEmpty()) {
+      try {
+        return workflowService.getRunningLogs(run)
+      } catch (e: RestClientResponseException) {
+        if (e.statusCode != HttpStatus.NOT_FOUND) throw e
+      }
+    }
+    return workflowService.getArchivedLogs(run)
   }
 
   override fun getRunStatus(