feat: Exporter Metadata

Signed-off-by: Thomas Poignant <[email protected]>

Author: thomaspoignant

Sources/GOFeatureFlag/controller/exporter_metadata.swift

@@ -0,0 +1,82 @@
+import Foundation
+import OpenFeature
+
+// Define a Codable enum that can represent any type of JSON value
+public enum ExporterMetadataValue: Codable, Equatable {
+    case string(String)
+    case integer(Int64)
+    case double(Double)
+    case bool(Bool)
+
+    // Decode the JSON based on its type
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        if let stringValue = try? container.decode(String.self) {
+            self = .string(stringValue)
+        } else if let intValue = try? container.decode(Int64.self) {
+            self = .integer(intValue)
+        } else if let doubleValue = try? container.decode(Double.self) {
+            self = .double(doubleValue)
+        } else if let boolValue = try? container.decode(Bool.self) {
+            self = .bool(boolValue)
+        } else {
+            throw DecodingError.dataCorruptedError(in: container, debugDescription: "Cannot decode JSONValue")
+        }
+    }
+
+    // Encode the JSON based on its type
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.singleValueContainer()
+        switch self {
+        case .string(let value):
+            try container.encode(value)
+        case .integer(let value):
+            try container.encode(value)
+        case .double(let value):
+            try container.encode(value)
+        case .bool(let value):
+            try container.encode(value)
+        }
+    }
+
+    public func asString() -> String? {
+        if case .string(let value) = self {
+            return value
+        }
+        return nil
+    }
+
+    public func asBoolean() -> Bool? {
+        if case .bool(let value) = self {
+            return value
+        }
+        return nil
+    }
+
+    public func asInteger() -> Int64? {
+        if case .integer(let value) = self {
+            return value
+        }
+        return nil
+    }
+
+    public func asDouble() -> Double? {
+        if case .double(let value) = self {
+            return value
+        }
+        return nil
+    }
+
+    public func toValue() -> Value {
+            switch self {
+            case .string(let string):
+                return .string(string)
+            case .integer(let integer):
+                return .integer(integer)
+            case .double(let double):
+                return .double(double)
+            case .bool(let bool):
+                return .boolean(bool)
+            }
+        }
+}

Sources/GOFeatureFlag/controller/goff_api.swift

