fix bugs in raw stage and unnest stage

Author: cherylEnkidu

Firestore/Source/API/FIRPipelineBridge.mm

@@ -710,9 +710,11 @@ - (id)initWithPercentage:(double)percentage {
 - (std::shared_ptr<api::Stage>)cppStageWithReader:(FSTUserDataReader *)reader {
   if (!isUserDataRead) {
     if ([type isEqualToString:@"count"]) {
-      cpp_sample = std::make_shared<Sample>("count", _count, 0);
+      cpp_sample =
+          std::make_shared<Sample>(Sample::SampleMode(Sample::SampleMode::DOCUMENTS), _count, 0);
     } else {
-      cpp_sample = std::make_shared<Sample>("percentage", 0, _percentage);
+      cpp_sample =
+          std::make_shared<Sample>(Sample::SampleMode(Sample::SampleMode::PERCENT), 0, _percentage);
     }
   }
 
@@ -750,30 +752,35 @@ - (id)initWithOther:(FIRPipelineBridge *)other {
 
 @implementation FIRUnnestStageBridge {
   FIRExprBridge *_field;
-  NSString *_Nullable _indexField;
+  FIRExprBridge *_Nullable _index_field;
+  FIRExprBridge *_alias;
   Boolean isUserDataRead;
   std::shared_ptr<Unnest> cpp_unnest;
 }
 
-- (id)initWithField:(FIRExprBridge *)field indexField:(NSString *_Nullable)indexField {
+- (id)initWithField:(FIRExprBridge *)field
+              alias:(FIRExprBridge *)alias
+         indexField:(FIRExprBridge *_Nullable)index_field {
   self = [super init];
   if (self) {
     _field = field;
-    _indexField = indexField;
+    _alias = alias;
+    _index_field = index_field;
     isUserDataRead = NO;
   }
   return self;
 }
 
 - (std::shared_ptr<api::Stage>)cppStageWithReader:(FSTUserDataReader *)reader {
   if (!isUserDataRead) {
-    absl::optional<std::string> cpp_index_field;
-    if (_indexField != nil) {
-      cpp_index_field = MakeString(_indexField);
+    absl::optional<std::shared_ptr<Expr>> cpp_index_field;
+    if (_index_field != nil) {
+      cpp_index_field = [_index_field cppExprWithReader:reader];
     } else {
       cpp_index_field = absl::nullopt;
     }
-    cpp_unnest = std::make_shared<Unnest>([_field cppExprWithReader:reader], cpp_index_field);
+    cpp_unnest = std::make_shared<Unnest>([_field cppExprWithReader:reader],
+                                          [_alias cppExprWithReader:reader], cpp_index_field);
   }
 
   isUserDataRead = YES;
@@ -784,14 +791,14 @@ - (id)initWithField:(FIRExprBridge *)field indexField:(NSString *_Nullable)index
 
 @implementation FIRRawStageBridge {
   NSString *_name;
-  NSArray<FIRExprBridge *> *_params;
+  NSArray<id> *_params;
   NSDictionary<NSString *, FIRExprBridge *> *_Nullable _options;
   Boolean isUserDataRead;
   std::shared_ptr<RawStage> cpp_generic_stage;
 }
 
 - (id)initWithName:(NSString *)name
-            params:(NSArray<FIRExprBridge *> *)params
+            params:(NSArray<id> *)params
            options:(NSDictionary<NSString *, FIRExprBridge *> *_Nullable)options {
   self = [super init];
   if (self) {
@@ -803,12 +810,43 @@ - (id)initWithName:(NSString *)name
   return self;
 }
 
+- (firebase::firestore::google_firestore_v1_Value)convertIdToV1Value:(id)value
+                                                              reader:(FSTUserDataReader *)reader {
+  if ([value isKindOfClass:[FIRExprBridge class]]) {
+    return [((FIRExprBridge *)value) cppExprWithReader:reader]->to_proto();
+  } else if ([value isKindOfClass:[FIRAggregateFunctionBridge class]]) {
+    return [((FIRAggregateFunctionBridge *)value) cppExprWithReader:reader]->to_proto();
+  } else if ([value isKindOfClass:[NSDictionary class]]) {
+    NSDictionary<NSString *, FIRExprBridge *> *dictionary =
+        (NSDictionary<NSString *, FIRExprBridge *> *)value;
+
+    std::unordered_map<std::string, firebase::firestore::google_firestore_v1_Value> cpp_dictionary;
+    for (NSString *key in dictionary) {
+      cpp_dictionary[MakeString(key)] = [dictionary[key] cppExprWithReader:reader]->to_proto();
+    }
+
+    firebase::firestore::google_firestore_v1_Value result;
+    result.which_value_type = google_firestore_v1_Value_map_value_tag;
+
+    nanopb::SetRepeatedField(
+        &result.map_value.fields, &result.map_value.fields_count, cpp_dictionary,
+        [](const std::pair<std::string, firebase::firestore::google_firestore_v1_Value> &entry) {
+          return firebase::firestore::_google_firestore_v1_MapValue_FieldsEntry{
+              nanopb::MakeBytesArray(entry.first), entry.second};
+        });
+    return result;
+  } else {
+    ThrowInvalidArgument("Subscript key must be an NSString or FIRFieldPath.");
+  }
+}
+
 - (std::shared_ptr<api::Stage>)cppStageWithReader:(FSTUserDataReader *)reader {
   if (!isUserDataRead) {
-    std::vector<std::shared_ptr<Expr>> cpp_params;
-    for (FIRExprBridge *param in _params) {
-      cpp_params.push_back([param cppExprWithReader:reader]);
+    std::vector<firebase::firestore::google_firestore_v1_Value> cpp_params;
+    for (id param in _params) {
+      cpp_params.push_back([self convertIdToV1Value:param reader:reader]);
     }
+
     std::unordered_map<std::string, std::shared_ptr<Expr>> cpp_options;
     if (_options) {
       for (NSString *key in _options) {

Firestore/Source/Public/FirebaseFirestore/FIRPipelineBridge.h

@@ -191,14 +191,16 @@ NS_SWIFT_NAME(UnionStageBridge)
 NS_SWIFT_SENDABLE
 NS_SWIFT_NAME(UnnestStageBridge)
 @interface FIRUnnestStageBridge : FIRStageBridge
-- (id)initWithField:(FIRExprBridge *)field indexField:(NSString *_Nullable)indexField;
+- (id)initWithField:(FIRExprBridge *)field
+              alias:(FIRExprBridge *)alias
+         indexField:(FIRExprBridge *_Nullable)index_field;
 @end
 
 NS_SWIFT_SENDABLE
 NS_SWIFT_NAME(RawStageBridge)
 @interface FIRRawStageBridge : FIRStageBridge
 - (id)initWithName:(NSString *)name
-            params:(NSArray<FIRExprBridge *> *)params
+            params:(NSArray<id> *)params
            options:(NSDictionary<NSString *, FIRExprBridge *> *_Nullable)options;
 @end
 

Firestore/Swift/Source/Helper/PipelineHelper.swift

@@ -14,18 +14,18 @@
 
 enum Helper {
   static func sendableToExpr(_ value: Sendable?) -> Expr {
-    if value == nil {
+    guard let value = value else {
       return Constant.nil
     }
 
-    if value! is Expr {
-      return value! as! Expr
-    } else if value! is [String: Sendable?] {
-      return map(value! as! [String: Sendable?])
-    } else if value! is [Sendable?] {
-      return array(value! as! [Sendable?])
+    if value is Expr {
+      return value as! Expr
+    } else if value is [String: Sendable?] {
+      return map(value as! [String: Sendable?])
+    } else if value is [Sendable?] {
+      return array(value as! [Sendable?])
     } else {
-      return Constant(value!)
+      return Constant(value)
     }
   }
 
@@ -52,4 +52,27 @@ enum Helper {
     }
     return FunctionExpr("array", transformedElements)
   }
+
+  // This function is used to convert Swift type into Objective-C type.
+  static func sendableToAnyObjectForRawStage(_ value: Sendable?) -> AnyObject {
+    guard let value = value else {
+      return Constant.nil.bridge
+    }
+
+    // Step 2: Check for NSNull.
+    guard !(value is NSNull) else {
+      return Constant.nil.bridge
+    }
+
+    if value is Expr {
+      return (value as! Expr).toBridge()
+    } else if value is AggregateFunction {
+      return (value as! AggregateFunction).toBridge()
+    } else if value is [String: Sendable?] {
+      let mappedValue = (value as! [String: Sendable?]).mapValues { sendableToExpr($0).toBridge() }
+      return mappedValue as NSDictionary
+    } else {
+      return Constant(value).bridge
+    }
+  }
 }

Firestore/Swift/Source/SwiftAPI/Pipeline/Aggregation/AggregateFunction.swift

@@ -12,6 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+extension AggregateFunction {
+  func toBridge() -> AggregateFunctionBridge {
+    return (self as AggregateBridgeWrapper).bridge
+  }
+}
+
 public class AggregateFunction: AggregateBridgeWrapper, @unchecked Sendable {
   let bridge: AggregateFunctionBridge
 

Firestore/Swift/Source/SwiftAPI/Pipeline/Pipeline.swift

@@ -719,7 +719,7 @@ public struct Pipeline: @unchecked Sendable {
   ///   - params: An array of ordered, `Sendable` parameters for the stage.
   ///   - options: Optional dictionary of named, `Sendable` parameters.
   /// - Returns: A new `Pipeline` object with this stage appended.
-  public func rawStage(name: String, params: [Sendable],
+  public func rawStage(name: String, params: [Sendable?],
                        options: [String: Sendable]? = nil) -> Pipeline {
     return Pipeline(
       stages: stages + [RawStage(name: name, params: params, options: options)],

Firestore/Swift/Source/SwiftAPI/Stages.swift

@@ -327,15 +327,20 @@ class Union: Stage {
 class Unnest: Stage {
   let name: String = "unnest"
   let bridge: StageBridge
-  private var field: Selectable
+  private var alias: Expr
+  private var field: Expr
   private var indexField: String?
 
   init(field: Selectable, indexField: String? = nil) {
-    self.field = field
+    let seletable = field as! SelectableWrapper
+    self.field = seletable.expr
+    alias = Field(seletable.alias)
     self.indexField = indexField
+
     bridge = UnnestStageBridge(
-      field: Helper.sendableToExpr(field).toBridge(),
-      indexField: indexField
+      field: self.field.toBridge(),
+      alias: alias.toBridge(),
+      indexField: indexField.map { Field($0) } ?? nil
     )
   }
 }
@@ -344,14 +349,14 @@ class Unnest: Stage {
 class RawStage: Stage {
   let name: String
   let bridge: StageBridge
-  private var params: [Sendable]
+  private var params: [Sendable?]
   private var options: [String: Sendable]?
 
-  init(name: String, params: [Sendable], options: [String: Sendable]? = nil) {
+  init(name: String, params: [Sendable?], options: [String: Sendable]? = nil) {
     self.name = name
     self.params = params
     self.options = options
-    let bridgeParams = params.map { Helper.sendableToExpr($0).toBridge() }
+    let bridgeParams = params.map { Helper.sendableToAnyObjectForRawStage($0) }
     let bridgeOptions = options?.mapValues { Helper.sendableToExpr($0).toBridge() }
     bridge = RawStageBridge(name: name, params: bridgeParams, options: bridgeOptions)
   }