chore: adds evalDetails and evalTargetId if available to the provider evaluation response metadata (#5)

Author: kaushalkapasi

.gitignore

@@ -63,4 +63,6 @@ fastlane/screenshots/**/*.png
 fastlane/test_output
 
 .DS_Store
-.swiftpm/
+.swiftpm/
+
+.vscode/

Sources/DevCycleProvider.swift

@@ -175,8 +175,10 @@ public final class DevCycleProvider: FeatureProvider {
         }
 
         let variable = devcycleClient!.variable(key: key, defaultValue: defaultValue)
+
         return ProviderEvaluation(
             value: variable.value,
+            flagMetadata: DevCycleProvider.getFlagMetadata(variable: variable),
             reason: DevCycleProvider.getEvalReason(variable: variable)
         )
     }
@@ -205,6 +207,7 @@ public final class DevCycleProvider: FeatureProvider {
         let variable = devcycleClient!.variable(key: key, defaultValue: defaultValue)
         return ProviderEvaluation(
             value: variable.value,
+            flagMetadata: DevCycleProvider.getFlagMetadata(variable: variable),
             reason: DevCycleProvider.getEvalReason(variable: variable)
         )
     }
@@ -236,6 +239,7 @@ public final class DevCycleProvider: FeatureProvider {
 
         return ProviderEvaluation(
             value: Int64(variable.value),
+            flagMetadata: DevCycleProvider.getFlagMetadata(variable: variable),
             reason: DevCycleProvider.getEvalReason(variable: variable)
         )
     }
@@ -264,6 +268,7 @@ public final class DevCycleProvider: FeatureProvider {
         let variable = devcycleClient!.variable(key: key, defaultValue: defaultValue)
         return ProviderEvaluation(
             value: variable.value,
+            flagMetadata: DevCycleProvider.getFlagMetadata(variable: variable),
             reason: DevCycleProvider.getEvalReason(variable: variable)
         )
     }
@@ -295,6 +300,7 @@ public final class DevCycleProvider: FeatureProvider {
         return ProviderEvaluation(
             value: variable.isDefaulted
                 ? defaultValue : DevCycleProvider.convertDictionaryToValue(variable.value),
+            flagMetadata: DevCycleProvider.getFlagMetadata(variable: variable),
             reason: DevCycleProvider.getEvalReason(variable: variable)
         )
     }
@@ -546,4 +552,17 @@ public final class DevCycleProvider: FeatureProvider {
         }
         return variable.isDefaulted ? Reason.defaultReason.rawValue : Reason.targetingMatch.rawValue
     }
+
+    internal static func getFlagMetadata<T>(variable: DVCVariable<T>) -> [String: FlagMetadataValue] {
+        var flagMetadata: [String: FlagMetadataValue] = [:]
+        if let evalReason = variable.eval {
+            if let evalDetails = evalReason.details {
+                flagMetadata["evalDetails"] = FlagMetadataValue.of(evalDetails)
+            }
+            if let evalTargetId = evalReason.targetId {
+                flagMetadata["evalTargetId"] = FlagMetadataValue.of(evalTargetId)
+            }
+        }
+        return flagMetadata
+    }
 }

Tests/DevCycleProviderTests.swift

@@ -100,24 +100,28 @@ final class DevCycleProviderTests: XCTestCase {
             key: "test-bool", defaultValue: true, context: nil as EvaluationContext?)
         XCTAssertEqual(boolResult.value, true)
         XCTAssertEqual(boolResult.reason, Reason.defaultReason.rawValue)
+        XCTAssertEqual(boolResult.flagMetadata, [:])
 
         // String evaluation
         let stringResult = try provider.getStringEvaluation(
             key: "test-string", defaultValue: "default-value", context: nil as EvaluationContext?)
         XCTAssertEqual(stringResult.value, "default-value")
         XCTAssertEqual(stringResult.reason, Reason.defaultReason.rawValue)
+        XCTAssertEqual(stringResult.flagMetadata, [:])
 
         // Number evaluation
         let numberResult = try provider.getDoubleEvaluation(
             key: "test-number", defaultValue: 42.0, context: nil as EvaluationContext?)
         XCTAssertEqual(numberResult.value, 42.0)
         XCTAssertEqual(numberResult.reason, Reason.defaultReason.rawValue)
+        XCTAssertEqual(numberResult.flagMetadata, [:])
 
         // Integer evaluation
         let integerResult = try provider.getIntegerEvaluation(
             key: "test-integer", defaultValue: 42, context: nil as EvaluationContext?)
         XCTAssertEqual(integerResult.value, 42)
         XCTAssertEqual(integerResult.reason, Reason.defaultReason.rawValue)
