fix: http mock redefinitions always working (#122)

Circular map for registry is now properly handled by removing and adding back redefinitions of existing mocks to keep clientId in registry

Author: brian-mulier

mockfaster/src/main/java/com/decathlon/tzatziki/utils/MockFaster.java

@@ -15,6 +15,7 @@
 import org.apache.commons.lang3.tuple.Pair;
 import org.jetbrains.annotations.NotNull;
 import org.junit.Assert;
+import org.mockserver.closurecallback.websocketregistry.LocalCallbackRegistry;
 import org.mockserver.collections.CircularPriorityQueue;
 import org.mockserver.integration.ClientAndServer;
 import org.mockserver.matchers.*;
@@ -37,7 +38,6 @@
 import java.util.regex.Pattern;
 
 import static com.decathlon.tzatziki.utils.Fields.getValue;
-import static com.decathlon.tzatziki.utils.Mapper.toYaml;
 import static com.decathlon.tzatziki.utils.Unchecked.unchecked;
 import static java.util.function.Function.identity;
 import static java.util.stream.Collectors.*;
@@ -78,29 +78,6 @@ protected HttpState initialize() throws ConcurrentException {
     public static synchronized void add_mock(HttpRequest httpRequest, ExpectationResponseCallback callback, Comparison comparison) {
         HttpState httpState = unchecked(HTTP_STATE::get);
         CircularPriorityQueue<String, HttpRequestMatcher, SortableExpectationId> expectationsQueue = Fields.getValue(httpState.getRequestMatchers(), "httpRequestMatchers");
-        httpState.getRequestMatchers().retrieveActiveExpectations(httpRequest)
-                // we are redefining an old mock with a matches, let's see if we have old callbacks still in 404
-                .stream()
-                .filter(expectation -> {
-                    Pair<Expectation[], UpdatableExpectationResponseCallback> updatableExpectationResponseCallbackPair = MOCKS.get(expectation.getHttpRequest().toString());
-                    if (updatableExpectationResponseCallbackPair == null) {
-                        log.error("""
-                                couldn't find the httpRequest in the mocks, this shouldn't happen!
-                                                        
-                                httpRequest: {}
-                                                        
-                                MOCKS keys: {}
-                                """, toYaml(httpRequest.toString()), toYaml(MOCKS.keySet()));
-                        return false;
-                    }
-                    return updatableExpectationResponseCallbackPair.getValue().callback.equals(NOT_FOUND);
-                })
-                .forEach(expectation -> {
-                    expectationsQueue.remove(expectationsQueue.getByKey(expectation.getId()).orElseThrow(() ->
-                            new IllegalStateException("couldn't find the old expectation in the queue for removal")));
-                    MOCKS.remove(expectation.getHttpRequest().toString());
-                    log.debug("removing expectation {}", expectation.getHttpRequest());
-                });
 
         AtomicBoolean isNew = new AtomicBoolean(false);
         latestPriority++;
@@ -127,7 +104,14 @@ public static synchronized void add_mock(HttpRequest httpRequest, ExpectationRes
                     // update the priority of the expectation
                     .map(expectation -> expectation.withPriority(latestPriority))
                     // re-add the expectations, this will resort the CircularPriorityQueue
-                    .forEach(expectation -> httpState.getRequestMatchers().add(expectation, MockServerMatcherNotifier.Cause.API));
+                    .forEach(expectation -> {
+                        httpState.getRequestMatchers().add(expectation, MockServerMatcherNotifier.Cause.API);
+
+                        String clientId = expectation.getHttpResponseObjectCallback().getClientId();
+                        Map<String, ExpectationResponseCallback> responseCallbackRegistry = LocalCallbackRegistry.responseCallbackRegistry();
+                        responseCallbackRegistry.remove(clientId);
+                        responseCallbackRegistry.put(clientId, expectationWithCallback.getValue());
+                    });
         }
 
         if (httpRequest.getPath() instanceof NottableSchemaString uriSchema) {

tzatziki-http/src/test/java/com/decathlon/tzatziki/steps/LimitWebsocketsSteps.java

@@ -0,0 +1,12 @@
+package com.decathlon.tzatziki.steps;
+
+import io.cucumber.java.Before;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+public class LimitWebsocketsSteps {
+    @Before(order = -2)
+    public void before() {
+        System.setProperty("mockserver.maxWebSocketExpectations", "200");
+    }
+}

tzatziki-http/src/test/java/com/decathlon/tzatziki/steps/LocalSteps.java

@@ -1,14 +1,35 @@
 package com.decathlon.tzatziki.steps;
 
+import com.decathlon.tzatziki.utils.Comparison;
+import com.decathlon.tzatziki.utils.Guard;
 import com.decathlon.tzatziki.utils.Interaction;
 import io.cucumber.java.Before;
+import io.cucumber.java.en.Given;
+import lombok.RequiredArgsConstructor;
 
+import java.util.stream.IntStream;
+
+@RequiredArgsConstructor
 public class LocalSteps {
+    private final HttpSteps httpSteps;
 
     static {
         Interaction.printResponses = true;
     }
 
     @Before
     public void before() {}
+
+    @Given("^we add (\\d+)-(\\d+) mocks for id endpoint$")
+    public void mockIdEndpointAsSeveralMocks(int startId, int endId) {
+        IntStream.range(startId, endId + 1).forEach(idx -> httpSteps.url_is_mocked_as(Guard.always(), "http://backend/" + idx, Comparison.CONTAINS, """
+                request:
+                    method: GET
+                response:
+                    headers:
+                        Content-Type: application/json
+                    body:
+                        payload: Hello %d
+                """.formatted(idx)));
+    }
 }

tzatziki-http/src/test/resources/com/decathlon/tzatziki/steps/http.feature

@@ -1203,4 +1203,16 @@ Feature: to interact with an http service and setup mocks
     """
     <?xml version="1.0" encoding="utf-8"?><ns:user xmlns:ns="http://www.namespace.com">bob</ns:user>
     """
-    Then we received a status OK_200
+    Then we received a status OK_200
+
+  Scenario Template: Exceed max amount of expectation
+    Given we add 1-1 mocks for id endpoint
+    Given we add <mocksRange> mocks for id endpoint
+    Then getting on "http://backend/1" returns:
+    """
+    Hello 1
+    """
+    Examples:
+      | mocksRange |
+      | 2-150      |
+      | 151-250    |