Adding support for arrayFilters in updates

This PR is for the feature request [#4247](#4247).

This PR adds support for arrayFilters by passing the arrayFilters parameter to the Realm serverless function.

Additional testing was added to cover the case of an update with arrayFilters.

docs/sync.js

@@ -1279,6 +1279,8 @@ class MongoDBCollection {
    * @param {object} [options] Additional options to apply.
    * @param {boolean} [options.upsert=false] if true, indicates that MongoDB should insert a new document that matches the
    * query filter when the query does not match any existing documents in the collection.
+   * @param {object[]} [options.arrayFilters=false] if provided, indicates the arrayFilters to use to update 
+   * an embedded array
    * @returns {Promise<Realm.MongoDBCollection~UpdateResult>}
    */
   updateOne(filter, update, options) {}
@@ -1291,6 +1293,8 @@ class MongoDBCollection {
    * @param {object} [options] Additional options to apply.
    * @param {boolean} [options.upsert=false] if true, indicates that MongoDB should insert a new document that matches the
    * query filter when the query does not match any existing documents in the collection.
+   * @param {object[]} [options.arrayFilters=false] if provided, indicates the arrayFilters to use to update 
+   * an embedded array
    * @returns {Promise<Realm.MongoDBCollection~UpdateResult>}
    */
   updateMany(filter, update, options) {}

lib/mongo-client.js

@@ -183,6 +183,7 @@ class MongoDBCollection {
       query: filter,
       update,
       upsert: options.upsert,
+      arrayFilters: options.arrayFilters,
     });
   }
 
@@ -194,6 +195,7 @@ class MongoDBCollection {
       query: filter,
       update,
       upsert: options.upsert,
+      arrayFilters: options.arrayFilters,
     });
   }
 

packages/realm-web-integration-tests/src/remote-mongodb-service.test.ts

@@ -293,6 +293,34 @@ describe("Remote MongoDB", () => {
     expect(result.modifiedCount).equals(3);
   });
 
+  it("can update documents using array filters", async () => {
+    const collection = getCollection<TestDocument>();
+    // Insert a document with an embedded array
+    const insertResult = await collection.insertOne([
+      { runId, name: "arrayFilter", values: [ {condition: 1, status: false}, {condition: 2, status: false} ] },
+    ]);
+    expect(insertResult.insertedIds.length).equals(1);
+
+    // Update the array element with condition == 1 to have status == true
+    let filter = { runId, name: "arrayFilter" };
+    let update = {"$set": {"values.$[element].status": true}};
+    let arrayFilters = [{"element.condition": 1 }];
+    const result = await collection.updateOne(filter, update, { arrayFilters });
+    // Check the result
+    expect(typeof result).equals("object");
+    expect(result.matchedCount).equals(1);
+    expect(result.modifiedCount).equals(1);
+
+    // Fetch the document to ensure that only the filtered elements of the array were updated
+    const doc = await collection.findOne({ runId, name: "arrayFilter" });
+    if (doc === null) {
+      throw new Error("Expected a result");
+    } else {
+      expect(doc.values.find(e => e.condition === 1).status).equals(true);
+      expect(doc.values.find(e => e.condition === 2).status).equals(false);
+    }
+  });
+
   it("upserts when updating many non-existing documents", async () => {
     const collection = getCollection<TestDocument>();
     // Delete the document with the last name (Charlie)

packages/realm-web/src/services/MongoDBService/MongoDBCollection.ts

@@ -215,6 +215,7 @@ export class MongoDBCollection<T extends Document> implements Realm.Services.Mon
       query: filter,
       update,
       upsert: options.upsert,
+      arrayFilters: options.arrayFilters,
     });
   }
 
@@ -230,6 +231,7 @@ export class MongoDBCollection<T extends Document> implements Realm.Services.Mon
       query: filter,
       update,
       upsert: options.upsert,
+      arrayFilters: options.arrayFilters,
     });
   }
 

types/services.d.ts

@@ -122,6 +122,10 @@ declare namespace Realm {
          * When true, creates a new document if no document matches the query.
          */
         readonly upsert?: boolean;
+        /**
+         * Array Filters
+         */
+        readonly arrayFilters?: Filter[]
       }
 
       /**