diff --git a/pom.xml b/pom.xml index e30d67407..af8807b81 100644 --- a/pom.xml +++ b/pom.xml @@ -178,21 +178,6 @@ - - org.codehaus.mojo - build-helper-maven-plugin - 3.4.0 - - - validate - get-cpu-count - - cpu-count - - - - - org.cyclonedx cyclonedx-maven-plugin @@ -261,9 +246,6 @@ ${surefireArgLine} - - ${cpu.count} - false ${testExclusions} diff --git a/src/main/java/dev/openfeature/sdk/Client.java b/src/main/java/dev/openfeature/sdk/Client.java index a4ccf26f9..ebca0b131 100644 --- a/src/main/java/dev/openfeature/sdk/Client.java +++ b/src/main/java/dev/openfeature/sdk/Client.java @@ -5,7 +5,7 @@ /** * Interface used to resolve flags of varying types. */ -public interface Client extends Features { +public interface Client extends Features, EventBus { Metadata getMetadata(); /** diff --git a/src/main/java/dev/openfeature/sdk/EventBus.java b/src/main/java/dev/openfeature/sdk/EventBus.java new file mode 100644 index 000000000..d635e9bac --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/EventBus.java @@ -0,0 +1,64 @@ +package dev.openfeature.sdk; + +import java.util.function.Consumer; + +/** + * Interface for attaching event handlers. + */ +public interface EventBus { + + /** + * Add a handler for the {@link ProviderEvent#PROVIDER_READY} event. + * Shorthand for {@link #on(ProviderEvent, Consumer)} + * + * @param handler behavior to add with this event + * @return this + */ + T onProviderReady(Consumer handler); + + /** + * Add a handler for the {@link ProviderEvent#PROVIDER_CONFIGURATION_CHANGED} event. + * Shorthand for {@link #on(ProviderEvent, Consumer)} + * + * @param handler behavior to add with this event + * @return this + */ + T onProviderConfigurationChanged(Consumer handler); + + /** + * Add a handler for the {@link ProviderEvent#PROVIDER_STALE} event. + * Shorthand for {@link #on(ProviderEvent, Consumer)} + * + * @param handler behavior to add with this event + * @return this + */ + T onProviderError(Consumer handler); + + /** + * Add a handler for the {@link ProviderEvent#PROVIDER_ERROR} event. + * Shorthand for {@link #on(ProviderEvent, Consumer)} + * + * @param handler behavior to add with this event + * @return this + */ + T onProviderStale(Consumer handler); + + /** + * Add a handler for the specified {@link ProviderEvent}. + * + * @param event event type + * @param handler behavior to add with this event + * @return this + */ + T on(ProviderEvent event, Consumer handler); + + /** + * Remove the previously attached handler by reference. + * If the handler doesn't exists, no-op. + * + * @param event event type + * @param handler to be removed + * @return this + */ + T removeHandler(ProviderEvent event, Consumer handler); +} diff --git a/src/main/java/dev/openfeature/sdk/EventDetails.java b/src/main/java/dev/openfeature/sdk/EventDetails.java new file mode 100644 index 000000000..3f6db159f --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/EventDetails.java @@ -0,0 +1,28 @@ +package dev.openfeature.sdk; + +import edu.umd.cs.findbugs.annotations.Nullable; +import lombok.Data; +import lombok.experimental.SuperBuilder; + +/** + * The details of a particular event. + */ +@Data @SuperBuilder(toBuilder = true) +public class EventDetails extends ProviderEventDetails { + private String clientName; + + static EventDetails fromProviderEventDetails(ProviderEventDetails providerEventDetails) { + return EventDetails.fromProviderEventDetails(providerEventDetails, null); + } + + static EventDetails fromProviderEventDetails( + ProviderEventDetails providerEventDetails, + @Nullable String clientName) { + return EventDetails.builder() + .clientName(clientName) + .flagsChanged(providerEventDetails.getFlagsChanged()) + .eventMetadata(providerEventDetails.getEventMetadata()) + .message(providerEventDetails.getMessage()) + .build(); + } +} diff --git a/src/main/java/dev/openfeature/sdk/EventProvider.java b/src/main/java/dev/openfeature/sdk/EventProvider.java new file mode 100644 index 000000000..de12b0777 --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/EventProvider.java @@ -0,0 +1,95 @@ +package dev.openfeature.sdk; + +import dev.openfeature.sdk.internal.TriConsumer; + +/** + * Abstract EventProvider. Providers must extend this class to support events. + * Emit events with {@link #emit(ProviderEvent, ProviderEventDetails)}. Please + * note that the SDK will automatically emit + * {@link ProviderEvent#PROVIDER_READY } or + * {@link ProviderEvent#PROVIDER_ERROR } accordingly when + * {@link FeatureProvider#initialize(EvaluationContext)} completes successfully + * or with error, so these events need not be emitted manually during + * initialization. + * + * @see FeatureProvider + */ +public abstract class EventProvider implements FeatureProvider { + + private TriConsumer onEmit = null; + + /** + * "Attach" this EventProvider to an SDK, which allows events to propagate from this provider. + * No-op if the same onEmit is already attached. + * + * @param onEmit the function to run when a provider emits events. + */ + void attach(TriConsumer onEmit) { + if (this.onEmit != null && this.onEmit != onEmit) { + // if we are trying to attach this provider to a different onEmit, something has gone wrong + throw new IllegalStateException("Provider " + this.getMetadata().getName() + " is already attached."); + } else { + this.onEmit = onEmit; + } + } + + /** + * "Detach" this EventProvider from an SDK, stopping propagation of all events. + */ + void detach() { + this.onEmit = null; + } + + /** + * Emit the specified {@link ProviderEvent}. + * + * @param event The event type + * @param details The details of the event + */ + public void emit(ProviderEvent event, ProviderEventDetails details) { + if (this.onEmit != null) { + this.onEmit.accept(this, event, details); + } + } + + /** + * Emit a {@link ProviderEvent#PROVIDER_READY} event. + * Shorthand for {@link #emit(ProviderEvent, ProviderEventDetails)} + * + * @param details The details of the event + */ + public void emitProviderReady(ProviderEventDetails details) { + emit(ProviderEvent.PROVIDER_READY, details); + } + + /** + * Emit a + * {@link ProviderEvent#PROVIDER_CONFIGURATION_CHANGED} + * event. Shorthand for {@link #emit(ProviderEvent, ProviderEventDetails)} + * + * @param details The details of the event + */ + public void emitProviderConfigurationChanged(ProviderEventDetails details) { + emit(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, details); + } + + /** + * Emit a {@link ProviderEvent#PROVIDER_STALE} event. + * Shorthand for {@link #emit(ProviderEvent, ProviderEventDetails)} + * + * @param details The details of the event + */ + public void emitProviderStale(ProviderEventDetails details) { + emit(ProviderEvent.PROVIDER_STALE, details); + } + + /** + * Emit a {@link ProviderEvent#PROVIDER_ERROR} event. + * Shorthand for {@link #emit(ProviderEvent, ProviderEventDetails)} + * + * @param details The details of the event + */ + public void emitProviderError(ProviderEventDetails details) { + emit(ProviderEvent.PROVIDER_ERROR, details); + } +} diff --git a/src/main/java/dev/openfeature/sdk/EventSupport.java b/src/main/java/dev/openfeature/sdk/EventSupport.java new file mode 100644 index 000000000..6558f9694 --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/EventSupport.java @@ -0,0 +1,174 @@ +package dev.openfeature.sdk; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.function.Consumer; + +import edu.umd.cs.findbugs.annotations.Nullable; +import lombok.extern.slf4j.Slf4j; + +/** + * Util class for storing and running handlers. + */ +@Slf4j +class EventSupport { + + // we use a v4 uuid as a "placeholder" for anonymous clients, since + // ConcurrentHashMap doesn't support nulls + private static final String defaultClientUuid = UUID.randomUUID().toString(); + private static final ExecutorService taskExecutor = Executors.newCachedThreadPool(); + private final Map handlerStores = new ConcurrentHashMap<>(); + private final HandlerStore globalHandlerStore = new HandlerStore(); + + /** + * Run all the event handlers associated with this client name. + * If the client name is null, handlers attached to unnamed clients will run. + * + * @param clientName the client name to run event handlers for, or null + * @param event the event type + * @param eventDetails the event details + */ + public void runClientHandlers(@Nullable String clientName, ProviderEvent event, EventDetails eventDetails) { + clientName = Optional.ofNullable(clientName) + .orElse(defaultClientUuid); + + // run handlers if they exist + Optional.ofNullable(handlerStores.get(clientName)) + .filter(store -> Optional.of(store).isPresent()) + .map(store -> store.handlerMap.get(event)) + .ifPresent(handlers -> handlers + .forEach(handler -> runHandler(handler, eventDetails))); + } + + /** + * Run all the API (global) event handlers. + * + * @param event the event type + * @param eventDetails the event details + */ + public void runGlobalHandlers(ProviderEvent event, EventDetails eventDetails) { + globalHandlerStore.handlerMap.get(event) + .forEach(handler -> { + runHandler(handler, eventDetails); + }); + } + + /** + * Add a handler for the specified client name, or all unnamed clients. + * + * @param clientName the client name to add handlers for, or else the unnamed + * client + * @param event the event type + * @param handler the handler function to run + */ + public void addClientHandler(@Nullable String clientName, ProviderEvent event, Consumer handler) { + final String name = Optional.ofNullable(clientName) + .orElse(defaultClientUuid); + + // lazily create and cache a HandlerStore if it doesn't exist + HandlerStore store = Optional.ofNullable(this.handlerStores.get(name)) + .orElseGet(() -> { + HandlerStore newStore = new HandlerStore(); + this.handlerStores.put(name, newStore); + return newStore; + }); + store.addHandler(event, handler); + } + + /** + * Remove a client event handler for the specified event type. + * + * @param clientName the name of the client handler to remove, or null to remove + * from unnamed clients + * @param event the event type + * @param handler the handler ref to be removed + */ + public void removeClientHandler(String clientName, ProviderEvent event, Consumer handler) { + clientName = Optional.ofNullable(clientName) + .orElse(defaultClientUuid); + this.handlerStores.get(clientName).removeHandler(event, handler); + } + + /** + * Add a global event handler of the specified event type. + * + * @param event the event type + * @param handler the handler to be added + */ + public void addGlobalHandler(ProviderEvent event, Consumer handler) { + this.globalHandlerStore.addHandler(event, handler); + } + + /** + * Remove a global event handler for the specified event type. + * + * @param event the event type + * @param handler the handler ref to be removed + */ + public void removeGlobalHandler(ProviderEvent event, Consumer handler) { + this.globalHandlerStore.removeHandler(event, handler); + } + + /** + * Get all client names for which we have event handlers registered. + * + * @return set of client names + */ + public Set getAllClientNames() { + return this.handlerStores.keySet(); + } + + /** + * Run the passed handler on the taskExecutor. + * + * @param handler the handler to run + * @param eventDetails the event details + */ + public void runHandler(Consumer handler, EventDetails eventDetails) { + taskExecutor.submit(() -> { + try { + handler.accept(eventDetails); + } catch (Exception e) { + log.error("Exception in event handler {}", handler, e); + } + }); + } + + /** + * Stop the event handler task executor. + */ + public void shutdown() { + taskExecutor.shutdown(); + } + + // Handler store maintains a set of handlers for each event type. + // Each client in the SDK gets it's own handler store, which is lazily + // instantiated when a handler is added to that client. + static class HandlerStore { + + private final Map>> handlerMap; + + { + handlerMap = new ConcurrentHashMap>>(); + handlerMap.put(ProviderEvent.PROVIDER_READY, new ArrayList<>()); + handlerMap.put(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, new ArrayList<>()); + handlerMap.put(ProviderEvent.PROVIDER_ERROR, new ArrayList<>()); + handlerMap.put(ProviderEvent.PROVIDER_STALE, new ArrayList<>()); + } + + void addHandler(ProviderEvent event, Consumer handler) { + handlerMap.get(event).add(handler); + } + + void removeHandler(ProviderEvent event, Consumer handler) { + handlerMap.get(event).remove(handler); + } + } +} diff --git a/src/main/java/dev/openfeature/sdk/FeatureProvider.java b/src/main/java/dev/openfeature/sdk/FeatureProvider.java index 7df56a5f0..933166fac 100644 --- a/src/main/java/dev/openfeature/sdk/FeatureProvider.java +++ b/src/main/java/dev/openfeature/sdk/FeatureProvider.java @@ -4,7 +4,9 @@ import java.util.List; /** - * The interface implemented by upstream flag providers to resolve flags for their service. + * The interface implemented by upstream flag providers to resolve flags for + * their service. If you want to support realtime events with your provider, you + * should extend {@link EventProvider} */ public interface FeatureProvider { Metadata getMetadata(); @@ -24,22 +26,28 @@ default List getProviderHooks() { ProviderEvaluation getObjectEvaluation(String key, Value defaultValue, EvaluationContext ctx); /** - * This method is called before a provider is used to evaluate flags. Providers can overwrite this method, - * if they have special initialization needed prior being called for flag evaluation. + * This method is called before a provider is used to evaluate flags. Providers + * can overwrite this method, + * if they have special initialization needed prior being called for flag + * evaluation. *

- * It is ok, if the method is expensive as it is executed in the background. All runtime exceptions will be + * It is ok, if the method is expensive as it is executed in the background. All + * runtime exceptions will be * caught and logged. *

*/ - default void initialize() { + default void initialize(EvaluationContext evaluationContext) throws Exception { // Intentionally left blank } /** - * This method is called when a new provider is about to be used to evaluate flags, or the SDK is shut down. - * Providers can overwrite this method, if they have special shutdown actions needed. + * This method is called when a new provider is about to be used to evaluate + * flags, or the SDK is shut down. + * Providers can overwrite this method, if they have special shutdown actions + * needed. *

- * It is ok, if the method is expensive as it is executed in the background. All runtime exceptions will be + * It is ok, if the method is expensive as it is executed in the background. All + * runtime exceptions will be * caught and logged. *

*/ @@ -47,4 +55,14 @@ default void shutdown() { // Intentionally left blank } + /** + * Returns a representation of the current readiness of the provider. + * Providers which do not implement this method are assumed to be ready immediately. + * + * @return ProviderState + */ + default ProviderState getState() { + return ProviderState.READY; + } + } diff --git a/src/main/java/dev/openfeature/sdk/NoOpProvider.java b/src/main/java/dev/openfeature/sdk/NoOpProvider.java index c2e841a53..d3d9ca21b 100644 --- a/src/main/java/dev/openfeature/sdk/NoOpProvider.java +++ b/src/main/java/dev/openfeature/sdk/NoOpProvider.java @@ -10,6 +10,12 @@ public class NoOpProvider implements FeatureProvider { @Getter private final String name = "No-op Provider"; + // The Noop provider is ALWAYS NOT_READY, otherwise READY handlers would run immediately when attached. + @Override + public ProviderState getState() { + return ProviderState.NOT_READY; + } + @Override public Metadata getMetadata() { return new Metadata() { diff --git a/src/main/java/dev/openfeature/sdk/OpenFeatureAPI.java b/src/main/java/dev/openfeature/sdk/OpenFeatureAPI.java index 2e921a746..42ff4708c 100644 --- a/src/main/java/dev/openfeature/sdk/OpenFeatureAPI.java +++ b/src/main/java/dev/openfeature/sdk/OpenFeatureAPI.java @@ -1,31 +1,33 @@ package dev.openfeature.sdk; -import dev.openfeature.sdk.internal.AutoCloseableLock; -import dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock; -import lombok.extern.slf4j.Slf4j; - -import javax.annotation.Nullable; import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import java.util.Set; +import java.util.function.Consumer; + +import javax.annotation.Nullable; + +import dev.openfeature.sdk.internal.AutoCloseableLock; +import dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock; +import lombok.extern.slf4j.Slf4j; /** - * A global singleton which holds base configuration for the OpenFeature library. + * A global singleton which holds base configuration for the OpenFeature + * library. * Configuration here will be shared across all {@link Client}s. */ @Slf4j -public class OpenFeatureAPI { +public class OpenFeatureAPI implements EventBus { // package-private multi-read/single-write lock - static AutoCloseableReentrantReadWriteLock hooksLock = new AutoCloseableReentrantReadWriteLock(); - static AutoCloseableReentrantReadWriteLock contextLock = new AutoCloseableReentrantReadWriteLock(); - + static AutoCloseableReentrantReadWriteLock lock = new AutoCloseableReentrantReadWriteLock(); + private EvaluationContext evaluationContext; private final List apiHooks; - private ProviderRepository providerRepository = new ProviderRepository(); - private EvaluationContext evaluationContext; + private EventSupport eventSupport = new EventSupport(); protected OpenFeatureAPI() { - this.apiHooks = new ArrayList<>(); + apiHooks = new ArrayList<>(); } private static class SingletonHolder { @@ -49,23 +51,34 @@ public Metadata getProviderMetadata(String clientName) { return getProvider(clientName).getMetadata(); } + /** + * {@inheritDoc} + */ public Client getClient() { return getClient(null, null); } + /** + * {@inheritDoc} + */ public Client getClient(@Nullable String name) { return getClient(name, null); } + /** + * {@inheritDoc} + */ public Client getClient(@Nullable String name, @Nullable String version) { - return new OpenFeatureClient(this, name, version); + return new OpenFeatureClient(this, + name, + version); } /** * {@inheritDoc} */ public void setEvaluationContext(EvaluationContext evaluationContext) { - try (AutoCloseableLock __ = contextLock.writeLockAutoCloseable()) { + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { this.evaluationContext = evaluationContext; } } @@ -74,7 +87,7 @@ public void setEvaluationContext(EvaluationContext evaluationContext) { * {@inheritDoc} */ public EvaluationContext getEvaluationContext() { - try (AutoCloseableLock __ = contextLock.readLockAutoCloseable()) { + try (AutoCloseableLock __ = lock.readLockAutoCloseable()) { return this.evaluationContext; } } @@ -83,7 +96,14 @@ public EvaluationContext getEvaluationContext() { * Set the default provider. */ public void setProvider(FeatureProvider provider) { - providerRepository.setProvider(provider); + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { + providerRepository.setProvider( + provider, + (p) -> attachEventProvider(p), + (p) -> emitReady(p), + (p) -> detachEventProvider(p), + (p, message) -> emitError(p, message)); + } } /** @@ -93,7 +113,37 @@ public void setProvider(FeatureProvider provider) { * @param provider The provider to set. */ public void setProvider(String clientName, FeatureProvider provider) { - providerRepository.setProvider(clientName, provider); + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { + providerRepository.setProvider(clientName, + provider, + this::attachEventProvider, + this::emitReady, + this::detachEventProvider, + this::emitError); + } + } + + private void attachEventProvider(FeatureProvider provider) { + if (provider instanceof EventProvider) { + ((EventProvider)provider).attach((p, event, details) -> { + runHandlersForProvider(p, event, details); + }); + } + } + + private void emitReady(FeatureProvider provider) { + runHandlersForProvider(provider, ProviderEvent.PROVIDER_READY, ProviderEventDetails.builder().build()); + } + + private void detachEventProvider(FeatureProvider provider) { + if (provider instanceof EventProvider) { + ((EventProvider)provider).detach(); + } + } + + private void emitError(FeatureProvider provider, String message) { + runHandlersForProvider(provider, ProviderEvent.PROVIDER_ERROR, + ProviderEventDetails.builder().message(message).build()); } /** @@ -117,7 +167,7 @@ public FeatureProvider getProvider(String name) { * {@inheritDoc} */ public void addHooks(Hook... hooks) { - try (AutoCloseableLock __ = hooksLock.writeLockAutoCloseable()) { + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { this.apiHooks.addAll(Arrays.asList(hooks)); } } @@ -126,7 +176,7 @@ public void addHooks(Hook... hooks) { * {@inheritDoc} */ public List getHooks() { - try (AutoCloseableLock __ = hooksLock.readLockAutoCloseable()) { + try (AutoCloseableLock __ = lock.readLockAutoCloseable()) { return this.apiHooks; } } @@ -135,19 +185,124 @@ public List getHooks() { * {@inheritDoc} */ public void clearHooks() { - try (AutoCloseableLock __ = hooksLock.writeLockAutoCloseable()) { + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { this.apiHooks.clear(); } } public void shutdown() { providerRepository.shutdown(); + eventSupport.shutdown(); } /** - * This method is only here for testing as otherwise all tests after the API shutdown test would fail. + * {@inheritDoc} */ - final void resetProviderRepository() { + @Override + public OpenFeatureAPI onProviderReady(Consumer handler) { + return this.on(ProviderEvent.PROVIDER_READY, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public OpenFeatureAPI onProviderConfigurationChanged(Consumer handler) { + return this.on(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public OpenFeatureAPI onProviderStale(Consumer handler) { + return this.on(ProviderEvent.PROVIDER_STALE, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public OpenFeatureAPI onProviderError(Consumer handler) { + return this.on(ProviderEvent.PROVIDER_ERROR, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public OpenFeatureAPI on(ProviderEvent event, Consumer handler) { + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { + this.eventSupport.addGlobalHandler(event, handler); + return this; + } + } + + /** + * {@inheritDoc} + */ + @Override + public OpenFeatureAPI removeHandler(ProviderEvent event, Consumer handler) { + this.eventSupport.removeGlobalHandler(event, handler); + return this; + } + + void removeHandler(String clientName, ProviderEvent event, Consumer handler) { + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { + eventSupport.removeClientHandler(clientName, event, handler); + } + } + + void addHandler(String clientName, ProviderEvent event, Consumer handler) { + try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) { + // if the provider is READY, run immediately + if (ProviderEvent.PROVIDER_READY.equals(event) + && ProviderState.READY.equals(this.providerRepository.getProvider(clientName).getState())) { + eventSupport.runHandler(handler, EventDetails.builder().clientName(clientName).build()); + } + eventSupport.addClientHandler(clientName, event, handler); + } + } + + /** + * This method is only here for testing as otherwise all tests after the API + * shutdown test would fail. + */ + final void reset() { providerRepository = new ProviderRepository(); + eventSupport = new EventSupport(); + } + + /** + * Runs the handlers associated with a particular provider. + * + * @param provider the provider from where this event originated + * @param event the event type + * @param details the event details + */ + private void runHandlersForProvider(FeatureProvider provider, ProviderEvent event, ProviderEventDetails details) { + try (AutoCloseableLock __ = lock.readLockAutoCloseable()) { + + List clientNamesForProvider = providerRepository + .getClientNamesForProvider(provider); + + // run the global handlers + eventSupport.runGlobalHandlers(event, EventDetails.fromProviderEventDetails(details)); + + // run the handlers associated with named clients for this provider + clientNamesForProvider.forEach(name -> { + eventSupport.runClientHandlers(name, event, EventDetails.fromProviderEventDetails(details, name)); + }); + + if (providerRepository.isDefaultProvider(provider)) { + // run handlers for clients that have no bound providers (since this is the default) + Set allClientNames = eventSupport.getAllClientNames(); + Set boundClientNames = providerRepository.getAllBoundClientNames(); + allClientNames.removeAll(boundClientNames); + allClientNames.forEach(name -> { + eventSupport.runClientHandlers(name, event, EventDetails.fromProviderEventDetails(details, name)); + }); + } + } } } diff --git a/src/main/java/dev/openfeature/sdk/OpenFeatureClient.java b/src/main/java/dev/openfeature/sdk/OpenFeatureClient.java index 44febf77b..05d79d02d 100644 --- a/src/main/java/dev/openfeature/sdk/OpenFeatureClient.java +++ b/src/main/java/dev/openfeature/sdk/OpenFeatureClient.java @@ -5,6 +5,7 @@ import java.util.Collections; import java.util.List; import java.util.Map; +import java.util.function.Consumer; import dev.openfeature.sdk.exceptions.GeneralError; import dev.openfeature.sdk.exceptions.OpenFeatureError; @@ -33,13 +34,16 @@ public class OpenFeatureClient implements Client { private EvaluationContext evaluationContext; /** - * Client for evaluating the flag. There may be multiples of these floating - * around. + * Deprecated public constructor. Use OpenFeature.API.getClient() instead. * * @param openFeatureAPI Backing global singleton * @param name Name of the client (used by observability tools). * @param version Version of the client (used by observability tools). + * @deprecated Do not use this constructor. It's for internal use only. + * Clients created using it will not run event handlers. + * Use the OpenFeatureAPI's getClient factory method instead. */ + @Deprecated() // TODO: eventually we will make this non-public public OpenFeatureClient(OpenFeatureAPI openFeatureAPI, String name, String version) { this.openfeatureApi = openFeatureAPI; this.name = name; @@ -95,7 +99,6 @@ private FlagEvaluationDetails evaluateFlag(FlagValueType type, String key Map hints = Collections.unmodifiableMap(flagOptions.getHookHints()); ctx = ObjectUtils.defaultIfNull(ctx, () -> new ImmutableContext()); - FlagEvaluationDetails details = null; List mergedHooks = null; HookContext hookCtx = null; @@ -341,4 +344,54 @@ public FlagEvaluationDetails getObjectDetails(String key, Value defaultVa public Metadata getMetadata() { return () -> name; } + + /** + * {@inheritDoc} + */ + @Override + public Client onProviderReady(Consumer handler) { + return on(ProviderEvent.PROVIDER_READY, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public Client onProviderConfigurationChanged(Consumer handler) { + return on(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public Client onProviderError(Consumer handler) { + return on(ProviderEvent.PROVIDER_ERROR, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public Client onProviderStale(Consumer handler) { + return on(ProviderEvent.PROVIDER_STALE, handler); + } + + /** + * {@inheritDoc} + */ + @Override + public Client on(ProviderEvent event, Consumer handler) { + OpenFeatureAPI.getInstance().addHandler(name, event, handler); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public Client removeHandler(ProviderEvent event, Consumer handler) { + OpenFeatureAPI.getInstance().removeHandler(name, event, handler); + return this; + } } diff --git a/src/main/java/dev/openfeature/sdk/ProviderEvent.java b/src/main/java/dev/openfeature/sdk/ProviderEvent.java new file mode 100644 index 000000000..dcefd606a --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/ProviderEvent.java @@ -0,0 +1,8 @@ +package dev.openfeature.sdk; + +/** + * Provider event types. + */ +public enum ProviderEvent { + PROVIDER_READY, PROVIDER_CONFIGURATION_CHANGED, PROVIDER_ERROR, PROVIDER_STALE; +} diff --git a/src/main/java/dev/openfeature/sdk/ProviderEventDetails.java b/src/main/java/dev/openfeature/sdk/ProviderEventDetails.java new file mode 100644 index 000000000..149c92a7e --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/ProviderEventDetails.java @@ -0,0 +1,18 @@ +package dev.openfeature.sdk; + +import java.util.List; + +import javax.annotation.Nullable; + +import lombok.Data; +import lombok.experimental.SuperBuilder; + +/** + * The details of a particular event. + */ +@Data @SuperBuilder(toBuilder = true) +public class ProviderEventDetails { + @Nullable private List flagsChanged; + @Nullable private String message; + @Nullable private ImmutableMetadata eventMetadata; +} diff --git a/src/main/java/dev/openfeature/sdk/ProviderRepository.java b/src/main/java/dev/openfeature/sdk/ProviderRepository.java index 5a360eb63..0ff3b70be 100644 --- a/src/main/java/dev/openfeature/sdk/ProviderRepository.java +++ b/src/main/java/dev/openfeature/sdk/ProviderRepository.java @@ -1,24 +1,28 @@ package dev.openfeature.sdk; -import lombok.extern.slf4j.Slf4j; - +import java.util.List; import java.util.Map; import java.util.Optional; +import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.atomic.AtomicReference; +import java.util.function.BiConsumer; import java.util.function.Consumer; +import java.util.stream.Collectors; import java.util.stream.Stream; +import javax.annotation.Nullable; + +import lombok.extern.slf4j.Slf4j; + @Slf4j class ProviderRepository { private final Map providers = new ConcurrentHashMap<>(); - private final ExecutorService taskExecutor = Executors.newCachedThreadPool(); - private final Map initializingNamedProviders = new ConcurrentHashMap<>(); private final AtomicReference defaultProvider = new AtomicReference<>(new NoOpProvider()); - private FeatureProvider initializingDefaultProvider; + private final ExecutorService taskExecutor = Executors.newCachedThreadPool(); /** * Return the default provider. @@ -37,14 +41,32 @@ public FeatureProvider getProvider(String name) { return Optional.ofNullable(name).map(this.providers::get).orElse(this.defaultProvider.get()); } + public List getClientNamesForProvider(FeatureProvider provider) { + return providers.entrySet().stream() + .filter(entry -> entry.getValue().equals(provider)) + .map(entry -> entry.getKey()).collect(Collectors.toList()); + } + + public Set getAllBoundClientNames() { + return providers.keySet(); + } + + public boolean isDefaultProvider(FeatureProvider provider) { + return this.getProvider().equals(provider); + } + /** * Set the default provider. */ - public void setProvider(FeatureProvider provider) { + public void setProvider(FeatureProvider provider, + Consumer afterSet, + Consumer afterInit, + Consumer afterShutdown, + BiConsumer afterError) { if (provider == null) { throw new IllegalArgumentException("Provider cannot be null"); } - initializeProvider(provider); + initializeProvider(null, provider, afterSet, afterInit, afterShutdown, afterError); } /** @@ -53,76 +75,51 @@ public void setProvider(FeatureProvider provider) { * @param clientName The name of the client. * @param provider The provider to set. */ - public void setProvider(String clientName, FeatureProvider provider) { + public void setProvider(String clientName, + FeatureProvider provider, + Consumer afterSet, + Consumer afterInit, + Consumer afterShutdown, + BiConsumer afterError) { if (provider == null) { throw new IllegalArgumentException("Provider cannot be null"); } if (clientName == null) { throw new IllegalArgumentException("clientName cannot be null"); } - initializeProvider(clientName, provider); - } - - private void initializeProvider(FeatureProvider provider) { - initializingDefaultProvider = provider; - initializeProvider(provider, this::updateDefaultProviderAfterInitialization); - } - - private void initializeProvider(String clientName, FeatureProvider provider) { - initializingNamedProviders.put(clientName, provider); - initializeProvider(provider, newProvider -> updateProviderAfterInit(clientName, newProvider)); - } - - private void initializeProvider(FeatureProvider provider, Consumer afterInitialization) { + initializeProvider(clientName, provider, afterSet, afterInit, afterShutdown, afterError); + } + + private void initializeProvider(@Nullable String clientName, + FeatureProvider newProvider, + Consumer afterSet, + Consumer afterInit, + Consumer afterShutdown, + BiConsumer afterError) { + // provider is set immediately, on this thread + FeatureProvider oldProvider = clientName != null + ? this.providers.put(clientName, newProvider) + : this.defaultProvider.getAndSet(newProvider); + afterSet.accept(newProvider); taskExecutor.submit(() -> { + // initialization happens in a different thread try { - if (!isProviderRegistered(provider)) { - provider.initialize(); + if (ProviderState.NOT_READY.equals(newProvider.getState())) { + newProvider.initialize(OpenFeatureAPI.getInstance().getEvaluationContext()); + afterInit.accept(newProvider); } - afterInitialization.accept(provider); + shutDownOld(oldProvider, afterShutdown); } catch (Exception e) { - log.error("Exception when initializing feature provider {}", provider.getClass().getName(), e); + log.error("Exception when initializing feature provider {}", newProvider.getClass().getName(), e); + afterError.accept(newProvider, e.getMessage()); } }); } - private void updateProviderAfterInit(String clientName, FeatureProvider newProvider) { - Optional - .ofNullable(initializingNamedProviders.get(clientName)) - .filter(initializingProvider -> initializingProvider.equals(newProvider)) - .ifPresent(provider -> updateNamedProviderAfterInitialization(clientName, provider)); - } - - private void updateDefaultProviderAfterInitialization(FeatureProvider initializedProvider) { - Optional - .ofNullable(this.initializingDefaultProvider) - .filter(initializingProvider -> initializingProvider.equals(initializedProvider)) - .ifPresent(this::replaceDefaultProvider); - } - - private void replaceDefaultProvider(FeatureProvider provider) { - FeatureProvider oldProvider = this.defaultProvider.getAndSet(provider); - if (isOldProviderNotBoundByName(oldProvider)) { - shutdownProvider(oldProvider); - } - } - - private boolean isOldProviderNotBoundByName(FeatureProvider oldProvider) { - return !this.providers.containsValue(oldProvider); - } - - private void updateNamedProviderAfterInitialization(String clientName, FeatureProvider initializedProvider) { - Optional - .ofNullable(this.initializingNamedProviders.get(clientName)) - .filter(initializingProvider -> initializingProvider.equals(initializedProvider)) - .ifPresent(provider -> replaceNamedProviderAndShutdownOldOne(clientName, provider)); - } - - private void replaceNamedProviderAndShutdownOldOne(String clientName, FeatureProvider provider) { - FeatureProvider oldProvider = this.providers.put(clientName, provider); - this.initializingNamedProviders.remove(clientName, provider); + private void shutDownOld(FeatureProvider oldProvider,Consumer afterShutdown) { if (!isProviderRegistered(oldProvider)) { shutdownProvider(oldProvider); + afterShutdown.accept(oldProvider); } } @@ -133,6 +130,7 @@ private boolean isProviderRegistered(FeatureProvider oldProvider) { private void shutdownProvider(FeatureProvider provider) { taskExecutor.submit(() -> { try { + // detachProviderEvents(provider); provider.shutdown(); } catch (Exception e) { log.error("Exception when shutting down feature provider {}", provider.getClass().getName(), e); @@ -141,7 +139,8 @@ private void shutdownProvider(FeatureProvider provider) { } /** - * Shutdowns this repository which includes shutting down all FeatureProviders that are registered, + * Shuts down this repository which includes shutting down all FeatureProviders + * that are registered, * including the default feature provider. */ public void shutdown() { @@ -149,7 +148,16 @@ public void shutdown() { .concat(Stream.of(this.defaultProvider.get()), this.providers.values().stream()) .distinct() .forEach(this::shutdownProvider); - setProvider(new NoOpProvider()); + setProvider(new NoOpProvider(), + (FeatureProvider fp) -> { + }, + (FeatureProvider fp) -> { + }, + (FeatureProvider fp) -> { + }, + (FeatureProvider fp, + String message) -> { + }); this.providers.clear(); taskExecutor.shutdown(); } diff --git a/src/main/java/dev/openfeature/sdk/ProviderState.java b/src/main/java/dev/openfeature/sdk/ProviderState.java new file mode 100644 index 000000000..6685f8fe9 --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/ProviderState.java @@ -0,0 +1,8 @@ +package dev.openfeature.sdk; + +/** + * Indicates the state of the provider. + */ +public enum ProviderState { + READY, NOT_READY, ERROR; +} diff --git a/src/main/java/dev/openfeature/sdk/internal/ObjectUtils.java b/src/main/java/dev/openfeature/sdk/internal/ObjectUtils.java index ff16422e0..34caadaea 100644 --- a/src/main/java/dev/openfeature/sdk/internal/ObjectUtils.java +++ b/src/main/java/dev/openfeature/sdk/internal/ObjectUtils.java @@ -69,5 +69,4 @@ public static List merge(List... sources) { .flatMap(Collection::stream) .collect(Collectors.toList()); } - } diff --git a/src/main/java/dev/openfeature/sdk/internal/TriConsumer.java b/src/main/java/dev/openfeature/sdk/internal/TriConsumer.java new file mode 100644 index 000000000..723f4aeb4 --- /dev/null +++ b/src/main/java/dev/openfeature/sdk/internal/TriConsumer.java @@ -0,0 +1,38 @@ +package dev.openfeature.sdk.internal; + +import java.util.Objects; + +/** + * Like {@link java.util.function.BiConsumer} but with 3 params. + * + * @see java.util.function.BiConsumer + */ +@FunctionalInterface +public interface TriConsumer { + + /** + * Performs this operation on the given arguments. + * + * @param t the first input argument + * @param u the second input argument + * @param v the third input argument + */ + void accept(T t, U u, V v); + + /** + * Returns a composed {@code TriConsumer} that performs an additional operation. + * + * @param after the operation to perform after this operation + * @return a composed {@code TriConsumer} that performs in sequence this + * operation followed by the {@code after} operation + * @throws NullPointerException if {@code after} is null + */ + default TriConsumer andThen(TriConsumer after) { + Objects.requireNonNull(after); + + return (t, u, v) -> { + accept(t, u, v); + after.accept(t, u, v); + }; + } +} \ No newline at end of file diff --git a/src/test/java/dev/openfeature/sdk/EventProviderTest.java b/src/test/java/dev/openfeature/sdk/EventProviderTest.java new file mode 100644 index 000000000..cb73b5292 --- /dev/null +++ b/src/test/java/dev/openfeature/sdk/EventProviderTest.java @@ -0,0 +1,130 @@ +package dev.openfeature.sdk; + +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import dev.openfeature.sdk.internal.TriConsumer; + +class EventProviderTest { + + @Test + @DisplayName("should run attached onEmit with emitters") + void emitsEventsWhenAttached() { + TestEventProvider eventProvider = new TestEventProvider(); + TriConsumer onEmit = mockOnEmit(); + eventProvider.attach(onEmit); + + ProviderEventDetails details = ProviderEventDetails.builder().build(); + eventProvider.emit(ProviderEvent.PROVIDER_READY, details); + eventProvider.emitProviderReady(details); + eventProvider.emitProviderConfigurationChanged(details); + eventProvider.emitProviderStale(details); + eventProvider.emitProviderError(details); + + verify(onEmit, times(2)).accept(eventProvider, ProviderEvent.PROVIDER_READY, details); + verify(onEmit, times(1)).accept(eventProvider, ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, details); + verify(onEmit, times(1)).accept(eventProvider, ProviderEvent.PROVIDER_STALE, details); + verify(onEmit, times(1)).accept(eventProvider, ProviderEvent.PROVIDER_ERROR, details); + } + + @Test + @DisplayName("should do nothing with emitters if no onEmit attached") + void doesNotEmitsEventsWhenNotAttached() { + TestEventProvider eventProvider = new TestEventProvider(); + + // don't attach this emitter + TriConsumer onEmit = mockOnEmit(); + + ProviderEventDetails details = ProviderEventDetails.builder().build(); + eventProvider.emit(ProviderEvent.PROVIDER_READY, details); + eventProvider.emitProviderReady(details); + eventProvider.emitProviderConfigurationChanged(details); + eventProvider.emitProviderStale(details); + eventProvider.emitProviderError(details); + + // should not be called + verify(onEmit, never()).accept(any(), any(), any()); + } + + @Test + @DisplayName("should throw if second different onEmit attached") + void throwsWhenOnEmitDifferent() { + TestEventProvider eventProvider = new TestEventProvider(); + TriConsumer onEmit1 = mockOnEmit(); + TriConsumer onEmit2 = mockOnEmit(); + eventProvider.attach(onEmit1); + assertThrows(IllegalStateException.class, () -> eventProvider.attach(onEmit2)); + } + + + @Test + @DisplayName("should not throw if second same onEmit attached") + void doesNotThrowWhenOnEmitSame() { + TestEventProvider eventProvider = new TestEventProvider(); + TriConsumer onEmit1 = mockOnEmit(); + TriConsumer onEmit2 = onEmit1; + eventProvider.attach(onEmit1); + eventProvider.attach(onEmit2); // should not throw, same instance. noop + } + + + class TestEventProvider extends EventProvider { + + @Override + public Metadata getMetadata() { + return new Metadata() { + @Override + public String getName() { + return "TestEventProvider"; + } + }; + } + + @Override + public ProviderEvaluation getBooleanEvaluation(String key, Boolean defaultValue, + EvaluationContext ctx) { + // TODO Auto-generated method stub + throw new UnsupportedOperationException("Unimplemented method 'getBooleanEvaluation'"); + } + + @Override + public ProviderEvaluation getStringEvaluation(String key, String defaultValue, + EvaluationContext ctx) { + // TODO Auto-generated method stub + throw new UnsupportedOperationException("Unimplemented method 'getStringEvaluation'"); + } + + @Override + public ProviderEvaluation getIntegerEvaluation(String key, Integer defaultValue, + EvaluationContext ctx) { + // TODO Auto-generated method stub + throw new UnsupportedOperationException("Unimplemented method 'getIntegerEvaluation'"); + } + + @Override + public ProviderEvaluation getDoubleEvaluation(String key, Double defaultValue, + EvaluationContext ctx) { + // TODO Auto-generated method stub + throw new UnsupportedOperationException("Unimplemented method 'getDoubleEvaluation'"); + } + + @Override + public ProviderEvaluation getObjectEvaluation(String key, Value defaultValue, + EvaluationContext ctx) { + // TODO Auto-generated method stub + throw new UnsupportedOperationException("Unimplemented method 'getObjectEvaluation'"); + } + } + + @SuppressWarnings("unchecked") + private TriConsumer mockOnEmit() { + return (TriConsumer)mock(TriConsumer.class); + } +} \ No newline at end of file diff --git a/src/test/java/dev/openfeature/sdk/EventsTest.java b/src/test/java/dev/openfeature/sdk/EventsTest.java new file mode 100644 index 000000000..70f81657e --- /dev/null +++ b/src/test/java/dev/openfeature/sdk/EventsTest.java @@ -0,0 +1,599 @@ +package dev.openfeature.sdk; + +import static org.awaitility.Awaitility.await; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.argThat; +import static org.mockito.Mockito.after; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.timeout; +import static org.mockito.Mockito.verify; + +import java.util.Arrays; +import java.util.List; +import java.util.function.Consumer; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentMatcher; + +import dev.openfeature.sdk.testutils.TestEventsProvider; +import io.cucumber.java.AfterAll; + +class EventsTest { + + private static final int TIMEOUT = 200; + private static final int INIT_DELAY = TIMEOUT / 2; + + @AfterAll + public static void resetDefaultProvider() { + OpenFeatureAPI.getInstance().setProvider(new NoOpProvider()); + } + + @Nested + class ApiEvents { + + @Nested + @DisplayName("named provider") + class NamedProvider { + + @Nested + @DisplayName("initialization") + class Initialization { + + @Test + @DisplayName("should fire initial READY event when provider init succeeds") + @Specification(number = "5.3.1", text = "If the provider's initialize function terminates normally," + + " PROVIDER_READY handlers MUST run.") + void apiInitReady() { + final Consumer handler = (Consumer)mockHandler(); + final String name = "apiInitReady"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().onProviderReady(handler); + OpenFeatureAPI.getInstance().setProvider(name, provider); + verify(handler, timeout(TIMEOUT).atLeastOnce()) + .accept(any()); + } + + @Test + @DisplayName("should fire initial ERROR event when provider init errors") + @Specification(number = "5.3.2", text = "If the provider's initialize function terminates abnormally," + + " PROVIDER_ERROR handlers MUST run.") + void apiInitError() { + final Consumer handler = mockHandler(); + final String name = "apiInitError"; + final String errMessage = "oh no!"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY, true, errMessage); + OpenFeatureAPI.getInstance().onProviderError(handler); + OpenFeatureAPI.getInstance().setProvider(name, provider); + verify(handler, timeout(TIMEOUT)).accept(argThat(details -> { + return errMessage.equals(details.getMessage()); + })); + } + } + + @Nested + @DisplayName("provider events") + class ProviderEvents { + + @Test + @DisplayName("should propagate events") + @Specification(number = "5.1.2", text = "When a provider signals the occurrence of a particular event, " + + + "the associated client and API event handlers MUST run.") + void apiShouldPropagateEvents() { + final Consumer handler = mockHandler(); + final String name = "apiShouldPropagateEvents"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name, provider); + OpenFeatureAPI.getInstance().onProviderConfigurationChanged(handler); + + provider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, EventDetails.builder().build()); + verify(handler, timeout(TIMEOUT)).accept(any()); + } + + @Test + @DisplayName("should support all event types") + @Specification(number = "5.1.1", text = "The provider MAY define a mechanism for signaling the occurrence " + + "of one of a set of events, including PROVIDER_READY, PROVIDER_ERROR, " + + "PROVIDER_CONFIGURATION_CHANGED and PROVIDER_STALE, with a provider event details payload.") + @Specification(number = "5.2.2", text = "The API MUST provide a function for associating handler functions" + + + " with a particular provider event type.") + void apiShouldSupportAllEventTypes() throws Exception { + final String name = "apiShouldSupportAllEventTypes"; + final Consumer handler1 = mockHandler(); + final Consumer handler2 = mockHandler(); + final Consumer handler3 = mockHandler(); + final Consumer handler4 = mockHandler(); + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name, provider); + + OpenFeatureAPI.getInstance().onProviderReady(handler1); + OpenFeatureAPI.getInstance().onProviderConfigurationChanged(handler2); + OpenFeatureAPI.getInstance().onProviderStale(handler3); + OpenFeatureAPI.getInstance().onProviderError(handler4); + + Arrays.asList(ProviderEvent.values()).stream().forEach(eventType -> { + provider.mockEvent(eventType, ProviderEventDetails.builder().build()); + }); + + verify(handler1, timeout(TIMEOUT).atLeastOnce()).accept(any()); + verify(handler2, timeout(TIMEOUT).atLeastOnce()).accept(any()); + verify(handler3, timeout(TIMEOUT).atLeastOnce()).accept(any()); + verify(handler4, timeout(TIMEOUT).atLeastOnce()).accept(any()); + } + } + } + } + + @Nested + @DisplayName("client events") + class ClientEvents { + + @Nested + @DisplayName("default provider") + class DefaultProvider { + + @Nested + @DisplayName("provider events") + class ProviderEvents { + + @Test + @DisplayName("should propagate events for default provider and anonymous client") + @Specification(number = "5.1.2", text = "When a provider signals the occurrence of a particular event, the associated client and API event handlers MUST run.") + void shouldPropagateDefaultAndAnon() { + final Consumer handler = mockHandler(); + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + // set provider before getting a client + OpenFeatureAPI.getInstance().setProvider(provider); + Client client = OpenFeatureAPI.getInstance().getClient(); + client.onProviderStale(handler); + + provider.mockEvent(ProviderEvent.PROVIDER_STALE, EventDetails.builder().build()); + verify(handler, timeout(TIMEOUT)).accept(any()); + } + + @Test + @DisplayName("should propagate events for default provider and named client") + @Specification(number = "5.1.2", text = "When a provider signals the occurrence of a particular event, the associated client and API event handlers MUST run.") + void shouldPropagateDefaultAndNamed() { + final Consumer handler = mockHandler(); + final String name = "shouldPropagateDefaultAndNamed"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + // set provider before getting a client + OpenFeatureAPI.getInstance().setProvider(provider); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderStale(handler); + + provider.mockEvent(ProviderEvent.PROVIDER_STALE, EventDetails.builder().build()); + verify(handler, timeout(TIMEOUT)).accept(any()); + } + } + } + } + + @Nested + @DisplayName("named provider") + class NamedProvider { + + @Nested + @DisplayName("initialization") + class Initialization { + @Test + @DisplayName("should fire initial READY event when provider init succeeds after client retrieved") + @Specification(number = "5.3.1", text = "If the provider's initialize function terminates normally, PROVIDER_READY handlers MUST run.") + void initReadyProviderBefore() throws InterruptedException { + final Consumer handler = mockHandler(); + final String name = "initReadyProviderBefore"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderReady(handler); + // set provider after getting a client + OpenFeatureAPI.getInstance().setProvider(name, provider); + verify(handler, timeout(TIMEOUT).atLeastOnce()) + .accept(argThat(details -> details.getClientName().equals(name))); + } + + @Test + @DisplayName("should fire initial READY event when provider init succeeds before client retrieved") + @Specification(number = "5.3.1", text = "If the provider's initialize function terminates normally, PROVIDER_READY handlers MUST run.") + void initReadyProviderAfter() { + final Consumer handler = mockHandler(); + final String name = "initReadyProviderAfter"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + // set provider before getting a client + OpenFeatureAPI.getInstance().setProvider(name, provider); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderReady(handler); + verify(handler, timeout(TIMEOUT).atLeastOnce()) + .accept(argThat(details -> details.getClientName().equals(name))); + } + + @Test + @DisplayName("should fire initial ERROR event when provider init errors after client retrieved") + @Specification(number = "5.3.2", text = "If the provider's initialize function terminates abnormally, PROVIDER_ERROR handlers MUST run.") + void initErrorProviderAfter() { + final Consumer handler = mockHandler(); + final String name = "initErrorProviderAfter"; + final String errMessage = "oh no!"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY, true, errMessage); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderError(handler); + // set provider after getting a client + OpenFeatureAPI.getInstance().setProvider(name, provider); + verify(handler, timeout(TIMEOUT)).accept(argThat(details -> { + return name.equals(details.getClientName()) + && errMessage.equals(details.getMessage()); + })); + } + + @Test + @DisplayName("should fire initial ERROR event when provider init errors before client retrieved") + @Specification(number = "5.3.2", text = "If the provider's initialize function terminates abnormally, PROVIDER_ERROR handlers MUST run.") + void initErrorProviderBefore() { + final Consumer handler = mockHandler(); + final String name = "initErrorProviderBefore"; + final String errMessage = "oh no!"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY, true, errMessage); + // set provider after getting a client + OpenFeatureAPI.getInstance().setProvider(name, provider); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderError(handler); + verify(handler, timeout(TIMEOUT)).accept(argThat(details -> { + return name.equals(details.getClientName()) + && errMessage.equals(details.getMessage()); + })); + } + } + + @Nested + @DisplayName("provider events") + class ProviderEvents { + + @Test + @DisplayName("should propagate events when provider set before client retrieved") + @Specification(number = "5.1.2", text = "When a provider signals the occurrence of a particular event, the associated client and API event handlers MUST run.") + void shouldPropagateBefore() { + final Consumer handler = mockHandler(); + final String name = "shouldPropagateBefore"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + // set provider before getting a client + OpenFeatureAPI.getInstance().setProvider(name, provider); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderConfigurationChanged(handler); + + provider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, EventDetails.builder().build()); + verify(handler, timeout(TIMEOUT)).accept(argThat(details -> details.getClientName().equals(name))); + } + + @Test + @DisplayName("should propagate events when provider set after client retrieved") + @Specification(number = "5.1.2", text = "When a provider signals the occurrence of a particular event, the associated client and API event handlers MUST run.") + void shouldPropagateAfter() { + + final Consumer handler = mockHandler(); + final String name = "shouldPropagateAfter"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderConfigurationChanged(handler); + // set provider after getting a client + OpenFeatureAPI.getInstance().setProvider(name, provider); + + provider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, EventDetails.builder().build()); + verify(handler, timeout(TIMEOUT)).accept(argThat(details -> details.getClientName().equals(name))); + } + + @Test + @DisplayName("should support all event types") + @Specification(number = "5.1.1", text = "The provider MAY define a mechanism for signaling the occurrence " + + "of one of a set of events, including PROVIDER_READY, PROVIDER_ERROR, " + + "PROVIDER_CONFIGURATION_CHANGED and PROVIDER_STALE, with a provider event details payload.") + @Specification(number = "5.2.1", text = "The client MUST provide a function for associating handler functions" + + + " with a particular provider event type.") + void shouldSupportAllEventTypes() throws Exception { + final String name = "shouldSupportAllEventTypes"; + final Consumer handler1 = mockHandler(); + final Consumer handler2 = mockHandler(); + final Consumer handler3 = mockHandler(); + final Consumer handler4 = mockHandler(); + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name, provider); + Client client = OpenFeatureAPI.getInstance().getClient(name); + + client.onProviderReady(handler1); + client.onProviderConfigurationChanged(handler2); + client.onProviderStale(handler3); + client.onProviderError(handler4); + + Arrays.asList(ProviderEvent.values()).stream().forEach(eventType -> { + provider.mockEvent(eventType, ProviderEventDetails.builder().build()); + }); + ArgumentMatcher nameMatches = (EventDetails details) -> details.getClientName() + .equals(name); + verify(handler1, timeout(TIMEOUT).atLeastOnce()).accept(argThat(nameMatches)); + verify(handler2, timeout(TIMEOUT).atLeastOnce()).accept(argThat(nameMatches)); + verify(handler3, timeout(TIMEOUT).atLeastOnce()).accept(argThat(nameMatches)); + verify(handler4, timeout(TIMEOUT).atLeastOnce()).accept(argThat(nameMatches)); + } + } + } + + @Test + @DisplayName("shutdown provider should not run handlers") + void shouldNotRunHandlers() throws Exception { + final Consumer handler1 = mockHandler(); + final Consumer handler2 = mockHandler(); + final String name = "shouldNotRunHandlers"; + + TestEventsProvider provider1 = new TestEventsProvider(INIT_DELAY); + TestEventsProvider provider2 = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name, provider1); + Client client = OpenFeatureAPI.getInstance().getClient(name); + + // attached handlers + OpenFeatureAPI.getInstance().onProviderConfigurationChanged(handler1); + client.onProviderConfigurationChanged(handler2); + + OpenFeatureAPI.getInstance().setProvider(name, provider2); + + // wait for the new provider to be ready and make sure things are cleaned up. + await().until(() -> provider1.isShutDown()); + + // fire old event + provider1.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, EventDetails.builder().build()); + + // a bit of waiting here, but we want to make sure these are indeed never + // called. + verify(handler1, after(TIMEOUT).never()).accept(any()); + verify(handler2, never()).accept(any()); + } + + @Test + @DisplayName("other client handlers should not run") + @Specification(number = "5.1.3", text = "When a provider signals the occurrence of a particular event, " + + "event handlers on clients which are not associated with that provider MUST NOT run.") + void otherClientHandlersShouldNotRun() throws Exception { + final String name1 = "otherClientHandlersShouldNotRun1"; + final String name2 = "otherClientHandlersShouldNotRun2"; + final Consumer handlerToRun = mockHandler(); + final Consumer handlerNotToRun = mockHandler(); + + TestEventsProvider provider1 = new TestEventsProvider(INIT_DELAY); + TestEventsProvider provider2 = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name1, provider1); + OpenFeatureAPI.getInstance().setProvider(name2, provider2); + + Client client1 = OpenFeatureAPI.getInstance().getClient(name1); + Client client2 = OpenFeatureAPI.getInstance().getClient(name2); + + client1.onProviderConfigurationChanged(handlerToRun); + client2.onProviderConfigurationChanged(handlerNotToRun); + + provider1.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, ProviderEventDetails.builder().build()); + + verify(handlerToRun, timeout(TIMEOUT)).accept(any()); + verify(handlerNotToRun, never()).accept(any()); + } + + @Test + @DisplayName("bound named client handlers should not run with default") + @Specification(number = "5.1.3", text = "When a provider signals the occurrence of a particular event, " + + "event handlers on clients which are not associated with that provider MUST NOT run.") + void boundShouldNotRunWithDefault() throws Exception { + final String name = "boundShouldNotRunWithDefault"; + final Consumer handlerNotToRun = mockHandler(); + + TestEventsProvider namedProvider = new TestEventsProvider(INIT_DELAY); + TestEventsProvider defaultProvider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(defaultProvider); + + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderConfigurationChanged(handlerNotToRun); + OpenFeatureAPI.getInstance().setProvider(name, namedProvider); + + // await the new provider to make sure the old one is shut down + await().until(() -> namedProvider.getState().equals(ProviderState.READY)); + + // fire event on default provider + defaultProvider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, ProviderEventDetails.builder().build()); + + verify(handlerNotToRun, after(TIMEOUT).never()).accept(any()); + OpenFeatureAPI.getInstance().setProvider(new NoOpProvider()); + } + + @Test + @DisplayName("unbound named client handlers should run with default") + @Specification(number = "5.1.3", text = "When a provider signals the occurrence of a particular event, " + + "event handlers on clients which are not associated with that provider MUST NOT run.") + void unboundShouldRunWithDefault() throws Exception { + final String name = "unboundShouldRunWithDefault"; + final Consumer handlerToRun = mockHandler(); + + TestEventsProvider defaultProvider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(defaultProvider); + + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderConfigurationChanged(handlerToRun); + + // await the new provider to make sure the old one is shut down + await().until(() -> defaultProvider.getState().equals(ProviderState.READY)); + + // fire event on default provider + defaultProvider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, ProviderEventDetails.builder().build()); + + verify(handlerToRun, timeout(TIMEOUT)).accept(any()); + OpenFeatureAPI.getInstance().setProvider(new NoOpProvider()); + } + + @Test + @DisplayName("subsequent handlers run if earlier throws") + @Specification(number = "5.2.5", text = "If a handler function terminates abnormally, other handler functions MUST run.") + void handlersRunIfOneThrows() throws Exception { + final String name = "handlersRunIfOneThrows"; + final Consumer errorHandler = mockHandler(); + doThrow(new NullPointerException()).when(errorHandler).accept(any()); + final Consumer nextHandler = mockHandler(); + final Consumer lastHandler = mockHandler(); + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name, provider); + + Client client1 = OpenFeatureAPI.getInstance().getClient(name); + + client1.onProviderConfigurationChanged(errorHandler); + client1.onProviderConfigurationChanged(nextHandler); + client1.onProviderConfigurationChanged(lastHandler); + + provider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, ProviderEventDetails.builder().build()); + verify(errorHandler, timeout(TIMEOUT)).accept(any()); + verify(nextHandler, timeout(TIMEOUT)).accept(any()); + verify(lastHandler, timeout(TIMEOUT)).accept(any()); + } + + @Test + @DisplayName("should have all properties") + @Specification(number = "5.2.4", text = "The handler function MUST accept a event details parameter.") + @Specification(number = "5.2.3", text = "The event details MUST contain the client name associated with the event.") + void shouldHaveAllProperties() throws Exception { + final Consumer handler1 = mockHandler(); + final Consumer handler2 = mockHandler(); + final String name = "shouldHaveAllProperties"; + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name, provider); + Client client = OpenFeatureAPI.getInstance().getClient(name); + + // attached handlers + OpenFeatureAPI.getInstance().onProviderConfigurationChanged(handler1); + client.onProviderConfigurationChanged(handler2); + + List flagsChanged = Arrays.asList("flag"); + ImmutableMetadata metadata = ImmutableMetadata.builder().addInteger("int", 1).build(); + String message = "a message"; + ProviderEventDetails details = ProviderEventDetails.builder() + .eventMetadata(metadata) + .flagsChanged(flagsChanged) + .message(message) + .build(); + + provider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, details); + + // both global and client handler should have all the fields. + verify(handler1, timeout(TIMEOUT)) + .accept(argThat((EventDetails eventDetails) -> { + return metadata.equals(eventDetails.getEventMetadata()) + // TODO: issue for client name in events + && flagsChanged.equals(eventDetails.getFlagsChanged()) + && message.equals(eventDetails.getMessage()); + })); + verify(handler2, timeout(TIMEOUT)) + .accept(argThat((EventDetails eventDetails) -> { + return metadata.equals(eventDetails.getEventMetadata()) + && flagsChanged.equals(eventDetails.getFlagsChanged()) + && message.equals(eventDetails.getMessage()) + && name.equals(eventDetails.getClientName()); + })); + } + + @Test + @DisplayName("if the provider is ready handlers must run immediately") + @Specification(number = "5.3.3", text = "PROVIDER_READY handlers attached after the provider is already in a ready state MUST run immediately.") + void readyMustRunImmediately() throws Exception { + final String name = "readyMustRunImmediately"; + final Consumer handler = mockHandler(); + + // provider which is already ready + TestEventsProvider provider = new TestEventsProvider(ProviderState.READY); + OpenFeatureAPI.getInstance().setProvider(name, provider); + + // should run even thought handler was added after ready + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderReady(handler); + verify(handler, timeout(TIMEOUT)).accept(any()); + } + + @Test + @DisplayName("must persist across changes") + @Specification(number = "5.2.6", text = "Event handlers MUST persist across provider changes.") + void mustPersistAcrossChanges() throws Exception { + final String name = "mustPersistAcrossChanges"; + final Consumer handler = mockHandler(); + + TestEventsProvider provider1 = new TestEventsProvider(INIT_DELAY); + TestEventsProvider provider2 = new TestEventsProvider(INIT_DELAY); + + OpenFeatureAPI.getInstance().setProvider(name, provider1); + Client client = OpenFeatureAPI.getInstance().getClient(name); + client.onProviderConfigurationChanged(handler); + + provider1.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, ProviderEventDetails.builder().build()); + ArgumentMatcher nameMatches = (EventDetails details) -> details.getClientName().equals(name); + + verify(handler, timeout(TIMEOUT).times(1)).accept(argThat(nameMatches)); + + // wait for the new provider to be ready. + OpenFeatureAPI.getInstance().setProvider(name, provider2); + await().until(() -> provider2.getState().equals(ProviderState.READY)); + + // verify that with the new provider under the same name, the handler is called + // again. + provider2.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, ProviderEventDetails.builder().build()); + verify(handler, timeout(TIMEOUT).times(2)).accept(argThat(nameMatches)); + } + + @Nested + class HandlerRemoval { + @Test + @DisplayName("should not run removed events") + void removedEventsShouldNotRun() { + final String name = "removedEventsShouldNotRun"; + final Consumer handler1 = mockHandler(); + final Consumer handler2 = mockHandler(); + + TestEventsProvider provider = new TestEventsProvider(INIT_DELAY); + OpenFeatureAPI.getInstance().setProvider(name, provider); + Client client = OpenFeatureAPI.getInstance().getClient(name); + + // attached handlers + OpenFeatureAPI.getInstance().onProviderStale(handler1); + client.onProviderConfigurationChanged(handler2); + + OpenFeatureAPI.getInstance().removeHandler(ProviderEvent.PROVIDER_STALE, handler1); + client.removeHandler(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, handler2); + + // emit event + provider.mockEvent(ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, ProviderEventDetails.builder().build()); + + // both global and client handlers should not run. + verify(handler1, after(TIMEOUT).never()).accept(any()); + verify(handler2, never()).accept(any()); + } + } + + @Specification(number = "5.1.4", text = "PROVIDER_ERROR events SHOULD populate the provider event details's error message field.") + @Test + void thisIsAProviderRequirement() { + } + + @SuppressWarnings("unchecked") + private static Consumer mockHandler() { + return mock(Consumer.class); + } +} diff --git a/src/test/java/dev/openfeature/sdk/FlagEvaluationSpecTest.java b/src/test/java/dev/openfeature/sdk/FlagEvaluationSpecTest.java index 57f0c0454..eb41fd950 100644 --- a/src/test/java/dev/openfeature/sdk/FlagEvaluationSpecTest.java +++ b/src/test/java/dev/openfeature/sdk/FlagEvaluationSpecTest.java @@ -62,20 +62,20 @@ void getApiInstance() { assertSame(OpenFeatureAPI.getInstance(), OpenFeatureAPI.getInstance()); } - @Specification(number="1.1.2", text="The API MUST provide a function to set the global provider singleton, which accepts an API-conformant provider implementation.") + @Specification(number="1.1.2.1", text="The API MUST define a provider mutator, a function to set the default provider, which accepts an API-conformant provider implementation.") @Test void provider() { FeatureProvider mockProvider = mock(FeatureProvider.class); FeatureProviderTestUtils.setFeatureProvider(mockProvider); assertThat(api.getProvider()).isEqualTo(mockProvider); } - @Specification(number="1.1.4", text="The API MUST provide a function for retrieving the metadata field of the configured provider.") + @Specification(number="1.1.5", text="The API MUST provide a function for retrieving the metadata field of the configured provider.") @Test void provider_metadata() { FeatureProviderTestUtils.setFeatureProvider(new DoSomethingProvider()); assertThat(api.getProviderMetadata().getName()).isEqualTo(DoSomethingProvider.name); } - @Specification(number="1.1.3", text="The API MUST provide a function to add hooks which accepts one or more API-conformant hooks, and appends them to the collection of any previously added hooks. When new hooks are added, previously added hooks are not removed.") + @Specification(number="1.1.4", text="The API MUST provide a function to add hooks which accepts one or more API-conformant hooks, and appends them to the collection of any previously added hooks. When new hooks are added, previously added hooks are not removed.") @Test void hook_addition() { Hook h1 = mock(Hook.class); Hook h2 = mock(Hook.class); @@ -89,7 +89,7 @@ void getApiInstance() { assertEquals(h2, api.getHooks().get(1)); } - @Specification(number="1.1.5", text="The API MUST provide a function for creating a client which accepts the following options: - name (optional): A logical string identifier for the client.") + @Specification(number="1.1.6", text="The API MUST provide a function for creating a client which accepts the following options: - name (optional): A logical string identifier for the client.") @Test void namedClient() { assertThatCode(() -> api.getClient("Sir Calls-a-lot")).doesNotThrowAnyException(); // TODO: Doesn't say that you can *get* the client name.. which seems useful? @@ -286,7 +286,7 @@ void getApiInstance() { @Specification(number="1.3.3", text="The client SHOULD guarantee the returned value of any typed flag evaluation method is of the expected type. If the value returned by the underlying provider implementation does not match the expected type, it's to be considered abnormal execution, and the supplied default value should be returned.") @Test void type_system_prevents_this() {} - @Specification(number="1.1.6", text="The client creation function MUST NOT throw, or otherwise abnormally terminate.") + @Specification(number="1.1.7", text="The client creation function MUST NOT throw, or otherwise abnormally terminate.") @Test void constructor_does_not_throw() {} @Specification(number="1.4.11", text="The client SHOULD provide asynchronous or non-blocking mechanisms for flag evaluation.") diff --git a/src/test/java/dev/openfeature/sdk/InitializeBehaviorSpecTest.java b/src/test/java/dev/openfeature/sdk/InitializeBehaviorSpecTest.java index 7061719fa..0ab5e3719 100644 --- a/src/test/java/dev/openfeature/sdk/InitializeBehaviorSpecTest.java +++ b/src/test/java/dev/openfeature/sdk/InitializeBehaviorSpecTest.java @@ -21,12 +21,13 @@ class DefaultProvider { @Test @DisplayName("must call initialize function of the newly registered provider before using it for " + "flag evaluation") - void mustCallInitializeFunctionOfTheNewlyRegisteredProviderBeforeUsingItForFlagEvaluation() { + void mustCallInitializeFunctionOfTheNewlyRegisteredProviderBeforeUsingItForFlagEvaluation() throws Exception { FeatureProvider featureProvider = mock(FeatureProvider.class); + doReturn(ProviderState.NOT_READY).when(featureProvider).getState(); OpenFeatureAPI.getInstance().setProvider(featureProvider); - verify(featureProvider, timeout(1000)).initialize(); + verify(featureProvider, timeout(1000)).initialize(any()); } @Specification(number = "1.4.9", text = "Methods, functions, or operations on the client MUST NOT throw " @@ -35,14 +36,15 @@ void mustCallInitializeFunctionOfTheNewlyRegisteredProviderBeforeUsingItForFlagE + "the purposes for configuration or setup.") @Test @DisplayName("should catch exception thrown by the provider on initialization") - void shouldCatchExceptionThrownByTheProviderOnInitialization() { + void shouldCatchExceptionThrownByTheProviderOnInitialization() throws Exception { FeatureProvider featureProvider = mock(FeatureProvider.class); - doThrow(TestException.class).when(featureProvider).initialize(); + doReturn(ProviderState.NOT_READY).when(featureProvider).getState(); + doThrow(TestException.class).when(featureProvider).initialize(any()); assertThatCode(() -> OpenFeatureAPI.getInstance().setProvider(featureProvider)) .doesNotThrowAnyException(); - verify(featureProvider, timeout(1000)).initialize(); + verify(featureProvider, timeout(1000)).initialize(any()); } } @@ -54,12 +56,13 @@ class ProviderForNamedClient { @Test @DisplayName("must call initialize function of the newly registered named provider before using it " + "for flag evaluation") - void mustCallInitializeFunctionOfTheNewlyRegisteredNamedProviderBeforeUsingItForFlagEvaluation() { + void mustCallInitializeFunctionOfTheNewlyRegisteredNamedProviderBeforeUsingItForFlagEvaluation() throws Exception { FeatureProvider featureProvider = mock(FeatureProvider.class); + doReturn(ProviderState.NOT_READY).when(featureProvider).getState(); OpenFeatureAPI.getInstance().setProvider("clientName", featureProvider); - verify(featureProvider, timeout(1000)).initialize(); + verify(featureProvider, timeout(1000)).initialize(any()); } @Specification(number = "1.4.9", text = "Methods, functions, or operations on the client MUST NOT throw " @@ -68,14 +71,15 @@ void mustCallInitializeFunctionOfTheNewlyRegisteredNamedProviderBeforeUsingItFor + "the purposes for configuration or setup.") @Test @DisplayName("should catch exception thrown by the named client provider on initialization") - void shouldCatchExceptionThrownByTheNamedClientProviderOnInitialization() { + void shouldCatchExceptionThrownByTheNamedClientProviderOnInitialization() throws Exception { FeatureProvider featureProvider = mock(FeatureProvider.class); - doThrow(TestException.class).when(featureProvider).initialize(); + doReturn(ProviderState.NOT_READY).when(featureProvider).getState(); + doThrow(TestException.class).when(featureProvider).initialize(any()); assertThatCode(() -> OpenFeatureAPI.getInstance().setProvider("clientName", featureProvider)) .doesNotThrowAnyException(); - verify(featureProvider, timeout(1000)).initialize(); + verify(featureProvider, timeout(1000)).initialize(any()); } } } diff --git a/src/test/java/dev/openfeature/sdk/LockingTest.java b/src/test/java/dev/openfeature/sdk/LockingTest.java index 3d8d90c8f..d9601e85b 100644 --- a/src/test/java/dev/openfeature/sdk/LockingTest.java +++ b/src/test/java/dev/openfeature/sdk/LockingTest.java @@ -6,19 +6,20 @@ import static org.mockito.Mockito.when; import java.util.concurrent.locks.ReentrantReadWriteLock; +import java.util.function.Consumer; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; import dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock; class LockingTest { - + private static OpenFeatureAPI api; private OpenFeatureClient client; - private AutoCloseableReentrantReadWriteLock apiContextLock; - private AutoCloseableReentrantReadWriteLock apiHooksLock; + private AutoCloseableReentrantReadWriteLock apiLock; private AutoCloseableReentrantReadWriteLock clientContextLock; private AutoCloseableReentrantReadWriteLock clientHooksLock; @@ -31,10 +32,8 @@ static void beforeAll() { void beforeEach() { client = (OpenFeatureClient) api.getClient(); - apiContextLock = setupLock(apiContextLock, mockInnerReadLock(), mockInnerWriteLock()); - apiHooksLock = setupLock(apiHooksLock, mockInnerReadLock(), mockInnerWriteLock()); - OpenFeatureAPI.contextLock = apiContextLock; - OpenFeatureAPI.hooksLock = apiHooksLock; + apiLock = setupLock(apiLock, mockInnerReadLock(), mockInnerWriteLock()); + OpenFeatureAPI.lock = apiLock; clientContextLock = setupLock(clientContextLock, mockInnerReadLock(), mockInnerWriteLock()); clientHooksLock = setupLock(clientHooksLock, mockInnerReadLock(), mockInnerWriteLock()); @@ -42,6 +41,101 @@ void beforeEach() { client.hooksLock = clientHooksLock; } + @Nested + class EventsLocking { + + @Nested + class Api { + + @Test + void onShouldWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.on(ProviderEvent.PROVIDER_READY, handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderReadyShouldWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderReady(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderConfigurationChangedShouldWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderConfigurationChanged(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderStaleShouldWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderStale(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderErrorShouldWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderError(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + } + + @Nested + class Client { + + // Note that the API lock is used for adding client handlers, they are all added (indirectly) on the API object. + + @Test + void onShouldApiWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + client.on(ProviderEvent.PROVIDER_READY, handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderReadyShouldApiWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderReady(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderConfigurationChangedProviderReadyShouldApiWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderConfigurationChanged(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderStaleProviderReadyShouldApiWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderStale(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + + @Test + void onProviderErrorProviderReadyShouldApiWriteLockAndUnlock() { + Consumer handler = mock(Consumer.class); + api.onProviderError(handler); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); + } + } + } + + @Test void addHooksShouldWriteLockAndUnlock() { client.addHooks(new Hook() { @@ -51,8 +145,8 @@ void addHooksShouldWriteLockAndUnlock() { api.addHooks(new Hook() { }); - verify(apiHooksLock.writeLock()).lock(); - verify(apiHooksLock.writeLock()).unlock(); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); } @Test @@ -62,8 +156,8 @@ void getHooksShouldReadLockAndUnlock() { verify(clientHooksLock.readLock()).unlock(); api.getHooks(); - verify(apiHooksLock.readLock()).lock(); - verify(apiHooksLock.readLock()).unlock(); + verify(apiLock.readLock()).lock(); + verify(apiLock.readLock()).unlock(); } @Test @@ -73,8 +167,8 @@ void setContextShouldWriteLockAndUnlock() { verify(clientContextLock.writeLock()).unlock(); api.setEvaluationContext(new ImmutableContext()); - verify(apiContextLock.writeLock()).lock(); - verify(apiContextLock.writeLock()).unlock(); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); } @Test @@ -84,16 +178,16 @@ void getContextShouldReadLockAndUnlock() { verify(clientContextLock.readLock()).unlock(); api.getEvaluationContext(); - verify(apiContextLock.readLock()).lock(); - verify(apiContextLock.readLock()).unlock(); + verify(apiLock.readLock()).lock(); + verify(apiLock.readLock()).unlock(); } @Test void clearHooksShouldWriteLockAndUnlock() { api.clearHooks(); - verify(apiHooksLock.writeLock()).lock(); - verify(apiHooksLock.writeLock()).unlock(); + verify(apiLock.writeLock()).lock(); + verify(apiLock.writeLock()).unlock(); } private static ReentrantReadWriteLock.ReadLock mockInnerReadLock() { diff --git a/src/test/java/dev/openfeature/sdk/ProviderRepositoryTest.java b/src/test/java/dev/openfeature/sdk/ProviderRepositoryTest.java index 00c7949e6..5b6dac1b5 100644 --- a/src/test/java/dev/openfeature/sdk/ProviderRepositoryTest.java +++ b/src/test/java/dev/openfeature/sdk/ProviderRepositoryTest.java @@ -1,35 +1,40 @@ package dev.openfeature.sdk; -import dev.openfeature.sdk.testutils.exception.TestException; -import lombok.SneakyThrows; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.DisplayName; -import org.junit.jupiter.api.Nested; -import org.junit.jupiter.api.Test; +import static dev.openfeature.sdk.fixtures.ProviderFixture.createMockedErrorProvider; +import static dev.openfeature.sdk.fixtures.ProviderFixture.createMockedProvider; +import static dev.openfeature.sdk.fixtures.ProviderFixture.createMockedReadyProvider; +import static dev.openfeature.sdk.testutils.stubbing.ConditionStubber.doDelayResponse; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatCode; +import static org.awaitility.Awaitility.await; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.timeout; +import static org.mockito.Mockito.verify; import java.time.Duration; -import java.util.concurrent.CountDownLatch; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; +import java.util.function.BiConsumer; +import java.util.function.Consumer; import java.util.function.Function; -import static dev.openfeature.sdk.fixtures.ProviderFixture.*; -import static dev.openfeature.sdk.testutils.stubbing.ConditionStubber.doBlock; -import static dev.openfeature.sdk.testutils.stubbing.ConditionStubber.doDelayResponse; -import static java.util.concurrent.TimeUnit.SECONDS; -import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatCode; -import static org.awaitility.Awaitility.await; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.*; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import dev.openfeature.sdk.testutils.exception.TestException; class ProviderRepositoryTest { private static final String CLIENT_NAME = "client name"; private static final String ANOTHER_CLIENT_NAME = "another client name"; - private static final String FEATURE_KEY = "some key"; + private static final int TIMEOUT = 5000; private final ExecutorService executorService = Executors.newCachedThreadPool(); @@ -49,7 +54,8 @@ class DefaultProvider { @Test @DisplayName("should reject null as default provider") void shouldRejectNullAsDefaultProvider() { - assertThatCode(() -> providerRepository.setProvider(null)).isInstanceOf(IllegalArgumentException.class); + assertThatCode(() -> providerRepository.setProvider(null, mockAfterSet(), mockAfterInit(), + mockAfterShutdown(), mockAfterError())).isInstanceOf(IllegalArgumentException.class); } @Test @@ -60,78 +66,31 @@ void shouldHaveNoOpProviderSetAsDefaultOnInitialization() { @Test @DisplayName("should immediately return when calling the provider mutator") - void shouldImmediatelyReturnWhenCallingTheProviderMutator() { + void shouldImmediatelyReturnWhenCallingTheProviderMutator() throws Exception { FeatureProvider featureProvider = createMockedProvider(); - doDelayResponse(Duration.ofSeconds(10)).when(featureProvider).initialize(); + doDelayResponse(Duration.ofSeconds(10)).when(featureProvider).initialize(new ImmutableContext()); await() .alias("wait for provider mutator to return") .pollDelay(Duration.ofMillis(1)) .atMost(Duration.ofSeconds(1)) .until(() -> { - providerRepository.setProvider(featureProvider); - verify(featureProvider, timeout(100)).initialize(); + providerRepository.setProvider(featureProvider, mockAfterSet(), mockAfterInit(), + mockAfterShutdown(), mockAfterError()); + verify(featureProvider, timeout(TIMEOUT)).initialize(any()); return true; }); - verify(featureProvider).initialize(); - } - - @Test - @DisplayName("should not return set provider if initialize has not yet been finished executing") - void shouldNotReturnSetProviderIfItsInitializeMethodHasNotYetBeenFinishedExecuting() { - CountDownLatch latch = new CountDownLatch(1); - FeatureProvider newProvider = createMockedProvider(); - doBlock(latch).when(newProvider).initialize(); - FeatureProvider oldProvider = providerRepository.getProvider(); - - providerRepository.setProvider(newProvider); - - FeatureProvider providerWhileInitialization = providerRepository.getProvider(); - latch.countDown(); - - assertThat(providerWhileInitialization).isEqualTo(oldProvider); - await() - .pollDelay(Duration.ofMillis(1)) - .atMost(Duration.ofSeconds(1)) - .untilAsserted(() -> assertThat(providerRepository.getProvider()).isEqualTo(newProvider)); - verify(newProvider, timeout(100)).initialize(); - } - - @SneakyThrows - @Test - @DisplayName("should discard provider still initializing if a newer has finished before") - void shouldDiscardProviderStillInitializingIfANewerHasFinishedBefore() { - CountDownLatch latch = new CountDownLatch(1); - CountDownLatch testBlockingLatch = new CountDownLatch(1); - FeatureProvider blockedProvider = createBlockedProvider(latch, testBlockingLatch::countDown); - FeatureProvider fastProvider = createUnblockingProvider(latch); - - providerRepository.setProvider(blockedProvider); - providerRepository.setProvider(fastProvider); - - assertThat(testBlockingLatch.await(2, SECONDS)) - .as("blocking provider initialization not completed within 2 seconds") - .isTrue(); - - await() - .pollDelay(Duration.ofMillis(1)) - .atMost(Duration.ofSeconds(1)) - .untilAsserted(() -> assertThat(providerRepository.getProvider()).isEqualTo(fastProvider)); - - verify(blockedProvider, timeout(100)).initialize(); - verify(fastProvider, timeout(100)).initialize(); + verify(featureProvider, timeout(TIMEOUT)).initialize(any()); } @Test @DisplayName("should avoid additional initialization call if provider has been initialized already") - void shouldAvoidAdditionalInitializationCallIfProviderHasBeenInitializedAlready() { - FeatureProvider provider = createMockedProvider(); - setFeatureProvider(CLIENT_NAME, provider); - + void shouldAvoidAdditionalInitializationCallIfProviderHasBeenInitializedAlready() throws Exception { + FeatureProvider provider = createMockedReadyProvider(); setFeatureProvider(provider); - - verify(provider).initialize(); + + verify(provider, never()).initialize(any()); } } @@ -141,90 +100,45 @@ class NamedProvider { @Test @DisplayName("should reject null as named provider") void shouldRejectNullAsNamedProvider() { - assertThatCode(() -> providerRepository.setProvider(CLIENT_NAME, null)).isInstanceOf(IllegalArgumentException.class); + assertThatCode(() -> providerRepository.setProvider(CLIENT_NAME, null, mockAfterSet(), mockAfterInit(), + mockAfterShutdown(), mockAfterError())) + .isInstanceOf(IllegalArgumentException.class); } @Test @DisplayName("should reject null as client name") void shouldRejectNullAsDefaultProvider() { NoOpProvider provider = new NoOpProvider(); - assertThatCode(() -> providerRepository.setProvider(null, provider)).isInstanceOf(IllegalArgumentException.class); + assertThatCode(() -> providerRepository.setProvider(null, provider, mockAfterSet(), mockAfterInit(), + mockAfterShutdown(), mockAfterError())) + .isInstanceOf(IllegalArgumentException.class); } @Test @DisplayName("should immediately return when calling the named client provider mutator") - void shouldImmediatelyReturnWhenCallingTheNamedClientProviderMutator() { + void shouldImmediatelyReturnWhenCallingTheNamedClientProviderMutator() throws Exception { FeatureProvider featureProvider = createMockedProvider(); - doDelayResponse(Duration.ofSeconds(10)).when(featureProvider).initialize(); + doDelayResponse(Duration.ofSeconds(10)).when(featureProvider).initialize(any()); await() .alias("wait for provider mutator to return") .pollDelay(Duration.ofMillis(1)) .atMost(Duration.ofSeconds(1)) .until(() -> { - providerRepository.setProvider("named client", featureProvider); - verify(featureProvider, timeout(1000)).initialize(); + providerRepository.setProvider("named client", featureProvider, mockAfterSet(), + mockAfterInit(), mockAfterShutdown(), mockAfterError()); + verify(featureProvider, timeout(TIMEOUT)).initialize(any()); return true; }); } - @Test - @DisplayName("should not return set provider if it's initialization has not yet been finished executing") - void shouldNotReturnSetProviderIfItsInitializeMethodHasNotYetBeenFinishedExecuting() { - CountDownLatch latch = new CountDownLatch(1); - FeatureProvider newProvider = createMockedProvider(); - doBlock(latch).when(newProvider).initialize(); - FeatureProvider oldProvider = createMockedProvider(); - setFeatureProvider(CLIENT_NAME, oldProvider); - - providerRepository.setProvider(CLIENT_NAME, newProvider); - FeatureProvider providerWhileInitialization = getNamedProvider(); - latch.countDown(); - - assertThat(providerWhileInitialization).isEqualTo(oldProvider); - await() - .pollDelay(Duration.ofMillis(1)) - .atMost(Duration.ofSeconds(1)) - .untilAsserted(() -> assertThat(getNamedProvider()).isEqualTo(newProvider)); - verify(newProvider, timeout(100)).initialize(); - } - - @SneakyThrows - @Test - @DisplayName("should discard provider still initializing if a newer has finished before") - void shouldDiscardProviderStillInitializingIfANewerHasFinishedBefore() { - String clientName = "clientName"; - CountDownLatch latch = new CountDownLatch(1); - CountDownLatch testBlockingLatch = new CountDownLatch(1); - FeatureProvider blockedProvider = createBlockedProvider(latch, testBlockingLatch::countDown); - FeatureProvider unblockingProvider = createUnblockingProvider(latch); - - providerRepository.setProvider(clientName, blockedProvider); - providerRepository.setProvider(clientName, unblockingProvider); - - assertThat(testBlockingLatch.await(2, SECONDS)) - .as("blocking provider initialization not completed within 2 seconds") - .isTrue(); - - await() - .pollDelay(Duration.ofMillis(1)) - .atMost(Duration.ofSeconds(1)) - .untilAsserted(() -> assertThat(providerRepository.getProvider(clientName)) - .isEqualTo(unblockingProvider)); - - verify(blockedProvider, timeout(100)).initialize(); - verify(unblockingProvider, timeout(100)).initialize(); - } - @Test @DisplayName("should avoid additional initialization call if provider has been initialized already") - void shouldAvoidAdditionalInitializationCallIfProviderHasBeenInitializedAlready() { - FeatureProvider provider = createMockedProvider(); - setFeatureProvider(provider); - + void shouldAvoidAdditionalInitializationCallIfProviderHasBeenInitializedAlready() throws Exception { + FeatureProvider provider = createMockedReadyProvider(); setFeatureProvider(CLIENT_NAME, provider); - verify(provider).initialize(); + verify(provider, never()).initialize(any()); } } } @@ -237,43 +151,22 @@ class DefaultProvider { @Test @DisplayName("should immediately return when calling the provider mutator") - void shouldImmediatelyReturnWhenCallingTheProviderMutator() { + void shouldImmediatelyReturnWhenCallingTheProviderMutator() throws Exception { FeatureProvider newProvider = createMockedProvider(); - doDelayResponse(Duration.ofSeconds(10)).when(newProvider).initialize(); + doDelayResponse(Duration.ofSeconds(10)).when(newProvider).initialize(any()); await() .alias("wait for provider mutator to return") .pollDelay(Duration.ofMillis(1)) .atMost(Duration.ofSeconds(1)) .until(() -> { - providerRepository.setProvider(newProvider); - verify(newProvider, timeout(100)).initialize(); + providerRepository.setProvider(newProvider, mockAfterSet(), mockAfterInit(), + mockAfterShutdown(), mockAfterError()); + verify(newProvider, timeout(TIMEOUT)).initialize(any()); return true; }); - verify(newProvider).initialize(); - } - - @Test - @DisplayName("should use old provider if replacing one has not yet been finished initializing") - void shouldUseOldProviderIfReplacingOneHasNotYetBeenFinishedInitializing() { - CountDownLatch latch = new CountDownLatch(1); - FeatureProvider newProvider = createMockedProvider(); - doBlock(latch).when(newProvider).initialize(); - FeatureProvider oldProvider = createMockedProvider(); - - setFeatureProvider(oldProvider); - providerRepository.setProvider(newProvider); - - providerRepository.getProvider().getBooleanEvaluation("some key", true, null); - latch.countDown(); - - await() - .atMost(Duration.ofSeconds(1)) - .pollDelay(Duration.ofMillis(1)) - .untilAsserted(() -> assertThat(getProvider()).isEqualTo(newProvider)); - verify(oldProvider, timeout(100)).getBooleanEvaluation(any(), any(), any()); - verify(newProvider, never()).getBooleanEvaluation(any(), any(), any()); + verify(newProvider, timeout(TIMEOUT)).initialize(any()); } @Test @@ -295,12 +188,13 @@ class NamedProvider { @Test @DisplayName("should immediately return when calling the provider mutator") - void shouldImmediatelyReturnWhenCallingTheProviderMutator() { + void shouldImmediatelyReturnWhenCallingTheProviderMutator() throws Exception { FeatureProvider newProvider = createMockedProvider(); - doDelayResponse(Duration.ofSeconds(10)).when(newProvider).initialize(); + doDelayResponse(Duration.ofSeconds(10)).when(newProvider).initialize(any()); Future providerMutation = executorService - .submit(() -> providerRepository.setProvider(CLIENT_NAME, newProvider)); + .submit(() -> providerRepository.setProvider(CLIENT_NAME, newProvider, mockAfterSet(), + mockAfterInit(), mockAfterShutdown(), mockAfterError())); await() .alias("wait for provider mutator to return") @@ -309,34 +203,13 @@ void shouldImmediatelyReturnWhenCallingTheProviderMutator() { .until(providerMutation::isDone); } - @Test - @DisplayName("should use old provider if replacement one has not yet been finished initializing") - void shouldUseOldProviderIfReplacementHasNotYetBeenFinishedInitializing() { - CountDownLatch latch = new CountDownLatch(1); - FeatureProvider newProvider = createMockedProvider(); - doBlock(latch).when(newProvider).initialize(); - FeatureProvider oldProvider = createMockedProvider(); - - setFeatureProvider(CLIENT_NAME, oldProvider); - providerRepository.setProvider(CLIENT_NAME, newProvider); - - providerRepository.getProvider(CLIENT_NAME).getBooleanEvaluation(FEATURE_KEY, true, null); - latch.countDown(); - - await() - .pollDelay(Duration.ofMillis(1)) - .atMost(Duration.ofSeconds(1)) - .untilAsserted(() -> assertThat(getNamedProvider()).isEqualTo(newProvider)); - verify(oldProvider, timeout(100)).getBooleanEvaluation(eq(FEATURE_KEY), any(), any()); - verify(newProvider, never()).getBooleanEvaluation(any(), any(), any()); - } - @Test @DisplayName("should not call shutdown if replaced provider is bound to multiple names") - void shouldNotCallShutdownIfReplacedProviderIsBoundToMultipleNames() { + void shouldNotCallShutdownIfReplacedProviderIsBoundToMultipleNames() throws InterruptedException { FeatureProvider oldProvider = createMockedProvider(); FeatureProvider newProvider = createMockedProvider(); setFeatureProvider(CLIENT_NAME, oldProvider); + setFeatureProvider(ANOTHER_CLIENT_NAME, oldProvider); setFeatureProvider(CLIENT_NAME, newProvider); @@ -366,7 +239,48 @@ void shouldNotThrowExceptionIfProviderThrowsOneOnShutdown() { assertThatCode(() -> setFeatureProvider(new NoOpProvider())).doesNotThrowAnyException(); - verify(provider).shutdown(); + verify(provider, timeout(TIMEOUT)).shutdown(); + } + } + + @Nested + class LifecyleLambdas { + @Test + @DisplayName("should run afterSet, afterInit, afterShutdown on successful set/init") + @SuppressWarnings("unchecked") + void shouldRunLambdasOnSuccessful() { + Consumer afterSet = mock(Consumer.class); + Consumer afterInit = mock(Consumer.class); + Consumer afterShutdown = mock(Consumer.class); + BiConsumer afterError = mock(BiConsumer.class); + + FeatureProvider oldProvider = providerRepository.getProvider(); + FeatureProvider featureProvider1 = createMockedProvider(); + FeatureProvider featureProvider2 = createMockedProvider(); + + setFeatureProvider(featureProvider1, afterSet, afterInit, afterShutdown, afterError); + setFeatureProvider(featureProvider2); + verify(afterSet, timeout(TIMEOUT)).accept(featureProvider1); + verify(afterInit, timeout(TIMEOUT)).accept(featureProvider1); + verify(afterShutdown, timeout(TIMEOUT)).accept(oldProvider); + verify(afterError, never()).accept(any(), any()); + } + + @Test + @DisplayName("should run afterSet, afterError on unsuccessful set/init") + @SuppressWarnings("unchecked") + void shouldRunLambdasOnError() throws Exception { + Consumer afterSet = mock(Consumer.class); + Consumer afterInit = mock(Consumer.class); + Consumer afterShutdown = mock(Consumer.class); + BiConsumer afterError = mock(BiConsumer.class); + + FeatureProvider errorFeatureProvider = createMockedErrorProvider(); + + setFeatureProvider(errorFeatureProvider, afterSet, afterInit, afterShutdown, afterError); + verify(afterSet, timeout(TIMEOUT)).accept(errorFeatureProvider); + verify(afterInit, never()).accept(any());; + verify(afterError, timeout(TIMEOUT)).accept(eq(errorFeatureProvider), any()); } } } @@ -385,31 +299,34 @@ void shouldShutdownAllFeatureProvidersOnShutdown() { await() .pollDelay(Duration.ofMillis(1)) - .atMost(Duration.ofSeconds(1)) + .atMost(Duration.ofSeconds(TIMEOUT)) .untilAsserted(() -> { assertThat(providerRepository.getProvider()).isInstanceOf(NoOpProvider.class); assertThat(providerRepository.getProvider(CLIENT_NAME)).isInstanceOf(NoOpProvider.class); assertThat(providerRepository.getProvider(ANOTHER_CLIENT_NAME)).isInstanceOf(NoOpProvider.class); }); - verify(featureProvider1).shutdown(); - verify(featureProvider2).shutdown(); + verify(featureProvider1, timeout(TIMEOUT)).shutdown(); + verify(featureProvider2, timeout(TIMEOUT)).shutdown(); } - private FeatureProvider getProvider() { - return providerRepository.getProvider(); + private void setFeatureProvider(FeatureProvider provider) { + providerRepository.setProvider(provider, mockAfterSet(), mockAfterInit(), mockAfterShutdown(), + mockAfterError()); + waitForSettingProviderHasBeenCompleted(ProviderRepository::getProvider, provider); } - private FeatureProvider getNamedProvider() { - return providerRepository.getProvider(CLIENT_NAME); - } - private void setFeatureProvider(FeatureProvider provider) { - providerRepository.setProvider(provider); + private void setFeatureProvider(FeatureProvider provider, Consumer afterSet, + Consumer afterInit, Consumer afterShutdown, + BiConsumer afterError) { + providerRepository.setProvider(provider, afterSet, afterInit, afterShutdown, + afterError); waitForSettingProviderHasBeenCompleted(ProviderRepository::getProvider, provider); } private void setFeatureProvider(String namedProvider, FeatureProvider provider) { - providerRepository.setProvider(namedProvider, provider); + providerRepository.setProvider(namedProvider, provider, mockAfterSet(), mockAfterInit(), mockAfterShutdown(), + mockAfterError()); waitForSettingProviderHasBeenCompleted(repository -> repository.getProvider(namedProvider), provider); } @@ -418,8 +335,30 @@ private void waitForSettingProviderHasBeenCompleted( FeatureProvider provider) { await() .pollDelay(Duration.ofMillis(1)) - .atMost(Duration.ofSeconds(1)) - .until(() -> extractor.apply(providerRepository) == provider); + .atMost(Duration.ofSeconds(5)) + .until(() -> { + return extractor.apply(providerRepository) == provider; + }); + } + + private Consumer mockAfterSet() { + return fp -> { + }; + } + + private Consumer mockAfterInit() { + return fp -> { + }; + } + + private Consumer mockAfterShutdown() { + return fp -> { + }; + } + + private BiConsumer mockAfterError() { + return (fp, message) -> { + }; } } diff --git a/src/test/java/dev/openfeature/sdk/ProviderSpecTest.java b/src/test/java/dev/openfeature/sdk/ProviderSpecTest.java index 31a6a5e8d..f5e5e6a42 100644 --- a/src/test/java/dev/openfeature/sdk/ProviderSpecTest.java +++ b/src/test/java/dev/openfeature/sdk/ProviderSpecTest.java @@ -18,7 +18,7 @@ void name_accessor() { @Specification(number = "2.2.2.1", text = "The feature provider interface MUST define methods for typed " + "flag resolution, including boolean, numeric, string, and structure.") @Specification(number = "2.2.3", text = "In cases of normal execution, the `provider` MUST populate the `resolution details` structure's `value` field with the resolved flag value.") - @Specification(number = "2.2.1", text = "The `feature provider` interface MUST define methods to resolve flag values, with parameters `flag key` (string, required), `default value` (boolean | number | string | structure, required) + and `evaluation context` (optional), which returns a `resolution details` structure.") + @Specification(number = "2.2.1", text = "The `feature provider` interface MUST define methods to resolve flag values, with parameters `flag key` (string, required), `default value` (boolean | number | string | structure, required) and `evaluation context` (optional), which returns a `resolution details` structure.") @Specification(number = "2.2.8.1", text = "The `resolution details` structure SHOULD accept a generic argument (or use an equivalent language feature) which indicates the type of the wrapped `value` field.") @Test void flag_value_set() { diff --git a/src/test/java/dev/openfeature/sdk/ShutdownBehaviorSpecTest.java b/src/test/java/dev/openfeature/sdk/ShutdownBehaviorSpecTest.java index d191c8c42..e470819f7 100644 --- a/src/test/java/dev/openfeature/sdk/ShutdownBehaviorSpecTest.java +++ b/src/test/java/dev/openfeature/sdk/ShutdownBehaviorSpecTest.java @@ -89,7 +89,7 @@ void shouldCatchExceptionThrownByTheNamedClientProviderOnShutdown() { @Nested class General { - @Specification(number = "1.6.1", text = "The API MUST define a shutdown function which, when called, must call the respective shutdown function on the active provider.") + @Specification(number = "1.6.1", text = "The API MUST define a mechanism to propagate a shutdown request to active providers.") @Test @DisplayName("must shutdown all providers on shutting down api") void mustShutdownAllProvidersOnShuttingDownApi() { @@ -110,7 +110,7 @@ void mustShutdownAllProvidersOnShuttingDownApi() { verify(namedProvider).shutdown(); }); - api.resetProviderRepository(); + api.reset(); } } } diff --git a/src/test/java/dev/openfeature/sdk/fixtures/ProviderFixture.java b/src/test/java/dev/openfeature/sdk/fixtures/ProviderFixture.java index f0b786422..c00b8ff27 100644 --- a/src/test/java/dev/openfeature/sdk/fixtures/ProviderFixture.java +++ b/src/test/java/dev/openfeature/sdk/fixtures/ProviderFixture.java @@ -1,24 +1,47 @@ package dev.openfeature.sdk.fixtures; -import dev.openfeature.sdk.FeatureProvider; -import lombok.experimental.UtilityClass; -import org.mockito.stubbing.Answer; +import static dev.openfeature.sdk.testutils.stubbing.ConditionStubber.doBlock; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import java.io.FileNotFoundException; import java.util.concurrent.CountDownLatch; -import static dev.openfeature.sdk.testutils.stubbing.ConditionStubber.doBlock; -import static org.mockito.Mockito.*; +import org.mockito.stubbing.Answer; + +import dev.openfeature.sdk.FeatureProvider; +import dev.openfeature.sdk.ImmutableContext; +import dev.openfeature.sdk.ProviderState; +import lombok.experimental.UtilityClass; @UtilityClass public class ProviderFixture { public static FeatureProvider createMockedProvider() { - return mock(FeatureProvider.class); + FeatureProvider provider = mock(FeatureProvider.class); + doReturn(ProviderState.NOT_READY).when(provider).getState(); + return provider; + } + + public static FeatureProvider createMockedReadyProvider() { + FeatureProvider provider = mock(FeatureProvider.class); + doReturn(ProviderState.READY).when(provider).getState(); + return provider; + } + + public static FeatureProvider createMockedErrorProvider() throws Exception { + FeatureProvider provider = mock(FeatureProvider.class); + doReturn(ProviderState.NOT_READY).when(provider).getState(); + doThrow(FileNotFoundException.class).when(provider).initialize(any()); + return provider; } - public static FeatureProvider createBlockedProvider(CountDownLatch latch, Runnable onAnswer) { + public static FeatureProvider createBlockedProvider(CountDownLatch latch, Runnable onAnswer) throws Exception { FeatureProvider provider = createMockedProvider(); - doBlock(latch, createAnswerExecutingCode(onAnswer)).when(provider).initialize(); + doBlock(latch, createAnswerExecutingCode(onAnswer)).when(provider).initialize(new ImmutableContext()); doReturn("blockedProvider").when(provider).toString(); return provider; } @@ -30,12 +53,12 @@ private static Answer createAnswerExecutingCode(Runnable onAnswer) { }; } - public static FeatureProvider createUnblockingProvider(CountDownLatch latch) { + public static FeatureProvider createUnblockingProvider(CountDownLatch latch) throws Exception { FeatureProvider provider = createMockedProvider(); doAnswer(invocation -> { latch.countDown(); return null; - }).when(provider).initialize(); + }).when(provider).initialize(new ImmutableContext()); doReturn("unblockingProvider").when(provider).toString(); return provider; } diff --git a/src/test/java/dev/openfeature/sdk/internal/TriConsumerTest.java b/src/test/java/dev/openfeature/sdk/internal/TriConsumerTest.java new file mode 100644 index 000000000..0c85a7cc5 --- /dev/null +++ b/src/test/java/dev/openfeature/sdk/internal/TriConsumerTest.java @@ -0,0 +1,34 @@ +package dev.openfeature.sdk.internal; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.util.concurrent.atomic.AtomicInteger; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +class TriConsumerTest { + + @Test + @DisplayName("should run accept") + void shouldRunAccept() { + AtomicInteger result = new AtomicInteger(0); + TriConsumer triConsumer = (num1, num2, num3) -> { + result.set(result.get() + num1 + num2 + num3); + }; + triConsumer.accept(1, 2, 3); + assertEquals(6, result.get()); + } + + @Test + @DisplayName("should run after accept") + void shouldRunAfterAccept() { + AtomicInteger result = new AtomicInteger(0); + TriConsumer triConsumer = (num1, num2, num3) -> { + result.set(result.get() + num1 + num2 + num3); + }; + TriConsumer composed = triConsumer.andThen(triConsumer); + composed.accept(1, 2, 3); + assertEquals(12, result.get()); + } +} \ No newline at end of file diff --git a/src/test/java/dev/openfeature/sdk/testutils/TestEventsProvider.java b/src/test/java/dev/openfeature/sdk/testutils/TestEventsProvider.java new file mode 100644 index 000000000..3fcb58886 --- /dev/null +++ b/src/test/java/dev/openfeature/sdk/testutils/TestEventsProvider.java @@ -0,0 +1,99 @@ +package dev.openfeature.sdk.testutils; + +import dev.openfeature.sdk.EvaluationContext; +import dev.openfeature.sdk.EventProvider; +import dev.openfeature.sdk.Metadata; +import dev.openfeature.sdk.ProviderEvaluation; +import dev.openfeature.sdk.ProviderEvent; +import dev.openfeature.sdk.ProviderEventDetails; +import dev.openfeature.sdk.ProviderState; +import dev.openfeature.sdk.Value; + +public class TestEventsProvider extends EventProvider { + + private boolean initError = false; + private String initErrorMessage; + private ProviderState state = ProviderState.NOT_READY; + private boolean shutDown = false; + private int initTimeout = 0; + + @Override + public ProviderState getState() { + return this.state; + } + + public TestEventsProvider(int initTimeout) { + this.initTimeout = initTimeout; + } + + public TestEventsProvider(int initTimeout, boolean initError, String initErrorMessage) { + this.initTimeout = initTimeout; + this.initError = initError; + this.initErrorMessage = initErrorMessage; + } + + public TestEventsProvider(ProviderState initialState) { + this.state = initialState; + } + + public void mockEvent(ProviderEvent event, ProviderEventDetails details) { + emit(event, details); + } + + public boolean isShutDown() { + return this.shutDown; + } + + @Override + public void shutdown() { + this.shutDown = true; + } + + @Override + public void initialize(EvaluationContext evaluationContext) throws Exception { + if (ProviderState.NOT_READY.equals(state)) { + // wait half the TIMEOUT, otherwise some init/errors can be fired before we add handlers + Thread.sleep(initTimeout); + if (this.initError) { + this.state = ProviderState.ERROR; + throw new Exception(initErrorMessage); + } + this.state = ProviderState.READY; + } + } + + @Override + public Metadata getMetadata() { + throw new UnsupportedOperationException("Unimplemented method 'getMetadata'"); + } + + @Override + public ProviderEvaluation getBooleanEvaluation(String key, Boolean defaultValue, + EvaluationContext ctx) { + throw new UnsupportedOperationException("Unimplemented method 'getBooleanEvaluation'"); + } + + @Override + public ProviderEvaluation getStringEvaluation(String key, String defaultValue, + EvaluationContext ctx) { + throw new UnsupportedOperationException("Unimplemented method 'getStringEvaluation'"); + } + + @Override + public ProviderEvaluation getIntegerEvaluation(String key, Integer defaultValue, + EvaluationContext ctx) { + throw new UnsupportedOperationException("Unimplemented method 'getIntegerEvaluation'"); + } + + @Override + public ProviderEvaluation getDoubleEvaluation(String key, Double defaultValue, + EvaluationContext ctx) { + throw new UnsupportedOperationException("Unimplemented method 'getDoubleEvaluation'"); + } + + @Override + public ProviderEvaluation getObjectEvaluation(String key, Value defaultValue, + EvaluationContext ctx) { + throw new UnsupportedOperationException("Unimplemented method 'getObjectEvaluation'"); + } +}; \ No newline at end of file