restore some collation nuances that were lost in the merge

tayloraswift · tayloraswift · commit 02f88fbb7a0c · 2023-09-22T21:11:45.000Z
diff --git a/Sources/UnidocDB/DatabaseCollation.swift b/Sources/UnidocDB/DatabaseCollation.swift
@@ -0,0 +1,8 @@
+import MongoDB
+
+public
+protocol DatabaseCollation
+{
+    static
+    var spec:Mongo.Collation { get }
+}
diff --git a/Sources/UnidocDB/DatabaseModel.swift b/Sources/UnidocDB/DatabaseModel.swift
@@ -4,22 +4,11 @@ import MongoQL
 public
 protocol DatabaseModel:Identifiable<Mongo.Database>, Equatable, Sendable
 {
-    static
-    var collation:Mongo.Collation { get }
-
     init(id:Mongo.Database)
 
     func setup(with session:Mongo.Session) async throws
 }
 extension DatabaseModel
-{
-    @inlinable public static
-    var collation:Mongo.Collation
-    {
-        .init(locale: "simple", normalization: true) // normalize unicode on insert
-    }
-}
-extension DatabaseModel
 {
     public static
     func setup(as id:Mongo.Database, in pool:__owned Mongo.SessionPool) async -> Self
diff --git a/Sources/UnidocDB/DatabaseQuery.swift b/Sources/UnidocDB/DatabaseQuery.swift
@@ -2,9 +2,9 @@ import BSONDecoding
 import MongoDB
 
 public
-protocol DatabaseQuery<Database, Output>:Sendable
+protocol DatabaseQuery<Collation, Output>:Sendable
 {
-    associatedtype Database:DatabaseModel
+    associatedtype Collation:DatabaseCollation
     associatedtype Output:BSONDocumentDecodable
 
     func build(pipeline:inout Mongo.Pipeline)
@@ -19,7 +19,7 @@ extension DatabaseQuery
     {
         .init(self.origin, pipeline: .init(with: self.build(pipeline:)))
         {
-            $0[.collation] = Database.collation
+            $0[.collation] = Collation.spec
             $0[.hint] = self.hint
         }
     }
diff --git a/Sources/UnidocDB/Packages/SimpleCollation.swift b/Sources/UnidocDB/Packages/SimpleCollation.swift
@@ -0,0 +1,11 @@
+import MongoDB
+
+@frozen public
+struct SimpleCollation:DatabaseCollation
+{
+    @inlinable public static
+    var spec:Mongo.Collation
+    {
+        .init(locale: "simple", normalization: true) // normalize unicode on insert
+    }
+}
diff --git a/Sources/UnidocDB/Packages/UnidocDatabase.Editions.swift b/Sources/UnidocDB/Packages/UnidocDatabase.Editions.swift
@@ -35,7 +35,7 @@ extension UnidocDatabase.Editions:DatabaseCollection
     [
         .init
         {
-            $0[.collation] = UnidocDatabase.collation
+            $0[.collation] = SimpleCollation.spec
 
             $0[.unique] = true
             $0[.name] = "package,name"
diff --git a/Sources/UnidocDB/Packages/UnidocDatabase.Graphs.swift b/Sources/UnidocDB/Packages/UnidocDatabase.Graphs.swift
@@ -43,7 +43,7 @@ extension UnidocDatabase.Graphs:DatabaseCollection
         },
         .init
         {
-            $0[.collation] = UnidocDatabase.collation
+            $0[.collation] = SimpleCollation.spec
 
             $0[.unique] = true // for now...
             $0[.name] = "metadata_package,version"
diff --git a/Sources/UnidocDB/Volumes/UnidocDatabase.Groups.swift b/Sources/UnidocDB/Volumes/UnidocDatabase.Groups.swift
@@ -25,16 +25,6 @@ extension UnidocDatabase.Groups:DatabaseCollection
     static
     let indexes:[Mongo.CreateIndexStatement] =
     [
-        // .init
-        // {
-        //     $0[.unique] = true
-        //     $0[.name] = "id,latest"
-        //     $0[.key] = .init
-        //     {
-        //         $0[Volume.Group[.id]] = (+)
-        //         $0[Volume.Group[.latest]] = (-)
-        //     }
-        // },
         .init
         {
             $0[.unique] = false
diff --git a/Sources/UnidocDB/Volumes/UnidocDatabase.Names.swift b/Sources/UnidocDB/Volumes/UnidocDatabase.Names.swift
@@ -57,7 +57,7 @@ extension UnidocDatabase.Names:DatabaseCollection
             $0[.unique] = true
             $0[.name] = "package,patch"
 
-            $0[.collation] = UnidocDatabase.collation
+            $0[.collation] = VolumeCollation.spec
             $0[.key] = .init
             {
                 $0[Volume.Names[.package]] = (+)
@@ -73,7 +73,7 @@ extension UnidocDatabase.Names:DatabaseCollection
             $0[.unique] = true
             $0[.name] = "package,version"
 
-            $0[.collation] = UnidocDatabase.collation
+            $0[.collation] = VolumeCollation.spec
             $0[.key] = .init
             {
                 $0[Volume.Names[.package]] = (+)
diff --git a/Sources/UnidocDB/Volumes/UnidocDatabase.Vertices.swift b/Sources/UnidocDB/Volumes/UnidocDatabase.Vertices.swift
@@ -39,7 +39,7 @@ extension UnidocDatabase.Vertices:DatabaseCollection
             $0[.unique] = true
             $0[.name] = "zone,stem,hash"
 
-            $0[.collation] = UnidocDatabase.collation
+            $0[.collation] = VolumeCollation.spec
             $0[.key] = .init
             {
                 $0[Volume.Vertex[.zone]] = (+)
@@ -58,7 +58,7 @@ extension UnidocDatabase.Vertices:DatabaseCollection
             $0[.unique] = true
             $0[.name] = "hash,id"
 
-            $0[.collation] = UnidocDatabase.collation
+            $0[.collation] = VolumeCollation.spec
             $0[.key] = .init
             {
                 $0[Volume.Vertex[.hash]] = (+)
diff --git a/Sources/UnidocDB/Volumes/VolumeCollation.swift b/Sources/UnidocDB/Volumes/VolumeCollation.swift
@@ -0,0 +1,14 @@
+import MongoDB
+
+@frozen public
+struct VolumeCollation:DatabaseCollation
+{
+    @inlinable public static
+    var spec:Mongo.Collation
+    {
+        .init(locale: "en", // casing is a property of english, not unicode
+            caseLevel: false, // url paths are case-insensitive
+            normalization: true, // normalize unicode on insert
+            strength: .secondary) // diacritics are significant
+    }
+}
diff --git a/Sources/UnidocQueries/Queries/PackageEditionsQuery.swift b/Sources/UnidocQueries/Queries/PackageEditionsQuery.swift
@@ -22,7 +22,7 @@ struct PackageEditionsQuery:Equatable, Hashable, Sendable
 extension PackageEditionsQuery:DatabaseQuery
 {
     public
-    typealias Database = UnidocDatabase
+    typealias Collation = SimpleCollation
 
     @inlinable public
     var origin:Mongo.Collection { UnidocDatabase.Packages.name }
diff --git a/Sources/UnidocQueries/Queries/SearchIndexQuery.swift b/Sources/UnidocQueries/Queries/SearchIndexQuery.swift
@@ -8,9 +8,8 @@ import UnidocDB
 import UnidocRecords
 
 @frozen public
-struct SearchIndexQuery<Database, ID>:Equatable, Hashable, Sendable
-    where   Database:DatabaseModel,
-            ID:Hashable,
+struct SearchIndexQuery<ID>:Equatable, Hashable, Sendable
+    where   ID:Hashable,
             ID:Sendable,
             ID:BSONDecodable,
             ID:BSONEncodable
@@ -32,6 +31,9 @@ struct SearchIndexQuery<Database, ID>:Equatable, Hashable, Sendable
 }
 extension SearchIndexQuery:DatabaseQuery
 {
+    public
+    typealias Collation = VolumeCollation
+
     @inlinable public
     var hint:Mongo.SortDocument? { nil }
 
diff --git a/Sources/UnidocQueries/Volumes/VolumeLookupQuery.swift b/Sources/UnidocQueries/Volumes/VolumeLookupQuery.swift
@@ -4,7 +4,7 @@ import UnidocDB
 import UnidocRecords
 
 public
-protocol VolumeLookupQuery:DatabaseQuery where Database == UnidocDatabase
+protocol VolumeLookupQuery:DatabaseQuery where Collation == VolumeCollation
 {
     associatedtype LookupPredicate:VolumeLookupPredicate
 
diff --git a/Sources/UnidocQueryTests/PackageQueries.swift b/Sources/UnidocQueryTests/PackageQueries.swift
@@ -80,14 +80,14 @@ struct PackageQueries:UnidocDatabaseTestBattery
 
         if  let tests:TestGroup = tests / "AllPackages"
         {
-            let query:SearchIndexQuery<UnidocDatabase, Int32> = .init(
+            let query:SearchIndexQuery<Int32> = .init(
                 from: UnidocDatabase.Meta.name,
                 tag: nil,
                 id: 0)
 
             await tests.do
             {
-                if  let index:SearchIndexQuery<UnidocDatabase, Int32>.Output = tests.expect(
+                if  let index:SearchIndexQuery<Int32>.Output = tests.expect(
                         value: try await unidoc.execute(query: query, with: session)),
                     let _:MD5 = tests.expect(value: index.hash)
                 {
diff --git a/Sources/UnidocServer/Operations/Server.Endpoint.swift b/Sources/UnidocServer/Operations/Server.Endpoint.swift
@@ -162,8 +162,8 @@ extension Server.Endpoint
         case "lunr":
             if  let id:VolumeIdentifier = .init(trunk)
             {
-                return .interactive(Server.Operation.Pipeline<
-                        SearchIndexQuery<UnidocDatabase, VolumeIdentifier>>.init(
+                return .interactive(
+                    Server.Operation.Pipeline<SearchIndexQuery<VolumeIdentifier>>.init(
                     explain: explain,
                     query: .init(
                         from: UnidocDatabase.Search.name,
@@ -174,14 +174,15 @@ extension Server.Endpoint
             }
             else if trunk == "packages.json"
             {
-                return .interactive(Server.Operation.Pipeline<
-                        SearchIndexQuery<UnidocDatabase, Int32>>.init(
+                return .interactive(
+                    Server.Operation.Pipeline<SearchIndexQuery<Int32>>.init(
                     explain: explain,
                     query: .init(
                         from: UnidocDatabase.Meta.name,
                         tag: tag,
                         id: 0),
-                    uri: uri))
+                    uri: uri,
+                    tag: tag))
             }
             else
             {
diff --git a/Sources/UnidocServer/Operations/Server.Operation.Pipeline.swift b/Sources/UnidocServer/Operations/Server.Operation.Pipeline.swift
@@ -11,39 +11,24 @@ extension Server.Operation
         where   Query:DatabaseQuery,
                 Query.Output:ServerResponseFactory<URI>
     {
-        let database:@Sendable (_ among:Server.DB) -> Query.Database
         let explain:Bool
         let query:Query
         let uri:URI
         let tag:MD5?
 
-        private
         init(
-            database:@Sendable @escaping (Server.DB) -> Query.Database,
             explain:Bool,
             query:Query,
             uri:URI,
-            tag:MD5?)
+            tag:MD5? = nil)
         {
-            self.database = database
             self.explain = explain
             self.query = query
             self.uri = uri
             self.tag = tag
         }
     }
 }
-extension Server.Operation.Pipeline where Query.Database == UnidocDatabase
-{
-    init(explain:Bool, query:Query, uri:URI, tag:MD5? = nil)
-    {
-        self.init(database: \.unidoc,
-            explain: explain,
-            query: query,
-            uri: uri,
-            tag: tag)
-    }
-}
 extension Server.Operation.Pipeline:InteractiveOperation
 {
     var statisticalType:WritableKeyPath<ServerTour.Stats.ByType, Int>
@@ -56,12 +41,12 @@ extension Server.Operation.Pipeline:UnrestrictedOperation
     func load(from server:Server.State) async throws -> ServerResponse?
     {
         try await self.load(
-            from: self.database(server.db),
+            from: server.db.unidoc,
             with: try await .init(from: server.db.sessions))
     }
 
     private
-    func load(from db:Query.Database,
+    func load(from db:UnidocDatabase,
         with session:Mongo.Session) async throws -> ServerResponse?
     {
         if  self.explain

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@ import BSONDecoding`
`2`	`2`	`import MongoDB`
`3`	`3`
`4`	`4`	`public`
`5`		`-protocol DatabaseQuery<Database, Output>:Sendable`
	`5`	`+protocol DatabaseQuery<Collation, Output>:Sendable`
`6`	`6`	`{`
`7`		`- associatedtype Database:DatabaseModel`
	`7`	`+ associatedtype Collation:DatabaseCollation`
`8`	`8`	`associatedtype Output:BSONDocumentDecodable`
`9`	`9`
`10`	`10`	`func build(pipeline:inout Mongo.Pipeline)`
`@@ -19,7 +19,7 @@ extension DatabaseQuery`
`19`	`19`	`{`
`20`	`20`	`.init(self.origin, pipeline: .init(with: self.build(pipeline:)))`
`21`	`21`	`{`
`22`		`- $0[.collation] = Database.collation`
	`22`	`+ $0[.collation] = Collation.spec`
`23`	`23`	`$0[.hint] = self.hint`
`24`	`24`	`}`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ extension UnidocDatabase.Editions:DatabaseCollection`
`35`	`35`	`[`
`36`	`36`	`.init`
`37`	`37`	`{`
`38`		`- $0[.collation] = UnidocDatabase.collation`
	`38`	`+ $0[.collation] = SimpleCollation.spec`
`39`	`39`
`40`	`40`	`$0[.unique] = true`
`41`	`41`	`$0[.name] = "package,name"`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ extension UnidocDatabase.Graphs:DatabaseCollection`
`43`	`43`	`},`
`44`	`44`	`.init`
`45`	`45`	`{`
`46`		`- $0[.collation] = UnidocDatabase.collation`
	`46`	`+ $0[.collation] = SimpleCollation.spec`
`47`	`47`
`48`	`48`	`$0[.unique] = true // for now...`
`49`	`49`	`$0[.name] = "metadata_package,version"`