dns: support IPv6-only and IPv4-only in setLocalAddress() #58701
Conversation
This file contains hidden or 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
…ly) addresses
## Title
dns: allow `resolver.setLocalAddress()` to accept IPv6-only or IPv4-only addresses
## Description
`ResolverBase.prototype.setLocalAddress()` previously **required** the first argument (`ipv4`) to be a non-empty string, throwing `ERR_INVALID_ARG_TYPE` whenever a user tried to set **only** an IPv6 local address:
```js
const r = new (require('dns').Resolver)();
r.setLocalAddress(undefined, '::1'); // ❌ TypeError
This broke documented API behaviour and prevented IPv6-only configurations.
Changes
lib/internal/dns/utils.js
Imported ERR_MISSING_ARGS.
Updated
setLocalAddress()
:
If both ipv4 and ipv6 are undefined, throw ERR_MISSING_ARGS('ipv4', 'ipv6').
Validate each address only when provided.
Preserve snapshot-state logic.
Result
setLocalAddress()
now works correctly with any of:
resolver.setLocalAddress('0.0.0.0'); // IPv4-only
resolver.setLocalAddress(undefined, '::1'); // IPv6-only
resolver.setLocalAddress('0.0.0.0', '::1'); // both
Restores compliance with public documentation and unblocks IPv6-only deployments.
|
Review requested:
|
nodejs-github-bot
added
dns
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #58701 +/- ##
==========================================
- Coverage 90.17% 90.14% -0.03%
==========================================
Files 637 637
Lines 188023 188029 +6
Branches 36887 36889 +2
==========================================
- Hits 169552 169505 -47
- Misses 11223 11276 +53
Partials 7248 7248
🚀 New features to boost your workflow:
|
Ethan-Arrowood
approved these changes
Jun 14, 2025
mohiuddin-khan-shiam
changed the title
resolver.setLocalAddress() to accept IPv6-only / IPv4-only addresses
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.
What was fixed
Resolver.prototype.setLocalAddress(ipv4, ipv6)incorrectly required an IPv4 string even when callers only wanted to set an IPv6 local address.Calling
resolver.setLocalAddress(undefined, '::1')threwERR_INVALID_ARG_TYPE, breaking the documented API and blocking IPv6-only use-cases.Changes
ERR_MISSING_ARGSto imported error codes.ERR_MISSING_ARGS('ipv4','ipv6')when both arguments are omitted.Impact
Restores conformance with public documentation:
Refs: documentation for
resolver.setLocalAddress