Skip to content

Commit 81dea6d

Browse files
thomaspoignantthomaspoignant
authored
feat: GOFF Specificity (#11)
1 parent 73c79df commit 81dea6d

30 files changed

+1414
-279
lines changed

‎.swiftlint.yml

+1
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,5 @@ identifier_name:
7272
- GlobalAPIKey
7373
- key
7474
- dto
75+
- ctx
7576
reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, codeclimate, junit, html, emoji, sonarqube, markdown, github-actions-logging, summary)

‎Package.resolved

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"repositoryURL": "https://github.com/open-feature/swift-sdk.git",
77
"state": {
88
"branch": null,
9-
"revision": "02b033c954766e86d5706bfc8ee5248244c11e77",
10-
"version": "0.1.0"
9+
"revision": "907567cf9d43aad4c015a8758a7d53d755e76213",
10+
"version": "0.2.0"
1111
}
1212
}
1313
]

‎Package.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ let package = Package(
1818
targets: ["OFREP"])
1919
],
2020
dependencies: [
21-
.package(url: "https://github.com/open-feature/swift-sdk.git", from: "0.1.0")
21+
.package(url: "https://github.com/open-feature/swift-sdk.git", from: "0.2.0")
2222
],
2323
targets: [
2424
.target(

‎Sources/GOFeatureFlag/controller/data_collector_manager.swift

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
import Foundation
2+
import OpenFeature
3+
import Combine
4+
5+
class DataCollectorManager {
6+
var events: [FeatureEvent] = []
7+
var hooks: [any Hook] = []
8+
let queue = DispatchQueue(label: "org.gofeatureflag.feature.events", attributes: .concurrent)
9+
let goffAPI: GoFeatureFlagAPI
10+
let options: GoFeatureFlagProviderOptions
11+
private var timer: DispatchSourceTimer?
12+
13+
init(goffAPI: GoFeatureFlagAPI, options: GoFeatureFlagProviderOptions) {
14+
self.goffAPI = goffAPI
15+
self.options = options
16+
}
17+
18+
func start() {
19+
timer = DispatchSource.makeTimerSource(queue: DispatchQueue.global())
20+
timer?.schedule(deadline: .now(), repeating: self.options.dataCollectorInterval, leeway: .milliseconds(100))
21+
timer?.setEventHandler { [weak self] in
22+
guard let weakSelf = self else { return }
23+
Task {
24+
await weakSelf.pushEvents()
25+
}
26+
}
27+
timer?.resume()
28+
}
29+
30+
func appendFeatureEvent(event: FeatureEvent) {
31+
self.queue.async(flags:.barrier) {
32+
self.events.append(event)
33+
}
34+
}
35+
36+
func pushEvents() async {
37+
self.queue.async(flags:.barrier) {
38+
Task {
39+
do {
40+
if !self.events.isEmpty {
41+
(_,_) = try await self.goffAPI.postDataCollector(events: self.events)
42+
self.events = []
43+
}
44+
} catch {
45+
NSLog("data collector error: \(error)")
46+
}
47+
}
48+
}
49+
}
50+
51+
func getHooks() -> [any Hook] {
52+
return self.hooks
53+
}
54+
55+
func stop() async {
56+
await self.pushEvents()
57+
}
58+
}

‎Sources/GOFeatureFlag/controller/goff_api.swift

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
import Foundation
2+
import OpenFeature
3+
import OFREP
4+
5+
class GoFeatureFlagAPI {
6+
private let networkingService: NetworkingService
7+
private let options: GoFeatureFlagProviderOptions
8+
private let metadata: [String:String] = ["provider": "openfeature-swift"]
9+
10+
init(networkingService: NetworkingService, options: GoFeatureFlagProviderOptions) {
11+
self.networkingService = networkingService
12+
self.options = options
13+
}
14+
15+
func postDataCollector(events: [FeatureEvent]?) async throws -> (DataCollectorResponse, HTTPURLResponse) {
16+
guard let events = events else {
17+
throw GoFeatureFlagError.noEventToSend
18+
}
19+
if events.isEmpty {
20+
throw GoFeatureFlagError.noEventToSend
21+
}
22+
23+
guard let url = URL(string: options.endpoint) else {
24+
throw InvalidOptions.invalidEndpoint(message: "endpoint [" + options.endpoint + "] is not valid")
25+
}
26+
27+
let dataCollectorURL = url.appendingPathComponent("v1/data/collector")
28+
var request = URLRequest(url: dataCollectorURL)
29+
request.httpMethod = "POST"
30+
31+
let requestBody = DataCollectorRequest(meta: metadata, events: events)
32+
let encoder = JSONEncoder()
33+
encoder.outputFormatting = .prettyPrinted
34+
request.httpBody = try encoder.encode(requestBody)
35+
request.setValue(
36+
"application/json",
37+
forHTTPHeaderField: "Content-Type"
38+
)
39+
if let apiKey = self.options.apiKey {
40+
request.setValue("Bearer \(apiKey)", forHTTPHeaderField:"Authorization")
41+
}
42+
43+
let (data, response) = try await networkingService.doRequest(for: request)
44+
guard let httpResponse = response as? HTTPURLResponse else {
45+
throw GoFeatureFlagError.httpResponseCastError
46+
}
47+
48+
if httpResponse.statusCode == 401 {
49+
throw GoFeatureFlagError.apiUnauthorizedError(response: httpResponse)
50+
}
51+
if httpResponse.statusCode == 403 {
52+
throw GoFeatureFlagError.forbiddenError(response: httpResponse)
53+
}
54+
if httpResponse.statusCode >= 400 {
55+
throw GoFeatureFlagError.unexpectedResponseError(response: httpResponse)
56+
}
57+
58+
do {
59+
let response = try JSONDecoder().decode(DataCollectorResponse.self, from: data)
60+
return (response, httpResponse)
61+
} catch {
62+
throw GoFeatureFlagError.unmarshallError(error: error)
63+
}
64+
}
65+
}

‎Sources/GOFeatureFlag/exception/goff_errors.swift

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import Foundation
2+
3+
enum GoFeatureFlagError: Error, Equatable {
4+
static func == (left: GoFeatureFlagError, right: GoFeatureFlagError) -> Bool {
5+
return type(of: left) == type(of: right)
6+
}
7+
8+
case httpResponseCastError
9+
case noEventToSend
10+
case unmarshallError(error: Error)
11+
case apiUnauthorizedError(response: HTTPURLResponse)
12+
case forbiddenError(response: HTTPURLResponse)
13+
case unexpectedResponseError(response: HTTPURLResponse)
14+
}

‎Sources/GOFeatureFlag/hook/data_collector_bool_hook.swift

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
import Foundation
2+
import OpenFeature
3+
import OFREP
4+
5+
class BooleanHook: Hook {
6+
typealias HookValue = Bool
7+
let dataCollectorMngr: DataCollectorManager
8+
9+
init(dataCollectorMngr: DataCollectorManager) {
10+
self.dataCollectorMngr = dataCollectorMngr
11+
}
12+
13+
func before<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
14+
return
15+
}
16+
17+
func after<HookValue>(
18+
ctx: HookContext<HookValue>,
19+
details: FlagEvaluationDetails<HookValue>,
20+
hints: [String: Any]) {
21+
let contextKind = "user"
22+
let userKey = ctx.ctx?.getTargetingKey() ?? ""
23+
let key = ctx.flagKey
24+
guard let value = details.value as? Bool else {
25+
NSLog("Default value is not of type Bool")
26+
return
27+
}
28+
29+
let event = FeatureEvent(
30+
kind: "feature",
31+
contextKind: contextKind,
32+
userKey: userKey,
33+
creationDate: Int64(Date().timeIntervalSince1970),
34+
key: key,
35+
variation: details.variant ?? "SdkDefault",
36+
value: JSONValue.bool(value),
37+
default: false,
38+
source: "PROVIDER_CACHE"
39+
)
40+
self.dataCollectorMngr.appendFeatureEvent(event: event)
41+
}
42+
43+
func error<HookValue>(
44+
ctx: HookContext<HookValue>,
45+
error: Error,
46+
hints: [String: Any]) {
47+
let contextKind = "user"
48+
let userKey = ctx.ctx?.getTargetingKey() ?? ""
49+
let key = ctx.flagKey
50+
guard let value = ctx.defaultValue as? Bool else {
51+
NSLog("Default value is not of type Bool")
52+
return
53+
}
54+
55+
let event = FeatureEvent(
56+
kind: "feature",
57+
contextKind: contextKind,
58+
userKey: userKey,
59+
creationDate: Int64(Date().timeIntervalSince1970),
60+
key: key,
61+
variation: "SdkDefault",
62+
value: JSONValue.bool(value),
63+
default: true,
64+
source: "PROVIDER_CACHE"
65+
)
66+
self.dataCollectorMngr.appendFeatureEvent(event: event)
67+
}
68+
69+
func finallyAfter<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
70+
return
71+
}
72+
}

