Skip to content

DATAES-525 - Fixed doScroll() method which caused the deletion issues. #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pnowak85 wants to merge 1 commit into from
Closed

DATAES-525 - Fixed doScroll() method which caused the deletion issues. #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchRestTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -978,6 +978,12 @@ private SearchResponse doScroll(SearchRequest request, SearchQuery searchQuery)
Assert.notNull(searchQuery.getTypes(), "No type define for Query");
Assert.notNull(searchQuery.getPageable(), "Query.pageable is required for scan & scroll");

if (searchQuery.getQuery() != null) {
request.source().query(searchQuery.getQuery());
} else {
request.source().query(QueryBuilders.matchAllQuery());
}

if (searchQuery.getFilter() != null) {
request.source().postFilter(searchQuery.getFilter());
}
Expand Down
168 changes: 168 additions & 0 deletions src/test/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplateTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.stream.Collectors;

import org.apache.commons.lang.StringUtils;
import org.assertj.core.util.Lists;
import org.elasticsearch.action.get.MultiGetItemResponse;
Expand Down Expand Up @@ -2363,6 +2365,172 @@ public void shouldReturnMappingForGivenEntityClass() {
assertThat(((Map) ((Map) mapping.get("properties")).get("message")).get("type"), Matchers.<Object>is("text"));
}

@Test // DATAES-525
public void shouldDeleteOnlyDocumentsMatchedByDeleteQuery() {
List<IndexQuery> indexQueries = new ArrayList<>();

// given
// document to be deleted
String documentIdToDelete = UUID.randomUUID().toString();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(documentIdToDelete).message("some message")
.version(System.currentTimeMillis()).build()));

// remaining document
String remainingDocumentId = UUID.randomUUID().toString();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(remainingDocumentId).message("some other message")
.version(System.currentTimeMillis()).build()));
elasticsearchTemplate.bulkIndex(indexQueries);
elasticsearchTemplate.refresh(SampleEntity.class);

// when
DeleteQuery deleteQuery = new DeleteQuery();
deleteQuery.setQuery(idsQuery().addIds(documentIdToDelete));
elasticsearchTemplate.delete(deleteQuery, SampleEntity.class);
elasticsearchTemplate.refresh(SampleEntity.class);

// then
// document with id "remainingDocumentId" should still be indexed
SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(matchAllQuery()).build();
Page<SampleEntity> sampleEntities = elasticsearchTemplate.queryForPage(searchQuery, SampleEntity.class);
assertThat(sampleEntities.getTotalElements(), equalTo(1L));
assertThat(sampleEntities.getContent().get(0).getId(), is(remainingDocumentId));
}

@Test // DATAES-525
public void shouldDeleteOnlyDocumentsMatchedByCriteriaQuery() {
List<IndexQuery> indexQueries = new ArrayList<>();

// given
// document to be deleted
String documentIdToDelete = UUID.randomUUID().toString();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(documentIdToDelete).message("some message")
.version(System.currentTimeMillis()).build()));

// remaining document
String remainingDocumentId = UUID.randomUUID().toString();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(remainingDocumentId).message("some other message")
.version(System.currentTimeMillis()).build()));
elasticsearchTemplate.bulkIndex(indexQueries);
elasticsearchTemplate.refresh(SampleEntity.class);

// when
CriteriaQuery criteriaQuery = new CriteriaQuery(new Criteria("id").is(documentIdToDelete));
elasticsearchTemplate.delete(criteriaQuery, SampleEntity.class);
elasticsearchTemplate.refresh(SampleEntity.class);

// then
// document with id "remainingDocumentId" should still be indexed
SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(matchAllQuery()).build();
Page<SampleEntity> sampleEntities = elasticsearchTemplate.queryForPage(searchQuery, SampleEntity.class);
assertThat(sampleEntities.getTotalElements(), equalTo(1L));
assertThat(sampleEntities.getContent().get(0).getId(), is(remainingDocumentId));
}

@Test // DATAES-525
public void shouldDeleteDocumentForGivenIdOnly() {
List<IndexQuery> indexQueries = new ArrayList<>();

// given
// document to be deleted
String documentIdToDelete = UUID.randomUUID().toString();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(documentIdToDelete).message("some message")
.version(System.currentTimeMillis()).build()));

// remaining document
String remainingDocumentId = UUID.randomUUID().toString();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(remainingDocumentId).message("some other message")
.version(System.currentTimeMillis()).build()));
elasticsearchTemplate.bulkIndex(indexQueries);
elasticsearchTemplate.refresh(SampleEntity.class);

