refactor(firestore): Merge BsonBinaryData into Blob

This PR stacks on PR #2378 and implements the refactoring to merge BsonBinaryData into Blob, as requested by the user.

- Remove isBson property from Blob.java
- Update UserDataConverter to check blob.subtype() != 0
- Add BSON binary subtype 0 roundtrip unit tests
- Add BSON binary subtype 1 local sorting verification tests

Author: wu-hui

java-firestore/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Blob.java

@@ -28,16 +28,14 @@ public final class Blob implements Serializable {
 
   private final ByteString byteString;
   private final int subtype;
-  private final boolean isBson;
 
-  private Blob(ByteString byteString, int subtype, boolean isBson) {
+  private Blob(ByteString byteString, int subtype) {
     if (subtype < 0 || subtype > 255) {
       throw new IllegalArgumentException(
           "The subtype for Blob must be a value in the inclusive [0, 255] range.");
     }
     this.byteString = byteString;
     this.subtype = subtype;
-    this.isBson = isBson;
   }
 
   /**
@@ -49,7 +47,7 @@ private Blob(ByteString byteString, int subtype, boolean isBson) {
    */
   @Nonnull
   public static Blob fromByteString(@Nonnull ByteString byteString) {
-    return new Blob(byteString, 0, false);
+    return new Blob(byteString, 0);
   }
 
   /**
@@ -61,7 +59,7 @@ public static Blob fromByteString(@Nonnull ByteString byteString) {
    */
   @Nonnull
   public static Blob fromBytes(@Nonnull byte[] bytes) {
-    return new Blob(ByteString.copyFrom(bytes), 0, false);
+    return new Blob(ByteString.copyFrom(bytes), 0);
   }
 
   /**
@@ -73,7 +71,7 @@ public static Blob fromBytes(@Nonnull byte[] bytes) {
    */
   @Nonnull
   public static Blob createBsonBinary(@Nonnull byte[] bytes) {
-    return new Blob(ByteString.copyFrom(bytes), 0, true);
+    return new Blob(ByteString.copyFrom(bytes), 0);
   }
 
   /**
@@ -85,7 +83,7 @@ public static Blob createBsonBinary(@Nonnull byte[] bytes) {
    */
   @Nonnull
   public static Blob createBsonBinary(@Nonnull ByteString data) {
-    return new Blob(data, 0, true);
+    return new Blob(data, 0);
   }
 
   /**
@@ -98,7 +96,7 @@ public static Blob createBsonBinary(@Nonnull ByteString data) {
    */
   @Nonnull
   public static Blob createBsonBinary(int subtype, @Nonnull byte[] bytes) {
-    return new Blob(ByteString.copyFrom(bytes), subtype, true);
+    return new Blob(ByteString.copyFrom(bytes), subtype);
   }
 
   /**
@@ -111,7 +109,7 @@ public static Blob createBsonBinary(int subtype, @Nonnull byte[] bytes) {
    */
   @Nonnull
   public static Blob createBsonBinary(int subtype, @Nonnull ByteString data) {
-    return new Blob(data, subtype, true);
+    return new Blob(data, subtype);
   }
 
   /**
@@ -144,15 +142,6 @@ public int subtype() {
     return this.subtype;
   }
 
-  /**
-   * Returns whether this Blob represents a BSON binary data type.
-   *
-   * @return True if BSON representation, false if native representation.
-   */
-  public boolean isBson() {
-    return this.isBson;
-  }
-
   /**
    * Returns true if this Blob is equal to the provided object.
    *
@@ -194,6 +183,6 @@ public String toString() {
               + this.byteString.size()
               + ")";
     }
-    return "Blob{subtype=" + this.subtype + ", isBson=" + this.isBson + ", data=" + dataStr + "}";
+    return "Blob{subtype=" + this.subtype + ", data=" + dataStr + "}";
   }
 }

java-firestore/google-cloud-firestore/src/main/java/com/google/cloud/firestore/UserDataConverter.java

@@ -173,7 +173,7 @@ static Value encodeValue(
       return Value.newBuilder().setGeoPointValue(geopoint.toProto()).build();
     } else if (sanitizedObject instanceof Blob) {
       Blob blob = (Blob) sanitizedObject;
-      if (blob.isBson() && blob.subtype() != 0) {
+      if (blob.subtype() != 0) {
         return Value.newBuilder()
             .setMapValue(encodeBsonBinaryData(blob.subtype(), blob.toByteString()))
             .build();

java-firestore/google-cloud-firestore/src/test/java/com/google/cloud/firestore/ExtendedTypesTest.java

@@ -544,4 +544,13 @@ public void canEncodeAndDecodeBsonBinaryData() {
             .build();
     assertEncodesAndDecodesCorrectly(proto, bsonBinaryData);
   }
+
+  @Test
+  public void canEncodeAndDecodeBsonBinaryDataSubtype0() {
+    Blob bsonBinaryData = Blob.createBsonBinary(0, new byte[] {1, 2, 3});
+    Value proto =
+        Value.newBuilder().setBytesValue(ByteString.copyFrom(new byte[] {1, 2, 3})).build();
+    // BSON binary subtype 0 matches standard native Blob
+    assertEncodesAndDecodesCorrectly(proto, bsonBinaryData);
+  }
 }

java-firestore/google-cloud-firestore/src/test/java/com/google/cloud/firestore/OrderTest.java

@@ -128,6 +128,12 @@ public void verifyOrder() {
     groups.add(new Value[] {blobValue(new byte[] {0, 1, 2, 4, 3})});
     groups.add(new Value[] {blobValue(new byte[] {127})});
 
+    // BSON Binary Data Subtype 1
+    groups.add(new Value[] {bsonBinaryData(1, new byte[] {})});
+    groups.add(new Value[] {bsonBinaryData(1, new byte[] {0}), bsonBinaryData(1, new byte[] {0})});
+    groups.add(new Value[] {bsonBinaryData(1, new byte[] {0, 1, 2, 3, 4})});
+    groups.add(new Value[] {bsonBinaryData(1, new byte[] {0, 1, 2, 4, 3})});
+
     // BSON Binary Data
     groups.add(new Value[] {bsonBinaryData(5, new byte[] {})});
     groups.add(new Value[] {bsonBinaryData(5, new byte[] {0}), bsonBinaryData(5, new byte[] {0})});