+        XCTAssertEqual(integerResult.flagMetadata, [:])
     }
 
     // MARK: - Object Evaluation Tests
@@ -139,6 +143,7 @@ final class DevCycleProviderTests: XCTestCase {
             key: "test-object", defaultValue: defaultValue, context: nil as EvaluationContext?)
 
         XCTAssertEqual(result.reason, Reason.defaultReason.rawValue)
+        XCTAssertEqual(result.flagMetadata, [:])
 
         if case .structure(let attributes) = result.value {
             XCTAssertEqual(attributes["name"], .string("John"))
@@ -173,7 +178,8 @@ final class DevCycleProviderTests: XCTestCase {
         )
 
         XCTAssertEqual(result.reason, Reason.defaultReason.rawValue)
-
+        XCTAssertEqual(result.flagMetadata, [:])
+        
         if case .structure(let attributes) = result.value {
             XCTAssertEqual(attributes["string"], .string("text"))
             XCTAssertEqual(attributes["boolean"], .boolean(true))
@@ -1001,34 +1007,39 @@ final class DevCycleProviderTests: XCTestCase {
             key: "json-flag-list", defaultValue: listDefault, context: nil)
         XCTAssertEqual(listResult.value, .structure([:]))
         XCTAssertEqual(listResult.reason, "TARGETING_MATCH")
+        XCTAssertEqual(listResult.flagMetadata, ["evalDetails": FlagMetadataValue.of("OpenFeature Testing")])
 
         // .double
         let doubleDefault = Value.double(610)
         let doubleResult = try provider.getObjectEvaluation(
             key: "json-flag-double", defaultValue: doubleDefault, context: nil)
         XCTAssertEqual(doubleResult.value, .structure([:]))
         XCTAssertEqual(doubleResult.reason, "TARGETING_MATCH")
+        XCTAssertEqual(doubleResult.flagMetadata, ["evalDetails": FlagMetadataValue.of("OpenFeature Testing")])
 
         // .boolean
         let boolDefault = Value.boolean(false)
         let boolResult = try provider.getObjectEvaluation(
             key: "json-flag-bool", defaultValue: boolDefault, context: nil)
         XCTAssertEqual(boolResult.value, .structure([:]))
         XCTAssertEqual(boolResult.reason, "TARGETING_MATCH")
+        XCTAssertEqual(boolResult.flagMetadata, ["evalDetails": FlagMetadataValue.of("OpenFeature Testing")])
 
         // .string
         let stringDefault = Value.string("string")
         let stringResult = try provider.getObjectEvaluation(
             key: "json-flag-string", defaultValue: stringDefault, context: nil)
         XCTAssertEqual(stringResult.value, .structure([:]))
         XCTAssertEqual(stringResult.reason, "TARGETING_MATCH")
+        XCTAssertEqual(stringResult.flagMetadata, ["evalDetails": FlagMetadataValue.of("OpenFeature Testing")])
 
         // .null
         let nullDefault = Value.null
         let nullResult = try provider.getObjectEvaluation(
             key: "json-flag-null", defaultValue: nullDefault, context: nil)
         XCTAssertEqual(nullResult.value, .structure([:]))
         XCTAssertEqual(nullResult.reason, "TARGETING_MATCH")
+        XCTAssertEqual(stringResult.flagMetadata, ["evalDetails": FlagMetadataValue.of("OpenFeature Testing")])
 
         // .date
         let date = Date()
@@ -1037,6 +1048,7 @@ final class DevCycleProviderTests: XCTestCase {
             key: "json-flag-date", defaultValue: dateDefault, context: nil)
         XCTAssertEqual(dateResult.value, .structure([:]))
         XCTAssertEqual(dateResult.reason, "TARGETING_MATCH")
+        XCTAssertEqual(stringResult.flagMetadata, ["evalDetails": FlagMetadataValue.of("OpenFeature Testing")])
     }
 
     func testGetObjectEvaluationWithStructureValueIsAccepted() throws {
@@ -1047,5 +1059,6 @@ final class DevCycleProviderTests: XCTestCase {
             key: "json-flag-structure", defaultValue: structureDefault, context: nil)
         XCTAssertEqual(structureResult.value, structureDefault)
         XCTAssertEqual(structureResult.reason, "TARGETING_MATCH")
+        XCTAssertEqual(structureResult.flagMetadata, ["evalDetails": FlagMetadataValue.of("OpenFeature Testing")])
     }
 }