Merge pull request #513 from jimit-j-shah/jimit/506_nullvalue_demo_test

stickfigure · web-flow · commit ca7c9990c958 · 2024-07-23T19:31:40.000-07:00
test: Fix handling NullValue in embedded maps
diff --git a/src/main/java/com/googlecode/objectify/impl/translate/CollectionTranslatorFactory.java b/src/main/java/com/googlecode/objectify/impl/translate/CollectionTranslatorFactory.java
@@ -44,11 +44,6 @@ public Translator<Collection<Object>, List<? extends Value<?>>> create(final Typ
 
 			@Override
 			public Collection<Object> loadInto(final Value<List<? extends Value<?>>> node, final LoadContext ctx, final Path path, Collection<Object> collection) throws SkipException {
-				// If the collection does not exist, skip it entirely. This mirrors the OLD underlying behavior
-				// of collections in the datastore; if they are empty, they don't exist.
-				if (node == null || node.get() == null)
-					throw new SkipException();
-
 				if (collection == null)
 					//noinspection unchecked
 					collection = (Collection<Object>)fact.constructCollection(collectionType, node.get().size());
diff --git a/src/main/java/com/googlecode/objectify/impl/translate/EmbeddedMapTranslatorFactory.java b/src/main/java/com/googlecode/objectify/impl/translate/EmbeddedMapTranslatorFactory.java
@@ -70,10 +70,6 @@ else if (keyTypeErased == Key.class)
 
 			@Override
 			public Map<Object, Object> loadInto(final Value<FullEntity<?>> node, final LoadContext ctx, final Path path, Map<Object, Object> into) {
-				// Make this work more like collections than atomic values
-				if (node == null)
-					throw new SkipException();
-
 				if (into == null)
 					//noinspection unchecked
 					into = (Map<Object, Object>)fact.constructMap(mapType);
diff --git a/src/main/java/com/googlecode/objectify/impl/translate/TranslatorRecycles.java b/src/main/java/com/googlecode/objectify/impl/translate/TranslatorRecycles.java
@@ -1,6 +1,7 @@
 package com.googlecode.objectify.impl.translate;
 
 import com.google.cloud.datastore.Value;
+import com.google.cloud.datastore.ValueType;
 import com.googlecode.objectify.impl.Path;
 
 /**
@@ -13,6 +14,13 @@
 abstract public class TranslatorRecycles<P, D> implements Translator<P, D>, Recycles {
 	@Override
 	final public P load(final Value<D> node, final LoadContext ctx, final Path path) throws SkipException {
+		// If the underlying container (Map, EmbeddedMap or Collection) does not exist or is of type
+		// NullValue, skip it entirely. For Collections, this mirrors the OLD underlying behavior of
+		// collections in the datastore; if they are empty, they don't exist.
+		if (node == null || node.getType() == ValueType.NULL) {
+			throw new SkipException();
+		}
+
 		@SuppressWarnings("unchecked")
 		final P into = (P)ctx.useRecycled();
 
diff --git a/src/test/java/com/googlecode/objectify/test/StrangeNullishTests.java b/src/test/java/com/googlecode/objectify/test/StrangeNullishTests.java
@@ -0,0 +1,54 @@
+package com.googlecode.objectify.test;
+
+import com.google.cloud.datastore.NullValue;
+import com.googlecode.objectify.annotation.Entity;
+import com.googlecode.objectify.annotation.Id;
+import com.googlecode.objectify.test.util.TestBase;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.junit.jupiter.api.Test;
+
+import java.util.Map;
+
+import static com.googlecode.objectify.ObjectifyService.factory;
+import static com.googlecode.objectify.ObjectifyService.ofy;
+
+// This class tests Objectify APIs handling of Embedded NullValue by comparing with Entitites
+// written and read using raw Datastore API calls.
+public class StrangeNullishTests extends TestBase {
+
+	@Entity(name = "Sample")
+	@Data
+	@NoArgsConstructor
+	@AllArgsConstructor
+	public static class Sample {
+		@Id String name;
+		Map<String, String> inner;
+	}
+
+	/**
+	 * Verifies correctly loading NullValue embedded in a Map
+	 */
+	@Test
+	public void loadSimplerNestedStructureWithNulls() {
+		factory().register(Sample.class);
+
+		final String rawDatastoreDocId = "EmbeddedMapNullValue_rawDatastoreDoc";
+		final com.google.cloud.datastore.Key rawDatastoreKey = datastore().newKeyFactory()
+				.setKind("Sample")
+				.newKey(rawDatastoreDocId);
+
+		final com.google.cloud.datastore.Entity rawSample =
+				com.google.cloud.datastore.Entity.newBuilder(rawDatastoreKey)
+						.set("inner", new NullValue())
+						.build();
+
+		// Save to Datastore
+		datastore().put(rawSample);
+
+		// Verify using Objectify `load` API
+		final Sample sample = ofy().load().type(Sample.class).id(rawDatastoreDocId).now();
+		// Just verifying this loads without NPE is success
+	}
+}
