test: update type tests

Author: durran

src/operations/find_and_modify.ts

@@ -133,10 +133,7 @@ class FindAndModifyOperation extends CommandOperation<Document> {
       upsert: false
     };
 
-    // Default to returning the raw result.
-    if (!('includeResultMetadata' in options)) {
-      options.includeResultMetadata = true;
-    }
+    options.includeResultMetadata ??= true;
 
     const sort = formatSort(options.sort);
     if (sort) {

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

@@ -288,6 +288,25 @@ const fooObjWithArray: FooWithArray = {
 const fooFilterWithArray: Filter<FooWithArray> = fooObjWithArray;
 
 declare const coll: Collection<{ a: number; b: string }>;
+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: false } option will change the return type
+// to the modified document or null.
 expectType<WithId<{ a: number; b: string }> | null>(
   await coll.findOneAndDelete({ a: 3 }, { includeResultMetadata: false })
 );
@@ -299,12 +318,20 @@ expectType<WithId<{ a: number; b: string }> | null>(
   )
 );
 expectType<WithId<{ a: number; b: string }> | null>(
-  await coll.findOneAndUpdate({ a: 3 }, { $set: { a: 5 } }, { includeResultMetadata: false })
+  await coll.findOneAndUpdate(
+    { a: 3 },
+    {
+      $set: {
+        a: 5
+      }
+    },
+    { includeResultMetadata: false }
+  )
 );
 
 // projections do not change the return type - our typing doesn't support this
 expectType<WithId<{ a: number; b: string }> | null>(
-  await coll.findOneAndDelete({ a: 3 }, { projection: { _id: 0 }, includeResultMetadata: false })
+  (await coll.findOneAndDelete({ a: 3 }, { projection: { _id: 0 } })).value
 );
 
 // NODE-3568: Uncomment when ModifyResult is removed in 5.0

test/types/schema_helpers.test-d.ts

@@ -72,30 +72,22 @@ expectAssignable<SchemaWithIdInterface | null>(await interfaceTestCollection.fin
 expectAssignable<SchemaWithIdType>((await typeTestCollection.find().toArray())[0]);
 expectAssignable<SchemaWithIdInterface>((await interfaceTestCollection.find().toArray())[0]);
 expectAssignable<SchemaWithIdType | null>(
-  await typeTestCollection.findOneAndDelete({ a: 1 }, { includeResultMetadata: false })
+  (await typeTestCollection.findOneAndDelete({ a: 1 })).value
 );
 expectAssignable<SchemaWithIdInterface | null>(
-  await interfaceTestCollection.findOneAndDelete({ a: 1 }, { includeResultMetadata: false })
+  (await interfaceTestCollection.findOneAndDelete({ a: 1 })).value
 );
 expectAssignable<SchemaWithIdType | null>(
-  await typeTestCollection.findOneAndReplace({ a: 1 }, { a: 5 }, { includeResultMetadata: false })
+  (await typeTestCollection.findOneAndReplace({ a: 1 }, { a: 5 })).value
 );
 expectAssignable<SchemaWithIdInterface | null>(
-  await interfaceTestCollection.findOneAndReplace(
-    { a: 1 },
-    { a: 5 },
-    { includeResultMetadata: false }
-  )
+  (await interfaceTestCollection.findOneAndReplace({ a: 1 }, { a: 5 })).value
 );
 expectAssignable<SchemaWithIdType | null>(
-  await typeTestCollection.findOneAndUpdate({ a: 1 }, { a: 5 }, { includeResultMetadata: false })
+  (await typeTestCollection.findOneAndUpdate({ a: 1 }, { a: 5 })).value
 );
 expectAssignable<SchemaWithIdInterface | null>(
-  await interfaceTestCollection.findOneAndUpdate(
-    { a: 1 },
-    { a: 5 },
-    { includeResultMetadata: false }
-  )
+  (await interfaceTestCollection.findOneAndUpdate({ a: 1 }, { a: 5 })).value
 );
 
 // OptionalId assignability when wrapping a schema with _id: number
@@ -123,7 +115,7 @@ expectAssignable<SchemaWithIdNumberInterface | null>(
   (await interfaceNumberTestCollection.findOneAndDelete({ a: 1 })).value
 );
 expectAssignable<SchemaWithIdNumberType | null>(
-  (await typeNumberTestCollection.findOneAndReplace({ a: 1 }, { a: 5 }, {})).value
+  (await typeNumberTestCollection.findOneAndReplace({ a: 1 }, { a: 5 })).value
 );
 expectAssignable<SchemaWithIdNumberInterface | null>(
   (await interfaceNumberTestCollection.findOneAndReplace({ a: 1 }, { a: 5 })).value
@@ -135,41 +127,6 @@ expectAssignable<SchemaWithIdNumberInterface | null>(
   (await interfaceNumberTestCollection.findOneAndUpdate({ a: 1 }, { a: 5 })).value
 );
 
-expectAssignable<SchemaWithIdNumberType | null>(
-  await typeNumberTestCollection.findOneAndDelete({ a: 1 }, { includeResultMetadata: false })
-);
-expectAssignable<SchemaWithIdNumberInterface | null>(
-  await interfaceNumberTestCollection.findOneAndDelete({ a: 1 }, { includeResultMetadata: false })
-);
-expectAssignable<SchemaWithIdNumberType | null>(
-  await typeNumberTestCollection.findOneAndReplace(
-    { a: 1 },
-    { a: 5 },
-    { includeResultMetadata: false }
-  )
-);
-expectAssignable<SchemaWithIdNumberInterface | null>(
-  await interfaceNumberTestCollection.findOneAndReplace(
-    { a: 1 },
-    { a: 5 },
-    { includeResultMetadata: false }
-  )
-);
-expectAssignable<SchemaWithIdNumberType | null>(
-  await typeNumberTestCollection.findOneAndUpdate(
-    { a: 1 },
-    { a: 5 },
-    { includeResultMetadata: false }
-  )
-);
-expectAssignable<SchemaWithIdNumberInterface | null>(
-  await interfaceNumberTestCollection.findOneAndUpdate(
-    { a: 1 },
-    { a: 5 },
-    { includeResultMetadata: false }
-  )
-);
-
 /** ----------------------------------------------------------------------
  * OptionalUnlessRequiredId
  */