Update CustomCollectionsController to use key instead of name

Author: finestructure

Sources/App/Controllers/CustomCollectionsController.swift

@@ -60,9 +60,7 @@ enum CustomCollectionsController {
             throw Abort(.notFound)
         }
         let query = try req.query.decode(Query.self)
-        let collection = try await CustomCollection.query(on: req.db)
-            .filter(\.$key == key)
-            .first()
+        let collection = try await CustomCollection.find(on: req.db, key: key)
             .unwrap(or: Abort(.notFound))
         let page = try await Self.query(on: req.db, key: key, page: query.page, pageSize: query.pageSize)
 

Sources/App/Controllers/PackageCollectionController.swift

@@ -32,12 +32,14 @@ enum PackageCollectionController {
                         filterBy: .author(owner),
                         authorName: "\(owner) via the Swift Package Index"
                     )
-                case let .custom(name):
+                case let .custom(key):
+                    let collection = try await CustomCollection.find(on: req.db, key: key)
+                        .unwrap(or: Abort(.notFound))
                     return try await SignedCollection.generate(
                         db: req.db,
-                        filterBy: .customCollection(name),
+                        filterBy: .customCollection(key),
                         authorName: "Swift Package Index",
-                        collectionName: name,
+                        collectionName: collection.name,
                         overview: "A custom package collection generated by the Swift Package Index"
                     )
             }
@@ -53,7 +55,7 @@ enum PackageCollectionController {
 
     static func getCollectionType(req: Request) -> CollectionType? {
         if let owner = req.parameters.get("owner") { return .author(owner) }
-        if let name = req.parameters.get("name") { return .custom(name) }
+        if let key = req.parameters.get("key") { return .custom(key) }
         return nil
     }
 }

Sources/App/Core/PackageCollection+VersionResult.swift

@@ -55,11 +55,11 @@ extension PackageCollection.VersionResult {
         switch filter {
             case let .author(owner):
                 query.filter(Repository.self, \Repository.$owner, .custom("ilike"), owner)
-            case let .customCollection(name):
+            case let .customCollection(key):
                 query
                     .join(CustomCollectionPackage.self, on: \Package.$id == \CustomCollectionPackage.$package.$id)
                     .join(CustomCollection.self, on: \CustomCollection.$id == \CustomCollectionPackage.$customCollection.$id)
-                    .filter(CustomCollection.self, \.$name == name)
+                    .filter(CustomCollection.self, \.$key == key)
             case let .urls(packageURLs):
                 query.filter(App.Package.self, \.$url ~~ packageURLs)
         }

Sources/App/Models/CustomCollection.swift

@@ -79,10 +79,14 @@ extension CustomCollection {
         var url: URL
     }
 
+    static func find(on database: Database, key: String) async throws -> CustomCollection? {
+        try await CustomCollection.query(on: database)
+            .filter(\.$key == key)
+            .first()
+    }
+
     static func findOrCreate(on database: Database, _ details: Details) async throws -> CustomCollection {
-        if let collection = try await CustomCollection.query(on: database)
-            .filter(\.$key == details.key)
-            .first() {
+        if let collection = try await CustomCollection.find(on: database, key: details.key) {
             if collection.details != details {
                 // Update the collection if any of the details have changed
                 collection.details = details

Tests/AppTests/PackageCollectionControllerTests.swift

@@ -122,7 +122,7 @@ class PackageCollectionControllerTests: AppTestCase {
             let encoder = self.encoder
             try await app.test(
                 .GET,
-                "collections/Custom%20Collection/collection.json",
+                "collections/custom-collection/collection.json",
                 afterResponse: { @MainActor res async throws in
                     // validation
                     XCTAssertEqual(res.status, .ok)