Not working yet.

Author: wu-hui

firebase-firestore/src/main/java/com/google/firebase/firestore/SetOptions.java

@@ -84,7 +84,7 @@ public static SetOptions mergeFields(@NonNull List<String> fields) {
       fieldPaths.add(FieldPath.fromDotSeparatedPath(field).getInternalPath());
     }
 
-    return new SetOptions(true, FieldMask.fromSet(fieldPaths));
+    return new SetOptions(true, FieldMask.someFieldsMask(fieldPaths));
   }
 
   /**
@@ -105,7 +105,7 @@ public static SetOptions mergeFields(String... fields) {
       fieldPaths.add(FieldPath.fromDotSeparatedPath(field).getInternalPath());
     }
 
-    return new SetOptions(true, FieldMask.fromSet(fieldPaths));
+    return new SetOptions(true, FieldMask.someFieldsMask(fieldPaths));
   }
 
   /**
@@ -125,7 +125,7 @@ public static SetOptions mergeFieldPaths(@NonNull List<FieldPath> fields) {
       fieldPaths.add(field.getInternalPath());
     }
 
-    return new SetOptions(true, FieldMask.fromSet(fieldPaths));
+    return new SetOptions(true, FieldMask.someFieldsMask(fieldPaths));
   }
 
   @Override

firebase-firestore/src/main/java/com/google/firebase/firestore/core/UserData.java

@@ -138,7 +138,7 @@ void addToFieldTransforms(FieldPath fieldPath, TransformOperation transformOpera
      */
     public ParsedSetData toMergeData(ObjectValue data) {
       return new ParsedSetData(
-          data, FieldMask.fromSet(fieldMask), unmodifiableList(fieldTransforms));
+          data, FieldMask.someFieldsMask(fieldMask), unmodifiableList(fieldTransforms));
     }
 
     /**
@@ -184,7 +184,7 @@ public ParsedSetData toSetData(ObjectValue data) {
      */
     public ParsedUpdateData toUpdateData(ObjectValue data) {
       return new ParsedUpdateData(
-          data, FieldMask.fromSet(fieldMask), unmodifiableList(fieldTransforms));
+          data, FieldMask.someFieldsMask(fieldMask), unmodifiableList(fieldTransforms));
     }
   }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/local/LocalDocumentsView.java

@@ -18,20 +18,19 @@
 import static com.google.firebase.firestore.util.Assert.hardAssert;
 
 import androidx.annotation.VisibleForTesting;
-import com.google.firebase.Timestamp;
+
 import com.google.firebase.database.collection.ImmutableSortedMap;
 import com.google.firebase.firestore.core.Query;
 import com.google.firebase.firestore.model.Document;
 import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.MutableDocument;
 import com.google.firebase.firestore.model.ResourcePath;
 import com.google.firebase.firestore.model.SnapshotVersion;
-import com.google.firebase.firestore.model.mutation.EmptyMutation;
+import com.google.firebase.firestore.model.mutation.FieldMask;
 import com.google.firebase.firestore.model.mutation.Mutation;
 import com.google.firebase.firestore.model.mutation.MutationBatch;
 import com.google.firebase.firestore.model.mutation.PatchMutation;
-import com.google.firebase.firestore.model.mutation.Precondition;
-import java.util.HashMap;
+
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
@@ -199,7 +198,6 @@ private ImmutableSortedMap<DocumentKey, Document> getDocumentsMatchingCollection
 
     remoteDocuments = addMissingBaseDocuments(matchingBatches, remoteDocuments);
 
