Skip to content

Separate out mergeMutation from patchMutation #2306

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

Merged
merged 1 commit into from
Jan 8, 2021
Merged

Separate out mergeMutation from patchMutation #2306

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
3 changes: 2 additions & 1 deletion firebase-firestore/src/test/java/com/google/firebase/firestore/local/LocalStoreTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import static com.google.firebase.firestore.testutil.TestUtil.filter;
import static com.google.firebase.firestore.testutil.TestUtil.key;
import static com.google.firebase.firestore.testutil.TestUtil.map;
import static com.google.firebase.firestore.testutil.TestUtil.mergeMutation;
import static com.google.firebase.firestore.testutil.TestUtil.noChangeEvent;
import static com.google.firebase.firestore.testutil.TestUtil.patchMutation;
import static com.google.firebase.firestore.testutil.TestUtil.query;
Expand Down Expand Up @@ -1298,7 +1299,7 @@ public void testHandlesMergeMutationWithTransformThenRemoteEvent() {
assertTargetId(2);

writeMutation(
patchMutation("foo/bar", map("sum", FieldValue.increment(1)), Collections.EMPTY_LIST));
mergeMutation("foo/bar", map("sum", FieldValue.increment(1)), Collections.EMPTY_LIST));
assertChanged(doc("foo/bar", 0, map("sum", 1), Document.DocumentState.LOCAL_MUTATIONS));
assertContains(doc("foo/bar", 0, map("sum", 1), Document.DocumentState.LOCAL_MUTATIONS));

Expand Down
5 changes: 3 additions & 2 deletions firebase-firestore/src/test/java/com/google/firebase/firestore/model/MutationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import static com.google.firebase.firestore.testutil.TestUtil.fieldMask;
import static com.google.firebase.firestore.testutil.TestUtil.key;
import static com.google.firebase.firestore.testutil.TestUtil.map;
import static com.google.firebase.firestore.testutil.TestUtil.mergeMutation;
import static com.google.firebase.firestore.testutil.TestUtil.mutationResult;
import static com.google.firebase.firestore.testutil.TestUtil.patchMutation;
import static com.google.firebase.firestore.testutil.TestUtil.setMutation;
Expand Down Expand Up @@ -84,7 +85,7 @@ public void testAppliesPatchToDocuments() {
public void testAppliesPatchWithMergeToDocuments() {
MaybeDocument baseDoc = deletedDoc("collection/key", 0);
Mutation upsert =
patchMutation(
mergeMutation(
"collection/key", map("foo.bar", "new-bar-value"), Arrays.asList(field("foo.bar")));
MaybeDocument newDoc = upsert.applyToLocalView(baseDoc, baseDoc, Timestamp.now());
Map<String, Object> expectedData = map("foo", map("bar", "new-bar-value"));
Expand All @@ -96,7 +97,7 @@ public void testAppliesPatchWithMergeToDocuments() {
public void testAppliesPatchToNullDocWithMergeToDocuments() {
MaybeDocument baseDoc = null;
Mutation upsert =
patchMutation(
mergeMutation(
"collection/key", map("foo.bar", "new-bar-value"), Arrays.asList(field("foo.bar")));
MaybeDocument newDoc = upsert.applyToLocalView(baseDoc, baseDoc, Timestamp.now());
Map<String, Object> expectedData = map("foo", map("bar", "new-bar-value"));
Expand Down
3 changes: 2 additions & 1 deletion ...se-firestore/src/test/java/com/google/firebase/firestore/remote/RemoteSerializerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import static com.google.firebase.firestore.testutil.TestUtil.filter;
import static com.google.firebase.firestore.testutil.TestUtil.key;
import static com.google.firebase.firestore.testutil.TestUtil.map;
import static com.google.firebase.firestore.testutil.TestUtil.mergeMutation;
import static com.google.firebase.firestore.testutil.TestUtil.orderBy;
import static com.google.firebase.firestore.testutil.TestUtil.patchMutation;
import static com.google.firebase.firestore.testutil.TestUtil.query;
Expand Down Expand Up @@ -362,7 +363,7 @@ public void testEncodesPatchMutation() {
@Test
public void testEncodesPatchMutationWithFieldMask() {
Mutation mutation =
patchMutation("docs/1", map("key", "value", "key2", true), asList(field("key")));
mergeMutation("docs/1", map("key", "value", "key2", true), asList(field("key")));

Write expected =
Write.newBuilder()
Expand Down
26 changes: 18 additions & 8 deletions firebase-firestore/src/testUtil/java/com/google/firebase/firestore/testutil/TestUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,12 +486,20 @@ public static SetMutation setMutation(String path, Map<String, Object> values) {
}

public static PatchMutation patchMutation(String path, Map<String, Object> values) {
return patchMutation(path, values, null);
return patchMutationHelper(path, values, Precondition.exists(true), null);
}

public static PatchMutation patchMutation(
String path, Map<String, Object> values, @Nullable List<FieldPath> updateMask) {
// Replace '<DELETE>' from JSON with FieldValue
public static PatchMutation mergeMutation(
String path, Map<String, Object> values, List<FieldPath> updateMask) {
return patchMutationHelper(path, values, Precondition.NONE, updateMask);
}

private static PatchMutation patchMutationHelper(
String path,
Map<String, Object> values,
Precondition precondition,
@Nullable List<FieldPath> updateMask) {
// Replace '<DELETE>' from JSON
for (Entry<String, Object> entry : values.entrySet()) {
if (entry.getValue().equals(DELETE_SENTINEL)) {
values.put(entry.getKey(), FieldValue.delete());
Expand All @@ -500,13 +508,15 @@ public static PatchMutation patchMutation(

UserDataReader dataReader = new UserDataReader(DatabaseId.forProject("project"));
ParsedUpdateData parsed = dataReader.parseUpdateData(values);
boolean merge = updateMask != null;

// `mergeMutation()` provides an update mask for the merged fields, whereas `patchMutation()`
// requires the update mask to be parsed from the values.
Collection<FieldPath> mask = updateMask != null ? updateMask : parsed.getFieldMask().getMask();

// We sort the fieldMaskPaths to make the order deterministic in tests. (Otherwise, when we
// flatten a Set to a proto repeated field, we'll end up comparing in iterator order and
// possibly consider {foo,bar} != {bar,foo}.)
SortedSet<FieldPath> fieldMaskPaths =
new TreeSet<>(merge ? updateMask : parsed.getFieldMask().getMask());
SortedSet<FieldPath> fieldMaskPaths = new TreeSet<>(mask);

// The order of the transforms doesn't matter, but we sort them so tests can assume a particular
// order.
Expand All @@ -518,7 +528,7 @@ public static PatchMutation patchMutation(
key(path),
parsed.getData(),
FieldMask.fromSet(fieldMaskPaths),
merge ? Precondition.NONE : Precondition.exists(true),
precondition,
fieldTransforms);
}

Expand Down