ElasticSearchClient: Add deleteById API. (apache#11305)

docs/en/changes/changes.md

@@ -5,6 +5,7 @@
 
 #### OAP Server
 
+* ElasticSearchClient: Add `deleteById` API.
 
 
 #### UI

oap-server/server-library/library-client/src/main/java/org/apache/skywalking/oap/server/library/client/elasticsearch/ElasticSearchClient.java

@@ -346,6 +346,12 @@ public void forceUpdate(String indexName, String id, Map<String, Object> source)
         es.get().documents().update(wrapper.getRequest(), params);
     }
 
+    public void deleteById(String indexName, String id) {
+        indexName = indexNameConverter.apply(indexName);
+        Map<String, Object> params = ImmutableMap.of("refresh", "true");
+        es.get().documents().deleteById(indexName, TYPE, id, params);
+    }
+
     public IndexRequestWrapper prepareInsert(String indexName, String id,
                                              Map<String, Object> source) {
         return prepareInsert(indexName, id, Optional.empty(), source);

oap-server/server-library/library-client/src/test/java/org/apache/skywalking/library/elasticsearch/bulk/ElasticSearchIT.java

@@ -169,7 +169,8 @@ public void documentOperate(final ElasticsearchContainer server,
                                                                       .next()
                                                                       .getSource()
                                                                       .get("message"));
-
+        client.deleteById(indexName, id);
+        Assertions.assertFalse(client.existDoc(indexName, id));
         client.shutdown();
         server.stop();
     }

oap-server/server-library/library-elasticsearch-client/src/main/java/org/apache/skywalking/library/elasticsearch/client/DocumentClient.java

@@ -157,4 +157,26 @@ public void update(UpdateRequest request, Map<String, Object> params) {
         });
         future.join();
     }
+
+    @SneakyThrows
+    public void deleteById(String index, String type, String id, Map<String, Object> params) {
+        final CompletableFuture<Void> future = version.thenCompose(
+            v -> client.execute(v.requestFactory().document().deleteById(index, type, id, params))
+                       .aggregate().thenAccept(response -> {
+                    final HttpStatus status = response.status();
+                    if (status != HttpStatus.OK) {
+                        throw new RuntimeException(response.contentUtf8());
+                    }
+                }));
+        future.whenComplete((result, exception) -> {
+            if (exception != null) {
+                log.error("Failed to delete doc by id {} in index {}, params: {}", id, index, params, exception);
+                return;
+            }
+            if (log.isDebugEnabled()) {
+                log.debug("Succeeded delete doc by id {} in index {}, params: {}", id, params, index);
+            }
+        });
+        future.join();
+    }
 }

oap-server/server-library/library-elasticsearch-client/src/main/java/org/apache/skywalking/library/elasticsearch/requests/factory/DocumentFactory.java

@@ -60,4 +60,9 @@ public interface DocumentFactory {
      */
     HttpRequest delete(String index, String type, Query query,
                        Map<String, ?> params);
+
+    /**
+     * Returns a request to delete documents matching the given {@code id} in {@code index}.
+     */
+    HttpRequest deleteById(String index, String type, String id, Map<String, ?> params);
 }

oap-server/server-library/library-elasticsearch-client/src/main/java/org/apache/skywalking/library/elasticsearch/requests/factory/v6/V6DocumentFactory.java

@@ -198,4 +198,23 @@ public HttpRequest delete(String index, String type, Query query,
                       .content(MediaType.JSON, content)
                       .build();
     }
+
+    @Override
+    public HttpRequest deleteById(final String index, final String type, final String id, Map<String, ?> params) {
+        checkArgument(!isNullOrEmpty(index), "index cannot be null or empty");
+        checkArgument(!isNullOrEmpty(type), "type cannot be null or empty");
+        checkArgument(!isNullOrEmpty(id), "id cannot be null or empty");
+
+        final HttpRequestBuilder builder = HttpRequest.builder();
+        if (params != null) {
+            params.forEach(builder::queryParam);
+        }
+
+        return builder
+            .delete("/{index}/{type}/{id}")
+            .pathParam("index", index)
+            .pathParam("type", type)
+            .pathParam("id", id)
+            .build();
+    }
 }

oap-server/server-library/library-elasticsearch-client/src/main/java/org/apache/skywalking/library/elasticsearch/requests/factory/v7plus/V7DocumentFactory.java

@@ -191,4 +191,22 @@ public HttpRequest delete(String index, String type, Query query,
                       .content(MediaType.JSON, content)
                       .build();
     }
+
+    @Override
+    public HttpRequest deleteById(final String index, final String type, final String id, Map<String, ?> params) {
+        checkArgument(!isNullOrEmpty(index), "index cannot be null or empty");
+        checkArgument(!isNullOrEmpty(type), "type cannot be null or empty");
+        checkArgument(!isNullOrEmpty(id), "id cannot be null or empty");
+
+        final HttpRequestBuilder builder = HttpRequest.builder();
+        if (params != null) {
+            params.forEach(builder::queryParam);
+        }
+
+        return builder
+            .delete("/{index}/_doc/{id}")
+            .pathParam("index", index)
+            .pathParam("id", id)
+            .build();
+    }
 }

oap-server/server-library/library-elasticsearch-client/src/test/java/org/apache/skywalking/library/elasticsearch/ElasticSearchIT.java

@@ -389,4 +389,37 @@ public void testSearch(final String ignored,
 
         server.close();
     }
+
+    @ParameterizedTest(name = "version: {0}")
+    @MethodSource("es")
+    public void testDocDeleteById(final String ignored,
+                                  final ElasticsearchContainer server) {
+        server.start();
+
+        final ElasticSearch client =
+            ElasticSearch.builder()
+                         .endpoints(server.getHttpHostAddress())
+                         .build();
+        client.connect();
+
+        final String index = "test-index-delete";
+        assertTrue(client.index().create(index, null, null));
+
+        final ImmutableMap<String, Object> doc = ImmutableMap.of("key", "val");
+        final String idWithSpace = "an id"; // UI management templates' IDs contains spaces
+        final String type = "type";
+
+        client.documents().index(
+            IndexRequest.builder()
+                        .index(index)
+                        .type(type)
+                        .id(idWithSpace)
+                        .doc(doc)
+                        .build(), null);
+
+        assertTrue(client.documents().exists(index, type, idWithSpace));
+        client.documents().deleteById(index, type, idWithSpace, ImmutableMap.of("refresh", "true"));
+        assertFalse(client.documents().exists(index, type, idWithSpace));
+        server.close();
+    }
 }