merge in base branch

Author: cherylEnkidu

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

@@ -1558,7 +1558,6 @@ public protocol Expression: Sendable {
 
   // MARK: Equivalence Operations
 
-
   /// Creates a `BooleanExpr` that returns `true` if this expression is equivalent
   /// to the given value.
   ///

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

@@ -21,6 +21,29 @@ import Foundation
 
 @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
 struct PipelineListenOptions: Sendable, Equatable, Hashable {
+  /// Defines how to handle server-generated timestamps that are not yet known locally
+  /// during latency compensation.
+  struct ServerTimestampBehavior: Sendable, Equatable, Hashable {
+    /// The raw string value for the behavior, used for implementation and hashability.
+    let rawValue: String
+    /// Creates a new behavior with a private raw value.
+    private init(rawValue: String) {
+      self.rawValue = rawValue
+    }
+
+    /// Fields dependent on server timestamps will be `nil` until the value is
+    /// confirmed by the server.
+    public static let none = ServerTimestampBehavior(rawValue: "none")
+
+    /// Fields dependent on server timestamps will receive a local, client-generated
+    /// time estimate until the value is confirmed by the server.
+    public static let estimate = ServerTimestampBehavior(rawValue: "estimate")
+
+    /// Fields dependent on server timestamps will hold the value from the last
+    /// server-confirmed write until the new value is confirmed.
+    public static let previous = ServerTimestampBehavior(rawValue: "previous")
+  }
+
   // MARK: - Stored Properties
 
   /// The desired behavior for handling pending server timestamps.
@@ -46,31 +69,16 @@ struct PipelineListenOptions: Sendable, Equatable, Hashable {
     self.includeMetadataChanges = includeMetadataChanges
     self.source = source
     bridge = __PipelineListenOptionsBridge(
-      serverTimestampBehavior: PipelineListenOptions
-        .toRawValue(servertimestamp: self.serverTimestamps ?? .none),
+      serverTimestampBehavior: (self.serverTimestamps ?? .none).rawValue,
       includeMetadata: self.includeMetadataChanges ?? false,
       source: self.source ?? ListenSource.default
     )
   }
-
-  private static func toRawValue(servertimestamp: ServerTimestampBehavior) -> String {
-    switch servertimestamp {
-    case .none:
-      return "none"
-    case .estimate:
-      return "estimate"
-    case .previous:
-      return "previous"
-    @unknown default:
-      fatalError("Unknown server timestamp behavior")
-    }
-  }
 }
 
 @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
 struct RealtimePipeline: @unchecked Sendable {
   private var stages: [Stage]
-
   let bridge: RealtimePipelineBridge
   let db: Firestore
 
@@ -81,22 +89,18 @@ struct RealtimePipeline: @unchecked Sendable {
   }
 
   struct Snapshot: Sendable {
-    /// An array of all the results in the `Pipeline.Snapshot`.
+    /// An array of all the results in the `PipelineSnapshot`.
     let results_cache: [PipelineResult]
 
     public let changes: [PipelineResultChange]
     public let metadata: SnapshotMetadata
 
     let bridge: __RealtimePipelineSnapshotBridge
-    private var options: PipelineListenOptions
 
-    init(_ bridge: __RealtimePipelineSnapshotBridge,
-         options: PipelineListenOptions) {
+    init(_ bridge: __RealtimePipelineSnapshotBridge) {
       self.bridge = bridge
-      self.options = options
       metadata = bridge.metadata
-      results_cache = self.bridge.results
-        .map { PipelineResult($0, options.serverTimestamps ?? .none) }
+      results_cache = self.bridge.results.map { PipelineResult($0) }
       changes = self.bridge.changes.map { PipelineResultChange($0) }
     }
 
@@ -109,17 +113,13 @@ struct RealtimePipeline: @unchecked Sendable {
                                    listener: @escaping (RealtimePipeline.Snapshot?, Error?) -> Void)
     -> ListenerRegistration {
     return bridge.addSnapshotListener(options: options.bridge) { snapshotBridge, error in
-      if snapshotBridge != nil {
-        listener(
-          RealtimePipeline.Snapshot(
-            snapshotBridge!,
-            options: options
-          ),
-          error
-        )
-      } else {
-        listener(nil, error)
-      }
+      listener(
+        RealtimePipeline.Snapshot(
+          // TODO(pipeline): this needs to be fixed
+          snapshotBridge!
+        ),
+        error
+      )
     }
   }
 

Firestore/core/src/api/realtime_pipeline.cc

@@ -37,8 +37,7 @@ RealtimePipeline::RealtimePipeline(const RealtimePipeline& other)
     : stages_(other.stages_),
       rewritten_stages_(other.rewritten_stages_),
       serializer_(std::make_unique<remote::Serializer>(
-          other.serializer_->database_id())),
-      listen_options_(other.listen_options()) {
+          other.serializer_->database_id())) {
 }
 
 RealtimePipeline& RealtimePipeline::operator=(const RealtimePipeline& other) {
@@ -47,7 +46,6 @@ RealtimePipeline& RealtimePipeline::operator=(const RealtimePipeline& other) {
     rewritten_stages_ = other.rewritten_stages_;
     serializer_ =
         std::make_unique<remote::Serializer>(other.serializer_->database_id());
-    listen_options_ = other.listen_options();
   }
   return *this;
 }
@@ -72,7 +70,7 @@ RealtimePipeline::rewritten_stages() const {
 }
 
 EvaluateContext RealtimePipeline::evaluate_context() const {
-  return EvaluateContext(serializer_.get(), listen_options_);
+  return EvaluateContext(serializer_.get());
 }
 
 }  // namespace api

Firestore/core/src/api/realtime_pipeline.h

@@ -23,7 +23,6 @@
 #include "Firestore/core/src/api/api_fwd.h"
 #include "Firestore/core/src/api/stages.h"
 #include "Firestore/core/src/core/core_fwd.h"
-#include "Firestore/core/src/core/listen_options.h"
 
 namespace firebase {
 namespace firestore {
@@ -48,21 +47,14 @@ class RealtimePipeline {
 
   EvaluateContext evaluate_context() const;
 
-  RealtimePipeline WithListenOptions(const core::ListenOptions& options) const {
-    RealtimePipeline result(*this);
-    result.listen_options_ = options;
-    return result;
-  }
-
-  const core::ListenOptions& listen_options() const {
-    return listen_options_;
-  }
+  std::unique_ptr<api::ListenerRegistration> AddSnapshotListener(
+      core::ListenOptions options,
+      api::RealtimePipelineSnapshotListener&& listener);
 
  private:
   std::vector<std::shared_ptr<EvaluableStage>> stages_;
   std::vector<std::shared_ptr<EvaluableStage>> rewritten_stages_;
   std::unique_ptr<remote::Serializer> serializer_;
-  core::ListenOptions listen_options_;
 };
 
 }  // namespace api

Firestore/core/src/api/stages.h

@@ -55,9 +55,8 @@ class Stage {
 
 class EvaluateContext {
  public:
-  explicit EvaluateContext(remote::Serializer* serializer,
-                           core::ListenOptions options)
-      : serializer_(serializer), listen_options_(std::move(options)) {
+  explicit EvaluateContext(remote::Serializer* serializer)
+      : serializer_(serializer) {
   }
 
   const remote::Serializer& serializer() const {

Firestore/core/src/core/expressions_eval.cc

@@ -31,13 +31,12 @@
 #include "Firestore/core/src/api/expressions.h"
 #include "Firestore/core/src/api/stages.h"
 #include "Firestore/core/src/model/mutable_document.h"
-#include "Firestore/core/src/model/server_timestamp_util.h"
 #include "Firestore/core/src/model/value_util.h"  // For value helpers like IsArray, DeepClone
 #include "Firestore/core/src/nanopb/message.h"  // Added for MakeMessage
 #include "Firestore/core/src/remote/serializer.h"
 #include "Firestore/core/src/util/hard_assert.h"
-#include "Firestore/core/src/util/log.h"
 #include "absl/strings/ascii.h"  // For AsciiStrToLower/ToUpper (if needed later)
+#include "absl/strings/internal/utf8.h"
 #include "absl/strings/match.h"    // For StartsWith, EndsWith, StrContains
 #include "absl/strings/str_cat.h"  // For StrAppend
 #include "absl/strings/strip.h"    // For StripAsciiWhitespace
@@ -313,32 +312,6 @@ std::unique_ptr<EvaluableExpr> FunctionToEvaluable(
   HARD_FAIL("Unsupported function name: %s", function.name());
 }
 
-namespace {
-
-nanopb::Message<google_firestore_v1_Value> GetServerTimestampValue(
-    const api::EvaluateContext& context,
-    const google_firestore_v1_Value& timestamp_sentinel) {
-  if (context.listen_options().server_timestamp_behavior() ==
-      ListenOptions::ServerTimestampBehavior::kEstimate) {
-    google_firestore_v1_Value result;
-    result.which_value_type = google_firestore_v1_Value_timestamp_value_tag;
-    result.timestamp_value = model::GetLocalWriteTime(timestamp_sentinel);
-    return nanopb::MakeMessage<google_firestore_v1_Value>(result);
-  }
-
-  if (context.listen_options().server_timestamp_behavior() ==
-      ListenOptions::ServerTimestampBehavior::kPrevious) {
-    auto result = model::GetPreviousValue(timestamp_sentinel);
-    if (result.has_value()) {
-      return model::DeepClone(result.value());
-    }
-  }
-
-  return nanopb::MakeMessage<google_firestore_v1_Value>(model::NullValue());
-}
-
-}  // namespace
-
 EvaluateResult CoreField::Evaluate(
     const api::EvaluateContext& context,
     const model::PipelineInputOutput& input) const {
@@ -367,11 +340,6 @@ EvaluateResult CoreField::Evaluate(
   // Return 'UNSET' if the field doesn't exist, otherwise the Value.
   const auto& result = input.field(field->field_path());
   if (result.has_value()) {
-    if (model::IsServerTimestamp(result.value())) {
-      return EvaluateResult::NewValue(
-          GetServerTimestampValue(context, result.value()));
-    }
-
     // DeepClone the field value to avoid modifying the original.
     return EvaluateResult::NewValue(model::DeepClone(result.value()));
   } else {

Firestore/core/src/core/pipeline_util.cc

@@ -30,10 +30,9 @@
 #include "Firestore/core/src/core/expressions_eval.h"
 #include "Firestore/core/src/core/filter.h"
 #include "Firestore/core/src/core/order_by.h"
-#include "Firestore/core/src/core/pipeline_run.h"  // Contains RunPipeline, EvaluateContext
+#include "Firestore/core/src/core/pipeline_run.h"
 #include "Firestore/core/src/core/query.h"
 #include "Firestore/core/src/model/document.h"
-#include "Firestore/core/src/model/document_key.h"
 #include "Firestore/core/src/model/document_set.h"
 #include "Firestore/core/src/model/field_path.h"
 #include "Firestore/core/src/model/mutable_document.h"
@@ -46,7 +45,6 @@
 #include "absl/strings/str_cat.h"
 #include "absl/strings/str_format.h"
 #include "absl/strings/str_join.h"
-#include "absl/types/compare.h"
 #include "absl/types/optional.h"
 #include "absl/types/variant.h"
 

Firestore/core/src/core/pipeline_util.h

@@ -24,7 +24,6 @@
 #include "absl/types/optional.h"
 #include "absl/types/variant.h"
 
-#include "Firestore/core/src/api/expressions.h"
 #include "Firestore/core/src/api/realtime_pipeline.h"
 #include "Firestore/core/src/api/stages.h"
 #include "Firestore/core/src/core/query.h"

Firestore/core/src/core/query_listener.cc

@@ -68,9 +68,6 @@ QueryListener::QueryListener(QueryOrPipeline query,
     : query_(std::move(query)),
       options_(std::move(options)),
       listener_(std::move(listener)) {
-  if (query_.IsPipeline()) {
-    query_ = QueryOrPipeline(query_.pipeline().WithListenOptions(options_));
-  }
 }
 
 bool QueryListener::OnViewSnapshot(ViewSnapshot snapshot) {
@@ -199,4 +196,4 @@ void QueryListener::RaiseInitialEvent(const ViewSnapshot& snapshot) {
 
 }  // namespace core
 }  // namespace firestore
-}  // namespace firebase
+}  // namespace firebase

Firestore/core/src/core/query_listener.h

@@ -60,14 +60,10 @@ class QueryListener {
 
   virtual ~QueryListener() = default;
 
-  QueryOrPipeline& query() {
+  const QueryOrPipeline& query() const {
     return query_;
   }
 
-  ListenOptions listen_options() {
-    return options_;
-  }
-
   bool listens_to_remote_store() const {
     return options_.source() != ListenSource::Cache;
   }