Firestore VectorValue type (#13404)

Co-authored-by: Nick Cooke <[email protected]>

Author: MarkDuckworth

FirebaseFirestoreInternal/FirebaseFirestore/FIRVectorValue.h

@@ -0,0 +1,15 @@
+// Copyright 2024 Google LLC
+//
+// 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.
+
+#import <FirebaseFirestoreInternal/FIRVectorValue.h>

Firestore/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 11.1.0
+- [feature] Add `VectorValue` type support.
+
 # 11.0.0
 - [removed] **Breaking change**: The deprecated `FirebaseFirestoreSwift` module
   has been removed. See

Firestore/Example/Firestore.xcodeproj/project.pbxproj

@@ -26,8 +26,17 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      enableASanStackUseAfterReturn = "YES"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      enableASanStackUseAfterReturn = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "6003F5AD195388D20070C39A"
+            BuildableName = "Firestore_Tests_iOS.xctest"
+            BlueprintName = "Firestore_Tests_iOS"
+            ReferencedContainer = "container:Firestore.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
       <Testables>
          <TestableReference
             skipped = "NO">
@@ -40,17 +49,6 @@
             </BuildableReference>
          </TestableReference>
       </Testables>
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "6003F5AD195388D20070C39A"
-            BuildableName = "Firestore_Tests_iOS.xctest"
-            BlueprintName = "Firestore_Tests_iOS"
-            ReferencedContainer = "container:Firestore.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
@@ -71,8 +69,6 @@
             ReferencedContainer = "container:Firestore.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"

Firestore/Example/Firestore.xcodeproj/xcshareddata/xcschemes/Firestore_Tests_iOS.xcscheme

@@ -15,6 +15,7 @@
  */
 
 #import <FirebaseFirestore/FIRFieldValue.h>
+#import <FirebaseFirestore/FIRVectorValue.h>
 
 #import <XCTest/XCTest.h>
 

Firestore/Example/Tests/API/FIRFieldValueTests.mm

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * 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.
+ */
+
+#import <FirebaseFirestore/FIRFieldValue.h>
+#import <FirebaseFirestore/FIRVectorValue.h>
+
+#import <XCTest/XCTest.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FIRVectorValueTests : XCTestCase
+@end
+
+@implementation FIRVectorValueTests
+
+- (void)testCreateAndReadVectorValue {
+  FIRVectorValue *vector = [FIRFieldValue vectorWithArray:@[
+    @DBL_MIN, @0.0, [NSNumber numberWithLong:((long)pow(2, 53)) + 1], @DBL_MAX, @DBL_EPSILON,
+    @INT64_MAX
+  ]];
+  NSArray<NSNumber *> *outArray = vector.array;
+
+  XCTAssertEqualObjects([outArray objectAtIndex:0], @DBL_MIN);
+  XCTAssertEqualObjects([outArray objectAtIndex:1], @0.0);
+  // Assert that if the vector is created with large long values,
+  // then the data will be truncated as a double.
+  XCTAssertEqual([outArray objectAtIndex:2].longValue, pow(2, 53));
+  XCTAssertEqualObjects([outArray objectAtIndex:3], @DBL_MAX);
+  XCTAssertEqualObjects([outArray objectAtIndex:4], @DBL_EPSILON);
+  XCTAssertEqualObjects([outArray objectAtIndex:5], @INT64_MAX);
+}
+
+@end
+
+NS_ASSUME_NONNULL_END

Firestore/Example/Tests/API/FIRVectorValueTests.mm

@@ -15,6 +15,7 @@
  */
 
 #import "Firestore/Source/API/FIRFieldValue+Internal.h"
+#import "Firestore/Source/Public/FirebaseFirestore/FIRVectorValue.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -176,6 +177,10 @@ + (instancetype)fieldValueForIntegerIncrement:(int64_t)l {
   return [[FSTNumericIncrementFieldValue alloc] initWithOperand:@(l)];
 }
 
++ (nonnull FIRVectorValue *)vectorWithArray:(nonnull NSArray<NSNumber *> *)array {
+  return [[FIRVectorValue alloc] initWithArray:array];
+}
+
 @end
 
 NS_ASSUME_NONNULL_END

Firestore/Source/API/FIRFieldValue.mm

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+#include "Firestore/Source/Public/FirebaseFirestore/FIRVectorValue.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@implementation FIRVectorValue
+
+- (instancetype)initWithArray:(NSArray<NSNumber *> *)array {
+  if (self = [super init]) {
+    _array = [array valueForKey:@"doubleValue"];
+  }
+  return self;
+}
+
+- (BOOL)isEqual:(nullable id)object {
+  if (self == object) {
+    return YES;
+  }
+
+  if (![object isKindOfClass:[FIRVectorValue class]]) {
+    return NO;
+  }
+
+  FIRVectorValue *otherVector = ((FIRVectorValue *)object);
+
+  return [self.array isEqualToArray:otherVector.array];
+}
+
+@end
+
+NS_ASSUME_NONNULL_END

Firestore/Source/API/FIRVectorValue.m

@@ -25,6 +25,7 @@
 #import "Firestore/Source/API/FSTUserDataReader.h"
 
 #import "FIRGeoPoint.h"