@@ -4,12 +4,20 @@ import OFREP
 
 class GoFeatureFlagAPI {
     private let networkingService: NetworkingService
-    private let options: GoFeatureFlagProviderOptions
-    private let metadata: [String:String] = ["provider": "openfeature-swift"]
+    private var options: GoFeatureFlagProviderOptions
 
     init(networkingService: NetworkingService, options: GoFeatureFlagProviderOptions) {
         self.networkingService = networkingService
         self.options = options
+        
+        if self.options.exporterMetadata == nil {
+            self.options.exporterMetadata = [:]
+        }
+        if var exporterMetadata = self.options.exporterMetadata {
+            exporterMetadata["openfeature"] = .bool(true)
+            exporterMetadata["provider"] = .string("swift")
+            self.options.exporterMetadata = exporterMetadata
+        }
     }
 
     func postDataCollector(events: [FeatureEvent]?) async throws -> (DataCollectorResponse, HTTPURLResponse) {
@@ -27,8 +35,8 @@ class GoFeatureFlagAPI {
         let dataCollectorURL = url.appendingPathComponent("v1/data/collector")
         var request = URLRequest(url: dataCollectorURL)
         request.httpMethod = "POST"
-
-        let requestBody = DataCollectorRequest(meta: metadata, events: events)
+        
+        let requestBody = DataCollectorRequest(meta: self.options.exporterMetadata, events: events)
         let encoder = JSONEncoder()
         encoder.outputFormatting = .prettyPrinted
         request.httpBody = try encoder.encode(requestBody)

Sources/GOFeatureFlag/model/data_collector_request.swift

@@ -1,10 +1,10 @@
 import Foundation
 
 struct DataCollectorRequest: Codable {
-    var meta: [String:String]?
+    var meta: [String:ExporterMetadataValue]?
     var events: [FeatureEvent]? = []
 
-    public init(meta: [String:String]? = [:], events: [FeatureEvent]? = []) {
+    public init(meta: [String:ExporterMetadataValue]? = [:], events: [FeatureEvent]? = []) {
         self.meta = meta
         self.events = events
     }

Sources/GOFeatureFlag/options.swift

@@ -32,17 +32,24 @@ public struct GoFeatureFlagProviderOptions {
      * default: URLSession.shared
      */
     public var networkService: NetworkingService?
+    /**
+     * (optional) exporter metadata to be sent to the relay proxy data collector to be used for evaluation data events.
+     * default: empty
+     */
+    public var exporterMetadata: [String:ExporterMetadataValue]? = [:]
 
     public init(
         endpoint: String,
         pollInterval: TimeInterval = 60,
         apiKey: String? = nil,
         dataFlushInterval: TimeInterval = 600,
+        exporterMetadata: [String:ExporterMetadataValue]? = [:],
         networkService: NetworkingService? = URLSession.shared) {
         self.endpoint = endpoint
         self.pollInterval = pollInterval
         self.apiKey = apiKey
         self.networkService = networkService
         self.dataCollectorInterval = dataFlushInterval
+        self.exporterMetadata = exporterMetadata
     }
 }

Tests/GOFeatureFlagTests/mock_networking_service.swift

@@ -10,12 +10,14 @@ public class MockNetworkingService: NetworkingService {
     var callCounter = 0
     var dataCollectorCallCounter = 0
     var dataCollectorEventCounter = 0
+    var requests: [URLRequest] = []
 
     public init(mockStatus: Int = 200) {
         self.mockStatus = mockStatus
     }
 
     public func doRequest(for request: URLRequest) async throws -> (Data, URLResponse) {
+        self.requests.append(request)
         self.callCounter+=1
         let isDataCollector = request.url?.absoluteString.contains("/v1/data/collector") ?? false
         let isBulkEvaluation = request.url?.absoluteString.contains("/ofrep/v1/evaluate/flags") ?? false

Tests/GOFeatureFlagTests/provider_tests.swift

@@ -17,6 +17,7 @@ class GoFeatureFlagProviderTests: XCTestCase {
             options: GoFeatureFlagProviderOptions(
                 endpoint: "https://localhost:1031",
                 dataFlushInterval: 1,
+                exporterMetadata: ["version": ExporterMetadataValue.string("1.0.0")],
                 networkService: mockNetworkService
             )
         )
@@ -34,11 +35,72 @@ class GoFeatureFlagProviderTests: XCTestCase {
 
         let expectation = self.expectation(description: "Waiting for delay")
 
-        DispatchQueue.global().asyncAfter(deadline: .now() + 1.0) { expectation.fulfill() }
-        await fulfillment(of: [expectation], timeout: 2.0)
+        DispatchQueue.global().asyncAfter(deadline: .now() + 2.0) { expectation.fulfill() }
+        await fulfillment(of: [expectation], timeout: 3.0)
 
         XCTAssertEqual(1, mockNetworkService.dataCollectorCallCounter)
         XCTAssertEqual(6, mockNetworkService.dataCollectorEventCounter)
+        
+        do {
+            let httpBodyCollector = mockNetworkService.requests[mockNetworkService.requests.count - 1].httpBody!
+            // print httpBodyCollector
+            print(String(data: httpBodyCollector, encoding: .utf8)!)
+            let json = try JSONSerialization.jsonObject(with: httpBodyCollector, options: []) as? [String: Any]
+            guard let jsonDict = json else {
+                XCTFail("Could not deserialize JSON")
+                return
+            }
+        } catch {
+            XCTFail("Error deserializing JSON: \(error)")
+        }
+        
+    }
+    
+    func testExporterMetadata() async {
+        let mockNetworkService = MockNetworkingService(mockStatus: 200)
+        let provider = GoFeatureFlagProvider(
+            options: GoFeatureFlagProviderOptions(
+                endpoint: "https://localhost:1031",
+                dataFlushInterval: 1,
+                exporterMetadata: ["version": ExporterMetadataValue.string("1.0.0"),"testInt": ExporterMetadataValue.integer(123), "testDouble": ExporterMetadataValue.double(123.45)],
+                networkService: mockNetworkService
+            )
+        )
+        let evaluationCtx = MutableContext(targetingKey: "ede04e44-463d-40d1-8fc0-b1d6855578d0")
+        let api = OpenFeatureAPI()
+        await api.setProviderAndWait(provider: provider, initialContext: evaluationCtx)
+        let client = api.getClient()
+
+        _ = client.getBooleanDetails(key: "my-flag", defaultValue: false)
+        _ = client.getBooleanDetails(key: "my-flag", defaultValue: false)
+        _ = client.getIntegerDetails(key: "int-flag", defaultValue: 1)
+        _ = client.getDoubleDetails(key: "double-flag", defaultValue: 1.0)
+        _ = client.getStringDetails(key: "string-flag", defaultValue: "default")
+        _ = client.getObjectDetails(key: "object-flag", defaultValue: Value.null)
+
+        let expectation = self.expectation(description: "Waiting for delay")
+
+        DispatchQueue.global().asyncAfter(deadline: .now() + 2.0) { expectation.fulfill() }
+        await fulfillment(of: [expectation], timeout: 3.0)
+
+        XCTAssertEqual(1, mockNetworkService.dataCollectorCallCounter)
+        XCTAssertEqual(6, mockNetworkService.dataCollectorEventCounter)
+        
+        do {
+            let httpBodyCollector = mockNetworkService.requests[mockNetworkService.requests.count - 1].httpBody!
+            let decodedStruct = try JSONDecoder().decode(DataCollectorRequest.self, from: httpBodyCollector)
+            let want = [
+                "version": ExporterMetadataValue.string("1.0.0"),
+                "testDouble": ExporterMetadataValue.double(123.45),
+                "testInt": ExporterMetadataValue.integer(123),
+                "openfeature": ExporterMetadataValue.bool(true),
+                "provider": ExporterMetadataValue.string("swift")
+            ] as? [String: ExporterMetadataValue]
+            XCTAssertEqual(want, decodedStruct.meta)
+        } catch {
+            XCTFail("Error deserializing: \(error)")
+        }
+        
     }
 
     func testProviderMultipleHookCall() async {