Skip to main content

OpenFeature iOS SDK

SpecificationRelease
Status

Quick startโ€‹

Requirementsโ€‹

This SDK supports the following Apple platforms:

  • iOS 14+
  • macOS 11+
  • watchOS 7+
  • tvOS 14+

The SDK is built with Swift 5.5+ and uses only Foundation and Combine frameworks, making it suitable for all Apple platform contexts including mobile, desktop, wearable, and TV applications.

Installโ€‹

Xcode Dependenciesโ€‹

You have two options, both start from File > Add Packages... in the code menu.

First, ensure you have your GitHub account added as an option (+ > Add Source Control Account...). You will need to create a Personal Access Token with the permissions defined in the Xcode interface.

  1. Add as a remote repository
    • Search for git@github.com:open-feature/swift-sdk.git and click "Add Package"
  2. Clone the repository locally
    • Clone locally using your preferred method
    • Use the "Add Local..." button to select the local folder

Note: Option 2 is only recommended if you are making changes to the client SDK.

Swift Package Managerโ€‹

If you manage dependencies through SPM, in the dependencies section of Package.swift add:

.package(url: "git@github.com:open-feature/swift-sdk.git", from: "0.4.0")

and in the target dependencies section add:

.product(name: "OpenFeature", package: "swift-sdk"),

CocoaPodsโ€‹

If you manage dependencies through CocoaPods, add the following to your Podfile:

pod 'OpenFeature', '~> 0.3.0'

Then, run:

pod install

iOS Usageโ€‹

import OpenFeature

Task {
let provider = CustomProvider()
// configure a provider, wait for it to complete its initialization tasks
await OpenFeatureAPI.shared.setProviderAndWait(provider: provider)

// get a bool flag value
let client = OpenFeatureAPI.shared.getClient()
let flagValue = client.getBooleanValue(key: "boolFlag", defaultValue: false)
}

Featuresโ€‹

StatusFeaturesDescription
โœ…ProvidersIntegrate with a commercial, open source, or in-house feature management tool.
โœ…TargetingContextually-aware flag evaluation using evaluation context.
โœ…HooksAdd functionality to various stages of the flag evaluation life-cycle.
โŒTrackingAssociate user actions with feature flag evaluations.
โŒLoggingIntegrate with popular logging packages.
โœ…MultiProviderUtilize multiple providers in a single application.
โœ…EventingReact to state changes in the provider or flag management system.
โŒShutdownGracefully clean up a provider during application shutdown.
โœ…ExtendingExtend OpenFeature with custom providers and hooks.
Implemented: โœ… | In-progress: โš ๏ธ | Not implemented yet: โŒ

Providersโ€‹

Providers are an abstraction between a flag management system and the OpenFeature SDK. Look here for a complete list of available providers. If the provider you're looking for hasn't been created yet, see the develop a provider section to learn how to build it yourself.

Once you've added a provider as a dependency, it can be registered with OpenFeature like this:

await OpenFeatureAPI.shared.setProviderAndWait(provider: MyProvider())

Asynchronous API that doesn't wait is also available

Targetingโ€‹

Sometimes, the value of a flag must consider some dynamic criteria about the application or user, such as the user's location, IP, email address, or the server's location. In OpenFeature, we refer to this as targeting. If the flag management system you're using supports targeting, you can provide the input data using the evaluation context.

// Configure your evaluation context and pass it to OpenFeatureAPI
let ctx = ImmutableContext(
targetingKey: userId,
structure: ImmutableStructure(attributes: ["product": Value.string(productId)]))
OpenFeatureAPI.shared.setEvaluationContext(evaluationContext: ctx)

Hooksโ€‹

Hooks allow for custom logic to be added at well-defined points of the flag evaluation life-cycle. Look here for a complete list of available hooks. If the hook you're looking for hasn't been created yet, see the develop a hook section to learn how to build it yourself.

Once you've added a hook as a dependency, it can be registered at the global, client, or flag invocation level.

// add a hook globally, to run on all evaluations
OpenFeatureAPI.shared.addHooks(hooks: ExampleHook())

// add a hook on this client, to run on all evaluations made by this client
val client = OpenFeatureAPI.shared.getClient()
client.addHooks(ExampleHook())

// add a hook for this evaluation only
_ = client.getValue(
key: "key",
defaultValue: false,
options: FlagEvaluationOptions(hooks: [ExampleHook()]))

Trackingโ€‹

Tracking is not yet available in the iOS SDK.

Loggingโ€‹

Logging customization is not yet available in the iOS SDK.

Named clientsโ€‹

Support for named clients is not yet available in the iOS SDK.

