feat: adding array and regex support to deleting a state (#98)

- add `contexts` parameter to `deleteState`
- add `contextsMatching` parameter to `deleteState`
- cleaned up `DeleteStateEventListenerTest`
- fixed display issues in README

<!-- Please describe your pull request here. -->

## References

 #68

<!-- References to relevant GitHub issues and pull requests, esp.
upstream and downstream changes -->

## Submitter checklist

- [ ] Recommended: Join [WireMock Slack](https://slack.wiremock.org/) to
get any help in `#help-contributing` or a project-specific channel like
`#wiremock-java`
- [ ] Recommended: If you participate in Hacktoberfest 2023, make sure
you're [signed up](https://wiremock.org/events/hacktoberfest/) there and
in the WireMock form
- [ ] The PR request is well described and justified, including the body
and the references
- [ ] The PR title represents the desired changelog entry
- [ ] The repository's code style is followed (see the contributing
guide)
- [ ] Test coverage that demonstrates that the change works as expected
- [ ] For new features, there's necessary documentation in this pull
request or in a subsequent PR to
[wiremock.org](https://github.com/wiremock/wiremock.org)

<!--
Put an `x` into the [ ] to show you have filled the information.
The template comes from
https://github.com/wiremock/.github/blob/main/.github/pull_request_template.md
You can override it by creating .github/pull_request_template.md in your
own repository
-->

Author: dirkbolte

README.md

@@ -1,6 +1,7 @@
 # WireMock State extension
 
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/wiremock/wiremock-state-extension)](https://github.com/wiremock/wiremock-state-extension/releases)
+[![Maven Central](https://img.shields.io/maven-central/v/org.wiremock.extensions/wiremock-state-extension)](https://img.shields.io/maven-central/v/org.wiremock.extensions/wiremock-state-extension)
 [![Slack](https://img.shields.io/badge/slack-slack.wiremock.org-brightgreen?style=flat&logo=slack)](https://slack.wiremock.org/)
 [![GitHub contributors](https://img.shields.io/github/contributors/wiremock/wiremock-state-extension)](https://github.com/wiremock/wiremock-state-extension/graphs/contributors)
 
@@ -124,48 +125,41 @@ the `GET` won't have any knowledge of the previous post.
    {
   "firstName": "Jane",
   "lastName": "Doe"
-
-}
-
+  }
    ```
 
 - Response:
 
    ```json
-    {
-  "id": "54owywgurlqepq1wc5xvyc2hipe8xp4u",
-  #
-  Random
-  value
-  "firstName": "Jane",
-  "lastName": "Doe"
-}
+   {
+   "id": "54owywgurlqepq1wc5xvyc2hipe8xp4u",  # Random value
+   "firstName": "Jane",
+   "lastName": "Doe"
+   }
    ```
 
 3. `GET` to retrieve the first value (`GET /queue`)
 
 - Response:
 
   ```json
-    {
+  {
   "id": "kn0ixsaswzrzcfzriytrdupnjnxor1is",
   "firstName": "John",
   "lastName": "Doe"
-
-}
-
+  }
   ```
 
 4. `GET` to retrieve the second value (`GET /queue`)
 
 - Response:
 
   ```json
-    {
+  {
   "id": "54owywgurlqepq1wc5xvyc2hipe8xp4u",
   "firstName": "Jane",
   "lastName": "Doe"
-}
+  }
   ```
 
 # Usage
@@ -288,7 +282,7 @@ storing any data.
 The standalone jar can be downloaded from [GitHub](https://github.com/wiremock/wiremock-extension-state/packages/1902576) .
 
 ```bash
-java -cp "wiremock-state-extension-standalone-0.0.5.jar:wiremock-standalone-3.0.0-beta-11.jar" wiremock.Run
+java -cp "wiremock-state-extension-standalone-0.4.0.jar:wiremock-standalone-3.3.0.jar" wiremock.Run
 ```
 
 ### Docker
@@ -303,7 +297,7 @@ docker run -it --rm \
 -p 8080:8080 \
 --name wiremock \
 -v $PWD/extensions:/var/wiremock/extensions \
-wiremock/wiremock:3x \
+wiremock/wiremock:3.3.0 \
 -- --global-response-templating
 ```
 
@@ -349,7 +343,7 @@ The following parameters have to be provided:
 <td>
 
 ```json
-  {
+{
   "id": "{{jsonPath response.body '$.id'}}",
   "firstName": "{{jsonPath request.body '$.firstName'}}",
   "lastName": "{{jsonPath request.body '$.lastName'}}"
@@ -374,7 +368,7 @@ Dictionary
 <td>
 
 ```json
-  {
+{
   "addLast": {
     "id": "{{jsonPath response.body '$.id'}}",
     "firstName": "{{jsonPath request.body '$.firstName'}}",
@@ -529,14 +523,19 @@ The following parameters have to be provided:
 
 <table>
 <tr>
+<th>Task</th>
 <th>Parameter</th>
 <th>Type</th>
 <th>Example</th>
 </tr>
 <tr>
+<td rowspan="3">
+context deletion
+</td>
 <td>
 
-`context`
+`context`<br>
+Deletes a single context.
 
 </td>
 <td>String</td>
@@ -550,9 +549,45 @@ The following parameters have to be provided:
 <tr>
 <td>
 
-`list` (Optional) <br>
-When list is provided, only the specified list element is deleted. If `list` is not provided, the whole context is deleted.
+`contexts`
+Deletes all contexts specified in the array.
+
+</td>
+<td>Array<br>
+An empty array or unknown contexts are silently ignored.
+</td>
+<td>
+
+- `"contexts": ["{{jsonPath response.body '$.firstContext'}}", "{{jsonPath response.body '$.secondContext'}}"]`
+- `"contexts": ["a", "b", "c"]`
+
+</td>
+</tr>
+<tr>
+<td>
+
+`contextsMatching`
+Deletes all contexts matching the regex.
+</td>
+<td>String (regex)<br>
+An invalid regex results in an exception. If there are no matches, this is silently ignored.
+</td>
+<td>
+
+- `"contextsMatching": ".*userNa.*"`
+- `"contextsMatching": ".*(john|jane).*"`
+- `"contextsMatching": ".*"` (delete all contexts)
+
+</td>
+</tr>
+<tr>
+<td>List entry deletion</td>
+<td>
+
+- `context` (string): the context to delete the list entry from
+- `list` (dictionary, see next column)
 
+If `list` is specified and `context` is missing, an error is thrown. 
 </td>
 <td>
 Dictionary - only one option is interpreted (top to bottom as listed here)
@@ -666,7 +701,7 @@ The default expiration is 60 minutes. The default value can be overwritten (`0`
 
 ```java
 int expiration=1024;
-    var store=new CaffeineStore(expiration);
+var store=new CaffeineStore(expiration);
 ```
 
 ## Match a request against a context

demo/wiremock_state_extension_demo/src/stores/counter.ts

@@ -28,9 +28,13 @@
 import org.wiremock.extensions.state.internal.ResponseTemplateModel;
 import org.wiremock.extensions.state.internal.StateExtensionMixin;
 
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.regex.Pattern;
+import java.util.regex.PatternSyntaxException;
+import java.util.stream.Collectors;
 
 import static org.wiremock.extensions.state.internal.ExtensionLogger.logger;
 
@@ -68,13 +72,52 @@ public void beforeResponseSent(ServeEvent serveEvent, Parameters parameters) {
             "response", ResponseTemplateModel.from(serveEvent.getResponse())
         );
         var configuration = Json.mapToObject(parameters, DeleteStateParameters.class);
-        var contextName = createContextName(model, configuration);
         Optional.ofNullable(configuration.getList()).ifPresentOrElse(
-            listConfig -> handleListDeletion(listConfig, contextName, model),
-            () -> contextManager.deleteContext(contextName)
+            listConfig -> handleListDeletion(listConfig, createContextName(model, configuration.getContext()), model),
+            () -> handleContextDeletion(configuration, model)
         );
     }
 
+    private void handleContextDeletion(DeleteStateParameters configuration, Map<String, Object> model) {
+        if (configuration.getContext() != null) {
+            deleteContext(configuration.getContext(), model);
+        } else if (configuration.getContexts() != null) {
+            deleteContexts(configuration.getContexts(), model);
+        } else if (configuration.getContextsMatching() != null) {
+            deleteContextsMatching(configuration.getContextsMatching(), model);
+        } else {
+            throw createConfigurationError("Missing/invalid configuration for context deletion");
+        }
+    }
+
+    private void deleteContexts(List<String> rawContexts, Map<String, Object> model) {
+
+        var contexts = rawContexts.stream().map(it -> renderTemplate(model, it)).collect(Collectors.toList());
+        contextManager.onEach(context -> {
+            if(contexts.contains(context.getContextName())) {
+                contextManager.deleteContext(context.getContextName());
+            }
+        });
+    }
+
+    private void deleteContextsMatching(String rawRegex, Map<String, Object> model) {
+        try {
+            var regex = renderTemplate(model, rawRegex);
+            var pattern = Pattern.compile(regex);
+            contextManager.onEach(context -> {
+                if(pattern.matcher(context.getContextName()).matches()) {
+                    contextManager.deleteContext(context.getContextName());
+                }
+            });
+        } catch (PatternSyntaxException ex) {
+            throw createConfigurationError("Missing/invalid configuration for context deletion: %s", ex.getMessage());
+        }
+    }
+
+    private void deleteContext(String rawContext, Map<String, Object> model) {
+        contextManager.deleteContext(createContextName(model, rawContext));
+    }
+
     private void handleListDeletion(DeleteStateParameters.ListParameters listConfig, String contextName, Map<String, Object> model) {
         if (Boolean.TRUE.equals(listConfig.getDeleteFirst())) {
             deleteFirst(contextName);
@@ -88,7 +131,7 @@ private void handleListDeletion(DeleteStateParameters.ListParameters listConfig,
         ) {
             deleteWhere(listConfig, contextName, model);
         } else {
-            throw createConfigurationError("Missing/invalid configuration for list: ");
+            throw createConfigurationError("Missing/invalid configuration for list entry deletion");
         }
     }
 
@@ -114,7 +157,7 @@ private void deleteIndex(DeleteStateParameters.ListParameters listConfig, String
                 logger().info(contextName, String.format("list::deleteIndex(%d)", index));
             });
         } catch (IndexOutOfBoundsException | NumberFormatException e) {
-            throw createConfigurationError("List index '%s' does not exist or cannot be parsed: %s", listConfig.getDeleteIndex(), e.getMessage());
+            logger().info(contextName, String.format("Unknown or unparsable list index: '%s' - ignoring", listConfig.getDeleteIndex()));
         }
     }
 
@@ -134,9 +177,10 @@ private void deleteWhere(DeleteStateParameters.ListParameters listConfig, String
         });
     }
 
-    private String createContextName(Map<String, Object> model, DeleteStateParameters parameters) {
-        var rawContext = Optional.ofNullable(parameters.getContext()).filter(StringUtils::isNotBlank).orElseThrow(() -> new ConfigurationException("no context specified"));
-        String context = renderTemplate(model, rawContext);
+    private String createContextName(Map<String, Object> model, String rawContext) {
+        var context = Optional.ofNullable(rawContext).filter(StringUtils::isNotBlank)
+            .map(it -> renderTemplate(model, it))
+            .orElseThrow(() -> new ConfigurationException("no context specified"));
         if (StringUtils.isBlank(context)) {
             throw createConfigurationError("Context cannot be blank");
         }

src/main/java/org/wiremock/extensions/state/extensions/DeleteStateEventListener.java

@@ -52,7 +52,7 @@ public Object getState(String contextName, String property) {
      */
     public Optional<Context> getContext(String contextName) {
         synchronized (store) {
-            return store.get(contextName).map(it -> (Context) it).map(Context::new);
+            return getSafeContextCopy(contextName);
         }
     }
 
@@ -63,6 +63,14 @@ public void deleteContext(String contextName) {
         }
     }
 
+    public void onEach(Consumer<Context> consumer) {
+        synchronized(store) {
+            store.getAllKeys().forEach(contextName -> {
+                getSafeContextCopy(contextName).ifPresent(consumer);
+            });
+        }
+    }
+
     public void deleteAllContexts() {
         synchronized (store) {
             logger().info("allContexts", "deleted");
@@ -117,4 +125,8 @@ public Long numReads(String contextName) {
             return store.get(contextName).map(it -> ((Context) it).getMatchCount()).orElse(0L);
         }
     }
+
+    private Optional<Context> getSafeContextCopy(String contextName) {
+        return store.get(contextName).map(it -> (Context) it).map(Context::new);
+    }
 }

src/main/java/org/wiremock/extensions/state/internal/ContextManager.java

@@ -17,9 +17,14 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 
+import java.util.List;
+
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class DeleteStateParameters {
     private String context;
+    private String contextsMatching;
+
+    private List<String> contexts;
     private ListParameters list;
 
     public ListParameters getList() {
@@ -38,6 +43,22 @@ public void setContext(String context) {
         this.context = context;
     }
 
+    public List<String> getContexts() {
+        return contexts;
+    }
+
+    public void setContexts(List<String> contexts) {
+        this.contexts = contexts;
+    }
+
+    public String getContextsMatching() {
+        return contextsMatching;
+    }
+
+    public void setContextsMatching(String contextsMatching) {
+        this.contextsMatching = contextsMatching;
+    }
+
     @JsonIgnoreProperties(ignoreUnknown = true)
     public static class ListParameters {
         private Boolean deleteFirst;