Merge pull request #342 from tayloraswift/mark-vintage

Mark vintage symbol graphs

Author: tayloraswift

Sources/UnidocAPI/Building/Unidoc.LinkerRoute.swift

@@ -6,6 +6,9 @@ extension Unidoc
         case uplink
         case unlink
         case delete
+        /// This is not really a linker action, but it is related closely enough to piggyback
+        /// on the same route.
+        case vintage
     }
 }
 extension Unidoc.LinkerRoute:CustomStringConvertible

Sources/UnidocDB/Snapshots/Unidoc.DB.Snapshots.ClearAction.swift

@@ -40,9 +40,10 @@ extension Unidoc.DB.Snapshots
     }
 
     public static
-    let indexSymbolGraphABI:Mongo.CollectionIndex = .init("ABI",
+    let indexSymbolGraphABI:Mongo.CollectionIndex = .init("ABI/2",
         unique: false)
     {
+        $0[Unidoc.Snapshot[.vintage]] = (+)
         $0[Unidoc.Snapshot[.metadata] / SymbolGraphMetadata[.abi]] = (+)
     }
 
@@ -168,6 +169,107 @@ extension Unidoc.DB.Snapshots
     }
 }
 
+extension Unidoc.DB.Snapshots
+{
+    @discardableResult
+    public
+    func queueAll(for action:Unidoc.LinkerAction) async throws -> Int
+    {
+        try await self.updateMany
+        {
+            $0
+            {
+                $0[.multi] = true
+                $0[.q]
+                {
+                    $0[Unidoc.Snapshot[.action]] { $0[.exists] = false }
+                }
+                $0[.u]
+                {
+                    $0[.set]
+                    {
+                        $0[Unidoc.Snapshot[.action]] = action
+                    }
+                }
+            }
+        }
+    }
+
+    @discardableResult
+    public
+    func queue(id:Unidoc.Edition, for action:Unidoc.LinkerAction) async throws -> Bool?
+    {
+        try await self.update
+        {
+            $0
+            {
+                $0[.q]
+                {
+                    $0[Unidoc.Snapshot[.action]] { $0[.exists] = false }
+                    $0[Unidoc.Snapshot[.id]] = id
+                }
+                $0[.u]
+                {
+                    $0[.set]
+                    {
+                        $0[Unidoc.Snapshot[.action]] = action
+                    }
+                }
+            }
+        }
+    }
+
+    /// Clears the **queued action** for a single snapshot. Does not delete the snapshot!
+    @discardableResult
+    public
+    func clear(id:Unidoc.Edition) async throws -> Bool?
+    {
+        try await self.update
+        {
+            $0
+            {
+                $0[.q] { $0[Unidoc.Snapshot[.id]] = id }
+                $0[.u]
+                {
+                    $0[.unset]
+                    {
+                        $0[Unidoc.Snapshot[.action]] = ()
+                    }
+                }
+            }
+        }
+    }
+
+    @discardableResult
+    public
+    func mark(id:Unidoc.Edition, vintage:Bool) async throws -> Bool?
+    {
+        try await self.update
+        {
+            $0
+            {
+                $0[.q] { $0[Unidoc.Snapshot[.id]] = id }
+                $0[.u]
+                {
+                    if  vintage
+                    {
+                        $0[.set]
+                        {
+                            $0[Unidoc.Snapshot[.vintage]] = true
+                        }
+                    }
+                    else
+                    {
+                        $0[.unset]
+                        {
+                            $0[Unidoc.Snapshot[.vintage]] = ()
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
 extension Unidoc.DB.Snapshots
 {
     /// Returns a single batch of symbol graphs that are queued for linking.
@@ -207,6 +309,9 @@ extension Unidoc.DB.Snapshots
             {
                 $0[.filter]
                 {
+                    //  This needs to be ``BSON.Null`` and not just `{ $0[.exists] = false }`,
+                    //  otherwise it will not use the partial index.
+                    $0[Unidoc.Snapshot[.vintage]] = BSON.Null.init()
                     $0[Unidoc.Snapshot[.metadata] / SymbolGraphMetadata[.abi]]
                     {
                         $0[.lt] = version

Sources/UnidocDB/Snapshots/Unidoc.DB.Snapshots.QueueAction.swift

@@ -136,8 +136,7 @@ extension Unidoc.GraphLinker
             }
         }
 
-        try await context.db.update(
-            with: Unidoc.DB.Snapshots.ClearAction.one(operation.edition))
+        try await context.db.snapshots.clear(id: operation.edition)
 
         if  let event:Event
         {

Sources/UnidocDB/Snapshots/Unidoc.DB.Snapshots.swift

@@ -39,15 +39,34 @@ extension Unidoc
         public
         var size:Int64
 
-        @inlinable internal
+        /// Indicates if the symbol graph is no longer buildable from source. This flag prevents
+        /// the automated build system from repeatedly attempting to build the package.
+        ///
+        /// Possible reasons for this include:
+        ///
+        /// -   The package no longer compiles using the latest version of its dependencies,
+        ///     and its manifest does not constrain the dependencies to compatible versions.
+        ///
+        /// -   The package, or one of its dependencies, has been taken down from GitHub.
+        ///
+        /// -   The package only builds on a platform that is no longer supported by the hosting
+        ///     service.
+        ///
+        /// -   The package suffers from a Swift (or Unidoc) compiler bug that prevents it from
+        ///     being built.
+        public
+        var vintage:Bool
+
+        @inlinable
         init(id:Edition,
             metadata:SymbolGraphMetadata,
             inline:SymbolGraph?,
             action:LinkerAction?,
             swift:PatchVersion?,
             pins:[Edition?],
             type:GraphType,
-            size:Int64)
+            size:Int64,
+            vintage:Bool)
         {
             self.id = id
             self.metadata = metadata
@@ -57,6 +76,7 @@ extension Unidoc
             self.pins = pins
             self.type = type
             self.size = size
+            self.vintage = vintage
         }
     }
 }
@@ -87,7 +107,8 @@ extension Unidoc.Snapshot
             swift: swift,
             pins: [],
             type: .bson,
-            size: 0)
+            size: 0,
+            vintage: false)
     }
 }
 extension Unidoc.Snapshot
@@ -155,6 +176,7 @@ extension Unidoc.Snapshot
         case pins = "p"
         case type = "T"
         case size = "B"
+        case vintage = "V"
 
         @available(*, deprecated, renamed: "inline")
         @inlinable public static
@@ -179,6 +201,7 @@ extension Unidoc.Snapshot:BSONDocumentEncodable
         bson[.pins] = self.pins.isEmpty ? nil : self.pins
         bson[.type] = self.type
         bson[.size] = self.size
+        bson[.vintage] = self.vintage ? true : nil
     }
 }
 extension Unidoc.Snapshot:BSONDocumentDecodable
@@ -193,6 +216,7 @@ extension Unidoc.Snapshot:BSONDocumentDecodable
             swift: try bson[.swift]?.decode(),
             pins: try bson[.pins]?.decode() ?? [],
             type: try bson[.type]?.decode() ?? .bson,
-            size: try bson[.size]?.decode() ?? 0)
+            size: try bson[.size]?.decode() ?? 0,
+            vintage: try bson[.vintage]?.decode() ?? false)
     }
 }

Sources/UnidocLinkerPlugin/Unidoc.GraphLinker.swift

@@ -0,0 +1,8 @@
+extension Unidoc.LinkerOperation
+{
+    enum Update
+    {
+        case action(Unidoc.LinkerAction)
+        case vintage(Bool)
+    }
+}