-    Map<DocumentKey, Mutation> squashedMutations = new HashMap<>();
     for (MutationBatch batch : matchingBatches) {
       for (Mutation mutation : batch.getMutations()) {
         // Only process documents belonging to the collection.
@@ -214,19 +212,11 @@ private ImmutableSortedMap<DocumentKey, Document> getDocumentsMatchingCollection
           document = MutableDocument.newInvalidDocument(key);
           remoteDocuments = remoteDocuments.insert(key, document);
         }
-        Mutation squashed =
-            squashedMutations.containsKey(key)
-                ? squashedMutations.get(key)
-                : new EmptyMutation(key, Precondition.NONE);
-        squashedMutations.put(key, mutation.squash(squashed, document, batch.getLocalWriteTime()));
-      }
-    }
-
-    for (Map.Entry<DocumentKey, Mutation> entry : squashedMutations.entrySet()) {
-      MutableDocument document = remoteDocuments.get(entry.getKey());
-      entry.getValue().applyToLocalView(document, Timestamp.now());
-      if (!document.isFoundDocument()) {
-        remoteDocuments = remoteDocuments.remove(entry.getKey());
+        // TODO(Overlay): Here we should be reading squashed mutation and apply that instead.
+        mutation.applyToLocalView(document, batch.getLocalWriteTime(), FieldMask.someFieldsMask(new HashSet<>()));
+        if (!document.isFoundDocument()) {
+          remoteDocuments = remoteDocuments.remove(key);
+        }
       }
     }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/model/ObjectValue.java

@@ -89,7 +89,7 @@ private FieldMask extractFieldMask(MapValue value) {
         fields.add(currentPath);
       }
     }
