feat: support isolated API instances

Signed-off-by: marcozabel <marco.zabel@dynatrace.com>

Author: marcozabel

src/main/java/dev/openfeature/sdk/EventProvider.java

@@ -1,5 +1,6 @@
 package dev.openfeature.sdk;
 
+import dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock;
 import dev.openfeature.sdk.internal.ConfigurableThreadFactory;
 import dev.openfeature.sdk.internal.TriConsumer;
 import java.util.concurrent.ExecutorService;
@@ -30,20 +31,24 @@ void setEventProviderListener(EventProviderListener eventProviderListener) {
     }
 
     private TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit = null;
+    private AutoCloseableReentrantReadWriteLock lock = 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.
+     * @param lock   the API instance's read/write lock for thread safety.
      * @throws IllegalStateException if attempted to bind a new emitter for already bound provider
      */
-    void attach(TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit) {
+    void attach(TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit,
+                AutoCloseableReentrantReadWriteLock lock) {
         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;
+            this.lock = lock;
         }
     }
 
@@ -52,6 +57,7 @@ void attach(TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEm
      */
     void detach() {
         this.onEmit = null;
+        this.lock = null;
     }
 
     /**
@@ -81,6 +87,7 @@ public void shutdown() {
     public Awaitable emit(final ProviderEvent event, final ProviderEventDetails details) {
         final var localEventProviderListener = this.eventProviderListener;
         final var localOnEmit = this.onEmit;
+        final var localLock = this.lock;
 
         if (localEventProviderListener == null && localOnEmit == null) {
             return Awaitable.FINISHED;
@@ -91,7 +98,7 @@ public Awaitable emit(final ProviderEvent event, final ProviderEventDetails deta
         // These calls need to be executed on a different thread to prevent deadlocks when the provider initialization
         // relies on a ready event to be emitted
         emitterExecutor.submit(() -> {
-            try (var ignored = OpenFeatureAPI.lock.readLockAutoCloseable()) {
+            try (var ignored = localLock != null ? localLock.readLockAutoCloseable() : null) {
                 if (localEventProviderListener != null) {
                     localEventProviderListener.onEmit(event, details);
                 }

src/main/java/dev/openfeature/sdk/OpenFeatureAPI.java

@@ -22,8 +22,8 @@
 @Slf4j
 @SuppressWarnings("PMD.UnusedLocalVariable")
 public class OpenFeatureAPI implements EventBus<OpenFeatureAPI> {
-    // package-private multi-read/single-write lock
-    static AutoCloseableReentrantReadWriteLock lock = new AutoCloseableReentrantReadWriteLock();
+    // package-private multi-read/single-write lock (instance-level for isolation)
+    AutoCloseableReentrantReadWriteLock lock = new AutoCloseableReentrantReadWriteLock();
     private final ConcurrentLinkedQueue<Hook> apiHooks;
     private ProviderRepository providerRepository;
     private EventSupport eventSupport;
@@ -50,6 +50,24 @@ public static OpenFeatureAPI getInstance() {
         return SingletonHolder.INSTANCE;
     }
 
+    /**
+     * Creates a new, independent {@link OpenFeatureAPI} instance with fully
+     * isolated state.
+     *
+     * <p>Each instance maintains its own providers, evaluation context, hooks,
+     * event handlers, and transaction context propagators. Instances do not
+     * share state with the global singleton or with each other.
+     *
+     * <p>For better discoverability, prefer using
+     * {@link dev.openfeature.sdk.isolated.OpenFeatureAPIFactory#createAPI()}.
+     *
+     * @return a new API instance
+     * @see dev.openfeature.sdk.isolated.OpenFeatureAPIFactory#createAPI()
+     */
+    public static OpenFeatureAPI createIsolated() {
+        return new OpenFeatureAPI();
+    }
+
     /**
      * Get metadata about the default provider.
      *
@@ -251,7 +269,7 @@ public void setProviderAndWait(String domain, FeatureProvider provider) throws O
 
     private void attachEventProvider(FeatureProvider provider) {
         if (provider instanceof EventProvider) {
-            ((EventProvider) provider).attach(this::runHandlersForProvider);
+            ((EventProvider) provider).attach(this::runHandlersForProvider, this.lock);
         }
     }
 

src/main/java/dev/openfeature/sdk/isolated/OpenFeatureAPIFactory.java

@@ -0,0 +1,48 @@
+package dev.openfeature.sdk.isolated;
+
+import dev.openfeature.sdk.OpenFeatureAPI;
+
+/**
+ * Factory for creating isolated OpenFeature API instances.
+ *
+ * <p>Each instance returned by {@link #createAPI()} maintains its own state,
+ * including providers, evaluation context, hooks, event handlers, and
+ * transaction context propagators. Instances do not share state with the
+ * global singleton ({@link OpenFeatureAPI#getInstance()}) or with each other.
+ *
+ * <p>This is useful for dependency injection frameworks, testing scenarios,
+ * and applications composed of multiple submodules requiring distinct providers.
+ *
+ * <p><strong>Spec references:</strong>
+ * <ul>
+ *   <li>Requirement 1.8.1 &mdash; factory function for isolated instances</li>
+ *   <li>Requirement 1.8.3 &mdash; distinct package for discoverability</li>
+ * </ul>
+ *
+ * @see <a href="https://openfeature.dev/specification/sections/flag-evaluation#18-isolated-api-instances">
+ *     Spec &sect;1.8 &mdash; Isolated API Instances</a>
+ */
+public final class OpenFeatureAPIFactory {
+
+    private OpenFeatureAPIFactory() {
+        // utility class
+    }
+
+    /**
+     * Creates a new, independent {@link OpenFeatureAPI} instance with fully
+     * isolated state.
+     *
+     * <p>Usage:
+     * <pre>{@code
+     * OpenFeatureAPI api = OpenFeatureAPIFactory.createAPI();
+     * api.setProvider(new MyProvider());
+     * Client client = api.getClient();
+     * }</pre>
+     *
+     * @return a new API instance
+     * @see OpenFeatureAPI#createIsolated()
+     */
+    public static OpenFeatureAPI createAPI() {
+        return OpenFeatureAPI.createIsolated();
+    }
+}

src/test/java/dev/openfeature/sdk/EventProviderTest.java

@@ -4,6 +4,7 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.*;
 
+import dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock;
 import dev.openfeature.sdk.internal.TriConsumer;
 import dev.openfeature.sdk.testutils.TestStackedEmitCallsProvider;
 import io.cucumber.java.AfterAll;
@@ -36,7 +37,7 @@ public static void resetDefaultProvider() {
     @DisplayName("should run attached onEmit with emitters")
     void emitsEventsWhenAttached() {
         TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit = mockOnEmit();
-        eventProvider.attach(onEmit);
+        eventProvider.attach(onEmit, new AutoCloseableReentrantReadWriteLock());
 
         ProviderEventDetails details = ProviderEventDetails.builder().build();
         eventProvider.emit(ProviderEvent.PROVIDER_READY, details);
@@ -73,17 +74,18 @@ void doesNotEmitsEventsWhenNotAttached() {
     void throwsWhenOnEmitDifferent() {
         TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit1 = mockOnEmit();
         TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit2 = mockOnEmit();
-        eventProvider.attach(onEmit1);
-        assertThrows(IllegalStateException.class, () -> eventProvider.attach(onEmit2));
+        eventProvider.attach(onEmit1, new AutoCloseableReentrantReadWriteLock());
+        assertThrows(IllegalStateException.class,
+                () -> eventProvider.attach(onEmit2, new AutoCloseableReentrantReadWriteLock()));
     }
 
     @Test
     @DisplayName("should not throw if second same onEmit attached")
     void doesNotThrowWhenOnEmitSame() {
         TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit1 = mockOnEmit();
         TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit2 = onEmit1;
-        eventProvider.attach(onEmit1);
-        eventProvider.attach(onEmit2); // should not throw, same instance. noop
+        eventProvider.attach(onEmit1, new AutoCloseableReentrantReadWriteLock());
+        eventProvider.attach(onEmit2, new AutoCloseableReentrantReadWriteLock()); // should not throw, same instance. noop
     }
 
     @Test
@@ -132,8 +134,9 @@ public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultVa
         }
 
         @Override
-        public void attach(TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit) {
-            super.attach(onEmit);
+        public void attach(TriConsumer<EventProvider, ProviderEvent, ProviderEventDetails> onEmit,
+                           AutoCloseableReentrantReadWriteLock lock) {
+            super.attach(onEmit, lock);
         }
     }
 

src/test/java/dev/openfeature/sdk/LockingSingeltonTest.java

@@ -33,7 +33,7 @@ void beforeEach() {
         client = (OpenFeatureClient) api.getClient("LockingTest");
 
         apiLock = setupLock(apiLock, mockInnerReadLock(), mockInnerWriteLock());
-        OpenFeatureAPI.lock = apiLock;
+        api.lock = apiLock;
 
         clientHooksLock = setupLock(clientHooksLock, mockInnerReadLock(), mockInnerWriteLock());
     }