fix: consistent method chainability (#913)

* mutablecontext settargetkey now return(s) this method chainable

Signed-off-by: DBlanchard88 <[email protected]>

* addHooks & setEvaluationContext are now chainable

Signed-off-by: DBlanchard88 <[email protected]>

* OpenFeatureAPI setEvaluationContext new chainable

Signed-off-by: DBlanchard88 <[email protected]>

* Update src/test/java/dev/openfeature/sdk/MutableContextTest.java

Signed-off-by: Todd Baert <[email protected]>

---------

Signed-off-by: DBlanchard88 <[email protected]>
Signed-off-by: Todd Baert <[email protected]>
Co-authored-by: Todd Baert <[email protected]>

Author: DBlanchard88

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

@@ -18,15 +18,15 @@ public interface Client extends Features, EventBus<Client> {
      * Set the client-level evaluation context.
      * @param ctx Client level context.
      */
-    void setEvaluationContext(EvaluationContext ctx);
+    Client setEvaluationContext(EvaluationContext ctx);
 
     /**
      * Adds hooks for evaluation.
      * Hooks are run in the order they're added in the before stage. They are run in reverse order for all other stages.
      *
      * @param hooks The hook to add.
      */
-    void addHooks(Hook... hooks);
+    Client addHooks(Hook... hooks);
 
     /**
      * Fetch the hooks associated to this client.

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

@@ -87,10 +87,11 @@ public MutableContext add(String key, List<Value> value) {
     /**
      * Override or set targeting key for this mutable context. Value should be non-null and non-empty to be accepted.
      */
-    public void setTargetingKey(String targetingKey) {
+    public MutableContext setTargetingKey(String targetingKey) {
         if (targetingKey != null && !targetingKey.trim().isEmpty()) {
             this.add(TARGETING_KEY, targetingKey);
         }
+        return this;
     }
 
 

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

@@ -83,10 +83,11 @@ public Client getClient(@Nullable String name, @Nullable String version) {
     /**
      * {@inheritDoc}
      */
-    public void setEvaluationContext(EvaluationContext evaluationContext) {
+    public OpenFeatureAPI setEvaluationContext(EvaluationContext evaluationContext) {
         try (AutoCloseableLock __ = lock.writeLockAutoCloseable()) {
             this.evaluationContext = evaluationContext;
         }
+        return this;
     }
 
     /**

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

@@ -56,10 +56,11 @@ public OpenFeatureClient(OpenFeatureAPI openFeatureAPI, String name, String vers
      * {@inheritDoc}
      */
     @Override
-    public void addHooks(Hook... hooks) {
+    public OpenFeatureClient addHooks(Hook... hooks) {
         try (AutoCloseableLock __ = this.hooksLock.writeLockAutoCloseable()) {
             this.clientHooks.addAll(Arrays.asList(hooks));
         }
+        return this;
     }
 
     /**
@@ -76,10 +77,11 @@ public List<Hook> getHooks() {
      * {@inheritDoc}
      */
     @Override
-    public void setEvaluationContext(EvaluationContext evaluationContext) {
+    public OpenFeatureClient setEvaluationContext(EvaluationContext evaluationContext) {
         try (AutoCloseableLock __ = contextLock.writeLockAutoCloseable()) {
             this.evaluationContext = evaluationContext;
         }
+        return this;
     }
 
     /**

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

@@ -116,4 +116,19 @@ void mergeShouldRetainItsSubkeysWhenOverridingContextHasNoTargetingKey() {
         Structure value = key1.asStructure();
         assertArrayEquals(new Object[]{"key1_1"}, value.keySet().toArray());
     }
+
+    @DisplayName("Ensure mutations are chainable")
+    @Test
+    void shouldAllowChainingOfMutations() {
+        MutableContext context = new MutableContext();
+        context.add("key1", "val1")
+                .add("key2", 2)
+                .setTargetingKey("TARGETING_KEY")
+                .add("key3", 3.0);
+
+        assertEquals("TARGETING_KEY", context.getTargetingKey());
+        assertEquals("val1", context.getValue("key1").asString());
+        assertEquals(2, context.getValue("key2").asInteger());
+        assertEquals(3.0, context.getValue("key3").asDouble());        
+    }
 }

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

@@ -5,6 +5,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.util.Collections;
+import java.util.HashMap;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -78,4 +79,12 @@ void settingNamedClientProviderToNullErrors() {
     void settingTransactionalContextPropagatorToNullErrors() {
         assertThatCode(() -> api.setTransactionContextPropagator(null)).isInstanceOf(IllegalArgumentException.class);
     }
+
+    @Test
+    void setEvaluationContextShouldAllowChaining() {
+        OpenFeatureClient client = new OpenFeatureClient(api, "name", "version");
+        EvaluationContext ctx = new ImmutableContext("targeting key", new HashMap<>());
+        OpenFeatureClient result = client.setEvaluationContext(ctx);
+        assertEquals(client, result);
+    }
 }

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

@@ -3,12 +3,18 @@
 import java.util.*;
 
 import dev.openfeature.sdk.fixtures.HookFixtures;
+
 import org.junit.jupiter.api.*;
 import org.mockito.Mockito;
 import org.simplify4u.slf4jmock.LoggerMock;
 import org.slf4j.Logger;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.argThat;
+import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.*;
 
 class OpenFeatureClientTest implements HookFixtures {
@@ -67,4 +73,28 @@ void mergeContextTest() {
 
         assertThat(result.getValue()).isTrue();
     }
+
+    @Test
+    @DisplayName("addHooks should allow chaining by returning the same client instance")
+    void addHooksShouldAllowChaining() {
+        OpenFeatureAPI api = mock(OpenFeatureAPI.class);
+        OpenFeatureClient client = new OpenFeatureClient(api, "name", "version");
+        Hook<?> hook1 = Mockito.mock(Hook.class);
+        Hook<?> hook2 = Mockito.mock(Hook.class);
+
+        OpenFeatureClient result = client.addHooks(hook1, hook2);
+        assertEquals(client, result);  
+    }
+
+    @Test
+    @DisplayName("setEvaluationContext should allow chaining by returning the same client instance")
+    void setEvaluationContextShouldAllowChaining() {
+        OpenFeatureAPI api = mock(OpenFeatureAPI.class);
+        OpenFeatureClient client = new OpenFeatureClient(api, "name", "version");
+        EvaluationContext ctx = new ImmutableContext("targeting key", new HashMap<>());
+
+        OpenFeatureClient result = client.setEvaluationContext(ctx);
+        assertEquals(client, result);
+    }
+   
 }