Merge pull request #3327 from SwiftPackageIndex/convert-PackageCollection-to-async-await

finestructure · web-flow · commit 1ff30d0421ac · 2024-08-23T15:30:07.000+02:00
Convert PackageCollection related ELFs to a/a
diff --git a/Sources/App/Controllers/API/API+PackageCollectionController.swift b/Sources/App/Controllers/API/API+PackageCollectionController.swift
@@ -23,14 +23,14 @@ extension API {
     enum PackageCollectionController {
 
         @Sendable
-        static func generate(req: Request) throws -> EventLoopFuture<SignedCollection> {
+        static func generate(req: Request) async throws -> SignedCollection {
             AppMetrics.apiPackageCollectionGetTotal?.inc()
 
             let dto = try req.content.decode(PostPackageCollectionDTO.self)
 
             switch dto.selection {
                 case let .author(author):
-                    return SignedCollection.generate(
+                    return try await SignedCollection.generate(
                         db: req.db,
                         filterBy: .author(author),
                         authorName: dto.authorName ?? "Swift Package Index",
@@ -44,7 +44,7 @@ extension API {
                     guard packageURLs.count <= 20 else {
                         throw Abort(.badRequest)
                     }
-                    return SignedCollection.generate(
+                    return try await SignedCollection.generate(
                         db: req.db,
                         filterBy: .urls(packageURLs),
                         authorName: dto.authorName ?? "Swift Package Index",
diff --git a/Sources/App/Controllers/PackageCollectionController.swift b/Sources/App/Controllers/PackageCollectionController.swift
@@ -17,22 +17,19 @@ import Vapor
 
 enum PackageCollectionController {
     @Sendable
-    static func generate(req: Request) throws -> EventLoopFuture<SignedCollection> {
+    static func generate(req: Request) async throws -> SignedCollection {
         AppMetrics.packageCollectionGetTotal?.inc()
 
-        guard let owner = req.parameters.get("owner") else {
-            return req.eventLoop.future(error: Abort(.notFound))
-        }
+        guard let owner = req.parameters.get("owner") else { throw Abort(.notFound) }
 
-        return SignedCollection.generate(
-            db: req.db,
-            filterBy: .author(owner),
-            authorName: "\(owner) via the Swift Package Index"
-        ).flatMapError {
-            if case PackageCollection.Error.noResults = $0 {
-                return req.eventLoop.makeFailedFuture(Abort(.notFound))
-            }
-            return req.eventLoop.makeFailedFuture($0)
+        do {
+            return try await SignedCollection.generate(
+                db: req.db,
+                filterBy: .author(owner),
+                authorName: "\(owner) via the Swift Package Index"
+            )
+        } catch PackageCollection.Error.noResults {
+            throw Abort(.notFound)
         }
     }
 }
diff --git a/Sources/App/Core/PackageCollection+VersionResult.swift b/Sources/App/Core/PackageCollection+VersionResult.swift
@@ -40,7 +40,7 @@ extension PackageCollection.VersionResult {
     var targets: [App.Target] { version.targets }
     var version: App.Version { model.version }
 
-    static func query(on database: Database, filterBy filter: PackageCollection.Filter) -> EventLoopFuture<[Self]> {
+    static func query(on database: Database, filterBy filter: PackageCollection.Filter) async throws -> [Self] {
         let query = M
             .query(
                 on: database,
@@ -59,8 +59,8 @@ extension PackageCollection.VersionResult {
                 query.filter(App.Package.self, \.$url ~~ packageURLs)
         }
 
-        return query.all()
-            .mapEach(Self.init(model:))
+        return try await query.all()
+            .map(Self.init(model:))
     }
 }
 
diff --git a/Sources/App/Core/PackageCollection+generate.swift b/Sources/App/Core/PackageCollection+generate.swift
@@ -44,39 +44,30 @@ extension PackageCollection {
                          collectionName: String? = nil,
                          keywords: [String]? = nil,
                          overview: String? = nil,
-                         revision: Int? = nil) -> EventLoopFuture<PackageCollection> {
-        VersionResult.query(on: db, filterBy: filter)
-            .map { results in
-                // Multiple versions can reference the same package, therefore
-                // we need to group them so we don't create duplicate packages.
-                results.groupedByPackage(sortBy: .url)
-            }
-            .map { groups -> ([Package], String, String) in
-                let packages = groups.compactMap {
-                    Package.init(resultGroup: $0,
-                                 keywords: keywords)
-                }
-                let authorLabel = authorLabel(repositories: groups.map(\.repository))
-                let collectionName = collectionName ?? Self.collectionName(for: filter, authorLabel: authorLabel)
-                let overview = overview ?? Self.overview(for: filter, authorLabel: authorLabel)
-                return (packages, collectionName, overview)
-            }
-            .flatMap { packages, collectionName, overview in
-                guard !packages.isEmpty else {
-                    return db.eventLoop.makeFailedFuture(Error.noResults)
-                }
-                return db.eventLoop.makeSucceededFuture(
-                    PackageCollection.init(
-                        name: collectionName,
-                        overview: overview,
-                        keywords: keywords,
-                        packages: packages,
-                        formatVersion: .v1_0,
-                        revision: revision,
-                        generatedAt: Current.date(),
-                        generatedBy: authorName.map(Author.init(name:)))
-                )
-            }
+                         revision: Int? = nil) async throws -> PackageCollection {
+        let results = try await VersionResult.query(on: db, filterBy: filter)
+
+        // Multiple versions can reference the same package, therefore
+        // we need to group them so we don't create duplicate packages.
+        let groups = results.groupedByPackage(sortBy: .url)
+
+        let packages = groups.compactMap { Package.init(resultGroup: $0, keywords: keywords) }
+        let authorLabel = authorLabel(repositories: groups.map(\.repository))
+        let collectionName = collectionName ?? Self.collectionName(for: filter, authorLabel: authorLabel)
+        let overview = overview ?? Self.overview(for: filter, authorLabel: authorLabel)
+
+        guard !packages.isEmpty else { throw Error.noResults }
+
+        return PackageCollection.init(
+            name: collectionName,
+            overview: overview,
+            keywords: keywords,
+            packages: packages,
+            formatVersion: .v1_0,
+            revision: revision,
+            generatedAt: Current.date(),
+            generatedBy: authorName.map(Author.init(name:))
+        )
     }
 
     static func authorLabel(repositories: [Repository]) -> String? {
diff --git a/Sources/App/Core/PackageCollection+signing.swift b/Sources/App/Core/PackageCollection+signing.swift
@@ -30,36 +30,30 @@ extension SignedCollection {
                          collectionName: String? = nil,
                          keywords: [String]? = nil,
                          overview: String? = nil,
-                         revision: Int? = nil) -> EventLoopFuture<SignedCollection> {
-        PackageCollection.generate(db: db,
-                                   filterBy: filter,
-                                   authorName: authorName,
-                                   collectionName: collectionName,
-                                   keywords: keywords,
-                                   overview: overview,
-                                   revision: revision)
-            .flatMap {
-                sign(eventLoop: db.eventLoop, collection: $0)
-            }
+                         revision: Int? = nil) async throws -> SignedCollection {
+        let collection  = try await PackageCollection.generate(db: db,
+                                                               filterBy: filter,
+                                                               authorName: authorName,
+                                                               collectionName: collectionName,
+                                                               keywords: keywords,
+                                                               overview: overview,
+                                                               revision: revision)
+        return try await sign(collection: collection)
     }
 
-    static func sign(eventLoop: EventLoop, collection: PackageCollection) -> EventLoopFuture<SignedCollection> {
+    static func sign(collection: PackageCollection) async throws -> SignedCollection {
         guard let privateKey = Current.collectionSigningPrivateKey() else {
-            return eventLoop.makeFailedFuture(AppError.envVariableNotSet("COLLECTION_SIGNING_PRIVATE_KEY"))
+            throw AppError.envVariableNotSet("COLLECTION_SIGNING_PRIVATE_KEY")
         }
 
-        return eventLoop.makeFutureWithTask {
-            try await signer.sign(collection: collection,
-                                  certChainPaths: Current.collectionSigningCertificateChain(),
-                                  privateKeyPEM: privateKey)
-        }
+        return try await signer.sign(collection: collection,
+                                     certChainPaths: Current.collectionSigningCertificateChain(),
+                                     privateKeyPEM: privateKey)
     }
 
-    static func validate(eventLoop: EventLoop, signedCollection: SignedCollection) -> EventLoopFuture<Bool> {
-        eventLoop.makeFutureWithTask {
-            try await signer.validate(signedCollection: signedCollection)
-            return true
-        }
+    static func validate(signedCollection: SignedCollection) async throws -> Bool {
+        try await signer.validate(signedCollection: signedCollection)
+        return true
     }
 
     static let certsDir = URL(fileURLWithPath: Current.fileManager.workingDirectory())
diff --git a/Tests/AppTests/PackageCollectionTests.swift b/Tests/AppTests/PackageCollectionTests.swift

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ extension PackageCollection.VersionResult {`
`40`	`40`	`var targets: [App.Target] { version.targets }`
`41`	`41`	`var version: App.Version { model.version }`
`42`	`42`
`43`		`- static func query(on database: Database, filterBy filter: PackageCollection.Filter) -> EventLoopFuture<[Self]> {`
	`43`	`+ static func query(on database: Database, filterBy filter: PackageCollection.Filter) async throws -> [Self] {`
`44`	`44`	`let query = M`
`45`	`45`	`.query(`
`46`	`46`	`on: database,`
`@@ -59,8 +59,8 @@ extension PackageCollection.VersionResult {`
`59`	`59`	`query.filter(App.Package.self, \.$url ~~ packageURLs)`
`60`	`60`	`}`
`61`	`61`
`62`		`- return query.all()`
`63`		`- .mapEach(Self.init(model:))`
	`62`	`+ return try await query.all()`
	`63`	`+ .map(Self.init(model:))`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`