‎Sources/GOFeatureFlag/hook/data_collector_double_hook.swift

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
import Foundation
2+
import OpenFeature
3+
import OFREP
4+
5+
class DoubleHook: Hook {
6+
typealias HookValue = Double
7+
let dataCollectorMngr: DataCollectorManager
8+
9+
init(dataCollectorMngr: DataCollectorManager) {
10+
self.dataCollectorMngr = dataCollectorMngr
11+
}
12+
13+
func before<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
14+
return
15+
}
16+
17+
func after<HookValue>(
18+
ctx: HookContext<HookValue>,
19+
details: FlagEvaluationDetails<HookValue>,
20+
hints: [String: Any]) {
21+
let contextKind = "user"
22+
let userKey = ctx.ctx?.getTargetingKey() ?? ""
23+
let key = ctx.flagKey
24+
guard let value = details.value as? Double else {
25+
NSLog("Default value is not of type Double")
26+
return
27+
}
28+
29+
let event = FeatureEvent(
30+
kind: "feature",
31+
contextKind: contextKind,
32+
userKey: userKey,
33+
creationDate: Int64(Date().timeIntervalSince1970),
34+
key: key,
35+
variation: details.variant ?? "SdkDefault",
36+
value: JSONValue.double(value),
37+
default: false,
38+
source: "PROVIDER_CACHE"
39+
)
40+
self.dataCollectorMngr.appendFeatureEvent(event: event)
41+
}
42+
43+
func error<HookValue>(
44+
ctx: HookContext<HookValue>,
45+
error: Error,
46+
hints: [String: Any]) {
47+
let contextKind = "user"
48+
let userKey = ctx.ctx?.getTargetingKey() ?? ""
49+
let key = ctx.flagKey
50+
51+
guard let value = ctx.defaultValue as? Double else {
52+
NSLog("Default value is not of type Double")
53+
return
54+
}
55+
56+
let event = FeatureEvent(
57+
kind: "feature",
58+
contextKind: contextKind,
59+
userKey: userKey,
60+
creationDate: Int64(Date().timeIntervalSince1970),
61+
key: key,
62+
variation: "SdkDefault",
63+
value: JSONValue.double(value),
64+
default: true,
65+
source: "PROVIDER_CACHE"
66+
)
67+
self.dataCollectorMngr.appendFeatureEvent(event: event)
68+
}
69+
70+
func finallyAfter<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
71+
return
72+
}
73+
}

