equivalent()

Author: cherylEnkidu

Firestore/Swift/Source/ExpressionImplementation.swift

@@ -888,4 +888,10 @@ public extension Expression {
   func descending() -> Ordering {
     return Ordering(expression: self, direction: .descending)
   }
+
+  // MARK: Equivalence Operations
+
+  func equivalent(_ other: Sendable) -> BooleanExpression {
+    return BooleanExpression("equivalent", [self, Helper.sendableToExpr(other)])
+  }
 }

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

@@ -1555,4 +1555,14 @@ public protocol Expression: Sendable {
   ///
   /// - Returns: A new `Ordering` instance for descending sorting.
   func descending() -> Ordering
+
+  // MARK: Equivalence Operations
+
+
+  /// Creates a `BooleanExpr` that returns `true` if this expression is equivalent
+  /// to the given value.
+  ///
+  /// - Parameter other: The value to compare against.
+  /// - Returns: A `BooleanExpr` that can be used in `where` clauses.
+  func equivalent(_ other: Sendable) -> BooleanExpression
 }

Firestore/Swift/Tests/Integration/PipelineTests.swift

@@ -1677,6 +1677,25 @@ class PipelineIntegrationTests: FSTIntegrationTestCase {
     TestHelper.compare(snapshot: snapshot, expected: expectedResults, enforceOrder: true)
   }
 
+  func testEquivalentWorks() async throws {
+    let collRef = collectionRef(withDocuments: [
+      "doc1": ["value": 1, "value2": 1],
+      "doc2": ["value": 1, "value2": 2],
+      "doc3": ["value": NSNull(), "value2": NSNull()],
+      "doc4": ["value": NSNull(), "value2": 1],
+      "doc5": ["value": Double.nan, "value2": Double.nan],
+      "doc6": ["value": Double.nan, "value2": 1],
+    ])
+    let db = collRef.firestore
+
+    let pipeline = db.pipeline()
+      .collection(collRef.path)
+      .where(Field("value").equivalent(Field("value2")))
+    let snapshot = try await pipeline.execute()
+
+    XCTAssertEqual(snapshot.results.count, 3)
+  }
+
   func testInWorks() async throws {
     let collRef = collectionRef(withDocuments: bookDocs)
     let db = collRef.firestore