-    return FieldMask.fromSet(fields);
+    return FieldMask.someFieldsMask(fields);
   }
 
   /**

firebase-firestore/src/main/java/com/google/firebase/firestore/model/mutation/DeleteMutation.java

@@ -19,7 +19,6 @@
 import androidx.annotation.Nullable;
 import com.google.firebase.Timestamp;
 import com.google.firebase.firestore.model.DocumentKey;
-import com.google.firebase.firestore.model.FieldPath;
 import com.google.firebase.firestore.model.MutableDocument;
 import com.google.firebase.firestore.model.ObjectValue;
 import com.google.firebase.firestore.model.SnapshotVersion;
@@ -71,27 +70,15 @@ public void applyToRemoteDocument(MutableDocument document, MutationResult mutat
   }
 
   @Override
-  public void applyToLocalView(MutableDocument document, Timestamp localWriteTime) {
+  public FieldMask applyToLocalView(MutableDocument document, Timestamp localWriteTime, FieldMask mask) {
     verifyKeyMatches(document);
 
     if (getPrecondition().isValidFor(document)) {
       document.convertToNoDocument(SnapshotVersion.NONE);
+      return FieldMask.allFieldsMask();
     }
-  }
 
-  @Override
-  public Mutation squash(
-      Mutation baseMutation, MutableDocument document, Timestamp localWriteTime) {
-    if (getPrecondition().isValidFor(document)) {
-      return this;
-    } else {
-      return baseMutation;
-    }
-  }
-
-  @Override
-  protected FieldUpdate getFieldUpdate(FieldPath fieldPath) {
-    return new FieldUpdate(FieldUpdate.Type.DELETE, null);
+    return mask;
   }
 
   @Nullable

firebase-firestore/src/main/java/com/google/firebase/firestore/model/mutation/EmptyMutation.java

@@ -15,6 +15,8 @@
 package com.google.firebase.firestore.model.mutation;
 
 import com.google.firebase.firestore.model.FieldPath;
+
+import java.util.HashSet;
 import java.util.Set;
 
 /**
@@ -26,14 +28,29 @@
  * object foo. If foo is not an object, foo is replaced with an object containing foo.
  */
 public final class FieldMask {
-  public static FieldMask fromSet(Set<FieldPath> mask) {
-    return new FieldMask(mask);
+  public static FieldMask someFieldsMask(Set<FieldPath> mask) {
+    return new FieldMask(mask, Scope.Some);
+  }
+
+  public static FieldMask allFieldsMask() {
+    return new FieldMask(new HashSet<FieldPath>(), Scope.All_Fields);
+  }
+
+  public static FieldMask emptyMask() {
+    return new FieldMask(new HashSet<FieldPath>(), Scope.None);
   }
 
   private final Set<FieldPath> mask;
+  private enum Scope{
+    All_Fields,
+    None,
+    Some
+  }
+  private Scope scope = Scope.None;
 
-  private FieldMask(Set<FieldPath> mask) {
+  private FieldMask(Set<FieldPath> mask, Scope scope) {
     this.mask = mask;
+    this.scope = scope;
   }
 
   @Override
@@ -77,4 +94,16 @@ public int hashCode() {
   public Set<FieldPath> getMask() {
     return mask;
   }
+
+  public boolean isAllFields() {
+    return scope == Scope.All_Fields;
+  }
+
+  public boolean isNoneFields() {
+    return scope == Scope.None;
+  }
+
+  public boolean isSomeFields() {
+    return scope == Scope.Some;
+  }
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/model/mutation/FieldMask.java

@@ -113,26 +113,10 @@ public abstract void applyToRemoteDocument(
    * @param document The document to mutate.
    * @param localWriteTime A timestamp indicating the local write time of the batch this mutation is
    *     a part of.
+   * @param mask The fields that have been updated before applying this mutation.
+   * @return A {@code FieldMask} representing the fields that are changed by applying this mutation.
    */
-  public abstract void applyToLocalView(MutableDocument document, Timestamp localWriteTime);
-
-  /**
-   * Builds a new mutation that would do the same as applying {@code baseMutation}, then {@code
-   * this} on the given document. Consider this as a git rebase operation.
-   *
-   * <p>One thing to note is the returned mutation should never have any un-applied transforms, if
-   * {@code this} has outstanding transforms, they need to be applied first, and their final value
-   * should be saved in the value of the returning mutation.
-   *
-   * @param baseMutation The mutation to first apply to the document. This is either {@code
-   *     EmptyMutation} or from previous calls to {@code squash}.
-   * @param document The document for which this squashing is applied to.
-   * @param localWriteTime A timestamp indicating the local write time of the batch this mutation is
-   *     a part of.
-   * @return A new mutation squashed mutation.
-   */
-  public abstract Mutation squash(
-      Mutation baseMutation, MutableDocument document, Timestamp localWriteTime);
+  public abstract FieldMask applyToLocalView(MutableDocument document, Timestamp localWriteTime, FieldMask mask);
 
   /** Helper for derived classes to implement .equals(). */
   boolean hasSameKeyAndPrecondition(Mutation other) {
@@ -213,43 +197,12 @@ protected Map<FieldPath, Value> localTransformResults(
     for (FieldTransform fieldTransform : fieldTransforms) {
       TransformOperation transform = fieldTransform.getOperation();
       Value previousValue = mutableDocument.getField(fieldTransform.getFieldPath());
-      if (mutation != null && !(mutation instanceof EmptyMutation)) {
-        FieldUpdate update = mutation.getFieldUpdate(fieldTransform.getFieldPath());
-        if (update.type == FieldUpdate.Type.DELETE) {
-          previousValue = null;
-        } else if (update.type == FieldUpdate.Type.SET) {
-          previousValue = update.value;
-        }
-      }
       transformResults.put(
           fieldTransform.getFieldPath(), transform.applyToLocalView(previousValue, localWriteTime));
     }
     return transformResults;
   }
 
-  /** A class specifying what a mutation would do to a field in a document. */
-  protected static class FieldUpdate {
-    protected enum Type {
-      // This mutation would do nothing.
-      ABSENT,
-      // This mutation would delete the field in question.
-      DELETE,
-      // This mutation would set the field in question to a value.
-      SET,
-    }
-
-    private Type type;
-    private Value value;
-
-    public FieldUpdate(Type type, Value value) {
-      this.type = type;
-      this.value = value;
-    }
-  }
-
-  /** Returns what this mutation would do to a given {@code FieldPath}. */
-  protected abstract FieldUpdate getFieldUpdate(FieldPath fieldPath);
-
   protected List<FieldPath> getFieldTransformPaths() {
     List<FieldPath> result = new ArrayList<>();
     for (FieldTransform fieldTransform : fieldTransforms) {