MultiProviderโ€‹

The MultiProvider allows you to combine multiple feature flag providers into a single provider, enabling you to use different providers for different flags or implement fallback mechanisms. This is useful when migrating between providers, implementing A/B testing across providers, or ensuring high availability.

Basic Usageโ€‹

import OpenFeature

Task {
// Create individual providers
let primaryProvider = PrimaryProvider()
let fallbackProvider = FallbackProvider()

// Create a MultiProvider with default FirstMatchStrategy
let multiProvider = MultiProvider(providers: [primaryProvider, fallbackProvider])

// Set the MultiProvider as the global provider
await OpenFeatureAPI.shared.setProviderAndWait(provider: multiProvider)

// Use flags normally - the MultiProvider will handle provider selection
let client = OpenFeatureAPI.shared.getClient()
let flagValue = client.getBooleanValue(key: "my-flag", defaultValue: false)
}

Evaluation Strategiesโ€‹

The MultiProvider supports different strategies for evaluating flags across multiple providers:

FirstMatchStrategy (Default)โ€‹

The FirstMatchStrategy evaluates providers in order and returns the first result that doesn't indicate "flag not found". If a provider returns an error other than "flag not found", that error is returned immediately.

let multiProvider = MultiProvider(
providers: [primaryProvider, fallbackProvider],
strategy: FirstMatchStrategy()
)
FirstSuccessfulStrategyโ€‹

The FirstSuccessfulStrategy evaluates providers in order and returns the first successful result (no error). Unlike FirstMatchStrategy, it continues to the next provider if any error occurs, including "flag not found".

let multiProvider = MultiProvider(
providers: [primaryProvider, fallbackProvider],
strategy: FirstSuccessfulStrategy()
)

Use Casesโ€‹

Provider Migration:

// Gradually migrate from OldProvider to NewProvider
let multiProvider = MultiProvider(providers: [
NewProvider(), // Check new provider first
OldProvider() // Fall back to old provider
])

High Availability:

// Use multiple providers for redundancy
let multiProvider = MultiProvider(providers: [
RemoteProvider(),
LocalCacheProvider(),
StaticProvider()
])

Environment-Specific Providers:

// Different providers for different environments
let providers = [
EnvironmentProvider(environment: "production"),
DefaultProvider()
]
let multiProvider = MultiProvider(providers: providers)

Eventingโ€‹

Events allow you to react to state changes in the provider or underlying flag management system, such as flag definition changes, provider readiness, or error conditions. Initialization events (PROVIDER_READY on success, PROVIDER_ERROR on failure) are dispatched for every provider. Some providers support additional events, such as PROVIDER_CONFIGURATION_CHANGED.

Please refer to the documentation of the provider you're using to see what events are supported.

let cancellable = OpenFeatureAPI.shared.observe().sink { event in
switch event {
case ProviderEvent.ready:
// ...
default:
// ...
}
}

Shutdownโ€‹

A shutdown function is not yet available in the iOS SDK.

Extendingโ€‹

Develop a providerโ€‹

To develop a provider, you need to create a new project and include the OpenFeature SDK as a dependency. You'll then need to write the provider by implementing the FeatureProvider interface exported by the OpenFeature SDK.

import OpenFeature

final class CustomProvider: FeatureProvider {
var hooks: [any Hook] = []
var metadata: ProviderMetadata = CustomMetadata()

func initialize(initialContext: EvaluationContext?) async {
// add context-aware provider initialisation
}

func onContextSet(oldContext: EvaluationContext?, newContext: EvaluationContext) async {
// add necessary changes on context change
}

func getBooleanEvaluation(
key: String,
defaultValue: Bool,
context: EvaluationContext?
) throws -> ProviderEvaluation<Bool> {
// resolve a boolean flag value
}

...
}

Built a new provider? Let us know so we can add it to the docs!

Develop a hookโ€‹

To develop a hook, you need to create a new project and include the OpenFeature SDK as a dependency. Implement your own hook by conforming to the Hook interface. To satisfy the interface, all methods (Before/After/Finally/Error) need to be defined.

class BooleanHook: Hook {
typealias HookValue = Bool

func before<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
// do something
}

func after<HookValue>(ctx: HookContext<HookValue>, details: FlagEvaluationDetails<HookValue>, hints: [String: Any]) {
// do something
}

func error<HookValue>(ctx: HookContext<HookValue>, error: Error, hints: [String: Any]) {
// do something
}

func finally<HookValue>(ctx: HookContext<HookValue>, hints: [String: Any]) {
// do something
}
}

Built a new hook? Let us know so we can add it to the docs!