Merge pull request #29 from k-kohey/feature/auto_trackings

Add modifier that hooks onAppear and sends logs

Author: k-kohey

Demo.swiftpm/Sources/AppModule/Demo.swift

@@ -16,10 +16,6 @@ struct MyLogger: LoggerComponent {
 }
 
 extension TrackingEvent {
-    static func impletion(_ screen: String) -> Self {
-        TrackingEvent(eventName: "impletion", parameters: ["screen": screen])
-    }
-
     static var tapIncrement: Self {
         .init(eventName: "tap increment", parameters: [:])
     }
@@ -30,7 +26,7 @@ extension TrackingEvent {
 }
 
 struct TimestampMutation: Mutation {
-    func transform(_ e: Parchment.Loggable, id: Parchment.LoggerComponentID) -> Parchment.AnyLoggable {
+    func transform(_ e: Loggable, id: LoggerComponentID) -> AnyLoggable {
         var e = AnyLoggable(e)
         e.parameters["createdAt"] = Date()
         return e
@@ -40,16 +36,34 @@ struct TimestampMutation: Mutation {
 struct UserIDMutation: Mutation {
     let userID = 1
 
-    func transform(_ e: Parchment.Loggable, id: Parchment.LoggerComponentID) -> Parchment.AnyLoggable {
+    func transform(_ e: Loggable, id: LoggerComponentID) -> AnyLoggable {
         var e = AnyLoggable(e)
         e.parameters["userID"] = userID
         return e
     }
 }
 
+struct ImpletionMutation: Mutation {
+    func transform(_ e: Loggable, id: LoggerComponentID) -> AnyLoggable {
+        var e = AnyLoggable(e)
+        if e.isBased(ImpletionEvent.self) {
+            e.eventName = (e.parameters["screen"] as! String) + "ScreenEvent"
+            e.parameters = ["event": "onAppear"]
+        }
+        return e
+    }
+}
+
 let logger = LoggerBundler.make(
     components: [MyLogger(), DebugLogger()],
-    bufferFlowController: DefaultBufferFlowController(pollingInterval: 5, delayInputLimit: 5)
+    bufferFlowController: DefaultBufferFlowController(
+        pollingInterval: 5, delayInputLimit: 5
+    ),
+    mutations: [
+        TimestampMutation(),
+        ImpletionMutation(),
+        UserIDMutation()
+    ]
 )
 
 @main
@@ -84,13 +98,12 @@ struct ExampleAppApp: App {
             .background(Color.gray)
             .task {
                 await logger.startLogging()
-
-                await logger.add(
-                    mutations: [TimestampMutation(), UserIDMutation()]
-                )
-
-                await logger.send(event: .impletion("home"))
             }
+            .track(
+                screen: "Top",
+                with: logger,
+                option: .init(policy: .immediately)
+            )
         }
     }
 }

Sources/Parchment/AnyLoggable.swift

@@ -0,0 +1,63 @@
+//
+//  File.swift
+//  
+//
+//  Created by Kohei Kawaguchi on 2023/05/23.
+//
+
+import Foundation
+
+@globalActor
+final actor AnyLoggableActor {
+    static var shared: AnyLoggableActor = .init()
+}
+
+@AnyLoggableActor
+private var findCache: [UUID: [String: Bool]] = [:]
+
+public struct AnyLoggable: Loggable {
+    public var eventName: String
+    public var parameters: [String : Sendable]
+
+    public let base: (any Loggable)?
+    private let id: UUID = .init()
+
+    public init(_ base: any Loggable) {
+        self.base = base
+        self.eventName = base.eventName
+        self.parameters = base.parameters
+    }
+
+    public init(
+        eventName: String, parameters: [String : Sendable]
+    ) {
+        self.base = nil
+        self.eventName = eventName
+        self.parameters = parameters
+    }
+
+    @AnyLoggableActor
+    public func isBased<T: Loggable>(_ type: T.Type) -> Bool {
+        if findCache[id]?["\(T.self)"] == true {
+            return true
+        }
+        let result = find(T.self, from: self)
+        if findCache[id] == nil {
+            findCache[id] = [:]
+        }
+        findCache[id]?["\(T.self)"] = result
+        return result
+    }
+
+    private func find<T: Loggable>(
+        _ type: T.Type, from anyLoggable: AnyLoggable
+    ) -> Bool {
+        if let base = anyLoggable.base, base is T {
+            return true
+        } else if let innerAnyLoggable = anyLoggable.base as? AnyLoggable {
+            return find(T.self, from: innerAnyLoggable)
+        } else {
+            return false
+        }
+    }
+}

Sources/Parchment/Mutation.swift

@@ -7,30 +7,10 @@
 
 import Foundation
 
-public struct AnyLoggable: Loggable {
-    public var eventName: String
-    public var parameters: [String : Sendable]
-
-    public let base: (any Loggable)?
-
-    public init(_ base: any Loggable) {
-        self.base = base
-        self.eventName = base.eventName
-        self.parameters = base.parameters
-    }
-
-    public init(
-        eventName: String, parameters: [String : Sendable]
-    ) {
-        self.base = nil
-        self.eventName = eventName
-        self.parameters = parameters
-    }
-}
-
-typealias Transform = @Sendable (Loggable, LoggerComponentID) -> AnyLoggable
+typealias Transform = @Sendable @AnyLoggableActor (Loggable, LoggerComponentID) -> AnyLoggable
 
 public protocol Mutation: Sendable {
+    @AnyLoggableActor 
     func transform(_: any Loggable, id: LoggerComponentID) -> AnyLoggable
 }
 

Sources/Parchment/View+track.swift

@@ -0,0 +1,52 @@
+//
+//  File.swift
+//  
+//
+//  Created by Kohei Kawaguchi on 2023/05/22.
+//
+
+import SwiftUI
+
+public struct ImpletionEvent: Loggable {
+    public var eventName = "ImpletionEvent"
+    public var parameters: [String : Sendable]
+}
+
+private struct Impletion: ViewModifier {
+    let screenName: String
+    let logger: LoggerBundler
+    let option: LoggerBundler.LoggingOption?
+
+    func body(content: Content) -> some View {
+        content.onAppear {
+            Task {
+                let e = ImpletionEvent(
+                    parameters: [
+                        "screen": screenName
+                    ]
+                )
+                if let option {
+                    await logger.send(e, with: option)
+                } else {
+                    await logger.send(e)
+                }
+            }
+        }
+    }
+}
+
+public extension View {
+    func track(
+        screen name: String,
+        with logger: LoggerBundler,
+        option: LoggerBundler.LoggingOption? = nil
+    ) -> some View {
+        modifier(
+            Impletion(
+                screenName: name,
+                logger: logger,
+                option: option
+            )
+        )
+    }
+}

Sources/ParchmentDefault/LoggerBundler+.swift

@@ -11,8 +11,14 @@ public extension LoggerBundler {
     static func make(
         components: [any LoggerComponent],
         buffer: some LogBuffer = try! SQLiteBuffer(),
-        bufferFlowController: some BufferFlowController = DefaultBufferFlowController(pollingInterval: 60)
+        bufferFlowController: some BufferFlowController = DefaultBufferFlowController(pollingInterval: 60),
+        mutations: [Mutation] = []
     ) -> LoggerBundler {
-        Self(components: components, buffer: buffer, bufferFlowController: bufferFlowController)
+        Self(
+            components: components,
+            buffer: buffer,
+            bufferFlowController: bufferFlowController,
+            mutations: mutations
+        )
     }
 }

Tests/ParchmentDefaultTests/MutationTest.swift

@@ -30,11 +30,11 @@ private enum Event: Loggable {
 class MutationTests: XCTestCase {
 #if canImport(UIKit)
     // 的確なテストに直す
-    @MainActor func testTransform() throws {
+    @MainActor func testTransform() async throws {
         let event = Event.hoge
         let mutation: [Mutation] = [DeviceDataMutation(device: .current)]
 
-        let newEvent = mutation.composed()(event, .init("hoge"))
+        let newEvent = await mutation.composed()(event, .init("hoge"))
 
         XCTAssertTrue(newEvent.parameters.count > 1)
     }

Tests/ParchmentTests/AnyLoggableTests.swift

@@ -0,0 +1,34 @@
+//
+//  AnyLoggableTests.swift
+//  
+//
+//  Created by Kohei Kawaguchi on 2023/05/23.
+//
+
+@testable import Parchment
+import XCTest
+
+private struct HogeEvent: Loggable {
+    var eventName: String = ""
+    var parameters: [String : Sendable] = [:]
+}
+
+private struct FugaEvent: Loggable {
+    var eventName: String = ""
+    var parameters: [String : Sendable] = [:]
+}
+
+class AnyLoggableTests: XCTestCase {
+    @AnyLoggableActor
+    func test_isBased() async throws {
+        let e = AnyLoggable(
+            AnyLoggable(
+                HogeEvent()
+            )
+        )
+
+        XCTAssertTrue(e.isBased(HogeEvent.self))
+        XCTAssertTrue(e.isBased(AnyLoggable.self))
+        XCTAssertFalse(e.isBased(FugaEvent.self))
+    }
+}

Tests/ParchmentTests/TransformTests.swift

@@ -20,7 +20,7 @@ private struct MutationMock: Mutation {
 }
 
 final class TransformTests: XCTestCase {
-    func testComposed() {
+    func testComposed() async {
         let mutationA = MutationMock { l, id in
             AnyLoggable(
                 eventName: l.eventName,
@@ -40,7 +40,7 @@ final class TransformTests: XCTestCase {
 
 
         let mutations: [any Mutation] = [mutationA, mutationB]
-        let r = mutations.composed()(TrackingEvent(eventName: "", parameters: ["foo": 2]), .init(""))
+        let r = await mutations.composed()(TrackingEvent(eventName: "", parameters: ["foo": 2]), .init(""))
 
         XCTAssertEqual(
             r.parameters as NSDictionary,