Merge pull request #3517 from SwiftPackageIndex/issue-3469-dependency-transition-7

Issue 3469 dependency transition 7

Author: finestructure

Sources/App/Core/AppEnvironment.swift

@@ -23,10 +23,6 @@ import FoundationNetworking
 
 
 struct AppEnvironment: Sendable {
-    var apiSigningKey: @Sendable () -> String?
-    var appVersion: @Sendable () -> String?
-    var collectionSigningCertificateChain: @Sendable () -> [URL]
-    var collectionSigningPrivateKey: @Sendable () -> Data?
     var currentReferenceCache: @Sendable () -> CurrentReferenceCache?
     var dbId: @Sendable () -> String?
     var fetchDocumentation: @Sendable (_ client: Client, _ url: URI) async throws -> ClientResponse
@@ -91,22 +87,6 @@ extension AppEnvironment {
     nonisolated(unsafe) static var logger: Logger!
 
     static let live = AppEnvironment(
-        apiSigningKey: { Environment.get("API_SIGNING_KEY") },
-        appVersion: { App.appVersion },
-        collectionSigningCertificateChain: {
-            [
-                SignedCollection.certsDir
-                    .appendingPathComponent("package_collections.cer"),
-                SignedCollection.certsDir
-                    .appendingPathComponent("AppleWWDRCAG3.cer"),
-                SignedCollection.certsDir
-                    .appendingPathComponent("AppleIncRootCertificate.cer")
-            ]
-        },
-        collectionSigningPrivateKey: {
-            Environment.get("COLLECTION_SIGNING_PRIVATE_KEY")
-                .map { Data($0.utf8) }
-        },
         currentReferenceCache: { .live },
         dbId: { Environment.get("DATABASE_ID") },
         fetchDocumentation: { client, url in try await client.get(url) },

Sources/App/Core/Authentication/User.swift

@@ -35,8 +35,10 @@ extension User {
     struct APITierAuthenticator: AsyncBearerAuthenticator {
         var tier: Tier<V1>
 
+        @Dependency(\.environment) var environment
+
         func authenticate(bearer: BearerAuthorization, for request: Request) async throws {
-            guard let signingKey = Current.apiSigningKey() else { throw AppError.envVariableNotSet("API_SIGNING_KEY") }
+            guard let signingKey = environment.apiSigningKey() else { throw AppError.envVariableNotSet("API_SIGNING_KEY") }
             let signer = Signer(secretSigningKey: signingKey)
             do {
                 let key = try signer.verifyToken(bearer.token)

Sources/App/Core/Dependencies/EnvironmentClient.swift

@@ -21,8 +21,12 @@ import Vapor
 struct EnvironmentClient {
     // See https://swiftpackageindex.com/pointfreeco/swift-dependencies/main/documentation/dependenciesmacros/dependencyclient()#Restrictions
     // regarding the use of XCTFail here.
+    // Closures returning optionals or Void don't need this, because they automatically get the default failing
+    // mechanism when they're not set up in a test.
     var allowBuildTriggers: @Sendable () -> Bool = { XCTFail("allowBuildTriggers"); return true }
     var allowSocialPosts: @Sendable () -> Bool = { XCTFail("allowSocialPosts"); return true }
+    var apiSigningKey: @Sendable () -> String?
+    var appVersion: @Sendable () -> String?
     var awsAccessKeyId: @Sendable () -> String?
     var awsDocsBucket: @Sendable () -> String?
     var awsReadmeBucket: @Sendable () -> String?
@@ -32,12 +36,9 @@ struct EnvironmentClient {
     var buildTriggerAllowList: @Sendable () -> [Package.Id] = { XCTFail("buildTriggerAllowList"); return [] }
     var buildTriggerDownscaling: @Sendable () -> Double = { XCTFail("buildTriggerDownscaling"); return 1 }
     var buildTriggerLatestSwiftVersionDownscaling: @Sendable () -> Double = { XCTFail("buildTriggerLatestSwiftVersionDownscaling"); return 1 }
-    // We're not defaulting current to XCTFail, because its use is too pervasive and would require the vast
-    // majority of tests to be wrapped with `withDependencies`.
-    // We can do so at a later time once more tests are transitioned over for other dependencies. This is
-    // the exact same default behaviour we have with the Current dependency injection: it defaults to
-    // .development and does not raise an error when not injected.
-    var current: @Sendable () -> Environment = { .development }
+    var collectionSigningCertificateChain: @Sendable () -> [URL] = { XCTFail("collectionSigningCertificateChain"); return [] }
+    var collectionSigningPrivateKey: @Sendable () -> Data?
+    var current: @Sendable () -> Environment = { XCTFail("current"); return .development }
     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) }
@@ -55,6 +56,8 @@ extension EnvironmentClient: DependencyKey {
                     .flatMap(\.asBool)
                     ?? Constants.defaultAllowSocialPosts
             },
+            apiSigningKey: { Environment.get("API_SIGNING_KEY") },
+            appVersion: { App.appVersion },
             awsAccessKeyId: { Environment.get("AWS_ACCESS_KEY_ID") },
             awsDocsBucket: { Environment.get("AWS_DOCS_BUCKET") },
             awsReadmeBucket: { Environment.get("AWS_README_BUCKET") },
@@ -77,6 +80,16 @@ extension EnvironmentClient: DependencyKey {
                     .flatMap(Double.init)
                     ?? 1.0
             },
+            collectionSigningCertificateChain: {
+                [
+                    "package_collections.cer",
+                    "AppleWWDRCAG3.cer",
+                    "AppleIncRootCertificate.cer",
+                ].map { SignedCollection.certsDir.appendingPathComponent($0) }
+            },
+            collectionSigningPrivateKey: {
+                Environment.get("COLLECTION_SIGNING_PRIVATE_KEY").map { Data($0.utf8) }
+            },
             current: { (try? Environment.detect()) ?? .development },
             mastodonCredentials: {
                 Environment.get("MASTODON_ACCESS_TOKEN")
@@ -102,7 +115,19 @@ extension EnvironmentClient {
 
 
 extension EnvironmentClient: TestDependencyKey {
-    static var testValue: Self { Self() }
+    static var testValue: Self {
+        // sas 2024-11-22:
+        // For a few attributes we provide a default value overriding the XCTFail, because theis use is too
+        // pervasive and would require the vast majority of tests to be wrapped with `withDependencies`.
+        // We can do so at a later time once more tests are transitioned over for other dependencies. This is
+        // the exact same default behaviour we had with the Current dependency injection. It did not have
+        // a "fail if not set" mechanism and relied on default values only. We're simply preserving this
+        // mechanism for a few heavily used dependencies at the moment.
+        var mock = Self()
+        mock.appVersion = { "test" }
+        mock.current = { .development }
+        return mock
+    }
 }
 
 

Sources/App/Core/PackageCollection+signing.swift

@@ -13,10 +13,11 @@
 // limitations under the License.
 
 import Basics
+import Dependencies
 import Fluent
+import Vapor
 @preconcurrency import PackageCollectionsModel
 @preconcurrency import PackageCollectionsSigning
-import Vapor
 
 
 typealias SignedCollection = PackageCollectionSigning.Model.SignedCollection
@@ -42,12 +43,14 @@ extension SignedCollection {
     }
 
     static func sign(collection: PackageCollection) async throws -> SignedCollection {
-        guard let privateKey = Current.collectionSigningPrivateKey() else {
+        @Dependency(\.environment) var environment
+
+        guard let privateKey = environment.collectionSigningPrivateKey() else {
             throw AppError.envVariableNotSet("COLLECTION_SIGNING_PRIVATE_KEY")
         }
 
         return try await signer.sign(collection: collection,
-                                     certChainPaths: Current.collectionSigningCertificateChain(),
+                                     certChainPaths: environment.collectionSigningCertificateChain(),
                                      privateKeyPEM: privateKey)
     }
 

Sources/App/Views/PublicPage.swift

@@ -30,9 +30,10 @@ class PublicPage {
     /// The page's full HTML document.
     /// - Returns: A fully formed page inside a <html> element.
     final func document() -> HTML {
-        HTML(
+        @Dependency(\.environment) var environment
+        return HTML(
             .lang(.english),
-            .comment("Version: \(Current.appVersion())"),
+            .comment("Version: \(environment.appVersion())"),
             .comment("DB Id: \(Current.dbId())"),
             head(),
             body()

Sources/App/Views/ResourceReloadIdentifier.swift

@@ -20,9 +20,10 @@ import Vapor
 
 struct ResourceReloadIdentifier {
     static var value: String {
+        @Dependency(\.environment) var environment
         // In staging or production appVersion will be set to a commit hash or a tag name.
         // It will only ever be nil when running in a local development environment.
-        if let appVersion = Current.appVersion() {
+        if let appVersion = environment.appVersion() {
             return appVersion
         } else {
             // Return the date of the most recently modified between the JavaScript and CSS resources.