decompose many DB operations into CRUD primitives, and move those primitives to the _MongoDB module

Author: tayloraswift

Package.swift

@@ -290,6 +290,11 @@ let package:Package = .init(
 
         .target(name: "Media"),
 
+        .target(name: "_MongoDB",
+            dependencies: [
+                .product(name: "MongoDB", package: "swift-mongodb"),
+            ]),
+
         .target(name: "Multiparts",
             dependencies: [
                 .target(name: "Media"),
@@ -482,11 +487,11 @@ let package:Package = .init(
 
         .target(name: "UnidocDB",
             dependencies: [
+                .target(name: "_MongoDB"),
                 .target(name: "UnidocRecords_LZ77"),
                 .target(name: "UnidocLinker"),
                 .target(name: "UnidocRecords"),
                 .product(name: "UnixCalendar", package: "swift-unixtime"),
-                .product(name: "MongoDB", package: "swift-mongodb"),
             ]),
 
         .target(name: "UnidocRecords_LZ77",

Sources/UnidocDB/Activity/Unidoc.DB.RepoFeed.swift

@@ -36,15 +36,17 @@ extension Unidoc.DB.RepoFeed:Mongo.CollectionModel
 }
 extension Unidoc.DB.RepoFeed
 {
+    @available(*, deprecated, renamed: "find(last:)")
     public
     func last(_ count:Int) async throws -> [Activity]
     {
         try await self.find(last: count)
     }
 
+    @available(*, deprecated, renamed: "insert(_:)")
     public
     func push(_ activity:Activity) async throws
     {
-        try await self.insert(some: activity)
+        try await self.insert(activity)
     }
 }

Sources/UnidocDB/Crawling/Unidoc.DB.CrawlingWindows.swift

@@ -95,10 +95,11 @@ extension Unidoc.DB.CrawlingWindows
     }
 
     /// Updates the state of an existing crawling window.
+    @available(*, deprecated, renamed: "replace(_:)")
     @discardableResult
     public
     func push(window:Unidoc.CrawlingWindow) async throws -> Bool?
     {
-        try await self.update(some: window)
+        try await self.replace(window)
     }
 }

Sources/UnidocDB/Editions/Unidoc.DB.Editions.swift

@@ -105,10 +105,4 @@ extension Unidoc.DB.Editions:Mongo.CollectionModel
 }
 extension Unidoc.DB.Editions:Mongo.RecodableModel
 {
-    public
-    func recode() async throws -> (modified:Int, of:Int)
-    {
-        try await self.recode(through: Unidoc.EditionMetadata.self,
-            by: .now.advanced(by: .seconds(60)))
-    }
 }

Sources/UnidocDB/Mongo.CollectionModel (ext).swift

@@ -0,0 +1,30 @@
+import MongoDB
+
+//  TODO: we need to unify ``Unidoc.Scalar`` and ``Unidoc.Group`, most likely by introducing
+//  a new type ``Unidoc.Vertex``.
+extension Mongo.CollectionModel // where Element.ID == Unidoc.Scalar
+{
+    /// Deletes all records from the collection within the specified zone.
+    func clear(range:Unidoc.Edition) async throws
+    {
+        let response:Mongo.DeleteResponse = try await session.run(
+            command: Mongo.Delete<Mongo.Many>.init(Self.name)
+            {
+                $0
+                {
+                    $0[.limit] = .unlimited
+                    $0[.q]
+                    {
+                        $0[.and]
+                        {
+                            $0 { $0["_id"] { $0[.gte] = range.min } }
+                            $0 { $0["_id"] { $0[.lte] = range.max } }
+                        }
+                    }
+                }
+            },
+            against: self.database)
+
+        let _:Mongo.Deletions = try response.deletions()
+    }
+}

Sources/UnidocDB/Mongo.RecodableModel.swift

@@ -43,16 +43,14 @@ extension Unidoc.DB.PackageAliases:Mongo.CollectionModel
 }
 extension Unidoc.DB.PackageAliases
 {
-    public
-    func upsert(alias:Symbol.Package,
-        of coordinate:Unidoc.Package) async throws
+    @inlinable public
+    func upsert(alias:Symbol.Package, of coordinate:Unidoc.Package) async throws
     {
-        try await self.upsert(some: Unidoc.PackageAlias.init(id: alias, coordinate: coordinate))
+        try await self.upsert(.init(id: alias, coordinate: coordinate))
     }
 
-    func insert(alias:Symbol.Package,
-        of coordinate:Unidoc.Package) async throws
+    func insert(alias:Symbol.Package, of coordinate:Unidoc.Package) async throws
     {
-        try await self.insert(some: Unidoc.PackageAlias.init(id: alias, coordinate: coordinate))
+        try await self.insert(.init(id: alias, coordinate: coordinate))
     }
 }

Sources/UnidocDB/Mongo.UpdateListEncoder (ext).swift

@@ -56,12 +56,6 @@ extension Unidoc.DB.PackageDependencies:Mongo.CollectionModel
 }
 extension Unidoc.DB.PackageDependencies:Mongo.RecodableModel
 {
-    public
-    func recode() async throws -> (modified:Int, of:Int)
-    {
-        try await self.recode(through: Unidoc.PackageDependency.self,
-            by: .now.advanced(by: .seconds(30)))
-    }
 }
 extension Unidoc.DB.PackageDependencies
 {

Sources/UnidocDB/Packages/Unidoc.DB.PackageAliases.swift

@@ -95,31 +95,39 @@ extension Unidoc.DB.Packages:Mongo.CollectionModel
 }
 extension Unidoc.DB.Packages:Mongo.RecodableModel
 {
-    public
-    func recode() async throws -> (modified:Int, of:Int)
-    {
-        try await self.recode(through: Unidoc.PackageMetadata.self,
-            by: .now.advanced(by: .seconds(30)))
-    }
 }
 extension Unidoc.DB.Packages
 {
+    private
+    func reset<Value>(field:Element.CodingKey,
+        of package:Element.ID,
+        to value:Value?) async throws -> Element? where Value:BSONEncodable
+    {
+        try await self.modify(existing: package, returning: .new)
+        {
+            if  let value:Value
+            {
+                $0[.set] { $0[Element[field]] = value }
+            }
+            else
+            {
+                $0[.unset] { $0[Element[field]] = () }
+            }
+        }
+    }
+
     public
     func reset(media:Unidoc.PackageMedia?,
         of package:Unidoc.Package) async throws -> Unidoc.PackageMetadata?
     {
-        try await self.reset(field: .media,
-            of: package,
-            to: media)
+        try await self.reset(field: .media, of: package, to: media)
     }
 
     public
     func reset(platformPreference triple:Triple?,
         of package:Unidoc.Package) async throws -> Unidoc.PackageMetadata?
     {
-        try await self.reset(field: .platformPreference,
-            of: package,
-            to: triple)
+        try await self.reset(field: .platformPreference, of: package, to: triple)
     }
 }
 extension Unidoc.DB.Packages
@@ -151,17 +159,11 @@ extension Unidoc.DB.Packages
 }
 extension Unidoc.DB.Packages
 {
+    @available(*, deprecated, renamed: "replace(_:)")
     public
     func update(metadata:Unidoc.PackageMetadata) async throws -> Bool?
     {
-        try await self.update(some: metadata)
-    }
-
-    public
-    func update(package:Unidoc.Package,
-        symbol:Symbol.Package) async throws -> Bool?
-    {
-        try await self.update(field: .symbol, of: package, to: symbol)
+        try await self.replace(metadata)
     }
 
     public