Skip to content

Commit 3c9fd0d

Browse files
thomaspoignantthomaspoignant
authored
Merge branch 'main' into of-spec-0.8
2 parents ece5b7e + 91a9a90 commit 3c9fd0d

File tree

7 files changed

+155
-7
lines changed

7 files changed

+155
-7
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For documentation related to flags management in GO Feature Flag, refer to the [
2525

2626
In the dependencies section of `Package.swift` add:
2727
```swift
28-
.package(url: "https://github.com/go-feature-flag/openfeature-swift-provider.git", from: "0.1.0")
28+
.package(url: "https://github.com/go-feature-flag/openfeature-swift-provider.git", from: "0.3.0")
2929
```
3030

3131
and in the target dependencies section add:

‎Sources/GOFeatureFlag/controller/exporter_metadata.swift‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
import Foundation
2+
import OpenFeature
3+
4+
// Define a Codable enum that can represent any type of JSON value
5+
public enum ExporterMetadataValue: Codable, Equatable {
6+
case string(String)
7+
case integer(Int64)
8+
case double(Double)
9+
case bool(Bool)
10+
11+
// Decode the JSON based on its type
12+
public init(from decoder: Decoder) throws {
13+
let container = try decoder.singleValueContainer()
14+
if let stringValue = try? container.decode(String.self) {
15+
self = .string(stringValue)
16+
} else if let intValue = try? container.decode(Int64.self) {
17+
self = .integer(intValue)
18+
} else if let doubleValue = try? container.decode(Double.self) {
19+
self = .double(doubleValue)
20+
} else if let boolValue = try? container.decode(Bool.self) {
21+
self = .bool(boolValue)
22+
} else {
23+
throw DecodingError.dataCorruptedError(in: container, debugDescription: "Cannot decode JSONValue")
24+
}
25+
}
26+
27+
// Encode the JSON based on its type
28+
public func encode(to encoder: Encoder) throws {
29+
var container = encoder.singleValueContainer()
30+
switch self {
31+
case .string(let value):
32+
try container.encode(value)
33+
case .integer(let value):
34+
try container.encode(value)
35+
case .double(let value):
36+
try container.encode(value)
37+
case .bool(let value):
38+
try container.encode(value)
39+
}
40+
}
41+
}

‎Sources/GOFeatureFlag/controller/goff_api.swift‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ import OFREP
44

55
class GoFeatureFlagAPI {
66
private let networkingService: NetworkingService
7-
private let options: GoFeatureFlagProviderOptions
8-
private let metadata: [String:String] = ["provider": "openfeature-swift"]
7+
private var options: GoFeatureFlagProviderOptions
98

109
init(networkingService: NetworkingService, options: GoFeatureFlagProviderOptions) {
1110
self.networkingService = networkingService
1211
self.options = options
12+
13+
if self.options.exporterMetadata == nil {
14+
self.options.exporterMetadata = [:]
15+
}
16+
if var exporterMetadata = self.options.exporterMetadata {
17+
exporterMetadata["openfeature"] = .bool(true)
18+
exporterMetadata["provider"] = .string("swift")
19+
self.options.exporterMetadata = exporterMetadata
20+
}
1321
}
1422

1523
func postDataCollector(events: [FeatureEvent]?) async throws -> (DataCollectorResponse, HTTPURLResponse) {
@@ -27,8 +35,8 @@ class GoFeatureFlagAPI {
2735
let dataCollectorURL = url.appendingPathComponent("v1/data/collector")
2836
var request = URLRequest(url: dataCollectorURL)
2937
request.httpMethod = "POST"
30-
31-
let requestBody = DataCollectorRequest(meta: metadata, events: events)
38+
39+
let requestBody = DataCollectorRequest(meta: self.options.exporterMetadata, events: events)
3240
let encoder = JSONEncoder()
3341
encoder.outputFormatting = .prettyPrinted
3442
request.httpBody = try encoder.encode(requestBody)

‎Sources/GOFeatureFlag/model/data_collector_request.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import Foundation
22

33
struct DataCollectorRequest: Codable {
4-
var meta: [String:String]?
4+
var meta: [String:ExporterMetadataValue]?
55
var events: [FeatureEvent]? = []
66

7-
public init(meta: [String:String]? = [:], events: [FeatureEvent]? = []) {
7+
public init(meta: [String:ExporterMetadataValue]? = [:], events: [FeatureEvent]? = []) {
88
self.meta = meta
99
self.events = events
1010
}

‎Sources/GOFeatureFlag/options.swift‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,24 @@ public struct GoFeatureFlagProviderOptions {
3232
* default: URLSession.shared
3333
*/
3434
public var networkService: NetworkingService?
35+
/**
36+
* (optional) exporter metadata to be sent to the relay proxy data collector to be used for evaluation data events.
37+
* default: empty
38+
*/
39+
public var exporterMetadata: [String:ExporterMetadataValue]? = [:]
3540

3641
public init(
3742
endpoint: String,
3843
pollInterval: TimeInterval = 60,
3944
apiKey: String? = nil,
4045
dataFlushInterval: TimeInterval = 600,
46+
exporterMetadata: [String:ExporterMetadataValue]? = [:],
4147
networkService: NetworkingService? = URLSession.shared) {
4248
self.endpoint = endpoint
4349
self.pollInterval = pollInterval
4450
self.apiKey = apiKey
4551
self.networkService = networkService
4652
self.dataCollectorInterval = dataFlushInterval
53+
self.exporterMetadata = exporterMetadata
4754
}
4855
}

‎Tests/GOFeatureFlagTests/mock_networking_service.swift‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ public class MockNetworkingService: NetworkingService {
1010
var callCounter = 0
1111
var dataCollectorCallCounter = 0
1212
var dataCollectorEventCounter = 0
13+
var requests: [URLRequest] = []
1314

1415
public init(mockStatus: Int = 200) {
1516
self.mockStatus = mockStatus
1617
}
1718

1819
public func doRequest(for request: URLRequest) async throws -> (Data, URLResponse) {
20+
self.requests.append(request)
1921
self.callCounter+=1
2022
let isDataCollector = request.url?.absoluteString.contains("/v1/data/collector") ?? false
2123
let isBulkEvaluation = request.url?.absoluteString.contains("/ofrep/v1/evaluate/flags") ?? false

‎Tests/GOFeatureFlagTests/provider_tests.swift‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,102 @@ class GoFeatureFlagProviderTests: XCTestCase {
3434
_ = client.getDoubleDetails(key: "double-flag", defaultValue: 1.0)
3535
_ = client.getStringDetails(key: "string-flag", defaultValue: "default")
3636
_ = client.getObjectDetails(key: "object-flag", defaultValue: Value.null)
37+
3738
DispatchQueue.global().asyncAfter(deadline: .now() + 1.5) { expectation.fulfill() }
3839
await fulfillment(of: [expectation], timeout: 3.0)
3940

4041
XCTAssertEqual(1, mockNetworkService.dataCollectorCallCounter)
4142
XCTAssertEqual(6, mockNetworkService.dataCollectorEventCounter)
4243
}
44+
45+
func testExporterMetadata() async {
46+
let mockNetworkService = MockNetworkingService(mockStatus: 200)
47+
let provider = GoFeatureFlagProvider(
48+
options: GoFeatureFlagProviderOptions(
49+
endpoint: "https://localhost:1031",
50+
dataFlushInterval: 1,
51+
exporterMetadata: ["version": ExporterMetadataValue.string("1.0.0"),"testInt": ExporterMetadataValue.integer(123), "testDouble": ExporterMetadataValue.double(123.45)],
52+
networkService: mockNetworkService
53+
)
54+
)
55+
let evaluationCtx = MutableContext(targetingKey: "ede04e44-463d-40d1-8fc0-b1d6855578d0")
56+
let api = OpenFeatureAPI()
57+
await api.setProviderAndWait(provider: provider, initialContext: evaluationCtx)
58+
let client = api.getClient()
59+
60+
_ = client.getBooleanDetails(key: "my-flag", defaultValue: false)
61+
_ = client.getBooleanDetails(key: "my-flag", defaultValue: false)
62+
_ = client.getIntegerDetails(key: "int-flag", defaultValue: 1)
63+
_ = client.getDoubleDetails(key: "double-flag", defaultValue: 1.0)
64+
_ = client.getStringDetails(key: "string-flag", defaultValue: "default")
65+
_ = client.getObjectDetails(key: "object-flag", defaultValue: Value.null)
66+
67+
let expectation = self.expectation(description: "Waiting for delay")
68+
69+
DispatchQueue.global().asyncAfter(deadline: .now() + 2.0) { expectation.fulfill() }
70+
await fulfillment(of: [expectation], timeout: 3.0)
71+
72+
XCTAssertEqual(1, mockNetworkService.dataCollectorCallCounter)
73+
XCTAssertEqual(6, mockNetworkService.dataCollectorEventCounter)
74+
75+
do {
76+
let httpBodyCollector = mockNetworkService.requests[mockNetworkService.requests.count - 1].httpBody!
77+
let decodedStruct = try JSONDecoder().decode(DataCollectorRequest.self, from: httpBodyCollector)
78+
let want = [
79+
"version": ExporterMetadataValue.string("1.0.0"),
80+
"testDouble": ExporterMetadataValue.double(123.45),
81+
"testInt": ExporterMetadataValue.integer(123),
82+
"openfeature": ExporterMetadataValue.bool(true),
83+
"provider": ExporterMetadataValue.string("swift")
84+
] as? [String: ExporterMetadataValue]
85+
XCTAssertEqual(want, decodedStruct.meta)
86+
} catch {
87+
XCTFail("Error deserializing: \(error)")
88+
}
89+
}
90+
91+
func testExporterMetadataNil() async {
92+
let mockNetworkService = MockNetworkingService(mockStatus: 200)
93+
let provider = GoFeatureFlagProvider(
94+
options: GoFeatureFlagProviderOptions(
95+
endpoint: "https://localhost:1031",
96+
dataFlushInterval: 1,
97+
exporterMetadata: nil,
98+
networkService: mockNetworkService
99+
)
100+
)
101+
let evaluationCtx = MutableContext(targetingKey: "ede04e44-463d-40d1-8fc0-b1d6855578d0")
102+
let api = OpenFeatureAPI()
103+
await api.setProviderAndWait(provider: provider, initialContext: evaluationCtx)
104+
let client = api.getClient()
105+
106+
_ = client.getBooleanDetails(key: "my-flag", defaultValue: false)
107+
_ = client.getBooleanDetails(key: "my-flag", defaultValue: false)
108+
_ = client.getIntegerDetails(key: "int-flag", defaultValue: 1)
109+
_ = client.getDoubleDetails(key: "double-flag", defaultValue: 1.0)
110+
_ = client.getStringDetails(key: "string-flag", defaultValue: "default")
111+
_ = client.getObjectDetails(key: "object-flag", defaultValue: Value.null)
112+
113+
let expectation = self.expectation(description: "Waiting for delay")
114+
115+
DispatchQueue.global().asyncAfter(deadline: .now() + 2.0) { expectation.fulfill() }
116+
await fulfillment(of: [expectation], timeout: 3.0)
117+
118+
XCTAssertEqual(1, mockNetworkService.dataCollectorCallCounter)
119+
XCTAssertEqual(6, mockNetworkService.dataCollectorEventCounter)
120+
121+
do {
122+
let httpBodyCollector = mockNetworkService.requests[mockNetworkService.requests.count - 1].httpBody!
123+
let decodedStruct = try JSONDecoder().decode(DataCollectorRequest.self, from: httpBodyCollector)
124+
let want = [
125+
"openfeature": ExporterMetadataValue.bool(true),
126+
"provider": ExporterMetadataValue.string("swift")
127+
] as? [String: ExporterMetadataValue]
128+
XCTAssertEqual(want, decodedStruct.meta)
129+
} catch {
130+
XCTFail("Error deserializing: \(error)")
131+
}
132+
}
43133

44134
func testProviderMultipleHookCall() async {
45135
let mockNetworkService = MockNetworkingService(mockStatus: 200)

0 commit comments

Comments
 (0)