chore: allow to set wrapper SDK info (sourceId & version) (#115)

Author: duyhungtnn

Bucketeer/Sources/Internal/DI/Component.swift

@@ -27,7 +27,7 @@ final class ComponentImpl: Component {
             featureTag: dataModule.config.featureTag
         )
         self.eventInteractor = EventInteractorImpl(
-            sdkVersion: dataModule.config.sdkVersion,
+            sdkInfo: dataModule.config.toSDKInfo(),
             appVersion: dataModule.config.appVersion,
             device: dataModule.device,
             eventsMaxBatchQueueCount: dataModule.config.eventsMaxQueueSize,

Bucketeer/Sources/Internal/DI/DataModule.swift

@@ -33,6 +33,7 @@ final class DataModuleImpl: DataModule {
         apiEndpoint: config.apiEndpoint,
         apiKey: self.config.apiKey,
         featureTag: self.config.featureTag,
+        sdkInfo: self.config.toSDKInfo(),
         session: URLSession(configuration: .default),
         logger: self.config.logger
     )

Bucketeer/Sources/Internal/Event/EventInteractor.swift

@@ -18,7 +18,7 @@ extension EventInteractor {
 }
 
 final class EventInteractorImpl: EventInteractor {
-    let sdkVersion: String
+    let sdkInfo: SDKInfo
     let eventsMaxBatchQueueCount: Int
     let apiClient: ApiClient
     let eventSQLDao: EventSQLDao
@@ -31,7 +31,7 @@ final class EventInteractorImpl: EventInteractor {
     private var eventUpdateListener: EventUpdateListener?
 
     init(
-        sdkVersion: String,
+        sdkInfo: SDKInfo,
         appVersion: String,
         device: Device,
         eventsMaxBatchQueueCount: Int,
@@ -42,7 +42,7 @@ final class EventInteractorImpl: EventInteractor {
         logger: Logger?,
         featureTag: String
     ) {
-        self.sdkVersion = sdkVersion
+        self.sdkInfo = sdkInfo
         self.eventsMaxBatchQueueCount = eventsMaxBatchQueueCount
         self.apiClient = apiClient
         self.eventSQLDao = eventSQLDao
@@ -75,8 +75,8 @@ final class EventInteractorImpl: EventInteractor {
                     user: user,
                     reason: evaluation.reason,
                     tag: featureTag,
-                    sourceId: .ios,
-                    sdkVersion: sdkVersion,
+                    sourceId: sdkInfo.sourceId,
+                    sdkVersion: sdkInfo.sdkVersion,
                     metadata: metadata
                 )),
                 type: .evaluation
@@ -96,8 +96,8 @@ final class EventInteractorImpl: EventInteractor {
                     user: user,
                     reason: .init(type: .client),
                     tag: featureTag,
-                    sourceId: .ios,
-                    sdkVersion: sdkVersion,
+                    sourceId: sdkInfo.sourceId,
+                    sdkVersion: sdkInfo.sdkVersion,
                     metadata: metadata
                 )),
                 type: .evaluation
@@ -117,8 +117,8 @@ final class EventInteractorImpl: EventInteractor {
                     value: value,
                     user: user,
                     tag: featureTag,
-                    sourceId: .ios,
-                    sdkVersion: sdkVersion,
+                    sourceId: sdkInfo.sourceId,
+                    sdkVersion: sdkInfo.sdkVersion,
                     metadata: metadata
                 )),
                 type: .goal
@@ -140,8 +140,8 @@ final class EventInteractorImpl: EventInteractor {
                             latencySecond: seconds
                         )),
                         type: .responseLatency,
-                        sourceId: .ios,
-                        sdk_version: sdkVersion,
+                        sourceId: sdkInfo.sourceId,
+                        sdk_version: sdkInfo.sdkVersion,
                         metadata: metadata
                     )),
                     type: .metrics
