feat: Allow to mark runs as outdated

This is for cases where for example new resolutions have been added for
items found in the run, so that the message can be shown in the UI.

Relates to #1009.

Signed-off-by: Johanna Lamppu <[email protected]>

Author: lamppu

api/v1/mapping/src/commonMain/kotlin/ApiMappings.kt

@@ -391,7 +391,9 @@ fun OrtRun.mapToApi(jobs: ApiJobs) =
         resolvedJobConfigContext = resolvedJobConfigContext,
         environmentConfigPath = environmentConfigPath,
         traceId = traceId,
-        userDisplayName = userDisplayName?.mapToApi()
+        userDisplayName = userDisplayName?.mapToApi(),
+        outdated = outdated,
+        outdatedMessage = outdatedMessage
     )
 
 fun OrtRun.mapToApiSummary(jobs: ApiJobSummaries) =
@@ -412,7 +414,9 @@ fun OrtRun.mapToApiSummary(jobs: ApiJobSummaries) =
         jobConfigContext = jobConfigContext,
         resolvedJobConfigContext = resolvedJobConfigContext,
         environmentConfigPath = environmentConfigPath,
-        userDisplayName = userDisplayName?.mapToApi()
+        userDisplayName = userDisplayName?.mapToApi(),
+        outdated = outdated,
+        outdatedMessage = outdatedMessage
     )
 
 fun OrtRunSummary.mapToApi() =

api/v1/model/src/commonMain/kotlin/OrtRun.kt

@@ -138,7 +138,17 @@ data class OrtRun(
     /**
      * The display name of the user that triggered the scan.
      */
-    val userDisplayName: UserDisplayName? = null
+    val userDisplayName: UserDisplayName? = null,
+
+    /**
+     * A flag to indicate if the results of the run are outdated, e.g. because of a new resolution.
+     */
+    val outdated: Boolean = false,
+
+    /**
+     * A message describing why the results of the run are outdated.
+     */
+    val outdatedMessage: String? = null
 )
 
 /**

api/v1/model/src/commonMain/kotlin/OrtRunSummary.kt

@@ -118,7 +118,17 @@ data class OrtRunSummary(
     /**
      * The display name of the user that triggered this run.
      */
-    val userDisplayName: UserDisplayName? = null
+    val userDisplayName: UserDisplayName? = null,
+
+    /**
+     * A flag to indicate if the results of the run are outdated, e.g. because of a new resolution.
+     */
+    val outdated: Boolean = false,
+
+    /**
+     * A message describing why the results of the run are outdated.
+     */
+    val outdatedMessage: String? = null
 )
 
 /**

dao/src/main/kotlin/repositories/ortrun/OrtRunsTable.kt

@@ -83,6 +83,8 @@ object OrtRunsTable : SortableTable("ort_runs") {
     val traceId = text("trace_id").nullable()
     val environmentConfigPath = text("environment_config_path").nullable()
     val userDisplayName = reference("user_id", UserDisplayNamesTable.id).nullable()
+    val outdated = bool("outdated").default(false)
+    val outdatedMessage = text("outdated_message").nullable()
 
     /** Get the id of the analyzer run for the given ORT run [id]. Returns `null` if no run is found. */
     fun getAnalyzerRunIdById(id: Long): Long? =
