Skip to content

Undocumented change to "family" attribute in os.networkInterfaces() in Node 18 #42787

Closed
#42789
Closed
Undocumented change to "family" attribute in os.networkInterfaces() in Node 18#42787
#42789
Labels
osIssues and PRs related to the os subsystem.

Description

@BenSjoberg
BenSjoberg
opened on Apr 19, 2022

Version

v18.0.0

Platform

Darwin Bens-MacBook-Pro-2.local 21.4.0 Darwin Kernel Version 21.4.0: Fri Mar 18 00:45:05 PDT 2022; root:xnu-8020.101.4~15/RELEASE_X86_64 x86_64

Subsystem

No response

What steps will reproduce the bug?

Easy to reproduce in the REPL - just call os.networkInterfaces() Each listed IP has a "family" attribute. Before Node 18 this was a string value of "IPv4" or "IPv6", in Node 18 it's a numeric 4 or 6.

How often does it reproduce? Is there a required condition?

Happens 100% of the time. Only requirement is to be running Node 18.

What is the expected behavior?

The family attribute should be either "IPv4" or "IPv6". The Node 18 documentation still describes it this way, and the Node 18 changelog doesn't mention this change, so my assumption is that this is unintended. If it actually was intended, then the documentation and changelog should be updated to reflect it.

What do you see instead?

Example from the Node 18 REPL:

> os.networkInterfaces()
{
  lo0: [
    {
      address: '127.0.0.1',
      netmask: '255.0.0.0',
      family: 4,
      mac: '00:00:00:00:00:00',
      internal: true,
      cidr: '127.0.0.1/8'
    },
    {
      address: '::1',
      netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
      family: 6,
      mac: '00:00:00:00:00:00',
      internal: true,
      cidr: '::1/128',
      scopeid: 0
    },
    ...
]

Additional information

The changelog does say "net: make server.address() return an integer for family". If this was unintentional, maybe it could be a side effect from whatever was done in that PR? (I haven't looked at that PR, nor am I familiar with Node's internals, so this is just a guess.)

Activity

  1. ImageBenSjoberg
    changed the title [-]Undocumented change to "family" attribute in os.networkInterfaces() in Node18[/-] [+]Undocumented change to "family" attribute in os.networkInterfaces() in Node 18[/+] on Apr 19, 2022

  2. BethGriggs commented on Apr 19, 2022

    @BethGriggs
    BethGriggs
    on Apr 19, 2022
    Member

    /cc @aduh95 as the author of #41431

  3. bl-ue commented on Apr 19, 2022

    @bl-ue
    bl-ue
    on Apr 19, 2022
    Contributor

    Related: #41431 (comment)

  4. Imageaduh95
    added a commit that references this issue on Apr 19, 2022

    doc: fix outdated documentation for `family` property

    ac2b488
  5. ImageVoltrexKeyva
    added
    osIssues and PRs related to the os subsystem.
    on Apr 20, 2022

  6. richardlau commented on Apr 20, 2022

    @richardlau
    richardlau
    on Apr 20, 2022
    Member

    #41431 has now introduced an inconsistency between os.networkInterfaces() and diagnostic reports. e.g.

    > os.networkInterfaces()
{
  lo: [
    {
      address: '127.0.0.1',
      netmask: '255.0.0.0',
      family: 4,
      mac: '00:00:00:00:00:00',
      internal: true,
      cidr: '127.0.0.1/8'
    },
    {
      address: '::1',
      netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
      family: 6,
      mac: '00:00:00:00:00:00',
      internal: true,
      cidr: '::1/128',
      scopeid: 0
    }
  ],

    compared to:

    > process.report.getReport().header.networkInterfaces
[
  {
    name: 'lo',
    internal: true,
    mac: '00:00:00:00:00:00',
    address: '127.0.0.1',
    netmask: '255.0.0.0',
    family: 'IPv4'
  },
...
  {
    name: 'lo',
    internal: true,
    mac: '00:00:00:00:00:00',
    address: '::1',
    netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
    family: 'IPv6',
    scopeid: 0
  },
...
  7. Imageavwo
    added 2 commits that reference this issue on Apr 20, 2022

    fix: nodejs/node#42787

    4d642fa

    fix: nodejs/node#42787

    10b5ee3
  8. Imagenodejs-github-bot
    closed this as completedin #42789on Apr 21, 2022
  9. Imagenodejs-github-bot
    added a commit that references this issue on Apr 21, 2022

    doc: fix outdated documentation for `family` property

    4ad342a
  10. Imagextx1130
    added a commit that references this issue on Apr 25, 2022

    doc: fix outdated documentation for `family` property

    20e163a
  11. Imagetargos
    added a commit that references this issue on Apr 28, 2022

    doc: fix outdated documentation for `family` property

    d9f3f05
  12. Imageissotina
    added a commit that references this issue on May 2, 2022

    Use lts version of node instead of latest

    d11127b
  13. Imagescravy
    added a commit that references this issue on Jun 23, 2022

    Merge pull request #40 from Alexander-Taran/master

    1722be3
  14. ImagenailuoGG
    added a commit that references this issue on Jul 5, 2022

    Squashed 'vendor/whistle/' changes from 05e991e17..74ef62c97

    f0bae47
  15. Imagexcodebuild
    added a commit that references this issue on Nov 4, 2022

    Squashed 'vendor/whistle/' changes from 05e991e173..71c05db286

    c3b86d5
  16. Imagesylbru
    added a commit that references this issue on Dec 7, 2022

    Detect network address on Node 18

    e01d5d1
  17. Imageyoursunny
    added a commit that references this issue on Jul 29, 2023

    node-transport: delete intfHasAddressFamily

    77067f7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    osIssues and PRs related to the os subsystem.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions