Skip to content

Implemented BulkOperations API in MongoItemWriter #3721

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
wants to merge 1 commit into from
Closed

Implemented BulkOperations API in MongoItemWriter #3721

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
37 changes: 30 additions & 7 deletions ...tch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoItemWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -19,12 +19,22 @@
import java.util.ArrayList;
import java.util.List;

import org.bson.Document;
import org.bson.types.ObjectId;

import org.springframework.batch.item.ItemWriter;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.data.mongodb.core.BulkOperations;
import org.springframework.data.mongodb.core.BulkOperations.BulkMode;
import org.springframework.data.mongodb.core.FindAndReplaceOptions;
import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.convert.MongoConverter;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.transaction.support.TransactionSynchronizationAdapter;
import org.springframework.transaction.support.TransactionSynchronizationManager;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;

Expand All @@ -42,6 +52,7 @@
* </p>
*
* @author Michael Minella
* @author Parikshit Dutta
*
*/
public class MongoItemWriter<T> implements ItemWriter<T>, InitializingBean {
Expand Down Expand Up @@ -133,16 +144,28 @@ protected void doWrite(List<? extends T> items) {
}
}
else {
BulkOperations bulkOperations = null;

if(StringUtils.hasText(collection)) {
for (Object object : items) {
template.save(object, collection);
}
bulkOperations = template.bulkOps(BulkMode.ORDERED, collection);
}
else {
for (Object object : items) {
template.save(object);
}
bulkOperations = template.bulkOps(BulkMode.ORDERED, ClassUtils.getUserClass(items.get(0)));
}

for (Object object : items) {
Document document = new Document();

MongoConverter mongoConverter = template.getConverter();
mongoConverter.write(object, document);

Query query = new Query();
query.addCriteria(Criteria.where("_id").is((document.get("_id") != null)
? document.get("_id") : new ObjectId()));

bulkOperations.replaceOne(query, document, new FindAndReplaceOptions().upsert());
}
bulkOperations.execute();
}
}
}
Expand Down
73 changes: 53 additions & 20 deletions ...nfrastructure/src/test/java/org/springframework/batch/item/data/MongoItemWriterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2017 the original author or authors.
* Copyright 2013-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -19,36 +19,55 @@
import java.util.Collections;
import java.util.List;

import org.bson.Document;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import org.springframework.batch.support.transaction.ResourcelessTransactionManager;
import org.springframework.data.mongodb.core.BulkOperations;
import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.convert.MongoConverter;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.support.TransactionCallback;
import org.springframework.transaction.support.TransactionTemplate;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verifyZeroInteractions;

/**
* @author Michael Minella
* @author Parikshit Dutta
*/
@SuppressWarnings("serial")
public class MongoItemWriterTests {

private MongoItemWriter<Object> writer;
@Mock
private MongoOperations template;
@Mock
private BulkOperations bulkOperations;
@Mock
private MongoConverter mongoConverter;
private PlatformTransactionManager transactionManager = new ResourcelessTransactionManager();

@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
when(template.bulkOps(any(), anyString())).thenReturn(bulkOperations);
when(template.bulkOps(any(), any(Class.class))).thenReturn(bulkOperations);
when(template.getConverter()).thenReturn(mongoConverter);

writer = new MongoItemWriter<>();
writer.setTemplate(template);
writer.afterPropertiesSet();
Expand Down Expand Up @@ -77,8 +96,8 @@ public void testWriteNoTransactionNoCollection() throws Exception {

writer.write(items);

verify(template).save(items.get(0));
verify(template).save(items.get(1));
verify(template).bulkOps(any(), any(Class.class));
verify(bulkOperations, times(2)).replaceOne(any(Query.class), any(Object.class), any());
}

@Test
Expand All @@ -92,15 +111,16 @@ public void testWriteNoTransactionWithCollection() throws Exception {

writer.write(items);

verify(template).save(items.get(0), "collection");
verify(template).save(items.get(1), "collection");
verify(template).bulkOps(any(), anyString());
verify(bulkOperations, times(2)).replaceOne(any(Query.class), any(Object.class), any());
}

@Test
public void testWriteNoTransactionNoItems() throws Exception {
writer.write(null);

verifyZeroInteractions(template);
verifyZeroInteractions(bulkOperations);
}

@Test
Expand All @@ -120,8 +140,8 @@ public void testWriteTransactionNoCollection() throws Exception {
return null;
});

verify(template).save(items.get(0));
verify(template).save(items.get(1));
verify(template).bulkOps(any(), any(Class.class));
verify(bulkOperations, times(2)).replaceOne(any(Query.class), any(Object.class), any());
}

@Test
Expand All @@ -143,8 +163,8 @@ public void testWriteTransactionWithCollection() throws Exception {
return null;
});

verify(template).save(items.get(0), "collection");
verify(template).save(items.get(1), "collection");
verify(template).bulkOps(any(), anyString());
verify(bulkOperations, times(2)).replaceOne(any(Query.class), any(Object.class), any());
}

@Test
Expand Down Expand Up @@ -172,6 +192,7 @@ public void testWriteTransactionFails() throws Exception {
}

verifyZeroInteractions(template);
verifyZeroInteractions(bulkOperations);
}

/**
Expand Down Expand Up @@ -203,6 +224,7 @@ public void testWriteTransactionReadOnly() throws Exception {
}

verifyZeroInteractions(template);
verifyZeroInteractions(bulkOperations);
}

@Test
Expand Down Expand Up @@ -234,31 +256,43 @@ public void testRemoveNoTransactionWithCollection() throws Exception {
verify(template).remove(items.get(0), "collection");
verify(template).remove(items.get(1), "collection");
}
// BATCH-2018

// BATCH-2018, test code updated to pass BATCH-3713
@Test
public void testResourceKeyCollision() throws Exception {
final int limit = 5000;
@SuppressWarnings("unchecked")
List<MongoItemWriter<String>> writers = new ArrayList<>(limit);
final String[] documents = new String[limit];
final String[] results = new String[limit];
for(int i = 0; i< limit; i++) {
final int index = i;
MongoOperations mongoOperations = mock(MongoOperations.class);

BulkOperations bulkOperations = mock(BulkOperations.class);
MongoConverter mongoConverter = mock(MongoConverter.class);

when(mongoOperations.bulkOps(any(), any(Class.class))).thenReturn(bulkOperations);
when(mongoOperations.getConverter()).thenReturn(mongoConverter);

// mocking the object to document conversion which is used in forming bulk operation
doAnswer(invocation -> {
documents[index] = (String) invocation.getArguments()[0];
return null;
}).when(mongoConverter).write(any(String.class), any(Document.class));

doAnswer(invocation -> {
String val = (String) invocation.getArguments()[0];
if(results[index] == null) {
results[index] = val;
results[index] = documents[index];
} else {
results[index] += val;
results[index] += documents[index];
}
return null;
}).when(mongoOperations).save(any(String.class));
}).when(bulkOperations).replaceOne(any(Query.class), any(Document.class), any());

writers.add(i, new MongoItemWriter<>());
writers.get(i).setTemplate(mongoOperations);
}

new TransactionTemplate(transactionManager).execute((TransactionCallback<Void>) status -> {
try {
for(int i=0; i< limit; i++) {
Expand All @@ -270,10 +304,9 @@ public void testResourceKeyCollision() throws Exception {
}
return null;
});

for(int i=0; i< limit; i++) {
assertEquals(String.valueOf(i), results[i]);
}
}
}

}