@@ -117,6 +119,8 @@ class OrtRunDao(id: EntityID<Long>) : LongEntity(id) {
     var vcsProcessedId by OrtRunsTable.vcsProcessedId
     var environmentConfigPath by OrtRunsTable.environmentConfigPath
     var userDisplayName by UserDisplayNameDao optionalReferencedOn OrtRunsTable.userDisplayName
+    var outdated by OrtRunsTable.outdated
+    var outdatedMessage by OrtRunsTable.outdatedMessage
 
     val advisorJob by AdvisorJobDao optionalBackReferencedOn AdvisorJobsTable.ortRunId
     val analyzerJob by AnalyzerJobDao optionalBackReferencedOn AnalyzerJobsTable.ortRunId
@@ -152,6 +156,8 @@ class OrtRunDao(id: EntityID<Long>) : LongEntity(id) {
         traceId = traceId,
         environmentConfigPath = environmentConfigPath,
         userDisplayName = userDisplayName?.mapToModel(),
+        outdated = outdated,
+        outdatedMessage = outdatedMessage
     )
 
     /**

dao/src/main/resources/db/migration/V120__addOutdatedToOrtRun.sql

@@ -0,0 +1,3 @@
+ALTER TABLE ort_runs
+    ADD COLUMN outdated         boolean DEFAULT FALSE   NOT NULL,
+    ADD COLUMN outdated_message text                    NULL;

model/src/commonMain/kotlin/OrtRun.kt

@@ -155,7 +155,17 @@ data class OrtRun(
     /**
      * Name of the user that triggered this run.
      */
-    val userDisplayName: UserDisplayName? = null
+    val userDisplayName: UserDisplayName? = null,
+
+    /**
+     * A flag to indicate if the results of the run are outdated, e.g. because of a new resolution.
+     */
+    val outdated: Boolean = false,
+
+    /**
+     * A message describing why the results of the run are outdated.
+     */
+    val outdatedMessage: String? = null
 )
 
 enum class OrtRunStatus(

services/ort-run/src/main/kotlin/OrtRunService.kt

@@ -25,6 +25,7 @@ import kotlinx.datetime.Instant
 import org.eclipse.apoapsis.ortserver.dao.blockingQuery
 import org.eclipse.apoapsis.ortserver.dao.dbQuery
 import org.eclipse.apoapsis.ortserver.dao.repositories.ortrun.OrtRunDao
+import org.eclipse.apoapsis.ortserver.dao.repositories.ortrun.OrtRunsTable
 import org.eclipse.apoapsis.ortserver.dao.tables.NestedRepositoriesTable
 import org.eclipse.apoapsis.ortserver.dao.tables.shared.VcsInfoDao
 import org.eclipse.apoapsis.ortserver.model.AdvisorJob
@@ -73,6 +74,7 @@ import org.eclipse.apoapsis.ortserver.services.ResourceNotFoundException
 
 import org.jetbrains.exposed.sql.Database
 import org.jetbrains.exposed.sql.insert
+import org.jetbrains.exposed.sql.update
 
 import org.ossreviewtoolkit.model.FileList
 import org.ossreviewtoolkit.model.OrtResult
@@ -438,6 +440,18 @@ class OrtRunService(
         )
     }
 
+    /**
+     * Mark the ORT runs with the given [ortRunIds] as outdated with the provided [outdatedMessage].
+     */
+    fun markAsOutdated(ortRunIds: List<Long>, outdatedMessage: String) {
+        db.blockingQuery {
+            OrtRunsTable.update({ OrtRunsTable.id inList ortRunIds }) {
+                it[OrtRunsTable.outdated] = true
+                it[OrtRunsTable.outdatedMessage] = outdatedMessage
+            }
+        }
+    }
+
     /**
      * Start the [AdvisorJob] with the provided [id] and return the updated job or `null` if the job does not exist.
      */

services/ort-run/src/test/kotlin/OrtRunServiceTest.kt

@@ -1381,6 +1381,37 @@ class OrtRunServiceTest : WordSpec({
             }
         }
     }
+
+    "markAsOutdated" should {
+        "mark the provided runs as outdated and save the describing message" {
+            val run1Id = fixtures.createOrtRun().id
+            val run2Id = fixtures.createOrtRun().id
+            val run3Id = fixtures.createOrtRun().id
+
+            val outdatedMsg = "Outdated"
+
+            service.markAsOutdated(listOf(run1Id, run3Id), outdatedMsg)
+
+            val run1 = service.getOrtRun(run1Id)
+            val run2 = service.getOrtRun(run2Id)
+            val run3 = service.getOrtRun(run3Id)
+
+            run1 shouldNotBeNull {
+                outdated shouldBe true
+                outdatedMessage shouldBe outdatedMessage
+            }
+
+            run2 shouldNotBeNull {
+                outdated shouldBe false
+                outdatedMessage shouldBe null
+            }
+
+            run3 shouldNotBeNull {
+                outdated shouldBe true
+                outdatedMessage shouldBe outdatedMessage
+            }
+        }
+    }
 })
 
 private fun createOrtRun(