dns: remove `dns.lookup` and `dnsPromises.lookup` options type coercion #41431

aduh95 · 2022-01-07T16:26:44Z

No description provided.

nodejs-github-bot · 2022-01-07T16:26:48Z

Review requested:

@nodejs/net

doc/api/deprecations.md

nodejs-github-bot · 2022-04-03T17:29:34Z

CI: https://ci.nodejs.org/job/node-test-pull-request/43296/

nodejs-github-bot · 2022-04-03T19:39:17Z

CI: https://ci.nodejs.org/job/node-test-pull-request/43301/

aduh95 · 2022-04-03T19:55:22Z

@nodejs/tsc can we get this into v18.x?

Trott

LGTM if CITGM doesn't find problems.

mcollina · 2022-04-03T20:18:49Z

src/node_os.cc

      uv_ip6_name(&interfaces[i].address.address6, ip, sizeof(ip));
      uv_ip6_name(&interfaces[i].netmask.netmask6, netmask, sizeof(netmask));
-      family = env->ipv6_string();
+      family = Integer::New(env->isolate(), 6);


I'm concerned about these two specific changes, moving from IPv4 to 4 and IPv6 to 6. I'm 100% sure those will break some of my modules (Fastify v4).

The reason for this change is that currently passing an address object to the DNS resolver, the 'IPv6' string is converted to 0.
Would it be reasonable to ask you to update the code that using that to expect one form or the other? Something like info.family === 6 || info.family === 'IPv6'? If not, we could make the DNS resolver accept a string and interpret 'IPv6' same as 6.

I assume this change will hurt the community a lot.

I personally would see this:

If not, we could make the DNS resolver accept a string and interpret 'IPv6' same as 6.

as the better solution

Agreed here. I realize that Node v18 was a major version change, but changing the output of a widely used API (socket.address()) just so another core-Node API could match up with it instead of making the DNS resolver more flexible seems pretty overkill!

Now that it's out in the wild, can confirm it caused some widespread breaking for us that's going to make node 18 a pain and very uncertain to roll out.

I assume this change will hurt the community a lot.

Can confirm completely unexpected breakage

@aduh95 @mcollina Any chance to think about that change again and consider alternatives?

maybe a new issue is more visible to the nodejs team and allows a better discussion ... so see #43014 ... Please "thumbs up" it if you support to adjust this to be backward compatible. Thank you

mcollina

lgtm

aduh95 · 2022-04-04T13:36:29Z

CITGM (master): https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/2904/
CITGM (aduh95:no-dns-lookup-options-type-coercion): https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/2905/

nodejs-github-bot · 2022-04-06T22:14:45Z

CI: https://ci.nodejs.org/job/node-test-pull-request/43357/

nodejs-github-bot · 2022-04-08T10:11:46Z

CI: https://ci.nodejs.org/job/node-test-pull-request/43390/

richardlau · 2022-04-08T14:06:16Z

@aduh95 If it helps the failures in the recent CI runs for this PR have all been running inside containers.

nodejs-github-bot · 2022-04-08T18:19:50Z

CI: https://ci.nodejs.org/job/node-test-pull-request/43400/

nodejs-github-bot · 2022-04-08T18:22:00Z

CI: https://ci.nodejs.org/job/node-test-pull-request/43401/

Context: nodejs/node#41431 (comment)

Refs: #41431 Fixes: #42787 PR-URL: #42789 Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it>

Refs: #41431 PR-URL: #42795 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Context: nodejs/node#41431 (comment)

ref: #8530 See nodejs/node#41431 Signed-off-by: Francisco Buceta <frbuceta@gmail.com>

See nodejs/node#41431 Signed-off-by: Francisco Buceta <frbuceta@gmail.com>

Refs: #41431 PR-URL: #42795 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

See nodejs/node#41431 Signed-off-by: Francisco Buceta <frbuceta@gmail.com>

