Move currentReferenceCache to EnvironmentClient

finestructure · finestructure · commit e4162eca5105 · 2024-11-26T10:27:00.000+01:00
diff --git a/Sources/App/Core/AppEnvironment.swift b/Sources/App/Core/AppEnvironment.swift
@@ -23,7 +23,6 @@ import FoundationNetworking
 
 
 struct AppEnvironment: Sendable {
-    var currentReferenceCache: @Sendable () -> CurrentReferenceCache?
     var dbId: @Sendable () -> String?
     var fetchDocumentation: @Sendable (_ client: Client, _ url: URI) async throws -> ClientResponse
     var fetchHTTPStatusCode: @Sendable (_ url: String) async throws -> HTTPStatus
@@ -87,7 +86,6 @@ extension AppEnvironment {
     nonisolated(unsafe) static var logger: Logger!
 
     static let live = AppEnvironment(
-        currentReferenceCache: { .live },
         dbId: { Environment.get("DATABASE_ID") },
         fetchDocumentation: { client, url in try await client.get(url) },
         fetchHTTPStatusCode: { url in try await Networking.fetchHTTPStatusCode(url) },
diff --git a/Sources/App/Core/Dependencies/EnvironmentClient.swift b/Sources/App/Core/Dependencies/EnvironmentClient.swift
@@ -39,6 +39,7 @@ struct EnvironmentClient {
     var collectionSigningCertificateChain: @Sendable () -> [URL] = { XCTFail("collectionSigningCertificateChain"); return [] }
     var collectionSigningPrivateKey: @Sendable () -> Data?
     var current: @Sendable () -> Environment = { XCTFail("current"); return .development }
+    var currentReferenceCache: @Sendable () -> CurrentReferenceCache?
     var mastodonCredentials: @Sendable () -> Mastodon.Credentials?
     var mastodonPost: @Sendable (_ client: Client, _ post: String) async throws -> Void
     var random: @Sendable (_ range: ClosedRange<Double>) -> Double = { XCTFail("random"); return Double.random(in: $0) }
@@ -91,6 +92,7 @@ extension EnvironmentClient: DependencyKey {
                 Environment.get("COLLECTION_SIGNING_PRIVATE_KEY").map { Data($0.utf8) }
             },
             current: { (try? Environment.detect()) ?? .development },
+            currentReferenceCache: { .live },
             mastodonCredentials: {
                 Environment.get("MASTODON_ACCESS_TOKEN")
                     .map(Mastodon.Credentials.init(accessToken:))
diff --git a/Sources/App/routes+documentation.swift b/Sources/App/routes+documentation.swift
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-
+import Dependencies
 import Vapor
 
 
@@ -124,7 +124,7 @@ private extension Parameters {
         }
     }
 }
- 
+
 
 struct DocRedirect {
     var owner: String
@@ -152,15 +152,15 @@ extension Request {
                     target = try await DocumentationTarget.query(on: db, owner: owner, repository: repository,
                                                                  docVersion: .reference(ref))
                 }
-                
+
             case .none:
                 target = try await DocumentationTarget.query(on: db, owner: owner, repository: repository)
         }
         guard let target else { throw Abort(.notFound) }
 
         return .init(owner: owner, repository: repository, target: target, path: path)
     }
-    
+
     func getDocRoute(fragment: DocRoute.Fragment) async throws -> DocRoute {
         guard let owner = parameters.get("owner"),
               let repository = parameters.get("repository"),
@@ -170,16 +170,18 @@ extension Request {
         if fragment.requiresArchive && archive == nil { throw Abort(.badRequest) }
         let pathElements = parameters.pathElements(for: fragment, archive: archive)
 
+        @Dependency(\.environment) var environment
+
         let docVersion = try await { () -> DocVersion in
             if reference == String.current {
-                if let ref = Current.currentReferenceCache()?[owner: owner, repository: repository] {
+                if let ref = environment.currentReferenceCache()?[owner: owner, repository: repository] {
                     return .current(referencing: ref)
                 }
 
                 guard let params = try await DocumentationTarget.query(on: db, owner: owner, repository: repository)?.internal
                 else { throw Abort(.notFound) }
 
-                Current.currentReferenceCache()?[owner: owner, repository: repository] = "\(params.docVersion)"
+                environment.currentReferenceCache()?[owner: owner, repository: repository] = "\(params.docVersion)"
                 return .current(referencing: "\(params.docVersion)")
             } else {
                 return .reference(reference)
diff --git a/Tests/AppTests/Mocks/AppEnvironment+mock.swift b/Tests/AppTests/Mocks/AppEnvironment+mock.swift
@@ -22,7 +22,6 @@ import Vapor
 extension AppEnvironment {
     static func mock(eventLoop: EventLoop) -> Self {
         .init(
-            currentReferenceCache: { nil },
             dbId: { "db-id" },
             fetchDocumentation: { _, _ in .init(status: .ok) },
             fetchHTTPStatusCode: { _ in .ok },
diff --git a/Tests/AppTests/PackageController+routesTests.swift b/Tests/AppTests/PackageController+routesTests.swift
@@ -538,6 +538,7 @@ class PackageController_routesTests: SnapshotTestCase {
         //   /owner/package/documentation/~ + various path elements
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { nil }
         } operation: {
             // setup
             let pkg = try await savePackage(on: app.db, "1")
@@ -620,6 +621,7 @@ class PackageController_routesTests: SnapshotTestCase {
         //   /owner/package/documentation/~ + various path elements
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { nil }
         } operation: {
             // setup
             let pkg = try await savePackage(on: app.db, "1")
@@ -905,6 +907,7 @@ class PackageController_routesTests: SnapshotTestCase {
     func test_documentation_current_css() async throws {
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { nil }
         } operation: {
             // setup
             Current.fetchDocumentation = { _, uri in
@@ -967,6 +970,7 @@ class PackageController_routesTests: SnapshotTestCase {
     func test_documentation_current_js() async throws {
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { nil }
         } operation: {
             // setup
             Current.fetchDocumentation = { _, uri in
@@ -1029,6 +1033,7 @@ class PackageController_routesTests: SnapshotTestCase {
     func test_documentation_current_data() async throws {
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { nil }
         } operation: {
             // setup
             Current.fetchDocumentation = { _, uri in
@@ -1146,6 +1151,7 @@ class PackageController_routesTests: SnapshotTestCase {
         // Ensure references are path encoded
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { nil }
         } operation: {
             // setup
             let pkg = try await savePackage(on: app.db, "1")
@@ -1209,6 +1215,7 @@ class PackageController_routesTests: SnapshotTestCase {
     func test_documentation_routes_tutorials() async throws {
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { nil  }
         } operation: {
             // setup
             let pkg = try await savePackage(on: app.db, "1")
@@ -1478,6 +1485,7 @@ class PackageController_routesTests: SnapshotTestCase {
         // https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/2288
         try await withDependencies {
             $0.environment.awsDocsBucket = { "docs-bucket" }
+            $0.environment.currentReferenceCache = { .live }
         } operation: {
             // setup
             let pkg = try await savePackage(on: app.db, "https://github.com/foo/bar".url, processingStage: .ingestion)
@@ -1555,28 +1563,31 @@ class PackageController_routesTests: SnapshotTestCase {
 
     func test_getDocRoute_documentation_current() async throws {
         nonisolated(unsafe) let cache = CurrentReferenceCache()
-        Current.currentReferenceCache = { cache }
-        // owner/repo/~/documentation/archive
-        let req = Request(application: app, url: "", on: app.eventLoopGroup.next())
-        req.parameters.set("owner", to: "owner")
-        req.parameters.set("repository", to: "repo")
-        req.parameters.set("reference", to: "~")
-        req.parameters.set("archive", to: "archive")
+        try await withDependencies {
+            $0.environment.currentReferenceCache = { cache }
+        } operation: {
+            // owner/repo/~/documentation/archive
+            let req = Request(application: app, url: "", on: app.eventLoopGroup.next())
+            req.parameters.set("owner", to: "owner")
+            req.parameters.set("repository", to: "repo")
+            req.parameters.set("reference", to: "~")
+            req.parameters.set("archive", to: "archive")
 
-        do { // No cache value available and we've not set up the db with a record to be found -> notFound must be raised
-            _ = try await req.getDocRoute(fragment: .documentation)
-            XCTFail("expected a .notFound error")
-        } catch let error as Abort where error.status == .notFound {
-            // expected error
-        } catch {
-            XCTFail("unexpected error: \(error)")
-        }
+            do { // No cache value available and we've not set up the db with a record to be found -> notFound must be raised
+                _ = try await req.getDocRoute(fragment: .documentation)
+                XCTFail("expected a .notFound error")
+            } catch let error as Abort where error.status == .notFound {
+                // expected error
+            } catch {
+                XCTFail("unexpected error: \(error)")
+            }
 
-        cache[owner: "owner", repository: "repo"] = "1.2.3"
+            cache[owner: "owner", repository: "repo"] = "1.2.3"
 
-        do { // Now with the cache in place this resolves
-            let route = try await req.getDocRoute(fragment: .documentation)
-            XCTAssertEqual(route, .init(owner: "owner", repository: "repo", docVersion: .current(referencing: "1.2.3"), fragment: .documentation, pathElements: ["archive"]))
+            do { // Now with the cache in place this resolves
+                let route = try await req.getDocRoute(fragment: .documentation)
+                XCTAssertEqual(route, .init(owner: "owner", repository: "repo", docVersion: .current(referencing: "1.2.3"), fragment: .documentation, pathElements: ["archive"]))
+            }
         }
     }
 
