Move postPlausibleEvent to httpClient

Author: finestructure

Sources/App/Core/AppEnvironment.swift

@@ -41,7 +41,6 @@ struct AppEnvironment: Sendable {
     var logger: @Sendable () -> Logger
     var metricsPushGatewayUrl: @Sendable () -> String?
     var plausibleBackendReportingSiteID: @Sendable () -> String?
-    var postPlausibleEvent: @Sendable (Client, Plausible.Event.Kind, Plausible.Path, User?) async throws -> Void
     var processingBuildBacklog: @Sendable () -> Bool
     var runnerIds: @Sendable () -> [String]
     var setHTTPClient: @Sendable (Client) -> Void
@@ -65,19 +64,6 @@ struct AppEnvironment: Sendable {
 }
 
 
-extension AppEnvironment {
-    func postPlausibleEvent(_ event: Plausible.Event.Kind, path: Plausible.Path, user: User?) {
-        Task {
-            do {
-                try await Current.postPlausibleEvent(Current.httpClient(), event, path, user)
-            } catch {
-                Current.logger().warning("Plausible.postEvent failed: \(error)")
-            }
-        }
-    }
-}
-
-
 extension AppEnvironment {
     nonisolated(unsafe) static var httpClient: Client!
     nonisolated(unsafe) static var logger: Logger!
@@ -115,7 +101,6 @@ extension AppEnvironment {
         logger: { logger },
         metricsPushGatewayUrl: { Environment.get("METRICS_PUSHGATEWAY_URL") },
         plausibleBackendReportingSiteID: { Environment.get("PLAUSIBLE_BACKEND_REPORTING_SITE_ID") },
-        postPlausibleEvent: { client, kind, path, user in try await Plausible.postEvent(client: client, kind: kind, path: path, user: user) },
         processingBuildBacklog: {
             Environment.get("PROCESSING_BUILD_BACKLOG").flatMap(\.asBool) ?? false
         },

Sources/App/Core/BackendReportingMiddleware.swift

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import Dependencies
 import Vapor
 
 
@@ -23,7 +24,8 @@ struct BackendReportingMiddleware: AsyncMiddleware {
         let response = try await next.respond(to: request)
         guard isActive else { return response }
         let user = try? request.auth.require(User.self)
-        Current.postPlausibleEvent(.pageview, path: path, user: user)
+        @Dependency(\.httpClient) var httpClient
+        try await httpClient.postPlausibleEvent(kind: .pageview, path: path, user: user)
         return response
     }
 }

Sources/App/Core/Dependencies/EnvironmentClient.swift

@@ -21,7 +21,7 @@ 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
+    // Closures that are throwing or return 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 }

Sources/App/Core/Dependencies/HTTPClient.swift

@@ -22,13 +22,16 @@ import Vapor
 struct HTTPClient {
     typealias Response = Vapor.HTTPClient.Response
 
-    var fetchDocumentation: @Sendable (_ url: URI) async throws -> Response = { _ in XCTFail("fetchDocumentation"); return .ok }
-    var fetchHTTPStatusCode: @Sendable (_ url: String) async throws -> HTTPStatus = { _ in XCTFail("fetchHTTPStatusCode"); return .ok }
+    var client: @Sendable () -> Vapor.HTTPClient = { XCTFail("client"); return .shared }
+    var fetchDocumentation: @Sendable (_ url: URI) async throws -> Response
+    var fetchHTTPStatusCode: @Sendable (_ url: String) async throws -> HTTPStatus
+    var postPlausibleEvent: @Sendable (_ kind: Plausible.Event.Kind, _ path: Plausible.Path, _ user: User?) async throws -> Void
 }
 
 extension HTTPClient: DependencyKey {
     static var liveValue: HTTPClient {
         .init(
+            client: { .shared },
             fetchDocumentation: { url in
                 try await Vapor.HTTPClient.shared.get(url: url.string).get()
             },
@@ -45,6 +48,9 @@ extension HTTPClient: DependencyKey {
                 } defer: {
                     try await client.shutdown()
                 }
+            },
+            postPlausibleEvent: { kind, path, user in
+                try await Plausible.postEvent(kind: kind, path: path, user: user)
             }
         )
     }
@@ -74,6 +80,10 @@ extension HTTPClient {
                 .init(status: .ok, headers: headers, body: .init(string: url.path))
         }
     }
+
+    static var noop: @Sendable (_ kind: Plausible.Event.Kind, _ path: Plausible.Path, _ user: User?) async throws -> Void {
+        { _, _, _ in }
+    }
 }
 
 extension HTTPClient.Response {

Sources/App/Core/Plausible.swift

@@ -43,18 +43,22 @@ enum Plausible {
         var message: String
     }
 
-    static let postEventURI = URI(string: "https://plausible.io/api/event")
+    static let postEventURL = "https://plausible.io/api/event"
 
-    static func postEvent(client: Client, kind: Event.Kind, path: Path, user: User?) async throws {
+    static func postEvent(kind: Event.Kind, path: Path, user: User?) async throws {
+#warning("FIXME: need to inject a http client here to so we can test this in PlausibleTests")
         guard let siteID = Current.plausibleBackendReportingSiteID() else {
             throw Error(message: "PLAUSIBLE_BACKEND_REPORTING_SITE_ID not set")
         }
-        let res = try await client.post(postEventURI, headers: .applicationJSON) { req in
-            try req.content.encode(Event(name: .pageview,
-                                         url: "https://\(siteID)\(path.rawValue)",
-                                         domain: siteID,
-                                         props: user.props))
-        }
+        let data = try JSONEncoder().encode(Event(name: .pageview,
+                                                  url: "https://\(siteID)\(path.rawValue)",
+                                                  domain: siteID,
+                                                  props: user.props))
+        let req = try Vapor.HTTPClient.Request(url: postEventURL,
+                                               method: .POST,
+                                               headers: .applicationJSON,
+                                               body: .data(data))
+        let res = try await Vapor.HTTPClient.shared.execute(request: req).get()
         guard res.status.succeeded else {
             throw Error(message: "Request failed with status code: \(res.status)")
         }

Tests/AppTests/ApiTests.swift

@@ -32,6 +32,7 @@ class ApiTests: AppTestCase {
     func test_search_noQuery() throws {
         try withDependencies {
             $0.environment.apiSigningKey = { "secret" }
+            $0.httpClient.postPlausibleEvent = App.HTTPClient.noop
         } operation: {
             // MUT
             try app.test(.GET, "api/search",
@@ -48,8 +49,12 @@ class ApiTests: AppTestCase {
     }
 
     func test_search_basic_param() async throws {
+        let event = App.ActorIsolated<TestEvent?>(nil)
         try await withDependencies {
             $0.environment.apiSigningKey = { "secret" }
+            $0.httpClient.postPlausibleEvent = { @Sendable kind, path, _ in
+                await event.setValue(.init(kind: kind, path: path))
+            }
         } operation: {
             let p1 = Package(id: .id0, url: "1")
             try await p1.save(on: app.db)
@@ -69,11 +74,6 @@ class ApiTests: AppTestCase {
             try await Version(package: p2, packageName: "Bar", reference: .branch("main")).save(on: app.db)
             try await Search.refresh(on: app.db)
 
-            let event = App.ActorIsolated<TestEvent?>(nil)
-            Current.postPlausibleEvent = { @Sendable _, kind, path, _ in
-                await event.setValue(.init(kind: kind, path: path))
-            }
-
             // MUT
             try await app.test(.GET, "api/search?query=foo%20bar",
                                headers: .bearerApplicationJSON(try .apiToken(secretKey: "secret", tier: .tier1)),
@@ -765,6 +765,7 @@ class ApiTests: AppTestCase {
     }
 
     func test_get_badge() async throws {
+        // sas 2024-12-20: Badges are not reporting plausbile events, because they triggered way too many events. (This is an old changes, just adding this comment today as I'm removing the old, commented out test remnants we still had in place.)
         // setup
         let owner = "owner"
         let repo = "repo"
@@ -782,11 +783,6 @@ class ApiTests: AppTestCase {
         try await Build(version: v, platform: .macosXcodebuild, status: .ok, swiftVersion: .v1)
             .save(on: app.db)
 
-        let event = App.ActorIsolated<TestEvent?>(nil)
-        Current.postPlausibleEvent = { @Sendable _, kind, path, _ in
-            await event.setValue(.init(kind: kind, path: path))
-        }
-
         // MUT - swift versions
         try await app.test(
             .GET,
@@ -822,21 +818,20 @@ class ApiTests: AppTestCase {
                 XCTAssertEqual(badge.cacheSeconds, 6*3600)
                 XCTAssertNotNil(badge.logoSvg)
             })
-
-        // ensure API event has been reported
-        // API reporting for badges is currently disabled, because it is very noisy
-        //        await event.withValue {
-        //            XCTAssertEqual($0, .some(.init(kind: .pageview, path: .badge)))
-        //        }
     }
 
     func test_package_collections_owner() async throws {
         try XCTSkipIf(!isRunningInCI && EnvironmentClient.liveValue.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
+
+        let event = App.ActorIsolated<TestEvent?>(nil)
         try await withDependencies {
             $0.date.now = .t0
             $0.environment.apiSigningKey = { "secret" }
             $0.environment.collectionSigningCertificateChain = EnvironmentClient.liveValue.collectionSigningCertificateChain
             $0.environment.collectionSigningPrivateKey = EnvironmentClient.liveValue.collectionSigningPrivateKey
+            $0.httpClient.postPlausibleEvent = { @Sendable kind, path, _ in
+                await event.setValue(.init(kind: kind, path: path))
+            }
         } operation: {
             // setup
             let p1 = Package(id: .id1, url: "1")
@@ -855,11 +850,6 @@ class ApiTests: AppTestCase {
             try await Product(version: v, type: .library(.automatic), name: "lib")
                 .save(on: app.db)
 
-            let event = App.ActorIsolated<TestEvent?>(nil)
-            Current.postPlausibleEvent = { @Sendable _, kind, path, _ in
-                await event.setValue(.init(kind: kind, path: path))
-            }
-
             do {  // MUT
                 let body: ByteBuffer = .init(string: """
                 {
@@ -901,12 +891,14 @@ class ApiTests: AppTestCase {
 
     func test_package_collections_packageURLs() async throws {
         try XCTSkipIf(!isRunningInCI && EnvironmentClient.liveValue.collectionSigningPrivateKey() == nil, "Skip test for local user due to unset COLLECTION_SIGNING_PRIVATE_KEY env variable")
+
         let refDate = Date(timeIntervalSince1970: 0)
         try await withDependencies {
             $0.date.now = refDate
             $0.environment.apiSigningKey = { "secret" }
             $0.environment.collectionSigningCertificateChain = EnvironmentClient.liveValue.collectionSigningCertificateChain
             $0.environment.collectionSigningPrivateKey = EnvironmentClient.liveValue.collectionSigningPrivateKey
+            $0.httpClient.postPlausibleEvent = App.HTTPClient.noop
         } operation: {
             // setup
             let p1 = Package(id: UUID(uuidString: "442cf59f-0135-4d08-be00-bc9a7cebabd3")!,
@@ -1049,6 +1041,7 @@ class ApiTests: AppTestCase {
         try await withDependencies {
             $0.environment.apiSigningKey = { "secret" }
             $0.environment.dbId = { nil }
+            $0.httpClient.postPlausibleEvent = App.HTTPClient.noop
         } operation: {
             let owner = "owner"
             let repo = "repo"
@@ -1112,6 +1105,7 @@ class ApiTests: AppTestCase {
     func test_dependencies_get() async throws {
         try await withDependencies {
             $0.environment.apiSigningKey = { "secret" }
+            $0.httpClient.postPlausibleEvent = App.HTTPClient.noop
         } operation: {
             let pkg = try await savePackage(on: app.db, id: .id0, "http://github.com/foo/bar")
             try await Repository(package: pkg,

Tests/AppTests/Mocks/AppEnvironment+mock.swift

@@ -40,7 +40,6 @@ extension AppEnvironment {
             logger: { logger },
             metricsPushGatewayUrl: { "http://pushgateway:9091" },
             plausibleBackendReportingSiteID: { nil },
-            postPlausibleEvent: { _, _, _, _ in },
             processingBuildBacklog: { false },
             runnerIds: { [] },
             setHTTPClient: { client in Self.httpClient = client },

Tests/AppTests/PlausibleTests.swift

@@ -43,7 +43,7 @@ final class PlausibleTests: XCTestCase {
         }
 
         // MUT
-        _ = try await Plausible.postEvent(client: client, kind: .pageview, path: .search, user: nil)
+        _ = try await Plausible.postEvent(kind: .pageview, path: .search, user: nil)
 
         XCTAssertTrue(called)
     }
@@ -64,7 +64,7 @@ final class PlausibleTests: XCTestCase {
         }
 
         // MUT
-        _ = try await Plausible.postEvent(client: client, kind: .pageview, path: .package, user: user)
+        _ = try await Plausible.postEvent(kind: .pageview, path: .package, user: user)
 
         XCTAssertTrue(called)
     }