Merge pull request #340 from tayloraswift/build-prioritization

add priority to PendingBuild sort key

Author: tayloraswift

Sources/UnidocDB/Building/Unidoc.DB.PendingBuilds.swift

@@ -26,8 +26,9 @@ extension Unidoc.DB
 extension Unidoc.DB.PendingBuilds
 {
     public static
-    let indexEnqueued:Mongo.CollectionIndex = .init("Enqueued", unique: false)
+    let indexEnqueued:Mongo.CollectionIndex = .init("Enqueued/2", unique: false)
     {
+        $0[Unidoc.PendingBuild[.priority]] = (+)
         $0[Unidoc.PendingBuild[.enqueued]] = (+)
     }
         where:
@@ -84,6 +85,7 @@ extension Unidoc.DB.PendingBuilds
                     }
                     $0[.sort]
                     {
+                        $0[Unidoc.PendingBuild[.priority]] = (+)
                         $0[Unidoc.PendingBuild[.enqueued]] = (+)
                     }
                     $0[.hint] = Self.indexEnqueued.id
@@ -137,7 +139,8 @@ extension Unidoc.DB.PendingBuilds
     /// Adds a build to the queue, if it is not already queued, or returns the existing build.
     public
     func submitBuild(id:Unidoc.Edition,
-        name:Symbol.PackageAtRef) async throws -> Unidoc.PendingBuild
+        name:Symbol.PackageAtRef,
+        priority:Int32 = 0) async throws -> Unidoc.PendingBuild
     {
         let (pendingBuild, _):(Unidoc.PendingBuild, Bool) = try await self.modify(
             upserting: id,
@@ -147,6 +150,7 @@ extension Unidoc.DB.PendingBuilds
 
             $0[.setOnInsert] = Unidoc.PendingBuild.init(id: id,
                 run: now,
+                priority: priority,
                 enqueued: now,
                 launched: nil,
                 assignee: nil,

Sources/UnidocDB/Building/Unidoc.PendingBuild.swift

@@ -16,6 +16,9 @@ extension Unidoc
         public
         let run:UnixMillisecond
 
+        /// Build priority. Lower values are higher priority.
+        public
+        let priority:Int32
         public
         let enqueued:UnixMillisecond?
         public
@@ -34,6 +37,7 @@ extension Unidoc
         @inlinable public
         init(id:Edition,
             run:UnixMillisecond,
+            priority:Int32,
             enqueued:UnixMillisecond?,
             launched:UnixMillisecond?,
             assignee:Account?,
@@ -42,6 +46,7 @@ extension Unidoc
         {
             self.id = id
             self.run = run
+            self.priority = priority
             self.enqueued = enqueued
             self.launched = launched
             self.assignee = assignee
@@ -57,6 +62,7 @@ extension Unidoc.PendingBuild:Mongo.MasterCodingModel
     {
         case id = "_id"
         case run = "T"
+        case priority = "P"
         case enqueued = "Q"
         case launched = "L"
         case assignee = "A"
@@ -73,6 +79,7 @@ extension Unidoc.PendingBuild:BSONDocumentEncodable
     {
         bson[.id] = self.id
         bson[.run] = self.run
+        bson[.priority] = self.priority
         bson[.enqueued] = self.enqueued
         bson[.launched] = self.launched
         bson[.assignee] = self.assignee
@@ -89,6 +96,7 @@ extension Unidoc.PendingBuild:BSONDocumentDecodable
     {
         self.init(id: try bson[.id].decode(),
             run: try bson[.run].decode(),
+            priority: try bson[.priority].decode(),
             enqueued: try bson[.enqueued]?.decode(),
             launched: try bson[.launched]?.decode(),
             assignee: try bson[.assignee]?.decode(),