feat: save and send event

Author: zhu-xiaowei

.gitlab-ci.yml

@@ -1,8 +1,6 @@
 default:
-  image: swift
   tags:
-    - size:2xlarge
-    - arch:amd64
+    - instance-type:mac2.metal
 
 workflow:
   rules:
@@ -13,12 +11,42 @@ workflow:
     - when: never
 
 # Check merge request message
-lint:
-  stage: build
+title-lint:
+  stage: .pre
   script:
     - echo Start PR Validation
     - env
     - '[[ "$CI_COMMIT_MESSAGE" =~ ^(feat|fix|chore|docs|tests|ci) ]] || (echo "no commit type is specified in merge request title" && exit 1)'
 
+# Check code lint issue
+code-lint:
+  stage: .pre
+  script:
+    - swiftlint
 
+# Check code format issue
+code-format:
+  stage: .pre
+  script:
+    - swiftformat .
 
+# Execute code build
+build:
+  stage: build
+  script:
+    - swift build
+    
+# Execute code test
+test:
+  stage: test
+  script:
+    - rm -rf .build/test/
+    - xcodebuild test -scheme aws-solution-clickstream-swift -destination 'platform=iOS Simulator,name=iPhone 14 Pro,OS=latest' -resultBundlePath .build/test/TestResults.xcresult
+    - xcrun xccov view --report --json .build/test/TestResults.xcresult > .build/test/report.json
+    - COVERAGE_EXPRESS=$(grep -Eo '"lineCoverage":\s*([0-9]+\.[0-9]+)(?:,"targets":)' .build/test/report.json)
+    - COVERAGE=$(echo "$COVERAGE_EXPRESS" | grep -o '[0-9]*\.[0-9]*' | awk '{ printf "%.2f", $1 * 100 }')
+    - echo "coverage:$COVERAGE"
+  coverage: '/coverage:([0-9]+\.[0-9]+)/'
+  artifacts:
+    paths:
+      - .build/test/

.swiftlint.yml

@@ -5,6 +5,7 @@
 excluded:
   - Pods
   - .build
+  - Tests
 
 analyzer_rules:
   - unused_import
@@ -13,6 +14,9 @@ analyzer_rules:
 opt_in_rules:
   - empty_count
 
+disabled_rules:
+  - opening_brace
+
 # configurable rules can be customized from this configuration file
 closing_brace: error
 colon:
@@ -28,10 +32,12 @@ identifier_name:
     - id
     - of
     - or
+  allowed_symbols:
+    - _
+  validates_start_with_lowercase: false
 line_length:
   warning: 120
   error: 160
-opening_brace: error
 return_arrow_whitespace: error
 statement_position:
   severity: error

.swiftpm/xcode/xcshareddata/xcschemes/aws-solution-clickstream-swift.xcscheme

@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1420"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "Clickstream"
+               BuildableName = "Clickstream"
+               BlueprintName = "Clickstream"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "NO"
+            buildForArchiving = "NO"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "ClickstreamTests"
+               BuildableName = "ClickstreamTests"
+               BlueprintName = "ClickstreamTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "NO"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES">
+      <CommandLineArguments>
+         <CommandLineArgument
+            argument = "--enable-test-discovery"
+            isEnabled = "YES">
+         </CommandLineArgument>
+      </CommandLineArguments>
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "Clickstream"
+            BuildableName = "Clickstream"
+            BlueprintName = "Clickstream"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </CodeCoverageTargets>
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "ClickstreamTests"
+               BuildableName = "ClickstreamTests"
+               BlueprintName = "ClickstreamTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "Clickstream"
+            BuildableName = "Clickstream"
+            BlueprintName = "Clickstream"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

Package.resolved

@@ -10,18 +10,27 @@ let package = Package(
     products: [
         .library(
             name: "Clickstream",
-            targets: ["Clickstream"])
+            targets: ["Clickstream"]
+        )
     ],
     dependencies: [
-        .package(url: "https://github.com/aws-amplify/amplify-swift.git", exact: "2.4.0")
+        .package(url: "https://github.com/aws-amplify/amplify-swift.git", exact: "2.4.0"),
+        .package(url: "https://github.com/stephencelis/SQLite.swift.git", exact: "0.13.2"),
+        .package(url: "https://github.com/1024jp/GzipSwift", exact: "5.2.0"),
+        .package(url: "https://github.com/httpswift/swifter", exact: "1.5.0")
     ],
     targets: [
         .target(
             name: "Clickstream",
             dependencies: [
-                .product(name: "AWSPluginsCore", package: "amplify-swift")
-            ]),
+                .product(name: "AWSPluginsCore", package: "amplify-swift"),
+                .product(name: "SQLite", package: "SQLite.swift"),
+                .product(name: "Gzip", package: "GzipSwift")
+            ]
+        ),
         .testTarget(
             name: "ClickstreamTests",
-            dependencies: ["Clickstream"])
-    ])
+            dependencies: ["Clickstream", .product(name: "Swifter", package: "swifter")]
+        )
+    ]
+)