‎Sources/GOFeatureFlag/hook/data_collector_integer_hook.swift

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
import Foundation
2+
import OpenFeature
3+
import OFREP
4+
5+
class IntegerHook: Hook {
6+
typealias HookValue = Int64
7+
let dataCollectorMngr: DataCollectorManager
8+
9+
init(dataCollectorMngr: DataCollectorManager) {
10+
self.dataCollectorMngr = dataCollectorMngr
11+
}
12+
13+
func before<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
14+
return
15+
}
16+
17+
func after<HookValue>(
18+
ctx: HookContext<HookValue>,
19+
details: FlagEvaluationDetails<HookValue>,
20+
hints: [String: Any]) {
21+
let contextKind = "user"
22+
let userKey = ctx.ctx?.getTargetingKey() ?? ""
23+
let key = ctx.flagKey
24+
guard let value = details.value as? Int64 else {
25+
NSLog("Default value is not of type Integer")
26+
return
27+
}
28+
29+
let event = FeatureEvent(
30+
kind: "feature",
31+
contextKind: contextKind,
32+
userKey: userKey,
33+
creationDate: Int64(Date().timeIntervalSince1970),
34+
key: key,
35+
variation: details.variant ?? "SdkDefault",
36+
value: JSONValue.integer(value),
37+
default: false,
38+
source: "PROVIDER_CACHE"
39+
)
40+
self.dataCollectorMngr.appendFeatureEvent(event: event)
41+
}
42+
43+
func error<HookValue>(ctx: HookContext<HookValue>, error: Error, hints: [String: Any]) {
44+
let contextKind = "user"
45+
let userKey = ctx.ctx?.getTargetingKey() ?? ""
46+
let key = ctx.flagKey
47+
guard let value = ctx.defaultValue as? Int64 else {
48+
NSLog("Default value is not of type Integer")
49+
return
50+
}
51+
52+
let event = FeatureEvent(
53+
kind: "feature",
54+
contextKind: contextKind,
55+
userKey: userKey,
56+
creationDate: Int64(Date().timeIntervalSince1970),
57+
key: key,
58+
variation: "SdkDefault",
59+
value: JSONValue.integer(value),
60+
default: true,
61+
source: "PROVIDER_CACHE"
62+
)
63+
self.dataCollectorMngr.appendFeatureEvent(event: event)
64+
}
65+
66+
func finallyAfter<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
67+
return
68+
}
69+
}

0 commit comments

Comments
 (0)