Skip to content

Commit 16bf845

Browse files
christophstroblchristophstrobl
committed
DATAES-547 - Polishing.
Add test and directly use SearchHit to pass on the index name. Fix minor flaw in Exception translation for non existing indices along the way. Original Pull Request: spring-projects#257
1 parent 0829889 commit 16bf845

File tree

6 files changed

+177
-67
lines changed

6 files changed

+177
-67
lines changed

‎src/main/java/org/springframework/data/elasticsearch/core/DeleteEntry.java

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchExceptionTranslator.java

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,17 @@
1717
package org.springframework.data.elasticsearch.core;
1818

1919
import java.net.ConnectException;
20+
import java.util.List;
2021

2122
import org.elasticsearch.ElasticsearchException;
23+
import org.elasticsearch.ElasticsearchStatusException;
2224
import org.springframework.dao.DataAccessException;
2325
import org.springframework.dao.DataAccessResourceFailureException;
2426
import org.springframework.dao.support.PersistenceExceptionTranslator;
2527
import org.springframework.data.elasticsearch.NoSuchIndexException;
2628
import org.springframework.util.CollectionUtils;
29+
import org.springframework.util.ObjectUtils;
30+
import org.springframework.util.StringUtils;
2731

2832
/**
2933
* @author Christoph Strobl
@@ -39,7 +43,8 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
3943
ElasticsearchException elasticsearchException = (ElasticsearchException) ex;
4044

4145
if (!indexAvailable(elasticsearchException)) {
42-
return new NoSuchIndexException(elasticsearchException.getMetadata("es.index").toString(), ex);
46+
return new NoSuchIndexException(ObjectUtils.nullSafeToString(elasticsearchException.getMetadata("es.index")),
47+
ex);
4348
}
4449
}
4550

@@ -51,6 +56,13 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
5156
}
5257

5358
private boolean indexAvailable(ElasticsearchException ex) {
54-
return !CollectionUtils.contains(ex.getMetadata("es.index_uuid").iterator(), "_na_");
59+
60+
List<String> metadata = ex.getMetadata("es.index_uuid");
61+
if (metadata == null) {
62+
if (ex instanceof ElasticsearchStatusException) {
63+
return StringUtils.hasText(ObjectUtils.nullSafeToString(((ElasticsearchStatusException) ex).getIndex()));
64+
}
65+
}
66+
return !CollectionUtils.contains(metadata.iterator(), "_na_");
5567
}
5668
}

‎src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchRestTemplate.java

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -869,35 +869,27 @@ public <T> void delete(DeleteQuery deleteQuery, Class<T> clazz) {
869869
SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(deleteQuery.getQuery()).withIndices(indexName)
870870
.withTypes(typeName).withPageable(PageRequest.of(0, pageSize)).build();
871871

872-
SearchResultMapper deleteentryResultMapper = new SearchResultMapperAdapter() {
872+
SearchResultMapper deleteEntryResultMapper = new SearchResultMapperAdapter() {
873+
873874
@Override
874875
public <T> AggregatedPage<T> mapResults(SearchResponse response, Class<T> clazz, Pageable pageable) {
875-
List<DeleteEntry> result = new ArrayList<>();
876-
for (SearchHit searchHit : response.getHits().getHits()) {
877-
String id = searchHit.getId();
878-
String indexName = searchHit.getIndex();
879-
result.add(new DeleteEntry(id, indexName));
880-
}
881-
if (result.size() > 0) {
882-
return new AggregatedPageImpl<>((List<T>) result, response.getScrollId());
883-
}
884-
return new AggregatedPageImpl<>(Collections.emptyList(), response.getScrollId());
876+
return new AggregatedPageImpl<>((List<T>) Arrays.asList(response.getHits().getHits()), response.getScrollId());
885877
}
886878
};
887879

888-
Page<DeleteEntry> scrolledResult = startScroll(scrollTimeInMillis, searchQuery, DeleteEntry.class,
889-
deleteentryResultMapper);
880+
Page<SearchHit> scrolledResult = startScroll(scrollTimeInMillis, searchQuery, SearchHit.class,
881+
deleteEntryResultMapper);
890882
BulkRequest request = new BulkRequest();
891-
List<DeleteEntry> documentsToDelete = new ArrayList<>();
883+
List<SearchHit> documentsToDelete = new ArrayList<>();
892884

893885
do {
894886
documentsToDelete.addAll(scrolledResult.getContent());
895887
scrolledResult = continueScroll(((ScrolledPage<T>) scrolledResult).getScrollId(), scrollTimeInMillis,
896-
DeleteEntry.class, deleteentryResultMapper);
888+
SearchHit.class, deleteEntryResultMapper);
897889
} while (scrolledResult.getContent().size() != 0);
898890

899-
for (DeleteEntry entry : documentsToDelete) {
900-
request.add(new DeleteRequest(entry.getIndexName(), typeName, entry.getId()));
891+
for (SearchHit entry : documentsToDelete) {
892+
request.add(new DeleteRequest(entry.getIndex(), typeName, entry.getId()));
901893
}
902894

903895
if (request.numberOfActions() > 0) {

‎src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplate.java

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import java.io.IOException;
2525
import java.io.InputStreamReader;
2626
import java.util.ArrayList;
27-
import java.util.Collections;
27+
import java.util.Arrays;
2828
import java.util.HashMap;
2929
import java.util.Iterator;
3030
import java.util.LinkedList;
@@ -757,35 +757,26 @@ public <T> void delete(DeleteQuery deleteQuery, Class<T> clazz) {
757757
.withTypes(typeName).withPageable(PageRequest.of(0, pageSize)).build();
758758

759759
SearchResultMapper deleteEntryResultMapper = new SearchResultMapperAdapter() {
760+
760761
@Override
761762
public <T> AggregatedPage<T> mapResults(SearchResponse response, Class<T> clazz, Pageable pageable) {
762-
List<DeleteEntry> result = new ArrayList<>();
763-
for (SearchHit searchHit : response.getHits().getHits()) {
764-
765-
String id = searchHit.getId();
766-
String indexName = searchHit.getIndex();
767-
result.add(new DeleteEntry(id, indexName));
768-
}
769-
if (result.size() > 0) {
770-
return new AggregatedPageImpl<T>((List<T>) result, response.getScrollId());
771-
}
772-
return new AggregatedPageImpl<T>(Collections.emptyList(), response.getScrollId());
763+
return new AggregatedPageImpl<>((List<T>) Arrays.asList(response.getHits().getHits()), response.getScrollId());
773764
}
774765
};
775766

776-
Page<DeleteEntry> scrolledResult = startScroll(scrollTimeInMillis, searchQuery, DeleteEntry.class,
767+
Page<SearchHit> scrolledResult = startScroll(scrollTimeInMillis, searchQuery, SearchHit.class,
777768
deleteEntryResultMapper);
778769
BulkRequestBuilder bulkRequestBuilder = client.prepareBulk();
779-
List<DeleteEntry> documentsToDelete = new ArrayList<>();
770+
List<SearchHit> documentsToDelete = new ArrayList<>();
780771

781772
do {
782773
documentsToDelete.addAll(scrolledResult.getContent());
783774
scrolledResult = continueScroll(((ScrolledPage<T>) scrolledResult).getScrollId(), scrollTimeInMillis,
784-
DeleteEntry.class, deleteEntryResultMapper);
775+
SearchHit.class, deleteEntryResultMapper);
785776
} while (scrolledResult.getContent().size() != 0);
786777

787-
for (DeleteEntry entry : documentsToDelete) {
788-
bulkRequestBuilder.add(client.prepareDelete(entry.getIndexName(), typeName, entry.getId()));
778+
for (SearchHit entry : documentsToDelete) {
779+
bulkRequestBuilder.add(client.prepareDelete(entry.getIndex(), typeName, entry.getId()));
789780
}
790781

791782
if (bulkRequestBuilder.numberOfActions() > 0) {

‎src/test/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplateTests.java

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,14 @@
6666
import org.springframework.data.elasticsearch.entities.HetroEntity1;
6767
import org.springframework.data.elasticsearch.entities.HetroEntity2;
6868
import org.springframework.data.elasticsearch.entities.SampleEntity;
69+
import org.springframework.data.elasticsearch.entities.SampleEntityUUIDKeyed;
6970
import org.springframework.data.elasticsearch.entities.SampleMappingEntity;
7071
import org.springframework.data.elasticsearch.entities.UseServerConfigurationEntity;
7172
import org.springframework.data.util.CloseableIterator;
7273

7374
/**
7475
* Base for testing rest/transport templates
76+
*
7577
* @author Rizwan Idrees
7678
* @author Mohsin Husen
7779
* @author Franck Marchand
@@ -101,9 +103,15 @@ public class ElasticsearchTemplateTests {
101103

102104
@Before
103105
public void before() {
106+
104107
elasticsearchTemplate.deleteIndex(SampleEntity.class);
105108
elasticsearchTemplate.createIndex(SampleEntity.class);
106109
elasticsearchTemplate.putMapping(SampleEntity.class);
110+
111+
elasticsearchTemplate.deleteIndex(SampleEntityUUIDKeyed.class);
112+
elasticsearchTemplate.createIndex(SampleEntityUUIDKeyed.class);
113+
elasticsearchTemplate.putMapping(SampleEntityUUIDKeyed.class);
114+
107115
elasticsearchTemplate.deleteIndex(INDEX_1_NAME);
108116
elasticsearchTemplate.deleteIndex(INDEX_2_NAME);
109117
elasticsearchTemplate.deleteIndex(UseServerConfigurationEntity.class);
@@ -405,6 +413,86 @@ public void shouldDeleteDocumentForGivenQuery() {
405413
assertThat(sampleEntities.getTotalElements(), equalTo(0L));
406414
}
407415

416+
@Test // DATAES-547
417+
public void shouldDeleteAcrossIndex() {
418+
419+
// given
420+
SampleEntity sampleEntity = SampleEntity.builder() //
421+
.message("foo") //
422+
.version(System.currentTimeMillis()) //
423+
.build();
424+
425+
IndexQuery idxQuery1 = new IndexQueryBuilder().withIndexName(INDEX_1_NAME).withId(randomNumeric(5))
426+
.withObject(sampleEntity).build();
427+
428+
elasticsearchTemplate.index(idxQuery1);
429+
elasticsearchTemplate.refresh(INDEX_1_NAME);
430+
431+
IndexQuery idxQuery2 = new IndexQueryBuilder().withIndexName(INDEX_2_NAME).withId(randomNumeric(5))
432+
.withObject(sampleEntity).build();
433+
434+
elasticsearchTemplate.index(idxQuery2);
435+
elasticsearchTemplate.refresh(INDEX_2_NAME);
436+
437+
// when
438+
DeleteQuery deleteQuery = new DeleteQuery();
439+
deleteQuery.setQuery(termQuery("message", "foo"));
440+
deleteQuery.setType("test-type");
441+
deleteQuery.setIndex("test-index-*");
442+
443+
elasticsearchTemplate.delete(deleteQuery);
444+
445+
elasticsearchTemplate.refresh(INDEX_1_NAME);
446+
elasticsearchTemplate.refresh(INDEX_2_NAME);
447+
448+
// then
449+
SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(termQuery("message", "foo"))
450+
.withIndices(INDEX_1_NAME, INDEX_2_NAME) //
451+
.build();
452+
453+
assertThat(elasticsearchTemplate.count(searchQuery), equalTo(0L));
454+
}
455+
456+
@Test // DATAES-547
457+
public void shouldDeleteAcrossIndexWhenNoMatchingDataPresent() {
458+
459+
// given
460+
SampleEntity sampleEntity = SampleEntity.builder() //
461+
.message("positive") //
462+
.version(System.currentTimeMillis()) //
463+
.build();
464+
465+
IndexQuery idxQuery1 = new IndexQueryBuilder().withIndexName(INDEX_1_NAME).withId(randomNumeric(5))
466+
.withObject(sampleEntity).build();
467+
468+
elasticsearchTemplate.index(idxQuery1);
469+
elasticsearchTemplate.refresh(INDEX_1_NAME);
470+
471+
IndexQuery idxQuery2 = new IndexQueryBuilder().withIndexName(INDEX_2_NAME).withId(randomNumeric(5))
472+
.withObject(sampleEntity).build();
473+
474+
elasticsearchTemplate.index(idxQuery2);
475+
elasticsearchTemplate.refresh(INDEX_2_NAME);
476+
477+
// when
478+
DeleteQuery deleteQuery = new DeleteQuery();
479+
deleteQuery.setQuery(termQuery("message", "negative"));
480+
deleteQuery.setType("test-type");
481+
deleteQuery.setIndex("test-index-*");
482+
483+
elasticsearchTemplate.delete(deleteQuery);
484+
485+
elasticsearchTemplate.refresh(INDEX_1_NAME);
486+
elasticsearchTemplate.refresh(INDEX_2_NAME);
487+
488+
// then
489+
SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(termQuery("message", "positive"))
490+
.withIndices(INDEX_1_NAME, INDEX_2_NAME) //
491+
.build();
492+
493+
assertThat(elasticsearchTemplate.count(searchQuery), equalTo(2L));
494+
}
495+
408496
@Test
409497
public void shouldFilterSearchResultsForGivenFilter() {
410498
// given

‎src/test/java/org/springframework/data/elasticsearch/core/ReactiveElasticsearchTemplateTests.java

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@
5252
import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
5353
import org.springframework.data.elasticsearch.core.query.IndexQuery;
5454
import org.springframework.data.elasticsearch.core.query.IndexQueryBuilder;
55+
import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
56+
import org.springframework.data.elasticsearch.core.query.SearchQuery;
5557
import org.springframework.data.elasticsearch.core.query.StringQuery;
5658
import org.springframework.data.elasticsearch.entities.SampleEntity;
5759
import org.springframework.test.context.ContextConfiguration;
@@ -519,6 +521,62 @@ public void deleteByQueryShouldReturnZeroWhenIndexDoesNotExist() {
519521
.verifyComplete();
520522
}
521523

524+
@Test // DATAES-547
525+
@ElasticsearchVersion(asOf = "6.5.0")
526+
public void shouldDeleteAcrossIndex() {
527+
528+
String indexPrefix = "rx-template-test-index";
529+
String thisIndex = indexPrefix + "-this";
530+
String thatIndex = indexPrefix + "-that";
531+
532+
template.save(randomEntity("test"), thisIndex) //
533+
.then(template.save(randomEntity("test"), thatIndex)) //
534+
.then() //
535+
.as(StepVerifier::create)//
536+
.verifyComplete();
537+
538+
restTemplate.refresh(thisIndex);
539+
restTemplate.refresh(thatIndex);
540+
541+
SearchQuery searchQuery = new NativeSearchQueryBuilder() //
542+
.withQuery(termQuery("message", "test")) //
543+
.withIndices(indexPrefix + "*") //
544+
.build();
545+
546+
template.deleteBy(searchQuery, SampleEntity.class) //
547+
.as(StepVerifier::create) //
548+
.expectNext(2L) //
549+
.verifyComplete();
550+
}
551+
552+
@Test // DATAES-547
553+
@ElasticsearchVersion(asOf = "6.5.0")
554+
public void shouldDeleteAcrossIndexWhenNoMatchingDataPresent() {
555+
556+
String indexPrefix = "rx-template-test-index";
557+
String thisIndex = indexPrefix + "-this";
558+
String thatIndex = indexPrefix + "-that";
559+
560+
template.save(randomEntity("positive"), thisIndex) //
561+
.then(template.save(randomEntity("positive"), thatIndex)) //
562+
.then() //
563+
.as(StepVerifier::create)//
564+
.verifyComplete();
565+
566+
restTemplate.refresh(thisIndex);
567+
restTemplate.refresh(thatIndex);
568+
569+
SearchQuery searchQuery = new NativeSearchQueryBuilder() //
570+
.withQuery(termQuery("message", "negative")) //
571+
.withIndices(indexPrefix + "*") //
572+
.build();
573+
574+
template.deleteBy(searchQuery, SampleEntity.class) //
575+
.as(StepVerifier::create) //
576+
.expectNext(0L) //
577+
.verifyComplete();
578+
}
579+
522580
@Test // DATAES-504
523581
@ElasticsearchVersion(asOf = "6.5.0")
524582
public void deleteByQueryShouldReturnNumberOfDeletedDocuments() {

0 commit comments

Comments
 (0)