Added package collection query limit for keywords

Author: luis-gustavo

Sources/App/Controllers/PackageCollectionController.swift

@@ -39,7 +39,8 @@ enum PackageCollectionController {
                         authorName: "Swift Package Index",
                         collectionName: keyword,
                         keywords: [keyword],
-                        overview: "A custom package collection generated by the Swift Package Index"
+                        overview: "A custom package collection generated by the Swift Package Index",
+                        limit: Constants.maxKeywordPackageCollectionCount
                     )
                 case let .custom(key):
                     let collection = try await CustomCollection.find(on: req.db, key: key)

Sources/App/Core/Constants.swift

@@ -46,4 +46,7 @@ enum Constants {
     // build system settings
     static let trimBuildsGracePeriod: TimeInterval = .hours(4)
     static let branchVersionRefreshDelay: TimeInterval = .hours(24)
+
+    // package
+    static let maxKeywordPackageCollectionCount = 300
 }

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) async throws -> [Self] {
+    static func query(on database: Database, filterBy filter: PackageCollection.Filter, limit maxResults: Int? = nil) async throws -> [Self] {
         let query = M
             .query(
                 on: database,
@@ -66,6 +66,10 @@ extension PackageCollection.VersionResult {
                 query.filter(App.Package.self, \.$url ~~ packageURLs)
         }
 
+        if let maxResults = maxResults {
+            query.limit(maxResults)
+        }
+
         return try await query.all()
             .map(Self.init(model:))
     }

Sources/App/Core/PackageCollection+generate.swift

@@ -48,8 +48,9 @@ extension PackageCollection {
                          collectionName: String? = nil,
                          keywords: [String]? = nil,
                          overview: String? = nil,
-                         revision: Int? = nil) async throws -> PackageCollection {
-        let results = try await VersionResult.query(on: db, filterBy: filter)
+                         revision: Int? = nil,
+                         limit maxResults: Int? = nil) async throws -> PackageCollection {
+        let results = try await VersionResult.query(on: db, filterBy: filter, limit: maxResults)
 
         // Multiple versions can reference the same package, therefore
         // we need to group them so we don't create duplicate packages.

Sources/App/Core/PackageCollection+signing.swift

@@ -31,14 +31,16 @@ extension SignedCollection {
                          collectionName: String? = nil,
                          keywords: [String]? = nil,
                          overview: String? = nil,
-                         revision: Int? = nil) async throws -> SignedCollection {
+                         revision: Int? = nil,
+                         limit maxResults: 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)
+                                                              revision: revision,
+                                                              limit: maxResults)
         return try await sign(collection: collection)
     }
 

Sources/App/Views/Keyword/KeywordShow+View.swift

@@ -59,6 +59,11 @@ enum KeywordShow {
                 .copyableInputForm(buttonName: "Copy Package Collection URL",
                                    eventName: "Copy Package Collection URL Button",
                                    valueToCopy: SiteURL.packageCollectionKeyword(.value(model.keyword)).absoluteURL()),
+                .p(
+                    .h6(
+                        .i("Note: Package collections are limited to a maximum of \(Constants.maxKeywordPackageCollectionCount) packages. If a keyword has more than \(Constants.maxKeywordPackageCollectionCount) packages, only the top \(Constants.maxKeywordPackageCollectionCount) packages will be included based on their package score.")
+                    )
+                ),
                 .hr(.class("minor")),
                 .ul(
                     .id("package-list"),
@@ -79,7 +84,6 @@ enum KeywordShow {
             )
         }
     }
-
 }
 
 

Tests/AppTests/__Snapshots__/WebpageSnapshotTests/test_KeywordShow.1.html

@@ -89,6 +89,11 @@ <h2 class="trimmed">Packages for keyword “networking”</h2>
         <form class="copyable-input">
           <input type="text" data-button-name="Copy Package Collection URL" data-event-name="Copy Package Collection URL Button" value="http://localhost:8080/keywords/networking/collection.json" readonly/>
         </form>
+        <p>
+          <h6>
+            <i>Note: Package collections are limited to a maximum of 300 packages. If a keyword has more than 300 packages, only the top 300 packages will be included based on their package score.</i>
+          </h6>
+        </p>
         <hr class="minor"/>
         <ul id="package-list">
           <li>