#58 - Add sample for usage of Serverside Java Script.

Use a serverside script to simulate putIfAbsent as contracted by the Map interface. The op will be atomic since mongoDB will put a lock on db until the script is finished.

Author: christophstrobl

mongodb/example/src/main/java/example/springdata/mongodb/advanced/AdvancedRepository.java

@@ -27,7 +27,7 @@
  * 
  * @author Christoph Strobl
  */
-public interface AdvancedRepository extends CustomerRepository {
+public interface AdvancedRepository extends CustomerRepository, AdvancedRepositoryCustom {
 
 	String META_COMMENT = "s2gx-2014-rocks!";
 

mongodb/example/src/main/java/example/springdata/mongodb/advanced/AdvancedRepositoryCustom.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2015 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example.springdata.mongodb.advanced;
+
+import java.util.Map;
+
+import example.springdata.mongodb.customer.Customer;
+
+/**
+ * @author Christoph Strobl
+ */
+public interface AdvancedRepositoryCustom {
+
+	/**
+	 * If the specified customer is not already persisted in MongoDB (or is mapped to {@code null}) associates it with the
+	 * given value and returns {@code null}, else returns the current value.
+	 * 
+	 * @see Map#putIfAbsent(Object, Object)
+	 * @param customer
+	 * @return {@literal null} when inserted otherwise existing {@link Customer}
+	 */
+	Customer putIfAbsent(Customer customer);
+
+}

mongodb/example/src/main/java/example/springdata/mongodb/advanced/AdvancedRepositoryImpl.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2015 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example.springdata.mongodb.advanced;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.data.mongodb.core.script.ExecutableMongoScript;
+
+import com.mongodb.BasicDBObject;
+import com.mongodb.DBObject;
+
+import example.springdata.mongodb.customer.Customer;
+
+/**
+ * @author Christoph Strobl
+ */
+public class AdvancedRepositoryImpl implements AdvancedRepositoryCustom {
+
+	@Autowired MongoOperations mongoOps;
+
+	/*
+	 * (non-Javadoc)
+	 * @see example.springdata.mongodb.advanced.AdvancedRepositoryCustom#putIfAbsent(example.springdata.mongodb.customer.Customer)
+	 */
+	@Override
+	public Customer putIfAbsent(Customer customer) {
+
+		if (!mongoOps.collectionExists(Customer.class)) {
+			mongoOps.createCollection(Customer.class);
+		}
+
+		Object result = mongoOps.scriptOps().execute(createScript(customer));
+		if (result == null) {
+			return null;
+		}
+
+		return mongoOps.getConverter().read(Customer.class, (DBObject) result);
+	}
+
+	private ExecutableMongoScript createScript(Object entity) {
+
+		String collectionName = mongoOps.getCollectionName(Customer.class);
+		Object id = mongoOps.getConverter().getMappingContext().getPersistentEntity(Customer.class)
+				.getIdentifierAccessor(entity).getIdentifier();
+
+		DBObject dbo = new BasicDBObject();
+		mongoOps.getConverter().write(entity, dbo);
+
+		String scriptString = String
+				.format(
+						"object  =  db.%1$s.findOne('{\"_id\": \"%2$s\"}'); if(object == null) { db.%1s.insert(%3$s); return null; } else { return object; }",
+						collectionName, id, dbo);
+
+		return new ExecutableMongoScript(scriptString);
+	}
+}

mongodb/example/src/main/java/example/springdata/mongodb/customer/Customer.java

@@ -17,7 +17,6 @@
 
 import lombok.Data;
 
-import org.bson.types.ObjectId;
 import org.springframework.data.mongodb.core.mapping.Document;
 import org.springframework.util.Assert;
 
@@ -30,7 +29,7 @@
 @Document
 public class Customer {
 
-	private ObjectId id;
+	private String id;
 	private String firstname, lastname;
 
 	private Address address;

mongodb/example/src/main/java/example/springdata/mongodb/customer/CustomerRepository.java

@@ -17,7 +17,6 @@
 
 import java.util.List;
 
-import org.bson.types.ObjectId;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.geo.Distance;
 import org.springframework.data.geo.GeoResults;
@@ -29,7 +28,7 @@
  * 
  * @author Oliver Gierke
  */
-public interface CustomerRepository extends CrudRepository<Customer, ObjectId> {
+public interface CustomerRepository extends CrudRepository<Customer, String> {
 
 	/**
 	 * Derived query using dynamic sort information.

mongodb/example/src/test/java/example/springdata/mongodb/advanced/ServersideScriptTests.java

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2015 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example.springdata.mongodb.advanced;
+
+import static org.hamcrest.core.Is.*;
+import static org.hamcrest.core.IsNull.*;
+import static org.junit.Assert.*;
+
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.SpringApplicationConfiguration;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.data.mongodb.core.script.ExecutableMongoScript;
+import org.springframework.data.mongodb.core.script.NamedMongoScript;
+import org.springframework.data.util.Version;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+import com.mongodb.BasicDBObject;
+
+import example.springdata.mongodb.customer.Customer;
+import example.springdata.mongodb.util.RequiresMongoDB;
+
+/**
+ * @author Christoph Strobl
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@SpringApplicationConfiguration(classes = ApplicationConfiguration.class)
+public class ServersideScriptTests {
+
+	@ClassRule public static RequiresMongoDB mongodbAvailable = RequiresMongoDB.atLeast(new Version(2, 6));
+
+	@Autowired AdvancedRepository repository;
+	@Autowired MongoOperations operations;
+
+	@Before
+	public void setUp() {
+
+		// just make sure we remove everything properly
+		operations.getCollection("system.js").remove(new BasicDBObject());
+		repository.deleteAll();
+	}
+
+	/**
+	 * Use a script execution to create an atomic put-if-absent operation that fulfills the contract of
+	 * {@link Map#putIfAbsent(Object, Object)}
+	 */
+	@Test
+	public void putIfAbsent() {
+
+		Customer ned = new Customer("Ned", "Stark");
+		ned.setId("ned-stark");
+
+		// #1: on first insert null has to be returned
+		assertThat(repository.putIfAbsent(ned), nullValue());
+
+		// #2: change the firstname and put again, we expect to the existing customer without the change
+		ned.setFirstname("Eddard");
+		assertThat(repository.putIfAbsent(ned).getFirstname(), is("Ned"));
+
+		// #3: make sure the entity has not been altered by #2
+		assertThat(repository.findOne(ned.getId()).getFirstname(), is("Ned"));
+	}
+
+	/**
+	 * Store and call an arbitary JavaScript function (in this case a simple echo script) via its name.
+	 */
+	@Test
+	public void simpleScriptExecution() {
+
+		operations.scriptOps().register(
+				new NamedMongoScript("echoScript", new ExecutableMongoScript("function(x) { return x; }")));
+
+		Object o = operations.scriptOps().call("echoScript", "Hello echo...!");
+		assertThat(o, is((Object) "Hello echo...!"));
+	}
+}