feat(NODE-3568)!: ensure includeResultsMetadata is false by default

[W-A-James]

Description

What is changing?

• includeResultsMetadata is now set to false by default for findAndX family of methods
• Updated uses of findAndX methods to set includeResultMetadata as appropriate

Is there new documentation needed for these changes?

What is the motivation for this change?

• NODE-3568
• spec compliance

Release Highlight

findAndX family of methods will now set includeResultsMetadata to false by default

Previously, the default return type of this family of methods was a ModifyResult containing the found document and additional metadata. Now by default, they will return the found document or null.

// This has the same behaviour as providing `{ includeResultMetadata: false }` in the pre v6 driver
await collection.findOneAndUpdate(
	{ hello: 'world' },
	{ $set: { hello: 'WORLD' } });
// > { _id: new ObjectId("64c4204517f785be30795c92"), hello: 'world' }

// This has the same behaviour as providing no options in the pre v6 driver
await collection.findOneAndUpdate(
	{ hello: 'world' },
	{ $set: { hello: 'WORLD' } },
	{ includeResultMetadata: true } );
// > {
// >  lastErrorObject: { n: 1, updatedExisting: true },
// >  value: { _id: new ObjectId("64c4208b17f785be30795c93"), hello: 'world' },
// >  ok: 1
// > }

Double check the following

• Ran npm run check:lint script
• Self-review completed using the steps outlined here
• PR title follows the correct format: type(NODE-xxxx)[!]: description
  • Example: feat(NODE-1234)!: rewriting everything in coffeescript
• Changes are covered by tests
• New TODOs have a related JIRA ticket

[durran]

test/types/community/collection/findX.test-d.ts has some type tests to uncomment as part of this ticket. Also I expect those existing tests in that file to be failing, but they are not as the type definitions for findOneAndUpdate, findOneAndDelete, and findOneAndReplace are still typed as returning a ModifyResult when no options are passed or an options object without includeResultMetadata is provided - so those are incorrect with the new default.

[durran]

Looking good, just a few minor suggestions. (I think the schema helpers type tests should just use the default). There may some linting fixes needed with my change suggestions.

[durran]

@W-A-James Can you fix the conflicts then I'll merge. Thanks!