Providers which do not implement this method are assumed to be ready immediately.
- * + * * @return ProviderState + * @deprecated The state is handled by the SDK internally. Query the state from the {@link Client} instead. */ + @Deprecated default ProviderState getState() { return ProviderState.READY; } + /** + * Feature provider implementations can opt in for to support Tracking by implementing this method. + * + * @param eventName The name of the tracking event + * @param context Evaluation context used in flag evaluation (Optional) + * @param details Data pertinent to a particular tracking event (Optional) + */ + default void track(String eventName, EvaluationContext context, TrackingEventDetails details) {} } diff --git a/src/main/java/dev/openfeature/sdk/FeatureProviderStateManager.java b/src/main/java/dev/openfeature/sdk/FeatureProviderStateManager.java new file mode 100644 index 00000000..2c39ece6 --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/FeatureProviderStateManager.java @@ -0,0 +1,71 @@ +package dev.openfeature.sdk; + +import dev.openfeature.sdk.exceptions.OpenFeatureError; +import java.util.concurrent.atomic.AtomicBoolean; +import lombok.Getter; + +class FeatureProviderStateManager implements EventProviderListener { + private final FeatureProvider delegate; + private final AtomicBoolean isInitialized = new AtomicBoolean(); + + @Getter + private ProviderState state = ProviderState.NOT_READY; + + public FeatureProviderStateManager(FeatureProvider delegate) { + this.delegate = delegate; + if (delegate instanceof EventProvider) { + ((EventProvider) delegate).setEventProviderListener(this); + } + } + + public void initialize(EvaluationContext evaluationContext) throws Exception { + if (isInitialized.getAndSet(true)) { + return; + } + try { + delegate.initialize(evaluationContext); + state = ProviderState.READY; + } catch (OpenFeatureError openFeatureError) { + if (ErrorCode.PROVIDER_FATAL.equals(openFeatureError.getErrorCode())) { + state = ProviderState.FATAL; + } else { + state = ProviderState.ERROR; + } + isInitialized.set(false); + throw openFeatureError; + } catch (Exception e) { + state = ProviderState.ERROR; + isInitialized.set(false); + throw e; + } + } + + public void shutdown() { + delegate.shutdown(); + state = ProviderState.NOT_READY; + isInitialized.set(false); + } + + @Override + public void onEmit(ProviderEvent event, ProviderEventDetails details) { + if (ProviderEvent.PROVIDER_ERROR.equals(event)) { + if (details != null && details.getErrorCode() == ErrorCode.PROVIDER_FATAL) { + state = ProviderState.FATAL; + } else { + state = ProviderState.ERROR; + } + } else if (ProviderEvent.PROVIDER_STALE.equals(event)) { + state = ProviderState.STALE; + } else if (ProviderEvent.PROVIDER_READY.equals(event)) { + state = ProviderState.READY; + } + } + + FeatureProvider getProvider() { + return delegate; + } + + public boolean hasSameProvider(FeatureProvider featureProvider) { + return this.delegate.equals(featureProvider); + } +} diff --git a/src/main/java/dev/openfeature/sdk/Features.java b/src/main/java/dev/openfeature/sdk/Features.java index ba25021a..1f0b73d4 100644 --- a/src/main/java/dev/openfeature/sdk/Features.java +++ b/src/main/java/dev/openfeature/sdk/Features.java @@ -15,8 +15,8 @@ public interface Features { FlagEvaluationDetailsNote: If the provider fails during initialization, an {@link OpenFeatureError} will be thrown. + * It is recommended to wrap this call in a try-catch block to handle potential initialization failures gracefully. + * + * @param provider the {@link FeatureProvider} to set as the default. + * @throws OpenFeatureError if the provider fails during initialization. */ public void setProviderAndWait(FeatureProvider provider) throws OpenFeatureError { try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { @@ -226,12 +230,17 @@ public void setProviderAndWait(FeatureProvider provider) throws OpenFeatureError /** * Add a provider for a domain and wait for initialization to finish. * - * @param domain The domain to bind the provider to. - * @param provider The provider to set. + *
Note: If the provider fails during initialization, an {@link OpenFeatureError} will be thrown.
+ * It is recommended to wrap this call in a try-catch block to handle potential initialization failures gracefully.
+ *
+ * @param domain The domain to bind the provider to.
+ * @param provider The provider to set.
+ * @throws OpenFeatureError if the provider fails during initialization.
*/
public void setProviderAndWait(String domain, FeatureProvider provider) throws OpenFeatureError {
try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) {
- providerRepository.setProvider(domain,
+ providerRepository.setProvider(
+ domain,
provider,
this::attachEventProvider,
this::emitReady,
@@ -250,7 +259,10 @@ private void attachEventProvider(FeatureProvider provider) {
}
private void emitReady(FeatureProvider provider) {
- runHandlersForProvider(provider, ProviderEvent.PROVIDER_READY, ProviderEventDetails.builder().build());
+ runHandlersForProvider(
+ provider,
+ ProviderEvent.PROVIDER_READY,
+ ProviderEventDetails.builder().build());
}
private void detachEventProvider(FeatureProvider provider) {
@@ -260,7 +272,9 @@ private void detachEventProvider(FeatureProvider provider) {
}
private void emitError(FeatureProvider provider, OpenFeatureError exception) {
- runHandlersForProvider(provider, ProviderEvent.PROVIDER_ERROR,
+ runHandlersForProvider(
+ provider,
+ ProviderEvent.PROVIDER_ERROR,
ProviderEventDetails.builder().message(exception.getMessage()).build());
}
@@ -300,6 +314,7 @@ public void addHooks(Hook... hooks) {
/**
* Fetch the hooks associated to this client.
+ *
* @return A list of {@link Hook}s.
*/
public List