+#import "FIRVectorValue.h"
 
 #import "Firestore/Source/API/FIRDocumentReference+Internal.h"
 #import "Firestore/Source/API/FIRFieldPath+Internal.h"
@@ -341,6 +342,42 @@ - (ParsedUpdateData)parsedUpdateData:(id)input {
   return std::move(result);
 }
 
+- (Message<google_firestore_v1_Value>)parseVectorValue:(FIRVectorValue *)vectorValue
+                                               context:(ParseContext &&)context {
+  __block Message<google_firestore_v1_Value> result;
+  result->which_value_type = google_firestore_v1_Value_map_value_tag;
+  result->map_value = {};
+
+  result->map_value.fields_count = 2;
+  result->map_value.fields = nanopb::MakeArray<google_firestore_v1_MapValue_FieldsEntry>(2);
+
+  result->map_value.fields[0].key = nanopb::CopyBytesArray(model::kTypeValueFieldKey);
+  result->map_value.fields[0].value = *[self encodeStringValue:MakeString(@"__vector__")].release();
+
+  NSArray<NSNumber *> *vectorArray = vectorValue.array;
+
+  __block Message<google_firestore_v1_Value> arrayMessage;
+  arrayMessage->which_value_type = google_firestore_v1_Value_array_value_tag;
+  arrayMessage->array_value.values_count = CheckedSize([vectorArray count]);
+  arrayMessage->array_value.values =
+      nanopb::MakeArray<google_firestore_v1_Value>(arrayMessage->array_value.values_count);
+
+  [vectorArray enumerateObjectsUsingBlock:^(id entry, NSUInteger idx, BOOL *) {
+    if (![entry isKindOfClass:[NSNumber class]]) {
+      ThrowInvalidArgument("VectorValues must only contain numeric values.",
+                           context.FieldDescription());
+    }
+
+    // Vector values must always use Double encoding
+    arrayMessage->array_value.values[idx] = *[self encodeDouble:[entry doubleValue]].release();
+  }];
+
+  result->map_value.fields[1].key = nanopb::CopyBytesArray(model::kVectorValueFieldKey);
+  result->map_value.fields[1].value = *arrayMessage.release();
+
+  return std::move(result);
+}
+
 - (Message<google_firestore_v1_Value>)parseArray:(NSArray<id> *)array
                                          context:(ParseContext &&)context {
   __block Message<google_firestore_v1_Value> result;
@@ -529,7 +566,9 @@ - (void)parseSentinelFieldValue:(FIRFieldValue *)fieldValue context:(ParseContex
           _databaseID.database_id(), context.FieldDescription());
     }
     return [self encodeReference:_databaseID key:reference.key];
-
+  } else if ([input isKindOfClass:[FIRVectorValue class]]) {
+    FIRVectorValue *vector = input;
+    return [self parseVectorValue:vector context:std::move(context)];
   } else {
     ThrowInvalidArgument("Unsupported type: %s%s", NSStringFromClass([input class]),
                          context.FieldDescription());

Firestore/Source/API/FSTUserDataReader.mm

@@ -21,6 +21,7 @@
 
 #include "Firestore/Protos/nanopb/google/firestore/v1/document.nanopb.h"
 #include "Firestore/Source/API/FIRDocumentReference+Internal.h"
+#include "Firestore/Source/API/FIRFieldValue+Internal.h"
 #include "Firestore/Source/API/converters.h"
 #include "Firestore/core/include/firebase/firestore/geo_point.h"
 #include "Firestore/core/include/firebase/firestore/timestamp.h"
@@ -105,6 +106,8 @@ - (id)convertedValue:(const google_firestore_v1_Value &)value {
     case TypeOrder::kGeoPoint:
       return MakeFIRGeoPoint(
           GeoPoint(value.geo_point_value.latitude, value.geo_point_value.longitude));
+    case TypeOrder::kVector:
+      return [self convertedVector:value.map_value];
     case TypeOrder::kMaxValue:
       // It is not possible for users to construct a kMaxValue manually.
       break;
@@ -123,6 +126,18 @@ - (id)convertedValue:(const google_firestore_v1_Value &)value {
   return result;
 }
 
+- (FIRVectorValue *)convertedVector:(const google_firestore_v1_MapValue &)mapValue {
+  for (pb_size_t i = 0; i < mapValue.fields_count; ++i) {
+    absl::string_view key = MakeStringView(mapValue.fields[i].key);
+    const google_firestore_v1_Value &value = mapValue.fields[i].value;
+    if ((0 == key.compare(absl::string_view("value"))) &&
+        value.which_value_type == google_firestore_v1_Value_array_value_tag) {
+      return [FIRFieldValue vectorWithArray:[self convertedArray:value.array_value]];
+    }
+  }
+  return [FIRFieldValue vectorWithArray:@[]];
+}
+
 - (NSArray<id> *)convertedArray:(const google_firestore_v1_ArrayValue &)arrayValue {
   NSMutableArray *result = [NSMutableArray arrayWithCapacity:arrayValue.values_count];
   for (pb_size_t i = 0; i < arrayValue.values_count; ++i) {