Aligns Deno's `server.address()` with Node.js v18.4.0+ behavior by returning the `family` property as a string ("IPv4" or "IPv6") rather than a number. Node.js briefly changed `family` from string to number in v18.0.0 (nodejs/node#41431), but reverted in v18.4.0 (nodejs/node#43054) due to ecosystem breakage (nodejs/node#43014). This fix ensures compatibility with npm packages that rely on the string format, which has been the stable API since Node.js v18.4.0. Refs: - nodejs/node#43054 - nodejs/node@70b516e 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Aligns Deno's Node.js compatibility layer with Node.js v18.4.0+ behavior by returning the `family` property as a string ("IPv4" or "IPv6") rather than a number in `server.address()` and socket address methods. Node.js briefly changed `family` from string to number in v18.0.0 (nodejs/node#41431), but reverted in v18.4.0 (nodejs/node#43054) due to ecosystem breakage (nodejs/node#43014). Changes: - `http.Server.address()`, `https.Server.address()`, `http2.Server.address()` now include `family` property as string - `net.Server.address()` returns string `family` via tcp_wrap.ts - `socket.remoteFamily` returns string instead of number - `dns.lookup()` accepts both numeric (0, 4, 6) and string ("IPv4", "IPv6") family values, matching Node.js behavior Family value derivation follows Node.js C++ implementation: - isIP() === 4 → "IPv4" - isIP() === 6 → "IPv6" - isIP() === 0 → undefined (defensive, matches Node.js behavior for non-IP addresses, though not practically reachable via TCP server APIs) Refs: - nodejs/node#43054 - nodejs/node@70b516e 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

## Summary Aligns Deno's Node.js compatibility layer (`node:net`, `node:http`, `node:https`, `node:http2`, `node:dns`) with Node.js v18.4.0+ behavior by returning the `family` property as a string (`"IPv4"` or `"IPv6"`) rather than a number in `server.address()` and socket address methods. Node.js briefly changed `family` from string to number in v18.0.0 (nodejs/node#41431), but reverted in v18.4.0 (nodejs/node#43054) due to ecosystem breakage (nodejs/node#43014). This fix ensures compatibility with npm packages that rely on the string format, which has been the stable API since Node.js v18.4.0. ## Changes - Modified `ext/node/polyfills/http.ts` to add `family` property to `address()` return - Modified `ext/node/polyfills/internal_binding/tcp_wrap.ts` to return string `family` instead of number in `getsockname()`, `getpeername()`, and `#connect()` - Modified `ext/node/polyfills/net.ts` to fix `socket.remoteFamily` getter (no longer needs conversion since `family` is now a string) - Modified `ext/node/polyfills/dns.ts` and `ext/node/polyfills/internal/dns/promises.ts` to accept string family values (`"IPv4"`, `"IPv6"`) in `lookup()`, matching [Node.js behavior](https://nodejs.org/api/dns.html#dnslookuphostname-options-callback) - Added tests in `tests/unit_node/http_test.ts`, `tests/unit_node/http2_test.ts`, `tests/unit_node/https_test.ts`, `tests/unit_node/dns_test.ts`, and `tests/unit_node/net_test.ts` ## Node.js Compatibility Note For non-IP addresses (when `isIP()` returns 0), the `family` property is `undefined`. This matches Node.js C++ behavior in [`AddressToJS`](https://github.com/nodejs/node/blob/main/src/tcp_wrap.cc) where family is only set for `AF_INET` (`"IPv4"`) and `AF_INET6` (`"IPv6"`), and left undefined otherwise. ## Refs - nodejs/node#43054 - nodejs/node@70b516e  --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Daniel Rahmanto <daniel.rahmanto@gmail.com>

aduh95 added the semver-major PRs that contain breaking changes and should be released in the next major version. label Jan 7, 2022

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Jan 7, 2022

VoltrexKeyva reviewed Jan 8, 2022

View reviewed changes

doc/api/deprecations.md Outdated Show resolved Hide resolved

aduh95 force-pushed the no-dns-lookup-options-type-coercion branch from 740a691 to 8e53d29 Compare April 3, 2022 17:08

aduh95 added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 3, 2022

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 3, 2022

aduh95 force-pushed the no-dns-lookup-options-type-coercion branch from 8e53d29 to 13c8788 Compare April 3, 2022 19:39

Trott approved these changes Apr 3, 2022

View reviewed changes

mcollina reviewed Apr 3, 2022

View reviewed changes

mcollina approved these changes Apr 4, 2022

View reviewed changes

aduh95 force-pushed the no-dns-lookup-options-type-coercion branch from 13c8788 to 84164de Compare April 4, 2022 13:31

mcollina added the notable-change PRs with changes that should be highlighted in changelogs. label Apr 4, 2022

aduh95 added request-ci Add this label to start a Jenkins CI on a PR. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Apr 6, 2022

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 6, 2022

This was referenced Apr 7, 2022

CI Reliability 2022-04-07 nodejs/reliability#244

Open

CI Reliability 2022-04-08 nodejs/reliability#245

Open

aduh95 marked this pull request as draft April 8, 2022 10:11

IvanGoncharov added a commit to IvanGoncharov/apollo-server that referenced this pull request Apr 26, 2022

test: fix failing integration tests on node@18

29a2a7f

Context: nodejs/node#41431 (comment)

oznu mentioned this pull request Apr 27, 2022

Fix #18 - Node.js v18 os.networkInterfaces()[].family number/string c… homebridge/ciao#25

Merged

nodejs-github-bot pushed a commit that referenced this pull request Apr 28, 2022

test: fix parallel/test-dgram-udp6-link-local-address

68fb0bf

Refs: #41431 PR-URL: #42795 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

glasser pushed a commit to IvanGoncharov/apollo-server that referenced this pull request Apr 28, 2022

test: fix failing integration tests on node@18

494c15b

Context: nodejs/node#41431 (comment)

trevor-scheer pushed a commit to apollographql/apollo-server that referenced this pull request Apr 28, 2022

test: fix failing integration tests on node@18 (#6350)

6cd417c

Context: nodejs/node#41431 (comment)

miherlosev mentioned this pull request Apr 29, 2022

Testcafe doesn't work with node 18.0 DevExpress/testcafe#7000

Closed

bluwy mentioned this pull request Apr 29, 2022

fix: display network logs in node 18 sveltejs/kit#4778

Merged

5 tasks

frbuceta added a commit to loopbackio/loopback-next that referenced this pull request May 1, 2022

chore: pin eslint-plugin-mocha dependency to 10.0.3

af11da6

ref: #8530 See nodejs/node#41431 Signed-off-by: Francisco Buceta <frbuceta@gmail.com>

frbuceta added a commit to loopbackio/loopback-next that referenced this pull request May 1, 2022

chore: pin eslint-plugin-mocha dependency to 10.0.3

0979f81

ref: #8530 See nodejs/node#41431 Signed-off-by: Francisco Buceta <frbuceta@gmail.com>

frbuceta added a commit to loopbackio/loopback-next that referenced this pull request May 2, 2022

fix: address.family is number in Node v18

e45cafa

See nodejs/node#41431 Signed-off-by: Francisco Buceta <frbuceta@gmail.com>

targos pushed a commit that referenced this pull request May 2, 2022

test: fix parallel/test-dgram-udp6-link-local-address

3c796f8

Refs: #41431 PR-URL: #42795 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

frbuceta added a commit to loopbackio/loopback-next that referenced this pull request May 3, 2022

fix: address.family is number in Node v18

9758ba8

See nodejs/node#41431 Signed-off-by: Francisco Buceta <frbuceta@gmail.com>

panva mentioned this pull request May 3, 2022

os.networkInterfaces().family is no longer a string #42953

Closed

Apollon77 mentioned this pull request May 9, 2022

Revert the change of network interfaces family from String to Integer #43014

Closed

nodech mentioned this pull request May 11, 2022

Localhost lookup and default host settings handshake-org/hsd#722

Closed

JKRhb mentioned this pull request May 22, 2022

chore: update tested node versions to 14, 16, and 18 coapjs/node-coap#347

Merged

RaisinTen mentioned this pull request Sep 29, 2022

net: add autoSelectFamily option #44731

Merged

ksmithut mentioned this pull request Nov 2, 2022

Node 18 family parameter fails when passing url redis/ioredis#1672

Closed

climba03003 mentioned this pull request Sep 16, 2024

dns.lookup options..family throw errors when using 'IPv4' #54961

Closed

avivkeller mentioned this pull request Sep 16, 2024

doc: remove outdated sentence #54963

Closed

nrako mentioned this pull request Nov 30, 2025

fix(node/net): return string family in server.address() denoland/deno#31465

Merged

Uh oh!

dns: remove dns.lookup and dnsPromises.lookup options type coercion #41431

dns: remove dns.lookup and dnsPromises.lookup options type coercion #41431

Uh oh!

Conversation

aduh95 commented Jan 7, 2022

Uh oh!

nodejs-github-bot commented Jan 7, 2022

Uh oh!

Uh oh!

nodejs-github-bot commented Apr 3, 2022

Uh oh!

nodejs-github-bot commented Apr 3, 2022

Uh oh!

aduh95 commented Apr 3, 2022

Uh oh!

Trott left a comment

Choose a reason for hiding this comment

Uh oh!

mcollina Apr 3, 2022

Choose a reason for hiding this comment

Uh oh!

aduh95 Apr 3, 2022

Choose a reason for hiding this comment

Uh oh!

Apollon77 Apr 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

glasser Apr 28, 2022

Choose a reason for hiding this comment

Uh oh!

aredridel May 5, 2022

Choose a reason for hiding this comment

Uh oh!

Hypfer May 7, 2022

Choose a reason for hiding this comment

Uh oh!

Apollon77 May 7, 2022

Choose a reason for hiding this comment

Uh oh!

Apollon77 May 9, 2022

Choose a reason for hiding this comment

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

aduh95 commented Apr 4, 2022

Uh oh!

nodejs-github-bot commented Apr 6, 2022

Uh oh!

nodejs-github-bot commented Apr 8, 2022

Uh oh!

richardlau commented Apr 8, 2022

Uh oh!

nodejs-github-bot commented Apr 8, 2022

Uh oh!

nodejs-github-bot commented Apr 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

dns: remove `dns.lookup` and `dnsPromises.lookup` options type coercion #41431

dns: remove `dns.lookup` and `dnsPromises.lookup` options type coercion #41431

Apollon77 Apr 25, 2022 •

edited

Loading