Support tests

Firestore/Source/API/FIRPipelineBridge.mm

@@ -16,13 +16,16 @@
 
 #import "FIRPipelineBridge.h"
 
+#import <FirebaseCore/FIRTimestamp.h>
+
 #include <memory>
 
 #import "Firestore/Source/API/FIRDocumentReference+Internal.h"
 #import "Firestore/Source/API/FIRFirestore+Internal.h"
 #import "Firestore/Source/API/FIRPipelineBridge+Internal.h"
 #import "Firestore/Source/API/FSTUserDataReader.h"
 #import "Firestore/Source/API/FSTUserDataWriter.h"
+#import "Firestore/Source/API/converters.h"
 
 #include "Firestore/Protos/nanopb/google/firestore/v1/document.nanopb.h"
 
@@ -42,6 +45,7 @@
 using firebase::firestore::api::Expr;
 using firebase::firestore::api::Field;
 using firebase::firestore::api::FunctionExpr;
+using firebase::firestore::api::MakeFIRTimestamp;
 using firebase::firestore::api::Pipeline;
 using firebase::firestore::api::Where;
 using firebase::firestore::util::MakeCallback;
@@ -173,7 +177,7 @@ - (id)initWithExpr:(FIRExprBridge *)expr {
 
 @interface __FIRPipelineSnapshotBridge ()
 
-@property(nonatomic, strong, readwrite) NSArray<__FIRPipelineSnapshotBridge *> *results;
+@property(nonatomic, strong, readwrite) NSArray<__FIRPipelineResultBridge *> *results;
 
 @end
 
@@ -206,27 +210,51 @@ - (id)initWithCppSnapshot:(api::PipelineSnapshot)snapshot {
   return results_;
 }
 
+- (FIRTimestamp *)execution_time {
+  if (!snapshot_.has_value()) {
+    return nil;
+  } else {
+    return MakeFIRTimestamp(snapshot_.value().execution_time().timestamp());
+  }
+}
+
 @end
 
 @implementation __FIRPipelineResultBridge {
   api::PipelineResult _result;
   std::shared_ptr<api::Firestore> _db;
 }
 
-- (FIRDocumentReference *)reference {
+- (nullable FIRDocumentReference *)reference {
   if (!_result.internal_key().has_value()) return nil;
 
   return [[FIRDocumentReference alloc] initWithKey:_result.internal_key().value() firestore:_db];
 }
 
-- (NSString *)documentID {
+- (nullable NSString *)documentID {
   if (!_result.document_id().has_value()) {
     return nil;
   }
 
   return MakeNSString(_result.document_id().value());
 }
 
+- (nullable FIRTimestamp *)create_time {
+  if (!_result.create_time().has_value()) {
+    return nil;
+  }
+
+  return MakeFIRTimestamp(_result.create_time().value().timestamp());
+}
+
+- (nullable FIRTimestamp *)update_time {
+  if (!_result.update_time().has_value()) {
+    return nil;
+  }
+
+  return MakeFIRTimestamp(_result.update_time().value().timestamp());
+}
+
 - (id)initWithCppResult:(api::PipelineResult)result db:(std::shared_ptr<api::Firestore>)db {
   self = [super init];
   if (self) {
@@ -237,15 +265,15 @@ - (id)initWithCppResult:(api::PipelineResult)result db:(std::shared_ptr<api::Fir
   return self;
 }
 
-- (nullable NSDictionary<NSString *, id> *)data {
+- (NSDictionary<NSString *, id> *)data {
   return [self dataWithServerTimestampBehavior:FIRServerTimestampBehaviorNone];
 }
 
-- (nullable NSDictionary<NSString *, id> *)dataWithServerTimestampBehavior:
+- (NSDictionary<NSString *, id> *)dataWithServerTimestampBehavior:
     (FIRServerTimestampBehavior)serverTimestampBehavior {
   absl::optional<firebase::firestore::google_firestore_v1_Value> data =
       _result.internal_value()->Get();
-  if (!data) return nil;
+  if (!data) return [NSDictionary dictionary];
 
   FSTUserDataWriter *dataWriter =
       [[FSTUserDataWriter alloc] initWithFirestore:_db

Firestore/Source/Public/FirebaseFirestore/FIRPipelineBridge.h

@@ -20,6 +20,8 @@
 
 #import "FIRDocumentSnapshot.h"
 
+@class FIRTimestamp;
+
 NS_ASSUME_NONNULL_BEGIN
 
 NS_SWIFT_NAME(ExprBridge)
@@ -59,26 +61,33 @@ NS_SWIFT_NAME(WhereStageBridge)
 
 @end
 
-NS_SWIFT_NAME(__PipelineSnapshotBridge)
-@interface __FIRPipelineSnapshotBridge : NSObject
+NS_SWIFT_NAME(__PipelineResultBridge)
+@interface __FIRPipelineResultBridge : NSObject
 
-@property(nonatomic, strong, readonly) NSArray<__FIRPipelineSnapshotBridge *> *results;
+@property(nonatomic, strong, readonly, nullable) FIRDocumentReference *reference;
 
-@end
+@property(nonatomic, copy, readonly, nullable) NSString *documentID;
 
-NS_SWIFT_NAME(__PipelineResultBridge)
-@interface __FIRPipelineResultBridge : NSObject
+@property(nonatomic, strong, readonly, nullable) FIRTimestamp *create_time;
 
-@property(nonatomic, strong, readonly) FIRDocumentReference *reference;
+@property(nonatomic, strong, readonly, nullable) FIRTimestamp *update_time;
 
-@property(nonatomic, copy, readonly) NSString *documentID;
+- (NSDictionary<NSString *, id> *)data;
 
-- (nullable NSDictionary<NSString *, id> *)data;
-- (nullable NSDictionary<NSString *, id> *)dataWithServerTimestampBehavior:
+- (NSDictionary<NSString *, id> *)dataWithServerTimestampBehavior:
     (FIRServerTimestampBehavior)serverTimestampBehavior;
 
 @end
 
+NS_SWIFT_NAME(__PipelineSnapshotBridge)
+@interface __FIRPipelineSnapshotBridge : NSObject
+
+@property(nonatomic, strong, readonly) NSArray<__FIRPipelineResultBridge *> *results;
+
+@property(nonatomic, strong, readonly) FIRTimestamp *execution_time;
+
+@end
+
 NS_SWIFT_NAME(PipelineBridge)
 @interface FIRPipelineBridge : NSObject
 

Firestore/Swift/Source/Helper/PipelineHelper.swift

@@ -14,6 +14,9 @@
 
 enum Helper {
   static func valueToDefaultExpr(_ value: Any) -> any Expr {
+    if value is Constant {
+      return value as! Expr
+    }
     return Field("PLACEHOLDER")
   }
 

Firestore/Swift/Source/SwiftAPI/Pipeline/SampleOptions.swift → Firestore/Swift/Source/SelectableInternal.swift

@@ -12,20 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-public struct SampleOption {
-  let percentage: Double?
-  let count: Int64?
-
-  private init(percentage: Double?, count: Int64?) {
-    self.percentage = percentage
-    self.count = count
-  }
-
-  public init(percentage: Double) {
-    self.init(percentage: percentage, count: nil)
-  }
-
-  public init(count: Int64) {
-    self.init(percentage: nil, count: count)
-  }
+protocol SelectableInternal: Sendable {
+  var alias: String { get }
+  var expr: Expr { get }
 }

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

@@ -798,7 +798,7 @@ public func <= (lhs: Expr, rhs: @autoclosure () throws -> Any) rethrows -> Boole
 }
 
 public func == (lhs: Expr, rhs: @autoclosure () throws -> Any) rethrows -> BooleanExpr {
-  try BooleanExpr("eq", [lhs, rhs() as! Expr])
+  try BooleanExpr("eq", [lhs, Helper.valueToDefaultExpr(rhs())])
 }
 
 public func != (lhs: Expr, rhs: @autoclosure () throws -> Any) rethrows -> BooleanExpr {

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

@@ -12,10 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-public class Field: ExprBridge, Expr, Selectable, BridgeWrapper, @unchecked Sendable {
+public class Field: ExprBridge, Expr, Selectable, BridgeWrapper, SelectableInternal,
+  @unchecked Sendable {
   var bridge: ExprBridge
 
-  public var alias: String
+  var alias: String
+
+  var expr: any Expr {
+    return self
+  }
 
   public let fieldName: String
 
@@ -24,8 +29,4 @@ public class Field: ExprBridge, Expr, Selectable, BridgeWrapper, @unchecked Send
     alias = fieldName
     bridge = FieldBridge(alias)
   }
-
-  public var expr: any Expr {
-    return self
-  }
 }

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

@@ -15,9 +15,9 @@
 public struct ExprWithAlias: Selectable {
   public var alias: String
 
-  public var expr: any Expr
+  public var expr: Expr
 
-  init(_ expr: some Expr, _ alias: String) {
+  init(_ expr: Expr, _ alias: String) {
     self.alias = alias
     self.expr = expr
   }

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

@@ -37,7 +37,7 @@ public struct Pipeline {
         if let error {
           continuation.resume(throwing: error)
         } else {
-          continuation.resume(returning: PipelineSnapshot(result!))
+          continuation.resume(returning: PipelineSnapshot(result!, pipeline: self))
         }
       }
     }
@@ -288,9 +288,9 @@ public struct Pipeline {
   /// This stage allows you to emit a map value as a document. Each key of the map becomes a
   /// field on the document that contains the corresponding value.
   ///
-  /// - Parameter field: The `Selectable` field containing the nested map.
+  /// - Parameter field: The `Expr` field containing the nested map.
   /// - Returns: A new `Pipeline` object with this stage appended to the stage list.
-  public func replace(with field: Selectable) -> Pipeline {
+  public func replace(with expr: Expr) -> Pipeline {
     // Implementation
     return self
   }
@@ -312,9 +312,9 @@ public struct Pipeline {
   /// This stage will filter documents pseudo-randomly. The parameter specifies how number of
   /// documents to be returned.
   ///
-  /// - Parameter documents: The number of documents to sample.
+  /// - Parameter count: The number of documents to sample.
   /// - Returns: A new `Pipeline` object with this stage appended to the stage list.
-  public func sample(_ count: Int64) -> Pipeline {
+  public func sample(count: Int64) -> Pipeline {
     // Implementation
     return self
   }
@@ -324,9 +324,9 @@ public struct Pipeline {
   /// This stage will filter documents pseudo-randomly. The `options` parameter specifies how
   /// sampling will be performed. See `SampleOptions` for more information.
   ///
-  /// - Parameter options: The `SampleOptions` specifies how sampling is performed.
+  /// - Parameter percentage: The percentage of documents to sample.
   /// - Returns: A new `Pipeline` object with this stage appended to the stage list.
-  public func sample(with option: SampleOption) -> Pipeline {
+  public func sample(percentage: Double) -> Pipeline {
     // Implementation
     return self
   }

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

@@ -21,16 +21,15 @@ import Foundation
 
 @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
 public struct PipelineResult {
-  init(ref: DocumentReference? = nil,
-       id: String? = nil,
-       createTime: Timestamp? = nil,
-       updateTime: Timestamp? = nil,
-       data: [String: Any] = [:]) {
-    self.ref = ref
-    self.id = id
-    self.createTime = createTime
-    self.updateTime = updateTime
-    self.data = data
+  let bridge: __PipelineResultBridge
+
+  init(_ bridge: __PipelineResultBridge) {
+    self.bridge = bridge
+    ref = self.bridge.reference
+    id = self.bridge.documentID
+    data = self.bridge.data()
+    createTime = self.bridge.create_time
+    updateTime = self.bridge.update_time
   }
 
   /// The reference of the document, if the query returns the `__name__` field.

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

@@ -23,9 +23,12 @@ public struct PipelineSnapshot {
   /// The time at which the pipeline producing this result was executed.
   public let executionTime: Timestamp
 
-  init(pipeline: Pipeline, results: [PipelineResult], executionTime: Timestamp) {
+  let bridge: __PipelineSnapshotBridge
+
+  init(_ bridge: __PipelineSnapshotBridge, pipeline: Pipeline) {
+    self.bridge = bridge
     self.pipeline = pipeline
-    self.results = results
-    self.executionTime = executionTime
+    executionTime = self.bridge.execution_time
+    results = self.bridge.results.map { PipelineResult($0) }
   }
 }

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

@@ -12,7 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-public protocol Selectable: Sendable {
-  var alias: String { get }
-  var expr: Expr { get }
-}
+public protocol Selectable: Sendable {}

Firestore/Swift/Tests/Integration/PipelineApiTests.swift

@@ -219,13 +219,10 @@ final class PipelineTests: FSTIntegrationTestCase {
 
   func testSampleStage() async throws {
     // Sample 25 books, if the collection contains at least 25 documents
-    _ = db.pipeline().collection("books").sample(25)
-
-    // Sample 25 books, if the collection contains at least 25 documents
-    _ = db.pipeline().collection("books").sample(with: SampleOption(count: 10))
+    _ = db.pipeline().collection("books").sample(count: 10)
 
     // Sample 10 percent of the collection of books
-    _ = db.pipeline().collection("books").sample(with: SampleOption(percentage: 10))
+    _ = db.pipeline().collection("books").sample(percentage: 10)
   }
 
   func testUnionStage() async throws {

Firestore/core/src/api/pipeline_result.h

@@ -53,6 +53,14 @@ class PipelineResult {
   std::shared_ptr<model::ObjectValue> internal_value() const;
   absl::optional<absl::string_view> document_id() const;
 
+  absl::optional<model::SnapshotVersion> create_time() const {
+    return create_time_;
+  }
+
+  absl::optional<model::SnapshotVersion> update_time() const {
+    return update_time_;
+  }
+
   const absl::optional<model::DocumentKey>& internal_key() const {
     return internal_key_;
   }