feat(NODE-5754): allow auto select family options

[durran]

Description

Allows users to specify auto select family options passed to the underlying connections.

What is changing?

• Adds autoSelectFamily option to the client which defaults to true.
• Adds autoSelectFamilyAttemptTimeout option to the client with no default.
• Adds tests to verify the options are passed through to regular and TLS connections.

Is there new documentation needed for these changes?

Add note in documentation about the options.

What is the motivation for this change?

NODE-5754

Release Highlight

Driver now supports auto selecting between IPv4 and IPv6 connections

For users on Node versions that support the autoSelectFamily and autoSelectFamilyAttemptTimeout options (Node 18.13+), they can now be provided to the MongoClient and will be passed through to socket creation. autoSelectFamily will default to true with autoSelectFamilyAttemptTimeout by default not defined. Example:

const client = new MongoClient(process.env.MONGODB_URI, { autoSelectFamilyAttemptTimeout: 100 });

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

[nbbeeken]

Changes LGTM! Can you fill out the release highlights? this is def a feature to show off 🎉

[durran]

Changes LGTM! Can you fill out the release highlights? this is def a feature to show off 🎉

Ah yeah missed that. Updated now.

[baileympearson]

Question: should we also be using autoSelectFamily when establishing sockets for KMS requests in the state machine?

[durran]

Question: should we also be using autoSelectFamily when establishing sockets for KMS requests in the state machine?

Good question. I think the answer to that should be yes? If we agree I can add to this PR.

[baileympearson]

@durran We could potentially consume makeSocket directly from the KMS fetching in the state machine. That's a nice improvement regardless. Then we'd automatically support the new option, so long as we pass it into the state machine.

want to spend a bit of time looking at that approach?

[nbbeeken]

I am just putting back my request changes state since you're working on the above, given the reactions I think we're all on board with expanding this to KMS.

Using makeSocket sounds great but you may run into more refactoring than is worth, I'm thinking about how connecting will be inside that function now and you may have to catch and re-throw in "interesting" ways, additionally, I am unsure if the socks5 behavior is precisely equivalent.

If none of that ends up being a concern GREAT! But if it is, as long as we can get the autoFamily option through we can rest this work there, and file a follow up to consolidate 🚀 Good catch @baileympearson

[durran]

The refactor to use makeSocket did prove to be a bit more invasive for my liking, so I've left it out here and will create a ticket for that. PR has now been updated to pass through the new socket options to the state machine to use with KMS requests.

[nbbeeken]

couple of Qs

[nbbeeken]

LGTM!