Merge pull request #3568 from SwiftPackageIndex/issue-3469-dependency-transition-12

Issue 3469 dependency transition 12

Author: finestructure

Sources/App/Core/AppEnvironment.swift

@@ -36,14 +36,12 @@ struct AppEnvironment: Sendable {
     var gitlabPipelineLimit: @Sendable () -> Int
     var hideStagingBanner: @Sendable () -> Bool
     var maintenanceMessage: @Sendable () -> String?
-    var httpClient: @Sendable () -> Client
     var loadSPIManifest: @Sendable (String) -> SPIManifest.Manifest?
     var logger: @Sendable () -> Logger
     var metricsPushGatewayUrl: @Sendable () -> String?
     var plausibleBackendReportingSiteID: @Sendable () -> String?
     var processingBuildBacklog: @Sendable () -> Bool
     var runnerIds: @Sendable () -> [String]
-    var setHTTPClient: @Sendable (Client) -> Void
     var setLogger: @Sendable (Logger) -> Void
     var shell: Shell
     var siteURL: @Sendable () -> String
@@ -65,7 +63,6 @@ struct AppEnvironment: Sendable {
 
 
 extension AppEnvironment {
-    nonisolated(unsafe) static var httpClient: Client!
     nonisolated(unsafe) static var logger: Logger!
 
     static let live = AppEnvironment(
@@ -96,7 +93,6 @@ extension AppEnvironment {
         maintenanceMessage: {
             Environment.get("MAINTENANCE_MESSAGE").flatMap(\.trimmed)
         },
-        httpClient: { httpClient },
         loadSPIManifest: { path in SPIManifest.Manifest.load(in: path) },
         logger: { logger },
         metricsPushGatewayUrl: { Environment.get("METRICS_PUSHGATEWAY_URL") },
@@ -110,7 +106,6 @@ extension AppEnvironment {
                 .flatMap { try? JSONDecoder().decode([String].self, from: $0) }
             ?? []
         },
-        setHTTPClient: { client in Self.httpClient = client },
         setLogger: { logger in Self.logger = logger },
         shell: .live,
         siteURL: { Environment.get("SITE_URL") ?? "http://localhost:8080" },

Sources/App/Core/Dependencies/EnvironmentClient.swift

@@ -42,8 +42,6 @@ struct EnvironmentClient {
     var currentReferenceCache: @Sendable () -> CurrentReferenceCache?
     var dbId: @Sendable () -> String?
     var mastodonCredentials: @Sendable () -> Mastodon.Credentials?
-    #warning("drop client parameter and move this to httpClient")
-    var mastodonPost: @Sendable (_ client: Client, _ message: String) async throws -> Void
     var random: @Sendable (_ range: ClosedRange<Double>) -> Double = { XCTFail("random"); return Double.random(in: $0) }
 
     enum FailureMode: String {
@@ -110,7 +108,6 @@ extension EnvironmentClient: DependencyKey {
                 Environment.get("MASTODON_ACCESS_TOKEN")
                     .map(Mastodon.Credentials.init(accessToken:))
             },
-            mastodonPost: { client, message in try await Mastodon.post(client: client, message: message) },
             random: { range in Double.random(in: range) },
             shouldFail: { failureMode in
                 let shouldFail = Environment.get("FAILURE_MODE")

Sources/App/Core/Dependencies/HTTPClient.swift

@@ -23,17 +23,18 @@ struct HTTPClient {
     typealias Request = Vapor.HTTPClient.Request
     typealias Response = Vapor.HTTPClient.Response
 
-    var post: @Sendable (_ url: String, _ headers: HTTPHeaders, _ body: Data) async throws -> Response
+    var post: @Sendable (_ url: String, _ headers: HTTPHeaders, _ body: Data?) async throws -> Response
     var fetchDocumentation: @Sendable (_ url: URI) async throws -> Response
     var fetchHTTPStatusCode: @Sendable (_ url: String) async throws -> HTTPStatus
+    var mastodonPost: @Sendable (_ message: String) async throws -> Void
     var postPlausibleEvent: @Sendable (_ kind: Plausible.Event.Kind, _ path: Plausible.Path, _ user: User?) async throws -> Void
 }
 
 extension HTTPClient: DependencyKey {
     static var liveValue: HTTPClient {
         .init(
             post: { url, headers, body in
-                let req = try Request(url: url, method: .POST, headers: headers, body: .data(body))
+                let req = try Request(url: url, method: .POST, headers: headers, body: body.map({.data($0)}))
                 return try await Vapor.HTTPClient.shared.execute(request: req).get()
             },
             fetchDocumentation: { url in
@@ -53,6 +54,7 @@ extension HTTPClient: DependencyKey {
                     try await client.shutdown()
                 }
             },
+            mastodonPost: { message in try await Mastodon.post(message: message) },
             postPlausibleEvent: { kind, path, user in
                 try await Plausible.postEvent(kind: kind, path: path, user: user)
             }

Sources/App/Core/Mastodon.swift

@@ -18,34 +18,45 @@ import Vapor
 
 enum Mastodon {
 
-    private static let instance = "mas.to"
-    private static let apiURL = "https://\(instance)/api/v1/statuses"
+    private static let apiHost = "mas.to"
+    private static let apiPath = "/api/v1/statuses"
     static let postMaxLength = 490  // 500, leaving some buffer for unicode accounting oddities
 
     struct Credentials {
         var accessToken: String
     }
 
-    // NB: _testEncodedURL is a callback that exists purely to be able to regression test the encoded value
-    static func post(client: Client, message: String, _testEncodedURL: (String) -> Void = { _ in }) async throws {
+    static func apiURL(with message: String) throws -> String {
+        var components = URLComponents()
+        components.scheme = "https"
+        components.host = apiHost
+        components.path = apiPath
+        components.queryItems = [URLQueryItem(name: "status", value: message)]
+        guard let url = components.string else {
+            throw Social.Error.invalidURL
+        }
+        return url
+    }
+
+    static func post(message: String) async throws {
         @Dependency(\.environment) var environment
+        @Dependency(\.httpClient) var httpClient
+        @Dependency(\.uuid) var uuid
         guard let credentials = environment.mastodonCredentials() else {
             throw Social.Error.missingCredentials
         }
 
         let headers = HTTPHeaders([
             ("Authorization", "Bearer \(credentials.accessToken)"),
-            ("Idempotency-Key", UUID().uuidString),
+            ("Idempotency-Key", uuid().uuidString),
         ])
 
         struct Query: Encodable {
             var status: String
         }
 
-        let res = try await client.post(URI(string: apiURL), headers: headers) { req in
-            try req.query.encode(Query(status: message))
-            _testEncodedURL(req.url.string)
-        }
+        let res = try await httpClient.post(url: apiURL(with: message), headers: headers, body: nil)
+
         guard res.status == .ok else {
             throw Social.Error.requestFailed(res.status, res.body?.asString() ?? "")
         }

Sources/App/Core/Social.swift

@@ -22,6 +22,7 @@ enum Social {
 
     enum Error: LocalizedError {
         case invalidMessage
+        case invalidURL
         case missingCredentials
         case postingDisabled
         case requestFailed(HTTPStatus, String)
@@ -98,14 +99,15 @@ enum Social {
                                package: Joined<Package, Repository>,
                                version: Version) async throws {
         @Dependency(\.environment) var environment
+        @Dependency(\.httpClient) var httpClient
         guard environment.allowSocialPosts() else { throw Error.postingDisabled }
         guard let message = firehoseMessage(package: package,
                                             version: version,
                                             maxLength: postMaxLength) else {
             throw Error.invalidMessage
         }
         // Ignore errors from here for now to keep concurrency simpler
-        async let _ = try? await environment.mastodonPost(client: client, message: message)
+        async let _ = try? await httpClient.mastodonPost(message: message)
     }
 
     static func postToFirehose(client: Client,

Sources/App/configure.swift

@@ -27,7 +27,6 @@ public func configure(_ app: Application) async throws -> String {
 
     app.logger.component = "server"
     Current.setLogger(app.logger)
-    Current.setHTTPClient(app.client)
 
     // It will be tempting to uncomment/re-add these lines in the future. We should not enable
     // server-side compression as long as we pass requests through Cloudflare, which compresses

Tests/AppTests/AnalyzeErrorTests.swift

@@ -104,7 +104,7 @@ final class AnalyzeErrorTests: AppTestCase {
         withDependencies {
             $0.date.now = .t0
             $0.environment.allowSocialPosts = { true }
-            $0.environment.mastodonPost = { @Sendable [socialPosts = self.socialPosts] _, message in
+            $0.httpClient.mastodonPost = { @Sendable [socialPosts = self.socialPosts] message in
                 socialPosts.withValue { $0.append(message) }
             }
         } operation: {

Tests/AppTests/AnalyzerTests.swift

@@ -36,7 +36,7 @@ class AnalyzerTests: AppTestCase {
         try await withDependencies {
             $0.date.now = .now
             $0.environment.allowSocialPosts = { true }
-            $0.environment.mastodonPost = { @Sendable _, _ in }
+            $0.httpClient.mastodonPost = { @Sendable _ in }
         } operation: {
             // setup
             let urls = ["https://github.com/foo/1", "https://github.com/foo/2"]
@@ -219,7 +219,7 @@ class AnalyzerTests: AppTestCase {
         try await withDependencies {
             $0.date.now = .now
             $0.environment.allowSocialPosts = { true }
-            $0.environment.mastodonPost = { @Sendable _, _ in }
+            $0.httpClient.mastodonPost = { @Sendable _ in }
         } operation: {
             // setup
             let pkgId = UUID()

Tests/AppTests/LiveTests.swift

@@ -0,0 +1,54 @@
+// Copyright Dave Verwer, Sven A. Schmidt, and other contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+@testable import App
+
+import Dependencies
+import XCTVapor
+
+
+class LiveTests: XCTestCase {
+
+    func test_Mastodon_post() async throws {
+        // Only run this test manually to confirm posting works
+        try XCTSkipIf(true)
+
+        try await withDependencies {
+            $0.environment.mastodonCredentials = { .dev }
+            $0.httpClient = .liveValue
+            $0.uuid = .init(UUID.init)
+        } operation: {
+            let message = Social.versionUpdateMessage(
+                packageName: "packageName",
+                repositoryOwnerName: "owner",
+                url: "http://localhost:8080/owner/SomePackage",
+                version: .init(2, 6, 4),
+                summary: "Testing, testing αβγ ÄÖÜß 🔤 ✅",
+                maxLength: Social.postMaxLength
+            )
+
+            try await Mastodon.post(message: message)
+        }
+    }
+
+}
+
+
+extension Mastodon.Credentials {
+    // https://mas.to/@spi_test
+    static var dev: Self? {
+        guard let accessToken = Environment.get("DEV_MASTODON_ACCESS_TOKEN") else { return nil }
+        return .init(accessToken: accessToken)
+    }
+}

Tests/AppTests/MastodonTests.swift

@@ -25,7 +25,7 @@ final class MastodonTests: AppTestCase {
         let message = QueueIsolated<String?>(nil)
         try await withDependencies {
             $0.environment.allowSocialPosts = { true }
-            $0.environment.mastodonPost = { @Sendable _, msg in
+            $0.httpClient.mastodonPost = { @Sendable msg in
                 if message.value == nil {
                     message.setValue(msg)
                 } else {