Merge pull request #20 from spotify/metadata

Different Metadata protocols client/provider

Sources/OpenFeature/Client.swift

@@ -2,7 +2,7 @@ import Foundation
 
 /// Interface used to resolve flags of varying types.
 public protocol Client: Features {
-    var metadata: Metadata { get }
+    var metadata: ClientMetadata { get }
 
     /// The hooks associated to this client.
     var hooks: [any Hook] { get }

Sources/OpenFeature/Metadata.swift → Sources/OpenFeature/ClientMetadata.swift

@@ -1,5 +1,5 @@
 import Foundation
 
-public protocol Metadata {
+public protocol ClientMetadata {
     var name: String? { get }
 }

Sources/OpenFeature/FeatureProvider.swift

@@ -3,7 +3,7 @@ import Foundation
 /// The interface implemented by upstream flag providers to resolve flags for their service.
 public protocol FeatureProvider {
     var hooks: [any Hook] { get }
-    var metadata: Metadata { get }
+    var metadata: ProviderMetadata { get }
 
     /// Called by OpenFeatureAPI whenever the new Provider is registered
     func initialize(initialContext: EvaluationContext?) async

Sources/OpenFeature/HookContext.swift

@@ -6,6 +6,6 @@ public struct HookContext<T> {
     var type: FlagValueType
     var defaultValue: T
     var ctx: EvaluationContext?
-    var clientMetadata: Metadata?
-    var providerMetadata: Metadata?
+    var clientMetadata: ClientMetadata?
+    var providerMetadata: ProviderMetadata?
 }

Sources/OpenFeature/NoOpProvider.swift

@@ -4,7 +4,7 @@ import Foundation
 class NoOpProvider: FeatureProvider {
     public static let passedInDefault = "Passed in default"
 
-    var metadata: Metadata = NoOpMetadata(name: "No-op provider")
+    var metadata: ProviderMetadata = NoOpMetadata(name: "No-op provider")
     var hooks: [any Hook] = []
 
     func onContextSet(oldContext: EvaluationContext?, newContext: EvaluationContext) {
@@ -62,7 +62,7 @@ class NoOpProvider: FeatureProvider {
 }
 
 extension NoOpProvider {
-    struct NoOpMetadata: Metadata {
+    struct NoOpMetadata: ProviderMetadata {
         var name: String?
     }
 }

Sources/OpenFeature/OpenFeatureAPI.swift

@@ -42,7 +42,7 @@ public class OpenFeatureAPI {
         return self._context
     }
 
-    public func getProviderMetadata() -> Metadata? {
+    public func getProviderMetadata() -> ProviderMetadata? {
         return self.getProvider()?.metadata
     }
 

Sources/OpenFeature/OpenFeatureClient.swift

@@ -8,7 +8,7 @@ public class OpenFeatureClient: Client {
     private(set) var name: String?
     private(set) var version: String?
 
-    private(set) public var metadata: Metadata
+    private(set) public var metadata: ClientMetadata
     private(set) public var hooks: [any Hook] = []
 
     private var hookSupport = HookSupport()
@@ -18,7 +18,7 @@ public class OpenFeatureClient: Client {
         self.openFeatureApi = openFeatureApi
         self.name = name
         self.version = version
-        self.metadata = ClientMetadata(name: name)
+        self.metadata = Metadata(name: name)
     }
 
     public func addHooks(_ hooks: any Hook...) {
@@ -57,7 +57,7 @@ extension OpenFeatureClient {
 }
 
 extension OpenFeatureClient {
-    public struct ClientMetadata: Metadata {
+    public struct Metadata: ClientMetadata {
         public var name: String?
     }
 }
@@ -99,7 +99,8 @@ extension OpenFeatureClient {
             details = evalDetails
 
             try hookSupport.afterHooks(
-                flagValueType: T.flagValueType, hookCtx: hookCtx, details: evalDetails, hooks: mergedHooks, hints: hints)
+                flagValueType: T.flagValueType, hookCtx: hookCtx, details: evalDetails, hooks: mergedHooks, hints: hints
+            )
         } catch {
             logger.error("Unable to correctly evaluate flag with key \(key) due to exception \(error)")
 

Sources/OpenFeature/ProviderMetadata.swift

@@ -0,0 +1,5 @@
+import Foundation
+
+public protocol ProviderMetadata {
+    var name: String? { get }
+}

Tests/OpenFeatureTests/Helpers/AlwaysBrokenProvider.swift

@@ -3,7 +3,7 @@ import Foundation
 @testable import OpenFeature
 
 class AlwaysBrokenProvider: FeatureProvider {
-    var metadata: Metadata = AlwaysBrokenMetadata()
+    var metadata: ProviderMetadata = AlwaysBrokenMetadata()
     var hooks: [any Hook] = []
 
     func onContextSet(oldContext: OpenFeature.EvaluationContext?, newContext: OpenFeature.EvaluationContext) {
@@ -46,7 +46,7 @@ class AlwaysBrokenProvider: FeatureProvider {
 }
 
 extension AlwaysBrokenProvider {
-    struct AlwaysBrokenMetadata: Metadata {
+    struct AlwaysBrokenMetadata: ProviderMetadata {
         var name: String? = "test"
     }
 }

Tests/OpenFeatureTests/Helpers/DoSomethingProvider.swift

@@ -13,7 +13,7 @@ class DoSomethingProvider: FeatureProvider {
     }
 
     var hooks: [any OpenFeature.Hook] = []
-    var metadata: OpenFeature.Metadata = DoMetadata()
+    var metadata: OpenFeature.ProviderMetadata = DoMetadata()
 
     func getBooleanEvaluation(key: String, defaultValue: Bool, context: EvaluationContext?) throws
         -> ProviderEvaluation<
@@ -55,7 +55,7 @@ class DoSomethingProvider: FeatureProvider {
         return ProviderEvaluation(value: .null)
     }
 
-    public struct DoMetadata: Metadata {
+    public struct DoMetadata: ProviderMetadata {
         public var name: String? = DoSomethingProvider.name
     }
 }

Tests/OpenFeatureTests/ValueTests.swift

@@ -69,7 +69,7 @@ final class ValueTests: XCTestCase {
         formatter.dateFormat = "yyyy-MM-dd HH:mm:ss"
 
         let date = try XCTUnwrap(formatter.date(from: "2022-01-01 12:00:00"))
-        
+
         let value: Value = .structure([
             "null": .null,
             "bool": .boolean(true),