refactor snapshot

Author: cherylEnkidu

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

@@ -87,12 +87,32 @@ public struct Pipeline: @unchecked Sendable {
     self.db = db
     bridge = PipelineBridge(stages: stages.map { $0.bridge }, db: db)
   }
+  
+  public struct Snapshot: Sendable {
+    /// The Pipeline on which `execute()` was called to obtain this `Pipeline.Snapshot`.
+    public let pipeline: Pipeline
 
-  /// Executes the defined pipeline and returns a `PipelineSnapshot` containing the results.
+    /// An array of all the results in the `Pipeline.Snapshot`.
+    public let results: [PipelineResult]
+
+    /// The time at which the pipeline producing this result was executed.
+    public let executionTime: Timestamp
+
+    let bridge: __PipelineSnapshotBridge
+
+    init(_ bridge: __PipelineSnapshotBridge, pipeline: Pipeline) {
+      self.bridge = bridge
+      self.pipeline = pipeline
+      executionTime = self.bridge.execution_time
+      results = self.bridge.results.map { PipelineResult($0) }
+    }
+  }
+
+  /// Executes the defined pipeline and returns a `Pipeline.Snapshot` containing the results.
   ///
   /// This method asynchronously sends the pipeline definition to Firestore for execution.
   /// The resulting documents, transformed and filtered by the pipeline stages, are returned
-  /// within a `PipelineSnapshot`.
+  /// within a `Pipeline.Snapshot`.
   ///
   /// ```swift
   /// // let pipeline: Pipeline = ... // Assume a pipeline is already configured.
@@ -106,14 +126,14 @@ public struct Pipeline: @unchecked Sendable {
   /// ```
   ///
   /// - Throws: An error if the pipeline execution fails on the backend.
-  /// - Returns: A `PipelineSnapshot` containing the result of the pipeline execution.
-  public func execute() async throws -> PipelineSnapshot {
+  /// - Returns: A `Pipeline.Snapshot` containing the result of the pipeline execution.
+  public func execute() async throws -> Pipeline.Snapshot {
     return try await withCheckedThrowingContinuation { continuation in
       self.bridge.execute { result, error in
         if let error {
           continuation.resume(throwing: error)
         } else {
-          continuation.resume(returning: PipelineSnapshot(result!, pipeline: self))
+          continuation.resume(returning: Pipeline.Snapshot(result!, pipeline: self))
         }
       }
     }

Firestore/Swift/Source/SwiftAPI/Pipeline/RealtimePipelineSnapshot.swift renamed to Firestore/Swift/Source/SwiftAPI/Pipeline/PipelineResultChange.swift

@@ -19,37 +19,6 @@
 #endif // SWIFT_PACKAGE
 import Foundation
 
-@available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
-struct RealtimePipelineSnapshot: Sendable {
-  /// The Pipeline on which `execute()` was called to obtain this `PipelineSnapshot`.
-  public let pipeline: RealtimePipeline
-
-  /// 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,
-       pipeline: RealtimePipeline,
-       options: PipelineListenOptions) {
-    self.bridge = bridge
-    self.pipeline = pipeline
-    self.options = options
-    metadata = bridge.metadata
-    results_cache = self.bridge.results
-      .map { PipelineResult($0, options.serverTimestamps ?? .none) }
-    changes = self.bridge.changes.map { PipelineResultChange($0) }
-  }
-
-  public func results() -> [PipelineResult] {
-    return results_cache
-  }
-}
-
 @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
 struct PipelineResultChange: Sendable {
   public enum ChangeType {

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

@@ -79,14 +79,44 @@ struct RealtimePipeline: @unchecked Sendable {
     self.db = db
     bridge = RealtimePipelineBridge(stages: stages.map { $0.bridge }, db: db)
   }
+  
+  struct Snapshot: Sendable {
+    /// The Pipeline on which `execute()` was called to obtain this `Pipeline.Snapshot`.
+    public let pipeline: RealtimePipeline
+
+    /// An array of all the results in the `Pipeline.Snapshot`.
+    let results_cache: [PipelineResult]
+
+    public let changes: [PipelineResultChange]
+    public let metadata: SnapshotMetadata
+
+    let bridge: __RealtimePipelineSnapshotBridge
+    private var options: PipelineListenOptions
+
+    init(_ bridge: __RealtimePipelineSnapshotBridge,
+         pipeline: RealtimePipeline,
+         options: PipelineListenOptions) {
+      self.bridge = bridge
+      self.pipeline = pipeline
+      self.options = options
+      metadata = bridge.metadata
+      results_cache = self.bridge.results
+        .map { PipelineResult($0, options.serverTimestamps ?? .none) }
+      changes = self.bridge.changes.map { PipelineResultChange($0) }
+    }
+
+    public func results() -> [PipelineResult] {
+      return results_cache
+    }
+  }
 
   private func addSnapshotListener(options: PipelineListenOptions,
-                                   listener: @escaping (RealtimePipelineSnapshot?, Error?) -> Void)
+                                   listener: @escaping (RealtimePipeline.Snapshot?, Error?) -> Void)
     -> ListenerRegistration {
     return bridge.addSnapshotListener(options: options.bridge) { snapshotBridge, error in
       if snapshotBridge != nil {
         listener(
-          RealtimePipelineSnapshot(
+          RealtimePipeline.Snapshot(
             snapshotBridge!,
             pipeline: self,
             options: options
@@ -100,7 +130,7 @@ struct RealtimePipeline: @unchecked Sendable {
   }
 
   public func snapshotStream(options: PipelineListenOptions? = nil)
-    -> AsyncThrowingStream<RealtimePipelineSnapshot, Error> {
+    -> AsyncThrowingStream<RealtimePipeline.Snapshot, Error> {
     AsyncThrowingStream { continuation in
       let listener = self.addSnapshotListener(
         options: options ?? PipelineListenOptions()

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

@@ -36,7 +36,7 @@ final class PipelineApiTests: FSTIntegrationTestCase {
     let query: Query = db.collection("foo").limit(to: 2)
     let _: Pipeline = pipelineSource.create(from: query)
 
-    let _: PipelineSnapshot = try await pipeline.execute()
+    let _: Pipeline.Snapshot = try await pipeline.execute()
   }
 
   func testWhereStage() async throws {