refactor!: Add eval details to finally hook

fabriziodemaria · fabriziodemaria · commit 81c9fa27c909 · 2024-12-20T14:42:48.000+01:00
Signed-off-by: Fabrizio Demaria &lt;fabrizio.f.demaria@gmail.com&gt;
diff --git a/Sources/OpenFeature/Hook.swift b/Sources/OpenFeature/Hook.swift
@@ -11,7 +11,7 @@ public protocol Hook {
 
     func error<HookValue>(ctx: HookContext<HookValue>, error: Error, hints: [String: Any])
 
-    func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any])
+    func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any])
 
     func supportsFlagValueType(flagValueType: FlagValueType) -> Bool
 }
@@ -31,7 +31,7 @@ extension Hook {
         // Default implementation
     }
 
-    public func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
+    public func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any]) {
         // Default implementation
     }
 
diff --git a/Sources/OpenFeature/HookSupport.swift b/Sources/OpenFeature/HookSupport.swift
@@ -33,10 +33,14 @@ class HookSupport {
     }
 
     func finallyHooks<T>(
-        flagValueType: FlagValueType, hookCtx: HookContext<T>, hooks: [any Hook], hints: [String: Any]
+        flagValueType: FlagValueType,
+        hookCtx: HookContext<T>,
+        details: FlagEvaluationDetails<T>,
+        hooks: [any Hook],
+        hints: [String: Any]
     ) {
         hooks
             .filter { $0.supportsFlagValueType(flagValueType: flagValueType) }
-            .forEach { $0.finally(ctx: hookCtx, hints: hints) }
+            .forEach { $0.finally(ctx: hookCtx, details: details, hints: hints) }
     }
 }
diff --git a/Sources/OpenFeature/OpenFeatureClient.swift b/Sources/OpenFeature/OpenFeatureClient.swift
@@ -144,7 +144,7 @@ extension OpenFeatureClient {
                 flagValueType: T.flagValueType, hookCtx: hookCtx, error: error, hooks: mergedHooks, hints: hints)
         }
         hookSupport.finallyHooks(
-            flagValueType: T.flagValueType, hookCtx: hookCtx, hooks: mergedHooks, hints: hints)
+            flagValueType: T.flagValueType, hookCtx: hookCtx, details: details, hooks: mergedHooks, hints: hints)
         return details
     }
 
diff --git a/Tests/OpenFeatureTests/Helpers/BooleanHookMock.swift b/Tests/OpenFeatureTests/Helpers/BooleanHookMock.swift
@@ -38,7 +38,7 @@ class BooleanHookMock: Hook {
         self.addEval(self.prefix.isEmpty ? "error" : "\(self.prefix) error")
     }
 
-    func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
+    func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any]) {
         finallyCalled += 1
         self.addEval(self.prefix.isEmpty ? "finally" : "\(self.prefix) finally")
     }
diff --git a/Tests/OpenFeatureTests/Helpers/IntHookMock.swift b/Tests/OpenFeatureTests/Helpers/IntHookMock.swift
@@ -38,7 +38,7 @@ class IntHookMock: Hook {
         self.addEval(self.prefix.isEmpty ? "error" : "\(self.prefix) error")
     }
 
-    func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
+    func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any]) {
         finallyCalled += 1
         self.addEval(self.prefix.isEmpty ? "finally" : "\(self.prefix) finally")
     }
diff --git a/Tests/OpenFeatureTests/HookSupportTests.swift b/Tests/OpenFeatureTests/HookSupportTests.swift
@@ -37,6 +37,7 @@ final class HookSupportTests: XCTestCase {
         hookSupport.finallyHooks(
             flagValueType: .boolean,
             hookCtx: hookContext,
+            details: FlagEvaluationDetails(flagKey: "", value: false),
             hooks: [hook],
             hints: [:])
 

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public protocol Hook {`
`11`	`11`
`12`	`12`	`func error<HookValue>(ctx: HookContext<HookValue>, error: Error, hints: [String: Any])`
`13`	`13`
`14`		`- func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any])`
	`14`	`+ func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any])`
`15`	`15`
`16`	`16`	`func supportsFlagValueType(flagValueType: FlagValueType) -> Bool`
`17`	`17`	`}`
`@@ -31,7 +31,7 @@ extension Hook {`
`31`	`31`	`// Default implementation`
`32`	`32`	`}`
`33`	`33`
`34`		`- public func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {`
	`34`	`+ public func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any]) {`
`35`	`35`	`// Default implementation`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,14 @@ class HookSupport {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`func finallyHooks<T>(`
`36`		`- flagValueType: FlagValueType, hookCtx: HookContext<T>, hooks: [any Hook], hints: [String: Any]`
	`36`	`+ flagValueType: FlagValueType,`
	`37`	`+ hookCtx: HookContext<T>,`
	`38`	`+ details: FlagEvaluationDetails<T>,`
	`39`	`+ hooks: [any Hook],`
	`40`	`+ hints: [String: Any]`
`37`	`41`	`) {`
`38`	`42`	`hooks`
`39`	`43`	`.filter { $0.supportsFlagValueType(flagValueType: flagValueType) }`
`40`		`- .forEach { $0.finally(ctx: hookCtx, hints: hints) }`
	`44`	`+ .forEach { $0.finally(ctx: hookCtx, details: details, hints: hints) }`
`41`	`45`	`}`
`42`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ extension OpenFeatureClient {`
`144`	`144`	`flagValueType: T.flagValueType, hookCtx: hookCtx, error: error, hooks: mergedHooks, hints: hints)`
`145`	`145`	`}`
`146`	`146`	`hookSupport.finallyHooks(`
`147`		`- flagValueType: T.flagValueType, hookCtx: hookCtx, hooks: mergedHooks, hints: hints)`
	`147`	`+ flagValueType: T.flagValueType, hookCtx: hookCtx, details: details, hooks: mergedHooks, hints: hints)`
`148`	`148`	`return details`
`149`	`149`	`}`
`150`	`150`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ class BooleanHookMock: Hook {`
`38`	`38`	`self.addEval(self.prefix.isEmpty ? "error" : "\(self.prefix) error")`
`39`	`39`	`}`
`40`	`40`
`41`		`- func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {`
	`41`	`+ func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any]) {`
`42`	`42`	`finallyCalled += 1`
`43`	`43`	`self.addEval(self.prefix.isEmpty ? "finally" : "\(self.prefix) finally")`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ class IntHookMock: Hook {`
`38`	`38`	`self.addEval(self.prefix.isEmpty ? "error" : "\(self.prefix) error")`
`39`	`39`	`}`
`40`	`40`
`41`		`- func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {`
	`41`	`+ func finally<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any]) {`
`42`	`42`	`finallyCalled += 1`
`43`	`43`	`self.addEval(self.prefix.isEmpty ? "finally" : "\(self.prefix) finally")`
`44`	`44`	`}`