// when
elasticsearchTemplate.delete(SampleEntity.class, documentIdToDelete);
elasticsearchTemplate.refresh(SampleEntity.class);

// then
// document with id "remainingDocumentId" should still be indexed
SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(matchAllQuery()).build();
Page<SampleEntity> sampleEntities = elasticsearchTemplate.queryForPage(searchQuery, SampleEntity.class);
assertThat(sampleEntities.getTotalElements(), equalTo(1L));
assertThat(sampleEntities.getContent().get(0).getId(), is(remainingDocumentId));
}

@Test // DATAES-525
public void shouldApplyCriteriaQueryToScanAndScrollForGivenCriteriaQuery() {
// given
List<IndexQuery> indexQueries = new ArrayList<>();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(UUID.randomUUID().toString())
.message("some message that should be found by the scroll query").version(System.currentTimeMillis())
.build()));
indexQueries.add(getIndexQuery(SampleEntity.builder().id(UUID.randomUUID().toString())
.message("some other message that should be found by the scroll query")
.version(System.currentTimeMillis()).build()));
String notFindableMessage = "this entity must not be found by the scroll query";
indexQueries.add(getIndexQuery(SampleEntity.builder().id(UUID.randomUUID().toString())
.message(notFindableMessage).version(System.currentTimeMillis()).build()));

elasticsearchTemplate.bulkIndex(indexQueries);
elasticsearchTemplate.refresh(SampleEntity.class);

// when
CriteriaQuery criteriaQuery = new CriteriaQuery(new Criteria("message").contains("message"));
criteriaQuery.addIndices(INDEX_NAME);
criteriaQuery.addTypes(TYPE_NAME);
criteriaQuery.setPageable(PageRequest.of(0, 10));

ScrolledPage<SampleEntity> scroll = (ScrolledPage<SampleEntity>) elasticsearchTemplate.startScroll(1000,
criteriaQuery, SampleEntity.class);
List<SampleEntity> sampleEntities = new ArrayList<>();
while (scroll.hasContent()) {
sampleEntities.addAll(scroll.getContent());
scroll = (ScrolledPage<SampleEntity>) elasticsearchTemplate.continueScroll(scroll.getScrollId(), 1000,
SampleEntity.class);
}
elasticsearchTemplate.clearScroll(scroll.getScrollId());

// then
assertThat(sampleEntities.size(), is(equalTo(2)));
assertThat(sampleEntities.stream().map(SampleEntity::getMessage).collect(Collectors.toList()),
not(contains(notFindableMessage)));
}

@Test // DATAES-525
public void shouldApplySearchQueryToScanAndScrollForGivenSearchQuery() {
// given
List<IndexQuery> indexQueries = new ArrayList<>();
indexQueries.add(getIndexQuery(SampleEntity.builder().id(UUID.randomUUID().toString())
.message("some message that should be found by the scroll query").version(System.currentTimeMillis())
.build()));
indexQueries.add(getIndexQuery(SampleEntity.builder().id(UUID.randomUUID().toString())
.message("some other message that should be found by the scroll query")
.version(System.currentTimeMillis()).build()));
String notFindableMessage = "this entity must not be found by the scroll query";
indexQueries.add(getIndexQuery(SampleEntity.builder().id(UUID.randomUUID().toString())
.message(notFindableMessage).version(System.currentTimeMillis()).build()));

elasticsearchTemplate.bulkIndex(indexQueries);
elasticsearchTemplate.refresh(SampleEntity.class);

// when
SearchQuery searchQuery = new NativeSearchQueryBuilder().withQuery(matchQuery("message", "message"))
.withIndices(INDEX_NAME).withTypes(TYPE_NAME).withPageable(PageRequest.of(0, 10)).build();

ScrolledPage<SampleEntity> scroll = (ScrolledPage<SampleEntity>) elasticsearchTemplate.startScroll(1000,
searchQuery, SampleEntity.class);
List<SampleEntity> sampleEntities = new ArrayList<>();
while (scroll.hasContent()) {
sampleEntities.addAll(scroll.getContent());
scroll = (ScrolledPage<SampleEntity>) elasticsearchTemplate.continueScroll(scroll.getScrollId(), 1000,
SampleEntity.class);
}
elasticsearchTemplate.clearScroll(scroll.getScrollId());

// then
assertThat(sampleEntities.size(), is(equalTo(2)));
assertThat(sampleEntities.stream().map(SampleEntity::getMessage).collect(Collectors.toList()),
not(contains(notFindableMessage)));
}

private IndexQuery getIndexQuery(SampleEntity sampleEntity) {
return new IndexQueryBuilder()
.withId(sampleEntity.getId())
Expand Down