Add TypeMismatch error

spotify · Nov 6, 2024 · d2926be · d2926be
1 parent 382818a
commit d2926be
Show file tree

Hide file tree

Showing 12 changed files with 76 additions and 35 deletions.
diff --git a/ConfidenceDemoApp/ConfidenceDemoApp/ContentView.swift b/ConfidenceDemoApp/ConfidenceDemoApp/ContentView.swift
@@ -23,6 +23,8 @@ struct ContentView: View {
                     .padding(10)
                 Text(text.text)
                 Button("Get remote flag value") {
+                    let test = confidence.getEvaluation(key: "swift-demoapp.color", defaultValue: true)
+                    print("\(test)")
                     text.text = confidence.getValue(key: "swift-demoapp.color", defaultValue: "ERROR")
                     if text.text == "Green" {
                         color.color = .green

diff --git a/Sources/Confidence/Confidence.swift b/Sources/Confidence/Confidence.swift
@@ -23,8 +23,6 @@ public class Confidence: ConfidenceEventSender {
     internal let remoteFlagResolver: ConfidenceResolveClient
     internal let contextReconciliatedChanges = PassthroughSubject<String, Never>()
 
-    public static let sdkId: String = "SDK_ID_SWIFT_CONFIDENCE"
-
     required init(
         clientSecret: String,
         region: ConfidenceRegion,
@@ -153,8 +151,7 @@ public class Confidence: ConfidenceEventSender {
             return self.cache.evaluate(
                 flagName: key,
                 defaultValue: defaultValue,
-                // TMP - TESTING (force a different context, causing STALE)
-                context: ["test":ConfidenceValue(null: ())],
+                context: getContext(),
                 flagApplier: flagApplier
             )
         }
@@ -399,9 +396,7 @@ extension Confidence {
                 credentials: ConfidenceClientCredentials.clientSecret(secret: clientSecret),
                 region: region,
                 timeoutIntervalForRequest: timeout)
-            let metadata = ConfidenceMetadata(
-                name: sdkId,
-                version: "1.0.1") // x-release-please-version
+            let metadata = ConfidenceMetadata.defaultMetadata
             let uploader = RemoteConfidenceClient(
                 options: options,
                 metadata: metadata,

diff --git a/Sources/Confidence/ConfidenceMetadata.swift b/Sources/Confidence/ConfidenceMetadata.swift
@@ -1,11 +1,15 @@
 import Foundation
 
 struct ConfidenceMetadata {
+    private static let sdkName: String = "SDK_ID_SWIFT_CONFIDENCE"
+    private static let sdkId: Int = 13 // TODO enstablish cross-language identifiers
+
+    public var id: Int
     public var name: String
     public var version: String
 
-    public init(name: String, version: String) {
-        self.name = name
-        self.version = version
-    }
+    public static let defaultMetadata = ConfidenceMetadata(
+        id: sdkId,
+        name: sdkName,
+        version: "1.0.1") // x-release-please-version
 }
diff --git a/Sources/Confidence/FlagEvaluation.swift b/Sources/Confidence/FlagEvaluation.swift
@@ -96,6 +96,7 @@ extension FlagResolution {
                             errorMessage: nil
                         )
                     } else {
+                        Telemetry.shared.incrementFlagTypeMismatch()
                         return Evaluation(
                             value: defaultValue,
                             variant: nil,

diff --git a/Sources/Confidence/Telemetry/TelemetryManager.swift b/Sources/Confidence/Telemetry/TelemetryManager.swift
@@ -2,21 +2,28 @@ import Foundation
 
 protocol TelemetryManager {
     func incrementStaleAccess()
+    func incrementFlagTypeMismatch()
     func getSnapshot() -> TelemetryPayload
 }
 
 class Telemetry: TelemetryManager {
     private let queue = DispatchQueue(label: "com.confidence.telemetry_manager")
     private var staleAccessCounter = 0;
+    private var flagTypeMismatchCounter = 0;
 
     public init() {}
 
-    static public let shared: TelemetryManager = Telemetry()
+    static public let shared: TelemetryManager = Telemetry.init()
 
     public func getSnapshot() -> TelemetryPayload {
-        return queue.sync {
-            TelemetryPayload(staleAccess: getStaleAccessAndReset())
-        }
+        TelemetryPayload(
+            libraryId: ConfidenceMetadata.defaultMetadata.id,
+            libraryVersion: ConfidenceMetadata.defaultMetadata.version,
+            countTraces: [
+                CountTrace.init(traceId: TraceId.staleAccess, count: getStaleAccessAndReset()),
+                CountTrace.init(traceId: TraceId.typeMismatch, count: getFlagTypeMismatchAndReset()),
+            ],
+            durationsTraces: [])
     }
 
     public func incrementStaleAccess() {
@@ -25,11 +32,25 @@ class Telemetry: TelemetryManager {
         }
     }
 
+    public func incrementFlagTypeMismatch() {
+        queue.sync {
+            flagTypeMismatchCounter += 1
+        }
+    }
+
     private func getStaleAccessAndReset() -> Int {
         return queue.sync {
             let currentCounter = staleAccessCounter
             staleAccessCounter = 0;
             return currentCounter
         }
     }
+
+    private func getFlagTypeMismatchAndReset() -> Int {
+        return queue.sync {
+            let currentCounter = flagTypeMismatchCounter
+            flagTypeMismatchCounter = 0;
+            return currentCounter
+        }
+    }
 }
diff --git a/Sources/Confidence/Telemetry/TelemetryPayload.swift b/Sources/Confidence/Telemetry/TelemetryPayload.swift
@@ -1,5 +1,23 @@
 import Foundation
 
 struct TelemetryPayload: Encodable {
-    var staleAccess = 0
+    var libraryId: Int
+    var libraryVersion: String
+    var countTraces: [CountTrace]
+    var durationsTraces: [DurationsTrace]
+}
+
+struct CountTrace: Encodable {
+    var traceId: TraceId
+    var count: Int
+}
+
+struct DurationsTrace: Encodable {
+    var traceId: TraceId
+    var millisDuration: [Int]
+}
+
+enum TraceId: Int, Encodable {
+    case typeMismatch = 1
+    case staleAccess = 2
 }
diff --git a/Tests/ConfidenceTests/ConfidenceContextTests.swift b/Tests/ConfidenceTests/ConfidenceContextTests.swift
@@ -8,7 +8,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidenceParent = Confidence.init(
             clientSecret: "",
@@ -35,7 +35,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidenceParent = Confidence.init(
             clientSecret: "",
@@ -67,7 +67,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidence = Confidence.init(
             clientSecret: "",
@@ -94,7 +94,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidenceParent = Confidence.init(
             clientSecret: "",
@@ -125,7 +125,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidenceParent = Confidence.init(
             clientSecret: "",
@@ -156,7 +156,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidence = Confidence.init(
             clientSecret: "",
@@ -181,7 +181,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidenceParent = Confidence.init(
             clientSecret: "",
@@ -209,7 +209,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidenceParent = Confidence.init(
             clientSecret: "",
@@ -240,7 +240,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidenceParent = Confidence.init(
             clientSecret: "",
@@ -273,7 +273,7 @@ final class ConfidenceContextTests: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let confidence = Confidence.init(
             clientSecret: "",

diff --git a/Tests/ConfidenceTests/EventSenderEngineTest.swift b/Tests/ConfidenceTests/EventSenderEngineTest.swift
@@ -115,7 +115,7 @@ final class EventSenderEngineTest: XCTestCase {
                 timeoutIntervalForRequest: 10
             ),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let eventSenderEngine = EventSenderEngineImpl(
             clientSecret: "CLIENT_SECRET",
@@ -143,7 +143,7 @@ final class EventSenderEngineTest: XCTestCase {
                 timeoutIntervalForRequest: 10
             ),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let eventSenderEngine = EventSenderEngineImpl(
             clientSecret: "CLIENT_SECRET",

diff --git a/Tests/ConfidenceTests/FlagApplierWithRetriesTest.swift b/Tests/ConfidenceTests/FlagApplierWithRetriesTest.swift
@@ -14,7 +14,7 @@ class FlagApplierWithRetriesTest: XCTestCase {
     )
     private var storage = StorageMock()
     private var httpClient = HttpClientMock()
-    private let metadata = ConfidenceMetadata(name: "test-provider-name", version: "0.0.0.")
+    private let metadata = ConfidenceMetadata(id: 0, name: "test-provider-name", version: "0.0.0.")
 
     override func setUp() {
         storage = StorageMock()

diff --git a/Tests/ConfidenceTests/RemoteConfidenceClientTests.swift b/Tests/ConfidenceTests/RemoteConfidenceClientTests.swift
@@ -14,7 +14,7 @@ class RemoteConfidenceClientTest: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let processed = try await client.upload(events: [
             NetworkEvent(
@@ -31,7 +31,7 @@ class RemoteConfidenceClientTest: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let processed = try await client.upload(events: [])
         XCTAssertTrue(processed)
@@ -43,7 +43,7 @@ class RemoteConfidenceClientTest: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         let processed = try await client.upload(events: [
             NetworkEvent(
@@ -61,7 +61,7 @@ class RemoteConfidenceClientTest: XCTestCase {
             options: ConfidenceClientOptions(
                 credentials: ConfidenceClientCredentials.clientSecret(secret: ""), timeoutIntervalForRequest: 10),
             session: MockedClientURLProtocol.mockedSession(),
-            metadata: ConfidenceMetadata(name: "", version: ""))
+            metadata: ConfidenceMetadata(id: 0, name: "", version: ""))
 
         var caughtError: ConfidenceError?
         do {

diff --git a/Tests/ConfidenceTests/RemoteResolveConfidenceClientTest.swift b/Tests/ConfidenceTests/RemoteResolveConfidenceClientTest.swift
@@ -29,7 +29,7 @@ class RemoteResolveConfidenceClientTest: XCTestCase {
             options: .init(credentials: .clientSecret(secret: "test"), timeoutIntervalForRequest: 10),
             session: session,
             applyOnResolve: true,
-            metadata: ConfidenceMetadata(name: "", version: "")
+            metadata: ConfidenceMetadata(id: 0, name: "", version: "")
         )
 
         let context = ["targeting_key": ConfidenceValue(string: "user1")]

diff --git a/release-please-config.json b/release-please-config.json
@@ -11,7 +11,7 @@
                 "README.md",
                 "Sources/ConfidenceProvider/README.md",
                 "Sources/ConfidenceProvider/ConfidenceFeatureProvider.swift",
-                "Sources/Confidence/Confidence.swift"
+                "Sources/Confidence/ConfidenceMetadata.swift"
             ]
         }
     },