Skip to content

Commit 3588ae8

Browse files
nicklaslnicklasl
authored
refactor!: restructure automatic context decorator (#185)
RELEASE-AS: 1.3.0
1 parent 848d9ae commit 3588ae8

File tree

6 files changed

+190
-118
lines changed

6 files changed

+190
-118
lines changed

‎ConfidenceDemoApp/ConfidenceDemoApp/ConfidenceDemoApp.swift

+8
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,18 @@ struct ConfidenceDemoApp: App {
2121
context["user_id"] = ConfidenceValue.init(string: user)
2222
}
2323

24+
context = ConfidenceDeviceInfoContextDecorator(
25+
withDeviceInfo: true,
26+
withAppInfo: true,
27+
withOsInfo: true,
28+
withLocale: true
29+
).decorated(context: [:]);
30+
2431
confidence = Confidence
2532
.Builder(clientSecret: secret, loggerLevel: .TRACE)
2633
.withContext(initialContext: context)
2734
.build()
35+
2836
do {
2937
// NOTE: here we are activating all the flag values from storage, regardless of how `context` looks now
3038
try confidence.activate()

‎README.md

+29
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,35 @@ _Note: Changing the context could cause a change in the flag values._
9393

9494
_Note: When a context change is performed and the SDK is fetching the new values for it, the old values are still available for the Application to consume but marked with evaluation reason `STALE`._
9595

96+
The SDK comes with a built in helper class to decorate the Context with some static data from the device.
97+
The class is called `ConfidenceDeviceInfoContextDecorator` and used as follows:
98+
99+
```swift
100+
let context = ConfidenceDeviceInfoContextDecorator(
101+
withDeviceInfo: true,
102+
withAppInfo: true,
103+
withOsInfo: true,
104+
withLocale: true
105+
).decorated(context: [:]); // it's also possible to pass an already prepared context here.
106+
```
107+
The values appended to the Context come primarily from the Bundle and the UIDevice APIs.
108+
109+
- `withAppInfo` includes:
110+
- version: the value from `CFBundleShortVersionString`.
111+
- build: the value from `CFBundleVersion`.
112+
- namespace: the `bundleIdentifier`.
113+
- `withDeviceInfo` includes:
114+
- manufacturer: hard coded to Apple.
115+
- model: the device model identifier, for example "iPhone15,4" or "iPad14,11".
116+
- type: the value from `UIDevice.current.model`.
117+
- `withOsInfo` includes:
118+
- name: the system name.
119+
- version: the system version.
120+
- `withLocale` includes:
121+
- locale: the selected Locale.
122+
- preferred_languages: the user set preferred languages as set in the Locale.
123+
124+
96125
When integrating the SDK in your Application, it's important to understand the implications of changing the context at runtime:
97126
- You might want to keep the flag values unchanged within a certain session
98127
- You might want to show a loading UI while re-fetching all flag values

‎Sources/Confidence/ConfidenceAppLifecycleProducer.swift

-105
This file was deleted.

‎Sources/Confidence/ConfidenceDeviceInfoContextDecorator.swift

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
#if os(iOS) || os(tvOS) || os(visionOS) || targetEnvironment(macCatalyst)
2+
import Foundation
3+
import UIKit
4+
import Combine
5+
6+
/**
7+
Helper class to produce device information context for the Confidence context.
8+
9+
The values appended to the Context come primarily from the Bundle or UiDevice API
10+
11+
AppInfo contains:
12+
- version: the version name of the app.
13+
- build: the version code of the app.
14+
- namespace: the package name of the app.
15+
16+
DeviceInfo contains:
17+
- manufacturer: the manufacturer of the device.
18+
- brand: the brand of the device.
19+
- model: the model of the device.
20+
- type: the type of the device.
21+
22+
OsInfo contains:
23+
- name: the name of the OS.
24+
- version: the version of the OS.
25+
26+
Locale contains:
27+
- locale: the locale of the device.
28+
- preferred_languages: the preferred languages of the device.
29+
30+
The context is only updated when the class is initialized and then static.
31+
*/
32+
public class ConfidenceDeviceInfoContextDecorator {
33+
private let staticContext: ConfidenceValue
34+
35+
public init(
36+
withDeviceInfo: Bool = false,
37+
withAppInfo: Bool = false,
38+
withOsInfo: Bool = false,
39+
withLocale: Bool = false
40+
) {
41+
var context: [String: ConfidenceValue] = [:]
42+
43+
if withDeviceInfo {
44+
let device = UIDevice.current
45+
46+
context["device"] = .init(structure: [
47+
"manufacturer": .init(string: "Apple"),
48+
"model": .init(string: Self.getDeviceModelIdentifier()),
49+
"type": .init(string: device.model)
50+
])
51+
}
52+
53+
if withAppInfo {
54+
let currentVersion: String = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? ""
55+
let currentBuild: String = Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? ""
56+
let bundleId = Bundle.main.bundleIdentifier ?? ""
57+
58+
context["app"] = .init(structure: [
59+
"version": .init(string: currentVersion),
60+
"build": .init(string: currentBuild),
61+
"namespace": .init(string: bundleId)
62+
])
63+
}
64+
65+
if withOsInfo {
66+
let device = UIDevice.current
67+
68+
context["os"] = .init(structure: [
69+
"name": .init(string: device.systemName),
70+
"version": .init(string: device.systemVersion)
71+
])
72+
}
73+
74+
if withLocale {
75+
let locale = Locale.current
76+
let preferredLanguages = Locale.preferredLanguages
77+
78+
// Top level fields
79+
context["locale"] = .init(string: locale.identifier) // Locale identifier (e.g., "en_US")
80+
context["preferred_languages"] = .init(list: preferredLanguages.map { lang in
81+
.init(string: lang)
82+
})
83+
}
84+
85+
self.staticContext = .init(structure: context)
86+
}
87+
88+
/**
89+
Returns a context where values are decorated (appended) according to how the ConfidenceDeviceInfoContextDecorator was setup.
90+
The context values in the parameter context have precedence over the fields appended by this class.
91+
*/
92+
public func decorated(context contextToDecorate: [String: ConfidenceValue]) -> [String: ConfidenceValue] {
93+
var result = self.staticContext.asStructure() ?? [:]
94+
contextToDecorate.forEach { (key: String, value: ConfidenceValue) in
95+
result[key] = value
96+
}
97+
return result
98+
}
99+
100+
101+
private static func getDeviceModelIdentifier() -> String {
102+
var systemInfo = utsname()
103+
uname(&systemInfo)
104+
let machineMirror = Mirror(reflecting: systemInfo.machine)
105+
let identifier = machineMirror.children
106+
.compactMap { element in element.value as? Int8 }
107+
.filter { $0 != 0 }
108+
.map {
109+
Character(UnicodeScalar(UInt8($0)))
110+
}
111+
return String(identifier)
112+
}
113+
}
114+
#endif

‎Tests/ConfidenceTests/ConfidenceDeviceInfoContextDecoratorTests.swift

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import XCTest
2+
@testable import Confidence
3+
4+
final class DeviceInfoContextDecoratorTests: XCTestCase {
5+
func testEmptyConstructMakesNoOp() {
6+
let result = ConfidenceDeviceInfoContextDecorator().decorated(context: [:])
7+
XCTAssertEqual(result.count, 0)
8+
}
9+
10+
func testAddDeviceInfo() {
11+
let result = ConfidenceDeviceInfoContextDecorator(withDeviceInfo: true).decorated(context: [:])
12+
XCTAssertEqual(result.count, 1)
13+
XCTAssertNotNil(result["device"])
14+
XCTAssertNotNil(result["device"]?.asStructure()?["model"])
15+
XCTAssertNotNil(result["device"]?.asStructure()?["type"])
16+
XCTAssertNotNil(result["device"]?.asStructure()?["manufacturer"])
17+
}
18+
19+
func testAddLocale() {
20+
let result = ConfidenceDeviceInfoContextDecorator(withLocale: true).decorated(context: [:])
21+
XCTAssertEqual(result.count, 2)
22+
XCTAssertNotNil(result["locale"])
23+
XCTAssertNotNil(result["preferred_languages"])
24+
}
25+
26+
func testAppendsData() {
27+
let result = ConfidenceDeviceInfoContextDecorator(
28+
withDeviceInfo: true
29+
).decorated(context: ["my_key": .init(double: 42.0)])
30+
XCTAssertEqual(result.count, 2)
31+
XCTAssertEqual(result["my_key"]?.asDouble(), 42.0)
32+
XCTAssertNotNil(result["device"])
33+
}
34+
}

‎api/Confidence_public_api.json

+5-13
Original file line numberDiff line numberDiff line change
@@ -118,23 +118,15 @@
118118
]
119119
},
120120
{
121-
"className": "ConfidenceAppLifecycleProducer",
121+
"className": "ConfidenceDeviceInfoContextDecorator",
122122
"apiFunctions": [
123123
{
124-
"name": "init()",
125-
"declaration": "public init()"
126-
},
127-
{
128-
"name": "deinit",
129-
"declaration": "deinit"
130-
},
131-
{
132-
"name": "produceEvents()",
133-
"declaration": "public func produceEvents() -> AnyPublisher<Event, Never>"
124+
"name": "init(withDeviceInfo:withAppInfo:withOsInfo:withLocale:)",
125+
"declaration": "public init(\n withDeviceInfo: Bool = false,\n withAppInfo: Bool = false,\n withOsInfo: Bool = false,\n withLocale: Bool = false\n)"
134126
},
135127
{
136-
"name": "produceContexts()",
137-
"declaration": "public func produceContexts() -> AnyPublisher<ConfidenceStruct, Never>"
128+
"name": "decorated(context:)",
129+
"declaration": "public func decorated(context contextToDecorate: [String: ConfidenceValue]) -> [String: ConfidenceValue]"
138130
}
139131
]
140132
},

0 commit comments

Comments
 (0)