specify which Messages to delete with text

Author: Vladimir Kotal

apiary.apib

@@ -93,6 +93,10 @@ see https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java
 
 ### deletes messages with specified tag [DELETE]
 
++ Request (application/text)
+
+        string value of the message text - only messages with the text (and specified tag) will be deleted
+
 + Parameters
   + tag (string) - tag
 

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/RuntimeEnvironment.java

@@ -1935,11 +1935,11 @@ public void addMessage(final Message message) {
 
     /**
      * Remove all messages containing at least one of the tags.
-     *
      * @param tags set of tags
+     * @param text message text (can be null, empty)
      */
-    public void removeAnyMessage(final Set<String> tags) {
-        messagesContainer.removeAnyMessage(tags);
+    public void removeAnyMessage(final Set<String> tags, final String text) {
+        messagesContainer.removeAnyMessage(tags, text);
     }
 
     /**

opengrok-indexer/src/main/java/org/opengrok/indexer/web/messages/Message.java

@@ -112,6 +112,19 @@ public boolean hasAny(Set<String> t) {
         return !tmp.isEmpty();
     }
 
+    /**
+     * @param tags set of tags to check
+     * @param text message text
+     * @return true if a mesage has at least one of the tags and text
+     */
+    public boolean hasTagsAndText(Set<String> tags, String text) {
+        if (text == null || text.isEmpty()) {
+            return hasAny(tags);
+        }
+
+        return hasAny(tags) && getText().equals(text);
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {

opengrok-indexer/src/main/java/org/opengrok/indexer/web/messages/MessagesContainer.java

@@ -167,6 +167,13 @@ public void removeAnyMessage(Set<String> tags) {
         removeAnyMessage(t -> t.getMessage().hasAny(tags));
     }
 
+    public void removeAnyMessage(Set<String> tags, String text) {
+        if (tags == null) {
+            return;
+        }
+        removeAnyMessage(t -> t.getMessage().hasTagsAndText(tags, text));
+    }
+
     /**
      * Remove messages which have expired.
      */

opengrok-web/src/main/java/org/opengrok/web/api/v1/controller/MessagesController.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.web.api.v1.controller;
 
@@ -54,11 +54,12 @@ public Response addMessage(@Valid final Message message) {
     }
 
     @DELETE
-    public void removeMessagesWithTag(@QueryParam("tag") final String tag) {
+    @Consumes(MediaType.TEXT_PLAIN)
+    public void removeMessagesWithTag(@QueryParam("tag") final String tag, final String text) {
         if (tag == null) {
             throw new WebApplicationException("Message tag has to be specified", Response.Status.BAD_REQUEST);
         }
-        env.removeAnyMessage(Collections.singleton(tag));
+        env.removeAnyMessage(Collections.singleton(tag), text);
     }
 
     @GET

opengrok-web/src/test/java/org/opengrok/web/api/v1/controller/MessagesControllerTest.java

@@ -18,12 +18,20 @@
  */
 
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.web.api.v1.controller;
 
+import org.glassfish.grizzly.http.server.HttpServer;
+import org.glassfish.jersey.client.ClientConfig;
+import org.glassfish.jersey.client.ClientProperties;
+import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
 import org.glassfish.jersey.server.ResourceConfig;
+import org.glassfish.jersey.test.DeploymentContext;
 import org.glassfish.jersey.test.JerseyTest;
+import org.glassfish.jersey.test.spi.TestContainer;
+import org.glassfish.jersey.test.spi.TestContainerException;
+import org.glassfish.jersey.test.spi.TestContainerFactory;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -35,9 +43,13 @@
 import javax.ws.rs.client.Entity;
 import javax.ws.rs.core.Application;
 import javax.ws.rs.core.GenericType;
+import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriBuilder;
 
+import java.io.IOException;
 import java.lang.reflect.Field;
+import java.net.URI;
 import java.time.Duration;
 import java.util.Arrays;
 import java.util.Collections;
@@ -72,6 +84,67 @@ protected Application configure() {
         return new ResourceConfig(MessagesController.class);
     }
 
+    // Allow entity body for DELETE method on the client side.
+    @Override
+    protected void configureClient(ClientConfig config) {
+        config.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true);
+    }
+
+    // Allow entity body for DELETE method on the server side.
+    public static class CustomGrizzlyTestContainerFactory implements TestContainerFactory {
+        public CustomGrizzlyTestContainerFactory() {
+        }
+
+        public TestContainer create(URI baseUri, DeploymentContext context) {
+            return new GrizzlyTestContainer(baseUri, context);
+        }
+
+        private class GrizzlyTestContainer implements TestContainer {
+            private URI baseUri;
+            private final HttpServer server;
+
+            private GrizzlyTestContainer(URI baseUri, DeploymentContext context) {
+                this.baseUri = UriBuilder.fromUri(baseUri).path(context.getContextPath()).build(new Object[0]);
+                this.server = GrizzlyHttpServerFactory.createHttpServer(this.baseUri, context.getResourceConfig(), false);
+                this.server.getServerConfiguration().setAllowPayloadForUndefinedHttpMethods(true);
+            }
+
+            public ClientConfig getClientConfig() {
+                return null;
+            }
+
+            public URI getBaseUri() {
+                return this.baseUri;
+            }
+
+            public void start() {
+                if (this.server.isStarted()) {
+                    return;
+                }
+
+                try {
+                    this.server.start();
+                    if (this.baseUri.getPort() == 0) {
+                        this.baseUri = UriBuilder.fromUri(this.baseUri).port(this.server.getListener("grizzly").getPort()).build(new Object[0]);
+                    }
+                } catch (IOException e) {
+                    throw new TestContainerException(e);
+                }
+            }
+
+            public void stop() {
+                if (this.server.isStarted()) {
+                    this.server.shutdownNow();
+                }
+            }
+        }
+    }
+
+    @Override
+    protected TestContainerFactory getTestContainerFactory() throws TestContainerException {
+        return new CustomGrizzlyTestContainerFactory();
+    }
+
     @Before
     public void setupMessageListener() throws Exception {
         setMessageContainer(env, new MessagesContainer());
@@ -135,6 +208,15 @@ private void removeMessages(final String tag) {
                 .delete();
     }
 
+    private void removeMessages(final String tag, final String text) {
+        Entity<String> requestEntity = Entity.entity(text, MediaType.TEXT_PLAIN);
+        target("messages")
+                .queryParam("tag", tag)
+                .request()
+                .build("DELETE", requestEntity).
+                invoke();
+    }
+
     @Test
     public void addAndRemoveTest() {
         addMessage("test", "test");
@@ -147,6 +229,24 @@ public void addAndRemoveTest() {
         assertTrue(env.getMessages("test").isEmpty());
     }
 
+    @Test
+    public void addAndRemoveWithTextTest() {
+        final String tag = "foo";
+        final String text = "text";
+
+        addMessage(text, tag);
+        assertEquals(1, env.getMessages(tag).size());
+
+        removeMessages(tag + "bar", text);
+        assertEquals(1, env.getMessages(tag).size());
+
+        removeMessages(tag, text + "bar");
+        assertEquals(1, env.getMessages(tag).size());
+
+        removeMessages(tag, text);
+        assertTrue(env.getMessages(tag).isEmpty());
+    }
+
     @Test
     public void addAndRemoveDifferentTagsTest() {
         addMessage("test", "tag1");