feat: always keep the last executed scenariorun in any situation

Author: Leopold-Cramer

doc/Apis/ScenariorunApi.md

@@ -5,8 +5,8 @@ All URIs are relative to *https://dev.api.cosmotech.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**deleteHistoricalDataOrganization**](ScenariorunApi.md#deleteHistoricalDataOrganization) | **DELETE** /organizations/{organization_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Organization
+[**deleteHistoricalDataScenario**](ScenariorunApi.md#deleteHistoricalDataScenario) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Scenario
 [**deleteHistoricalDataWorkspace**](ScenariorunApi.md#deleteHistoricalDataWorkspace) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Workspace
-[**deleteHistoricalScenarioRunsByScenario**](ScenariorunApi.md#deleteHistoricalScenarioRunsByScenario) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns | Delete all historical ScenarioRuns for the Scenario
 [**deleteScenarioRun**](ScenariorunApi.md#deleteScenarioRun) | **DELETE** /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Delete a scenariorun
 [**findScenarioRunById**](ScenariorunApi.md#findScenarioRunById) | **GET** /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Get the details of a scenariorun
 [**getScenarioRunCumulatedLogs**](ScenariorunApi.md#getScenarioRunCumulatedLogs) | **GET** /organizations/{organization_id}/scenarioruns/{scenariorun_id}/cumulatedlogs | Get the cumulated logs of a scenariorun
@@ -22,7 +22,7 @@ Method | HTTP request | Description
 
 <a name="deleteHistoricalDataOrganization"></a>
 # **deleteHistoricalDataOrganization**
-> deleteHistoricalDataOrganization(organization\_id)
+> deleteHistoricalDataOrganization(organization\_id, deleteUnknown)
 
 Delete all historical ScenarioRuns in the Organization
 
@@ -31,6 +31,7 @@ Delete all historical ScenarioRuns in the Organization
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **organization\_id** | **String**| the Organization identifier | [default to null]
+ **deleteUnknown** | **Boolean**| condition to delete runs with an Unknown status | [optional] [default to false]
 
 ### Return type
 
@@ -45,18 +46,20 @@ null (empty response body)
 - **Content-Type**: Not defined
 - **Accept**: Not defined
 
-<a name="deleteHistoricalDataWorkspace"></a>
-# **deleteHistoricalDataWorkspace**
-> deleteHistoricalDataWorkspace(organization\_id, workspace\_id)
+<a name="deleteHistoricalDataScenario"></a>
+# **deleteHistoricalDataScenario**
+> deleteHistoricalDataScenario(organization\_id, workspace\_id, scenario\_id, deleteUnknown)
 
-Delete all historical ScenarioRuns in the Workspace
+Delete all historical ScenarioRuns in the Scenario
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **organization\_id** | **String**| the Organization identifier | [default to null]
  **workspace\_id** | **String**| the Workspace identifier | [default to null]
+ **scenario\_id** | **String**| the Scenario identifier | [default to null]
+ **deleteUnknown** | **Boolean**| condition to delete runs with an Unknown status | [optional] [default to false]
 
 ### Return type
 
@@ -71,19 +74,19 @@ null (empty response body)
 - **Content-Type**: Not defined
 - **Accept**: Not defined
 
-<a name="deleteHistoricalScenarioRunsByScenario"></a>
-# **deleteHistoricalScenarioRunsByScenario**
-> deleteHistoricalScenarioRunsByScenario(organization\_id, workspace\_id, scenario\_id)
+<a name="deleteHistoricalDataWorkspace"></a>
+# **deleteHistoricalDataWorkspace**
+> deleteHistoricalDataWorkspace(organization\_id, workspace\_id, deleteUnknown)
 
-Delete all historical ScenarioRuns for the Scenario
+Delete all historical ScenarioRuns in the Workspace
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **organization\_id** | **String**| the Organization identifier | [default to null]
  **workspace\_id** | **String**| the Workspace identifier | [default to null]
- **scenario\_id** | **String**| the Scenario identifier | [default to null]
+ **deleteUnknown** | **Boolean**| condition to delete runs with an Unknown status | [optional] [default to false]
 
 ### Return type
 

doc/README.md

@@ -60,8 +60,8 @@ Class | Method | HTTP request | Description
 *ScenarioApi* | [**updateScenario**](Apis/ScenarioApi.md#updatescenario) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id} | Update a scenario
 *ScenarioApi* | [**updateScenarioAccessControl**](Apis/ScenarioApi.md#updatescenarioaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/access/{identity_id} | Update the specified access to User for a Scenario
 *ScenariorunApi* | [**deleteHistoricalDataOrganization**](Apis/ScenariorunApi.md#deletehistoricaldataorganization) | **DELETE** /organizations/{organization_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Organization
+*ScenariorunApi* | [**deleteHistoricalDataScenario**](Apis/ScenariorunApi.md#deletehistoricaldatascenario) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Scenario
 *ScenariorunApi* | [**deleteHistoricalDataWorkspace**](Apis/ScenariorunApi.md#deletehistoricaldataworkspace) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Workspace
-*ScenariorunApi* | [**deleteHistoricalScenarioRunsByScenario**](Apis/ScenariorunApi.md#deletehistoricalscenariorunsbyscenario) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns | Delete all historical ScenarioRuns for the Scenario
 *ScenariorunApi* | [**deleteScenarioRun**](Apis/ScenariorunApi.md#deletescenariorun) | **DELETE** /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Delete a scenariorun
 *ScenariorunApi* | [**findScenarioRunById**](Apis/ScenariorunApi.md#findscenariorunbyid) | **GET** /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Get the details of a scenariorun
 *ScenariorunApi* | [**getScenarioRunCumulatedLogs**](Apis/ScenariorunApi.md#getscenarioruncumulatedlogs) | **GET** /organizations/{organization_id}/scenarioruns/{scenariorun_id}/cumulatedlogs | Get the cumulated logs of a scenariorun

scenariorun/src/main/kotlin/com/cosmotech/scenariorun/azure/ScenarioRunServiceImpl.kt

@@ -148,49 +148,70 @@ internal class ScenarioRunServiceImpl(
     }
   }
 
-  override fun deleteHistoricalScenarioRunsByScenario(
+  override fun deleteHistoricalDataOrganization(organizationId: String, deleteUnknown: Boolean) {
+    this.eventPublisher.publishEvent(
+        DeleteHistoricalDataOrganization(this, organizationId = organizationId, deleteUnknown))
+  }
+
+  override fun deleteHistoricalDataWorkspace(
       organizationId: String,
       workspaceId: String,
-      scenarioId: String
+      deleteUnknown: Boolean
   ) {
+    this.eventPublisher.publishEvent(
+        DeleteHistoricalDataWorkspace(
+            this, organizationId = organizationId, workspaceId = workspaceId, deleteUnknown))
+  }
 
+  override fun deleteHistoricalDataScenario(
+      organizationId: String,
+      workspaceId: String,
+      scenarioId: String,
+      deleteUnknown: Boolean
+  ) {
     GlobalScope.launch {
       this@ScenarioRunServiceImpl.deleteScenarioRunsByScenarioWithoutAccessEnforcement(
-          organizationId, workspaceId, scenarioId)
+          organizationId, workspaceId, scenarioId, deleteUnknown)
     }
   }
 
+  @EventListener(DeleteHistoricalDataScenario::class)
+  fun deleteHistoricalDataScenarioRun(data: DeleteHistoricalDataScenario) {
+    deleteHistoricalDataScenario(
+        data.organizationId, data.workspaceId, data.scenarioId, data.deleteUnknown)
+  }
+
   private fun deleteScenarioRunsByScenarioWithoutAccessEnforcement(
       organizationId: String,
       workspaceId: String,
-      scenarioId: String
+      scenarioId: String,
+      deleteUnknown: Boolean?
   ) {
     val scenarioRuns = getScenarioRuns(organizationId, workspaceId, scenarioId).toMutableList()
 
-    scenarioRuns.filter { it.state == ScenarioRunState.Failed }.forEach {
-      deleteScenarioRunWithoutAccessEnforcement(it)
-    }
-
     val lastRunId =
         scenarioApiService.findScenarioById(organizationId, workspaceId, scenarioId).lastRun!!
             .scenarioRunId
 
-    for (run in scenarioRuns.filter { it.state == ScenarioRunState.Successful }) {
-      if (run.id != lastRunId) {
-        deleteScenarioRunWithoutAccessEnforcement(run)
+    scenarioRuns.filter { it.state == ScenarioRunState.Failed }.forEach {
+      if (it.id != lastRunId) {
+        deleteScenarioRunWithoutAccessEnforcement(it)
       }
     }
-  }
 
-  override fun deleteHistoricalDataOrganization(organizationId: String) {
-    this.eventPublisher.publishEvent(
-        DeleteHistoricalDataOrganization(this, organizationId = organizationId))
-  }
+    if (deleteUnknown == true) {
+      scenarioRuns.filter { it.state == ScenarioRunState.Unknown }.forEach {
+        if (it.id != lastRunId) {
+          deleteScenarioRunWithoutAccessEnforcement(it)
+        }
+      }
+    }
 
-  override fun deleteHistoricalDataWorkspace(organizationId: String, workspaceId: String) {
-    this.eventPublisher.publishEvent(
-        DeleteHistoricalDataWorkspace(
-            this, organizationId = organizationId, workspaceId = workspaceId))
+    scenarioRuns.filter { it.state == ScenarioRunState.Successful }.forEach {
+      if (it.id != lastRunId) {
+        deleteScenarioRunWithoutAccessEnforcement(it)
+      }
+    }
   }
 
   override fun findScenarioRunById(organizationId: String, scenariorunId: String) =
@@ -313,11 +334,6 @@ internal class ScenarioRunServiceImpl(
           }
           .toList()
 
-  @EventListener(DeleteHistoricalDataScenario::class)
-  fun deleteHistoricalDataScenarioRun(data: DeleteHistoricalDataScenario) {
-    deleteHistoricalScenarioRunsByScenario(data.organizationId, data.workspaceId, data.scenarioId)
-  }
-
   @EventListener(ScenarioDataDownloadRequest::class)
   fun onScenarioDataDownloadRequest(scenarioDataDownloadRequest: ScenarioDataDownloadRequest) {
     val startInfo =
@@ -463,7 +479,7 @@ internal class ScenarioRunServiceImpl(
     sendScenarioRunMetaData(organizationId, workspace, scenarioId, scenarioRun.csmSimulationRun)
 
     val purgeHistoricalDataConfiguration =
-        startInfo.runTemplate?.deleteHistoricalData ?: DeleteHistoricalData()
+        startInfo.runTemplate.deleteHistoricalData ?: DeleteHistoricalData()
     if (purgeHistoricalDataConfiguration.enable) {
       logger.debug("Start coroutine to poll simulation status")
       GlobalScope.launch {
@@ -499,7 +515,8 @@ internal class ScenarioRunServiceImpl(
     }
     if (scenarioRunStatus == ScenarioRunState.Successful.value) {
       logger.info("ScenarioRun {} is Successfull => purging data", csmSimulationRun)
-      deleteScenarioRunsByScenarioWithoutAccessEnforcement(organizationId, workspaceId, scenarioId)
+      deleteScenarioRunsByScenarioWithoutAccessEnforcement(
+          organizationId, workspaceId, scenarioId, false)
     } else {
       logger.info(
           "ScenarioRun {} is in error {} => no purging data", csmSimulationRun, scenarioRunStatus)
@@ -636,9 +653,8 @@ internal class ScenarioRunServiceImpl(
     // >= 8.5
     var versionWithDataIngestionState = true
     if (scenarioRun.sdkVersion != null) {
-      logger.debug(
-          "SDK version for scenario run status detected: {}", scenarioRun.sdkVersion ?: "ERROR")
-      val splitVersion = scenarioRun.sdkVersion?.split(".") ?: listOf()
+      logger.debug("SDK version for scenario run status detected: {}", scenarioRun.sdkVersion)
+      val splitVersion = scenarioRun.sdkVersion.split(".") ?: listOf()
       if (splitVersion.size < 2) {
         logger.error("Malformed SDK version for scenario run status data ingestion check")
       } else {

scenariorun/src/main/openapi/scenariorun.yaml

@@ -25,6 +25,13 @@ paths:
         required: true
         schema:
           type: string
+      - name: deleteUnknown
+        in: query
+        description: condition to delete runs with an Unknown status
+        required: false
+        schema:
+          type: boolean
+          default: false
     delete:
       operationId: deleteHistoricalDataOrganization
       tags:
@@ -51,6 +58,13 @@ paths:
         required: true
         schema:
           type: string
+      - name: deleteUnknown
+        in: query
+        description: condition to delete runs with an Unknown status
+        required: false
+        schema:
+          type: boolean
+          default: false
     delete:
       operationId: deleteHistoricalDataWorkspace
       tags:
@@ -63,6 +77,45 @@ paths:
           description: Bad request
         "404":
           description: the Organization or Workspace specified is unknown or you don't have access to it
+  /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns/historicaldata:
+    parameters:
+      - name: organization_id
+        in: path
+        description: the Organization identifier
+        required: true
+        schema:
+          type: string
+      - name: workspace_id
+        in: path
+        description: the Workspace identifier
+        required: true
+        schema:
+          type: string
+      - name: scenario_id
+        in: path
+        description: the Scenario identifier
+        required: true
+        schema:
+          type: string
+      - name: deleteUnknown
+        in: query
+        description: condition to delete runs with an Unknown status
+        required: false
+        schema:
+          type: boolean
+          default: false
+    delete:
+      operationId: deleteHistoricalDataScenario
+      tags:
+        - scenariorun
+      summary: Delete all historical ScenarioRuns in the Scenario
+      responses:
+        "204":
+          description: Request succeeded
+        "400":
+          description: Bad request
+        "404":
+          description: the Scenario specified is unknown or you don't have access to it
   /organizations/{organization_id}/scenarioruns/search:
     parameters:
       - name: organization_id
@@ -348,18 +401,6 @@ paths:
               examples:
                 OneScenarioRun:
                   $ref: '#/components/examples/OneScenarioRun'
-    delete:
-      operationId: deleteHistoricalScenarioRunsByScenario
-      tags:
-        - scenariorun
-      summary: Delete all historical ScenarioRuns for the Scenario
-      responses:
-        "204":
-          description: Request succeeded
-        "400":
-          description: Bad request
-        "404":
-          description: the Scenario specified is unknown or you don't have access to it
   /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/run:
     parameters:
       - name: organization_id