Package.swift

@@ -12,7 +12,7 @@ public extension AWSClickstreamPlugin {
     func identifyUser(userId: String, userProfile: AnalyticsUserProfile?) {
         Task {
             if userId == Event.User.USER_ID_NIL {
-                await analyticsClient.removeUserAttribute(forKey: userId)
+                await analyticsClient.removeUserAttribute(forKey: Event.ReservedAttribute.USER_ID)
             } else if userId != Event.User.USER_ID_EMPTY {
                 await analyticsClient.addUserAttribute(userId, forKey: Event.ReservedAttribute.USER_ID)
             }
@@ -25,13 +25,17 @@ public extension AWSClickstreamPlugin {
     }
 
     func record(event: AnalyticsEvent) {
+        guard let event = event as? BaseClickstreamEvent else{
+            log.error("Event type does not match")
+            return
+        }
         if !isEnabled {
             log.warn("Cannot record events. Clickstream is disabled")
             return
         }
         let clickstreamEvent = analyticsClient.createEvent(withEventType: event.name)
-        if let properties = event.properties {
-            clickstreamEvent.addProperties(properties)
+        if let attributes = event.attribute {
+            clickstreamEvent.addAttribute(attributes)
         }
 
         Task {
@@ -44,7 +48,7 @@ public extension AWSClickstreamPlugin {
     }
 
     func record(eventWithName eventName: String) {
-        let event = BasicAnalyticsEvent(name: eventName)
+        let event = BaseClickstreamEvent(name: eventName)
         record(event: event)
     }
 

Sources/Clickstream/AWSClickstreamPlugin+ClientBehavior.swift

@@ -27,9 +27,10 @@ public extension AWSClickstreamPlugin {
         let contextConfiguration = ClickstreamContextConfiguration(appId: configuration.appId,
                                                                    endpoint: configuration.endpoint,
                                                                    sendEventsInterval: configuration.sendEventsInterval,
-                                                                   isTrackAppExceptionEvents: configuration.isTrackAppExceptionEvents,
+                                                                   isTrackAppExceptionEvents:
+                                                                   configuration.isTrackAppExceptionEvents,
                                                                    isCompressEvents: configuration.isCompressEvents)
-        let clickstream = try ClickstreamContext(with: contextConfiguration)
+        clickstream = try ClickstreamContext(with: contextConfiguration)
 
         let sessionClient = SessionClient(configuration: .init(uniqueDeviceId: clickstream.uniqueId,
                                                                sessionBackgroundTimeout: TimeInterval(10)),
@@ -52,7 +53,7 @@ public extension AWSClickstreamPlugin {
 
         var autoFlushEventsTimer: DispatchSourceTimer?
         if configuration.sendEventsInterval != 0 {
-            let timeInterval = TimeInterval(configuration.sendEventsInterval / 1000)
+            let timeInterval = TimeInterval(Double(configuration.sendEventsInterval) / 1_000)
             autoFlushEventsTimer = RepeatingTimer.createRepeatingTimer(
                 timeInterval: timeInterval,
                 eventHandler: { [weak self] in
@@ -62,21 +63,21 @@ public extension AWSClickstreamPlugin {
             )
         }
 
-        configure(clickstream: clickstream,
-                  autoFlushEventsTimer: autoFlushEventsTimer,
-                  networkMonitor: networkMonitor)
+        configure(
+            autoFlushEventsTimer: autoFlushEventsTimer,
+            networkMonitor: networkMonitor
+        )
         sessionClient.startSession()
         log.debug("init the sdk success")
     }
 
     // MARK: Internal
 
     /// Internal configure method to set the properties of the plugin
-    internal func configure(clickstream: ClickstreamContext,
-                            autoFlushEventsTimer: DispatchSourceTimer?,
-                            networkMonitor: NetworkMonitor)
-    {
-        self.clickstream = clickstream
+    internal func configure(
+        autoFlushEventsTimer: DispatchSourceTimer?,
+        networkMonitor: NetworkMonitor
+    ) {
         isEnabled = true
         self.autoFlushEventsTimer = autoFlushEventsTimer
         self.autoFlushEventsTimer?.resume()

Sources/Clickstream/AWSClickstreamPlugin+Configure.swift

@@ -5,6 +5,4 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
-import Amplify
-
-extension AWSClickstreamPlugin: DefaultLogger {}
+extension AWSClickstreamPlugin: ClickstreamLogger {}

Sources/Clickstream/AWSClickstreamPlugin+DefaultLogger.swift

@@ -18,7 +18,7 @@ public extension AWSClickstreamPlugin {
         }
 
         if isEnabled != nil {
-            isEnabled = nil
+            isEnabled = false
         }
 
         if networkMonitor != nil {