test: update suggestions

Author: durran

test/integration/crud/find_and_modify.test.ts

@@ -30,6 +30,30 @@ describe('Collection (#findOneAnd...)', function () {
       });
     });
 
+    context('when passing includeResultMetadata: false', function () {
+      let client;
+      let collection;
+
+      beforeEach(async function () {
+        client = this.configuration.newClient({}, { maxPoolSize: 1 });
+        collection = client.db('test').collection('findAndModifyTest');
+        await collection.insertMany([{ a: 1, b: 1 }], { writeConcern: { w: 1 } });
+      });
+
+      afterEach(async function () {
+        await collection.drop();
+        await client?.close();
+      });
+
+      it('returns the deleted document', async function () {
+        const result = await collection.findOneAndDelete(
+          { a: 1 },
+          { includeResultMetadata: false }
+        );
+        expect(result.b).to.equal(1);
+      });
+    });
+
     context('when passing an object id filter', function () {
       let client;
       let collection;
@@ -140,6 +164,31 @@ describe('Collection (#findOneAnd...)', function () {
       });
     });
 
+    context('when passing includeResultMetadata: false', function () {
+      let client;
+      let collection;
+
+      beforeEach(async function () {
+        client = this.configuration.newClient({}, { maxPoolSize: 1 });
+        collection = client.db('test').collection('findAndModifyTest');
+        await collection.insertMany([{ a: 1, b: 1 }], { writeConcern: { w: 1 } });
+      });
+
+      afterEach(async function () {
+        await collection.drop();
+        await client?.close();
+      });
+
+      it('returns the modified document', async function () {
+        const result = await collection.findOneAndUpdate(
+          { a: 1 },
+          { $set: { a: 1 } },
+          { includeResultMetadata: false }
+        );
+        expect(result.b).to.equal(1);
+      });
+    });
+
     context('when passing an object id filter', function () {
       let client;
       let collection;
@@ -280,6 +329,31 @@ describe('Collection (#findOneAnd...)', function () {
       });
     });
 
+    context('when passing includeResultMetadata: false', function () {
+      let client;
+      let collection;
+
+      beforeEach(async function () {
+        client = this.configuration.newClient({}, { maxPoolSize: 1 });
+        collection = client.db('test').collection('findAndModifyTest');
+        await collection.insertMany([{ a: 1, b: 1 }], { writeConcern: { w: 1 } });
+      });
+
+      afterEach(async function () {
+        await collection.drop();
+        await client?.close();
+      });
+
+      it('returns the replaced document', async function () {
+        const result = await collection.findOneAndReplace(
+          { a: 1 },
+          { a: 1 },
+          { includeResultMetadata: false }
+        );
+        expect(result.b).to.equal(1);
+      });
+    });
+
     context('when passing an object id filter', function () {
       let client;
       let collection;

test/types/community/collection/findX.test-d.ts

@@ -288,6 +288,7 @@ const fooObjWithArray: FooWithArray = {
 const fooFilterWithArray: Filter<FooWithArray> = fooObjWithArray;
 
 declare const coll: Collection<{ a: number; b: string }>;
+// Passing no options will return the modify result.
 expectType<WithId<{ a: number; b: string }> | null>((await coll.findOneAndDelete({ a: 3 })).value);
 expectType<WithId<{ a: number; b: string }> | null>(
   (await coll.findOneAndReplace({ a: 3 }, { a: 5, b: 'new string' })).value
@@ -305,6 +306,45 @@ expectType<WithId<{ a: number; b: string }> | null>(
   ).value
 );
 
+// Passing empty options will return the modify result.
+expectType<WithId<{ a: number; b: string }> | null>(
+  (await coll.findOneAndDelete({ a: 3 }, {})).value
+);
+expectType<WithId<{ a: number; b: string }> | null>(
+  (await coll.findOneAndReplace({ a: 3 }, { a: 5, b: 'new string' }, {})).value
+);
+expectType<WithId<{ a: number; b: string }> | null>(
+  (
+    await coll.findOneAndUpdate(
+      { a: 3 },
+      {
+        $set: {
+          a: 5
+        }
+      },
+      {}
+    )
+  ).value
+);
+
+// Including { includeResultMetadata: true } option will return the
+// modify result.
+expectType<WithId<{ a: number; b: string }> | null>(
+  (await coll.findOneAndDelete({ a: 3 }, { includeResultMetadata: true })).value
+);
+expectType<WithId<{ a: number; b: string }> | null>(
+  (
+    await coll.findOneAndReplace(
+      { a: 3 },
+      { a: 5, b: 'new string' },
+      { includeResultMetadata: true }
+    )
+  ).value
+);
+expectType<WithId<{ a: number; b: string }> | null>(
+  (await coll.findOneAndUpdate({ a: 3 }, { $set: { a: 5 } }, { includeResultMetadata: true })).value
+);
+
 // Including { includeResultMetadata: false } option will change the return type
 // to the modified document or null.
 expectType<WithId<{ a: number; b: string }> | null>(