Allow disabling autoSelectFamily in an Agent #4070
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently the options are only passed if they enable autoSelectFamily. However, if autoSelectFamily is the default, we want to be able to disable it too.
- Also add tests. - Fix types so that partial options can be passed to buildConnector without violating the TypeScript. For example, TcpNet options require 'port' but the options we pass should not.
hitsthings
commented
Feb 28, 2025
| @@ -70,7 +70,7 @@ export declare namespace Client { | |||
| /** TODO */ | |||
| maxRedirections?: number; | |||
| /** TODO */ | |||
| connect?: buildConnector.BuildOptions | buildConnector.connector; | |||
| connect?: Partial<buildConnector.BuildOptions> | buildConnector.connector; | |||
There was a problem hiding this comment.
new Agent({ connect: { autoSelectFamily: true } }) is not actually considered valid currently because it doesn't specify required properties of buildConnector.BuildOptions. But the rest of the options come from elsewhere (hence why connect itself is not a required property) so you don't need to specify everything.
metcoder95
approved these changes
Feb 28, 2025
|
Let me know if I need to do something about those tests. They seem unrelated to this afaict. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the options are only passed if they enable autoSelectFamily. However, if autoSelectFamily is the default, we want to be able to disable it too.
Noticed this while debugging nodejs/node#47822 (comment)
This relates to...
nodejs/node#47822 (comment)
Rationale
Currently this claims to accept a boolean but really only accepts
true.Changes
React to the autoSelectFamily option if it is passed in.
Features
Agent's can disable autoSelectFamily
Breaking Changes and Deprecations
None?
Status