@@ -156,8 +156,8 @@ final class EventInteractorImpl: EventInteractor {
                             sizeByte: sizeByte
                         )),
                         type: .responseSize,
-                        sourceId: .ios,
-                        sdk_version: sdkVersion,
+                        sourceId: sdkInfo.sourceId,
+                        sdk_version: sdkInfo.sdkVersion,
                         metadata: metadata
                     )),
                     type: .metrics
@@ -192,9 +192,10 @@ final class EventInteractorImpl: EventInteractor {
             apiId: apiId,
             labels: ["tag": featureTag],
             currentTimeSeconds: clock.currentTimeSeconds,
-            sdkVersion: sdkVersion,
+            sdkInfo: sdkInfo,
             metadata: metadata
         )
+
         try trackMetricsEvent(events: [
             .init(
                 id: idGenerator.id(),
@@ -332,8 +333,12 @@ extension Event {
 }
 
 extension BKTError {
-    func toMetricsEventData(apiId: ApiId, labels: [String: String], currentTimeSeconds: Int64, sdkVersion: String, metadata: [String: String]?) ->
-    EventData {
+    func toMetricsEventData(
+        apiId: ApiId,
+        labels: [String: String],
+        currentTimeSeconds: Int64,
+        sdkInfo: SDKInfo,
+        metadata: [String: String]?) -> EventData {
         let error = self
         let metricsEventData: MetricsEventData
         let metricsEventType: MetricsEventType
@@ -427,8 +432,8 @@ extension BKTError {
             timestamp: currentTimeSeconds,
             event: metricsEventData,
             type: metricsEventType,
-            sourceId: .ios,
-            sdk_version: sdkVersion,
+            sourceId: sdkInfo.sourceId,
+            sdk_version: sdkInfo.sdkVersion,
             metadata: metadata
         ))
     }

Bucketeer/Sources/Internal/Model/SDKInfo.swift

@@ -0,0 +1,4 @@
+struct SDKInfo {
+   let sourceId: SourceID
+   let sdkVersion: String
+}

Bucketeer/Sources/Internal/Model/SourceID.swift

@@ -8,4 +8,12 @@ enum SourceID: Int, Codable, Hashable {
     case goalBatch = 4
     case goServer = 5
     case nodeServer = 6
+    case flutter = 8
+    case react = 9
+    case reactNative = 10
+    case openFeatureKotlin = 100
+    case openFeatureSwift = 101
+    case openFeatureJavaScript = 102
+    case openFeatureGo = 103
+    case openFeatureNode = 104
 }

Bucketeer/Sources/Internal/Remote/ApiClientImpl.swift

@@ -7,6 +7,7 @@ final class ApiClientImpl: ApiClient {
     private let apiEndpoint: URL
     private let apiKey: String
     private let featureTag: String
+    private let sdkInfo: SDKInfo
     private let session: Session
     private let defaultRequestTimeoutMills: Int64
     private let logger: Logger?
@@ -23,14 +24,15 @@ final class ApiClientImpl: ApiClient {
         apiEndpoint: URL,
         apiKey: String,
         featureTag: String,
+        sdkInfo: SDKInfo,
         defaultRequestTimeoutMills: Int64 = ApiClientImpl.DEFAULT_REQUEST_TIMEOUT_MILLIS,
         session: Session,
         logger: Logger?
     ) {
-
         self.apiEndpoint = apiEndpoint
         self.apiKey = apiKey
         self.featureTag = featureTag
+        self.sdkInfo = sdkInfo
         self.defaultRequestTimeoutMills = defaultRequestTimeoutMills
         self.session = session
         self.logger = logger
@@ -48,12 +50,12 @@ final class ApiClientImpl: ApiClient {
             tag: self.featureTag,
             user: user,
             userEvaluationsId: userEvaluationsId,
-            sourceId: .ios,
+            sourceId: sdkInfo.sourceId,
             userEvaluationCondition: UserEvaluationCondition(
                 evaluatedAt: condition.evaluatedAt,
                 userAttributesUpdated: condition.userAttributesUpdated
             ),
-            sdkVersion: Version.current
+            sdkVersion: sdkInfo.sdkVersion
         )
         let featureTag = self.featureTag
         let timeoutMillisValue = timeoutMillis ?? defaultRequestTimeoutMills
@@ -82,7 +84,8 @@ final class ApiClientImpl: ApiClient {
     func registerEvents(events: [Event], completion: ((Result<RegisterEventsResponse, BKTError>) -> Void)?) {
         let requestBody = RegisterEventsRequestBody(
             events: events,
-            sdkVersion: Version.current
+            sdkVersion: sdkInfo.sdkVersion,
+            sourceId: sdkInfo.sourceId
         )
         logger?.debug(message: "[API] Register events: \(requestBody)")
         let encoder = JSONEncoder()

Bucketeer/Sources/Internal/Remote/RequestBody/RegisterEventsRequestBody.swift

@@ -2,8 +2,8 @@ import Foundation
 
 struct RegisterEventsRequestBody: Codable {
     internal init(events: [Event] = [],
-                  sdkVersion: String = Version.current,
-                  sourceId: SourceID = SourceID.ios
+                  sdkVersion: String,
+                  sourceId: SourceID
     ) {
         self.events = events
         self.sdkVersion = sdkVersion

Bucketeer/Sources/Public/BKTConfig.swift

@@ -8,6 +8,7 @@ public struct BKTConfig {
     let eventsMaxQueueSize: Int
     let pollingInterval: Int64
     let backgroundPollingInterval: Int64
+    let sourceId: SourceID
     let sdkVersion: String
     let appVersion: String
     let logger: BKTLogger?
@@ -22,6 +23,8 @@ public struct BKTConfig {
         private(set) var backgroundPollingInterval: Int64?
         private(set) var appVersion: String?
         private(set) var logger: BKTLogger?
+        private(set) var wrapperSdkVersion: String?
+        private(set) var wrapperSdkSourceId: Int?
 
         public init() {}
 
@@ -65,6 +68,28 @@ public struct BKTConfig {
             return self
         }
 
+        // Sets the SDK version explicitly.
+        // IMPORTANT: This option is intended for internal use only.
+        // It should NOT be set by developers directly integrating this SDK.
+        // Use this option ONLY when another SDK acts as a proxy and wraps this native SDK.
+        // In such cases, set this value to the version of the proxy SDK.
+        public func with(wrapperSdkVersion: String) -> Builder {
+            self.wrapperSdkVersion = wrapperSdkVersion
+            return self
+        }
+
+        // Sets the SDK sourceId explicitly.
+        // IMPORTANT: This option is intended for internal use only.
+        // It should NOT be set by developers directly integrating this SDK.
+        // Use this option ONLY when another SDK acts as a proxy and wraps this native SDK.
+        // In such cases, set this value to the sourceId of the proxy SDK.
+        // The wrapperSdkSourceId is used to identify the origin of the request.
+        // We don't expose the SourceID enum publicly because only Flutter and OpenFeature Swift are currently supported.
+        public func with(wrapperSdkSourceId: Int) -> Builder {
+            self.wrapperSdkSourceId = wrapperSdkSourceId
+            return self
+        }
+
         public func with(logger: BKTLogger) -> Builder {
             self.logger = logger
             return self
@@ -91,27 +116,55 @@ extension BKTConfig {
         appVersion: String,
         logger: BKTLogger? = nil
     ) throws {
-        guard !apiKey.isEmpty else {
+        // Delegate to Builder to keep a single validation/normalization path.
+        let builder = BKTConfig.Builder()
+            .with(apiKey: apiKey)
+            .with(apiEndpoint: apiEndpoint)
+            .with(featureTag: featureTag)
+            .with(eventsFlushInterval: eventsFlushInterval)
+            .with(eventsMaxQueueSize: eventsMaxQueueSize)
+            .with(pollingInterval: pollingInterval)
+            .with(backgroundPollingInterval: backgroundPollingInterval)
+            .with(appVersion: appVersion)
+        if let logger = logger {
+            _ = builder.with(logger: logger)
+        }
+        // Build and assign to self
+        self = try builder.build()
+    }
+
+    private init(with builder: Builder) throws {
+        guard let apiKey = builder.apiKey, apiKey.isNotEmpty() else {
             throw BKTError.illegalArgument(message: "apiKey is required")
         }
-        guard let apiEndpointURL = URL(string: apiEndpoint) else {
+        guard let apiEndpoint = builder.apiEndpoint, apiEndpoint.isNotEmpty(), let apiEndpointURL = URL(string: apiEndpoint) else {
             throw BKTError.illegalArgument(message: "apiEndpoint is required")
         }
-        guard !appVersion.isEmpty else {
+        guard let appVersion = builder.appVersion, appVersion.isNotEmpty() else {
             throw BKTError.illegalArgument(message: "appVersion is required")
         }
 
-        var pollingInterval = pollingInterval
+        // refs: JS SDK PR https://github.com/bucketeer-io/javascript-client-sdk/pull/91
+        // Allow Builder.featureTag to be nil
+        // So the default value of the BKTConfig will be ""
+        let featureTag = builder.featureTag ?? ""
+        let logger = builder.logger
+        // Set default intervals if needed
+        var pollingInterval: Int64 = builder.pollingInterval ?? Constant.MINIMUM_POLLING_INTERVAL_MILLIS
+        var backgroundPollingInterval: Int64 = builder.backgroundPollingInterval ?? Constant.MINIMUM_BACKGROUND_POLLING_INTERVAL_MILLIS
+        var eventsFlushInterval: Int64 = builder.eventsFlushInterval ?? Constant.DEFAULT_FLUSH_INTERVAL_MILLIS
+        let eventsMaxQueueSize = builder.eventsMaxQueueSize ?? Constant.DEFAULT_MAX_QUEUE_SIZE
+
         if pollingInterval < Constant.MINIMUM_POLLING_INTERVAL_MILLIS {
             logger?.warn(message: "pollingInterval: \(pollingInterval) is set but must be above \(Constant.MINIMUM_POLLING_INTERVAL_MILLIS)")
             pollingInterval = Constant.MINIMUM_POLLING_INTERVAL_MILLIS
         }
-        var backgroundPollingInterval = backgroundPollingInterval
+
         if backgroundPollingInterval < Constant.MINIMUM_BACKGROUND_POLLING_INTERVAL_MILLIS {
             logger?.warn(message: "backgroundPollingInterval: \(backgroundPollingInterval) is set but must be above \(Constant.MINIMUM_BACKGROUND_POLLING_INTERVAL_MILLIS)")
             backgroundPollingInterval = Constant.MINIMUM_BACKGROUND_POLLING_INTERVAL_MILLIS
         }
-        var eventsFlushInterval = eventsFlushInterval
+
         if eventsFlushInterval < Constant.MINIMUM_FLUSH_INTERVAL_MILLIS {
             logger?.warn(message: "eventsFlushInterval: \(eventsFlushInterval) is set but must be above \(Constant.MINIMUM_FLUSH_INTERVAL_MILLIS)")
             eventsFlushInterval = Constant.DEFAULT_FLUSH_INTERVAL_MILLIS
@@ -123,42 +176,46 @@ extension BKTConfig {
         self.eventsMaxQueueSize = eventsMaxQueueSize
         self.pollingInterval = pollingInterval
         self.backgroundPollingInterval = backgroundPollingInterval
-        self.sdkVersion = Version.current
+
+        let resolvedSdkSourceId = try resolveSdkSourceId(wrapperSdkSourceId: builder.wrapperSdkSourceId)
+        let resolvedSdkVersion = try resolveSdkVersion(
+            resolvedSdkSourceId: resolvedSdkSourceId,
+            wrapperSdkVersion: builder.wrapperSdkVersion
+        )
+
+        self.sourceId = resolvedSdkSourceId
+        self.sdkVersion = resolvedSdkVersion
         self.appVersion = appVersion
         self.logger = logger
     }
 
-    private init(with builder: Builder) throws {
-        guard let apiKey = builder.apiKey, apiKey.isNotEmpty() else {
-            throw BKTError.illegalArgument(message: "apiKey is required")
-        }
-        guard let apiEndpoint = builder.apiEndpoint, apiEndpoint.isNotEmpty() else {
-            throw BKTError.illegalArgument(message: "apiEndpoint is required")
-        }
-        guard let appVersion = builder.appVersion, appVersion.isNotEmpty() else {
-            throw BKTError.illegalArgument(message: "appVersion is required")
-        }
+    func toSDKInfo() -> SDKInfo {
+        return .init(sourceId: self.sourceId, sdkVersion: self.sdkVersion)
+    }
+}
 
-        // Set default intervals if needed
-        let pollingInterval: Int64 = builder.pollingInterval ?? Constant.MINIMUM_POLLING_INTERVAL_MILLIS
-        let backgroundPollingInterval: Int64 = builder.backgroundPollingInterval ?? Constant.MINIMUM_BACKGROUND_POLLING_INTERVAL_MILLIS
-        let eventsFlushInterval: Int64 = builder.eventsFlushInterval ?? Constant.DEFAULT_FLUSH_INTERVAL_MILLIS
-        let eventsMaxQueueSize = builder.eventsMaxQueueSize ?? Constant.DEFAULT_MAX_QUEUE_SIZE
+// Only Flutter (8) and OpenFeature Swift (101) are supported currently.
+// Other source IDs will throw an error as its not from iOS
+private let supportedWrapperSdkSourceIds: [SourceID] = [.flutter, .openFeatureSwift]
 
-        // Use the current init method
-        try self.init(apiKey: apiKey,
-                      apiEndpoint: apiEndpoint,
-                      // refs: JS SDK PR https://github.com/bucketeer-io/javascript-client-sdk/pull/91
-                      // Allow Builder.featureTag could be nill
-                      // So the default value of the BKTConfig will be ""
-                      featureTag: builder.featureTag ?? "",
-                      eventsFlushInterval: eventsFlushInterval,
-                      eventsMaxQueueSize: eventsMaxQueueSize,
-                      pollingInterval: pollingInterval,
-                      backgroundPollingInterval: backgroundPollingInterval,
-                      appVersion: appVersion,
-                      logger: builder.logger)
+private func resolveSdkSourceId(wrapperSdkSourceId: Int?) throws -> SourceID {
+    guard let wrapperSdkSourceId = wrapperSdkSourceId else {
+        return .ios // default ios
+    }
+    if let sourceId = SourceID(rawValue: wrapperSdkSourceId), supportedWrapperSdkSourceIds.contains(sourceId) {
+        return sourceId
+    }
+    throw BKTError.illegalArgument(message: "Unsupported wrapperSdkSourceId: \(wrapperSdkSourceId)")
+}
+
+private func resolveSdkVersion(resolvedSdkSourceId: SourceID, wrapperSdkVersion: String?) throws -> String {
+    if resolvedSdkSourceId != .ios {
+        if let wrapperSdkVersion = wrapperSdkVersion, wrapperSdkVersion.isNotEmpty() {
+            return wrapperSdkVersion
+        }
+        throw BKTError.illegalArgument(message: "wrapperSdkVersion is required when sourceId is not iOS")
     }
+    return Version.current
 }
 
 fileprivate extension String {