punycode module deprecated message #6689

mphillippiAPG · 2023-10-24T23:12:59Z

Steps To Reproduce

from terminal on macOS, run any bw command:

bw --version

Expected Result

should only provide the version:

2023.9.1

Actual Result

shows a deprecation warning for punycode in node:

(node:2299) [DEP0040] DeprecationWarning: The punycode module is deprecated. Please use a userland alternative instead.
(Use node --trace-deprecation ... to show where the warning was created)
2023.9.1

Screenshots or Videos

❯ bw --version
(node:2299) [DEP0040] DeprecationWarning: The punycode module is deprecated. Please use a userland alternative instead.
(Use node --trace-deprecation ... to show where the warning was created)
2023.9.1

Additional Context

No response

Operating System

macOS

Operating System Version

14.0 (23A344)

Shell

Zsh

Build Version

2023.9.1

Issue Tracking Info

I understand that work is tracked outside of Github. A PR will be linked to this issue should one be opened to address it, but Bitwarden doesn't use fields like "assigned", "milestone", or "project" to track progress.

The text was updated successfully, but these errors were encountered:

hseeberger · 2023-10-25T06:39:23Z

As a workaround you can use bw ... 2>/dev/null for the time being, because the noise is written to stderr.

tyler-8 · 2023-10-25T16:58:45Z

Output of the node --trace-deprecation command

~ node --trace-deprecation /opt/homebrew/bin/bw
(node:32186) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
    at node:punycode:3:9
    at BuiltinModule.compileForInternalLoader (node:internal/bootstrap/realm:392:7)
    at BuiltinModule.compileForPublicLoader (node:internal/bootstrap/realm:328:10)
    at loadBuiltinModule (node:internal/modules/helpers:101:7)
    at Module._load (node:internal/modules/cjs/loader:1001:17)
    at Module.require (node:internal/modules/cjs/loader:1235:19)
    at require (node:internal/modules/helpers:176:18)
    at Object.<anonymous> (/opt/homebrew/Cellar/bitwarden-cli/2023.9.1/libexec/lib/node_modules/@bitwarden/cli/node_modules/psl/index.js:5:16)
    at Module._compile (node:internal/modules/cjs/loader:1376:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1435:10)
Usage: bw [options] [command]

sammbw · 2023-10-27T04:46:53Z

Hi there,

Thank you for your report!

I was able to reproduce this issue, and I have flagged this to our engineering team.

If you wish to add any further information/screenshots/recordings etc., please feel free to do so at any time - our engineering team will be happy to review these.

Thanks once again!

RoboProgrammer69 · 2023-10-28T08:22:18Z

Downgrade node to 20.9.0 version!

maion308 · 2023-10-31T00:30:43Z

solution that worked for me:
npm install punycode --save

and then in node_modules go to the directory tr46 > index.js

// Replace this:
const punycode = require('punycode');
// With this:
const punycode = require('punycode/');

basically just add a trailing forward slash

lmerz1 · 2023-10-31T09:45:04Z

As a workaround you can use bw ... 2>/dev/null for the time being, because the noise is written to stderr.

So I was able to do this for e.g. bw sync, but not for a command like bw list items --search example.com – which to my understanding seems to imply the latter command writes its regular output to stderr instead of stdout.

Am I right in assuming this as a bug? I am relatively new to shell/command line use, so please do correct me in case I am mistaken.

The reverse also seems to hold:

bw sync 1>/dev/null shows no output (expected); whereas

bw list items --search example.com 1>/dev/null still shows output (both the deprecation message mentioned in this issue, as well as the prompt for entering the master password).

Screenshot attached as a quick demonstration of this.

TheUdK · 2023-10-31T16:53:35Z

Temporary fix im using:

NODE_OPTIONS="--no-deprecation" bw --version

or add as an env var.
export NODE_OPTIONS="--no-deprecation

If you add the env var this will suppress all other depreciation warnings as well. Should probably be removed once this has been fixed.

saidhammane · 2023-11-04T17:11:45Z

Temporary fix im using:

NODE_OPTIONS="--no-deprecation" bw --version

or add as an env var. export NODE_OPTIONS="--no-deprecation

If you add the env var this will suppress all other depreciation warnings as well. Should probably be removed once this has been fixed.

Where did you put that exactly?

WIP: bitwarden/clients#6689

TheUdK · 2023-11-13T07:10:03Z

Temporary fix im using:
NODE_OPTIONS="--no-deprecation" bw --version
or add as an env var. export NODE_OPTIONS="--no-deprecation
If you add the env var this will suppress all other depreciation warnings as well. Should probably be removed once this has been fixed.

Where did you put that exactly?

You can either:

if you are using zsh put export NODE_OPTIONS="--no-deprecation it in ~/.zshrc or ~/.zshenv to make it persist in new sessions.
put export NODE_OPTIONS="--no-deprecation in the terminal session to make it persist for this session.
execute every bw command with the node option as 'prefix' NODE_OPTIONS="--no-deprecation" bw --version

kschat · 2024-01-05T15:52:14Z

I didn't want to set --no-deprecation globally since I use Node at work. My temp workaround was to make an alias for bw:

# Temp workaround to disable punycode deprecation logging to stderr
# https://github.com/bitwarden/clients/issues/6689
alias bw='NODE_OPTIONS="--no-deprecation" bw'

Moulick · 2024-02-22T11:28:30Z

Can we please get some love on this??

Hinton · 2024-02-23T10:34:26Z

Hi everyone,

This seems to be caused by a transient dependency of jsdom which is required by several features of the CLI. Unfortunately this means we don't have a good way of resolving this until the dependency releases a new version.

In the meanwhile you can avoid the error by using the distributed version of the CLI from our website, by downgrading node or by passing in the --no-deprecation flag to NODE_OPTIONS.

luckydonald · 2024-02-29T00:51:08Z

Related Issues:

tolecnal · 2024-03-07T19:09:18Z

Not that it is needed, as it has been confirmed by several, but here is another one with the issue on macOS 14.3.1 running Node v21.6.2.

For the time being, I have added an alias per @kschat suggestion, which solves it for me until it has been resolved upstream.

navruz8080 · 2024-03-21T19:06:43Z

The easiest way to do this is:
1 Let's install the en package (n is its name)) to manage node versions globally:
npm install -g n
2 And then, using this package, we switch the node to the version we need:
n 20.9.0

valorisa · 2024-04-13T12:03:49Z

solution that worked for me: npm install punycode --save

and then in node_modules go to the directory tr46 > index.js

// Replace this: const punycode = require('punycode'); // With this: const punycode = require('punycode/');

basically just add a trailing forward slash

Hello,

Could you please explain in detail this part 'and then in node_modules go to the directory tr46 > index.js' ? Thanks.

Servinjesus1 · 2024-06-17T20:59:20Z

To keep the latest version and remove the error messasge, find your installation of bw:

realpath $(which bw)

then go there and up a few directories till you get to the directory with build/, node_modules/, and package*.json files. This is a node project, so run

npm install punycode --save

to install the "userland" version of punycode.
Then run

find . -type f -exec grep -H "require(.*punycode" {} \;

to find all the sub-dependencies which require punycode. As @maion308 suggested, making these

require('punycode/')

calls the right version. In this latest version ( 2024.6.0 ) I had to change a few subdependencies until the error went away. Notably I think it's still the tr46 package that's the problem: it's just now a dependent of node-fetch whose version of tr46 (cli/node_modules/node-fetch/node_modules/tr46/index.js) now also needs updating to punycode/ on top of bw-cli's version of tr46 (cli/node_modules/tr46/index.js). Not sure if other changes I made were also necessary. I have at least one instance of some code that says var punycode = require('punycode')(no trailing slash) and the warning message is gone, so maybe ignore those lines.

palaueb · 2024-07-04T10:13:53Z

Hello, for me it was file ./node_modules/node-fetch/node_modules/whatwg-url/lib/url-state-machine.js, changing to require('punycode/') fixed the issue.

Also changed:

./node_modules/psl/index.js
./node_modules/node-fetch/node_modules/tr46/index.js

Thanks!

jzadra · 2024-07-08T19:46:19Z

This just started occurring for me.

bw cli: 2024.6.0
macOS Sonoma 14.5

gsoneill · 2024-08-03T23:20:28Z

I'm also having this issue

bw cli: 2024.6.1
macOS: Sonoma 14.5 (23F79)

kniziol · 2024-08-11T10:25:11Z

Result from the Copy Last Error:

(node:36881) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Invalid master password.

The master password is 100% correct. I've copied and pasted it to avoid typos.

Do you have any ideas on when it will be solved? 🙄

ckujau · 2024-08-27T17:54:54Z

For me it was editing 4 files to get rid of that warning:

$ cd $(dirname $(readlink -f $(which bw)))/../../
$ grep -r 'require("punycode")' .
./cli/node_modules/node-fetch/node_modules/whatwg-url/lib/url-state-machine.js:const punycode = require("punycode");
./cli/node_modules/node-fetch/node_modules/tr46/index.js:var punycode = require("punycode");
./cli/node_modules/tr46/index.js:const punycode = require("punycode");
./cli/node_modules/tough-cookie/lib/cookie.js:const punycode = require("punycode");

Replace all those with punycode/ as suggested (and install the punycode module locally) and the warnings are gone.

rojosinalma · 2024-09-05T10:35:16Z

It's almost 1 year after the first acknowledgement of this issue and there's still no official solution. What's the current status, is there any intentions of fixing it or giving a reasonable timeline? @sammbw

djsmith85 · 2024-09-05T10:55:20Z

@rojosinalma As @Hinton has previously mentioned this is an upstream issue:

Hi everyone,

This seems to be caused by a transient dependency of jsdom which is required by several features of the CLI. Unfortunately this means we don't have a good way of resolving this until the dependency releases a new version.

In the meanwhile you can avoid the error by using the distributed version of the CLI from our website, by downgrading node or by passing in the --no-deprecation flag to NODE_OPTIONS.

chipschipschips · 2024-09-18T18:50:46Z

BitWarden, if you're not interested enough in resolving this properly[1], and it's otherwise harmless, and one recommended workaround includes passing the --no-deprecation flag to NODE_OPTIONS, then why not set that environment variable in the CLI itself?

For example:

@@ -1,4 +1,4 @@
-#!/usr/local/opt/node/bin/node
+#!/usr/bin/env NODE_OPTIONS=--no-deprecation /usr/local/opt/node/bin/node

You can then revert this once jsdom releases a new version.

[1] Eg: chasing this up with jsdom

valorisa · 2024-09-19T10:30:59Z

I scrupulously followed the instructions provided by @ckujau and @Servinjesus1. Now I no longer have the warnings of depreciation of the 'punycode' module

andrew-chang-dewitt · 2024-10-03T16:38:25Z

For everyone tracking this:

Looks like this has been resolved in jsdom/jsdom#3776, included in v 25.01 release as of 2024-09-22. Since then, you might notice above here BW's upgraded to v25 in #10742, merged to main 3 days ago & included in the browser & web version 2024.10.0 releases. No matching CLI release yet though.

DJAlPee · 2024-10-23T11:12:52Z

New CLI version released today (updated with brew on my device), but still having this issue:

✗ bw --version
(node:68370) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
2024.10.0

andrew-chang-dewitt · 2024-10-23T15:12:22Z

I still get the same deprecation warning even when I built bitwarden cli from source at the latest commit on main.

andrew-chang-dewitt · 2024-10-23T15:34:24Z

Did some cursory digging, looks like this is still upstream—this time with node-fetch@2.x:

Running bw w/ deprecation tracing outputs the following:

$ NODE_OPTIONS="--trace-deprecation" bw --version
(node:41464) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
    at node:punycode:3:9
    at BuiltinModule.compileForInternalLoader (node:internal/bootstrap/realm:398:7)
    at BuiltinModule.compileForPublicLoader (node:internal/bootstrap/realm:337:10)
    at loadBuiltinModule (node:internal/modules/helpers:96:7)
    at Module._load (node:internal/modules/cjs/loader:1037:17)
    at Module.require (node:internal/modules/cjs/loader:1271:19)
    at require (node:internal/modules/helpers:123:16)
    at Object.<anonymous> (/home/andrew/.nvm/versions/node/v22.2.0/lib/node_modules/@bitwarden/cli/node_modules/node-fetch/node_modules/whatwg-url/lib/url-state-machine.js:2:18)
    at Module._compile (node:internal/modules/cjs/loader:1434:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1518:10)
2024.10.0

Per node-fetch, version 2.x can't be updated to latest version of whatwg-url due to minimum supported version of Node is v18 & node-fetch@2.x supports Node versions all the way back to v4. See node-fetch/node-fetch/#1793. Maintainer recommends (see proceeding PR comment link) switching to node-fetch@3.x or native fetch in Node versions 18+.

bitwarden/clients pins node-fetch to 2.6.12 in package.json.

andrew-chang-dewitt · 2024-10-23T15:36:10Z

Did some cursory digging, looks like this is still upstream—this time with node-fetch@2.x:
...

Should this issue be reopened, or is it better if I file a new issue for this new cause?

djsmith85 · 2024-10-23T15:47:17Z

Thank you @andrew-chang-dewitt for the investigation and identifying another upstream issue. I'll go ahead and re-open this.

andrew-chang-dewitt · 2024-10-23T19:40:35Z

Just in case anyone else is looking at resolving this w/ a PR like I was, it seems like the following issues could be blocking a resolution:

[deps] Vault: Update node-fetch to v3 #10606: node-fetch@v3.x requires ESM support
1. I explored importing node-fetch@3.x using the const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args)); trick (as suggested by the node-fetch team), but quickly ran into a lot more issues than I have the time to spend on resolving this myself
  - I tried various versions of transformIgnorePatterns: ["node_modules/(?!node-fetch)"] in various jest.config.js files, but every time the tests at src/service-container/service-container.spec.ts failed to parse ESM syntax in node-fetch
  - Also tried converting ./babel.config.json to ./babel.config.js as suggested in a few different issues, but still no success
An alternative to (1) could be switching to native fetch, but this would require bumping the entire project's node version to 21+ (likely 22+ 21 went out of maintenance support earlier this year)—a change I assume the team would want to look at themselves instead of some random outsider.

evgenykushnarenko · 2024-11-20T16:37:52Z

For me it was editing 4 files to get rid of that warning:

$ cd $(dirname $(readlink -f $(which bw)))/../../
$ grep -r 'require("punycode")' .
./cli/node_modules/node-fetch/node_modules/whatwg-url/lib/url-state-machine.js:const punycode = require("punycode");
./cli/node_modules/node-fetch/node_modules/tr46/index.js:var punycode = require("punycode");
./cli/node_modules/tr46/index.js:const punycode = require("punycode");
./cli/node_modules/tough-cookie/lib/cookie.js:const punycode = require("punycode");

Replace all those with punycode/ as suggested (and install the punycode module locally) and the warnings are gone.

Its work for me! 🚀

mphillippiAPG added bug cli CLI Application labels Oct 24, 2023

ttys3 mentioned this issue Nov 10, 2023

Module punycode is deprecated since Node.js 21 petkaantonov/urlparser#20

Open

namikingsoft added a commit to namikingsoft/dotfiles that referenced this issue Nov 10, 2023

zsh: prevent deprecation warn dump on encmount

6864492

WIP: bitwarden/clients#6689

tophee mentioned this issue Nov 27, 2023

Error "The punycode module is deprecated." blacs30/bitwarden-alfred-workflow#184

Open

IsmailAkram referenced this issue in IsmailAkram/Bibliomania Dec 3, 2023

Saved a new book with mongoose

a7fb2c3

luckman212 mentioned this issue Dec 7, 2023

bw cli 2023.12.0 seems to have broken the workflow blacs30/bitwarden-alfred-workflow#186

Open

Amishkaz mentioned this issue Dec 14, 2023

"[DEP0040] The punycode module is deprecated" with Node.js 21.x yarnpkg/yarn#9005

Closed

Hinton added the upstream An issue with a dependency that needs to get addressed upstream label Feb 23, 2024

mkarroqe mentioned this issue Mar 12, 2024

Twilio CLI prints punycode module deprecation warning on every launch twilio/twilio-cli#560

Closed

mrdavidburns mentioned this issue Aug 8, 2024

yarn lerna publish is still broken Lullabot/drainpipe#560

Closed

djsmith85 mentioned this issue Sep 16, 2024

Sync Command Failure #11075

Open

1 task

djsmith85 mentioned this issue Sep 30, 2024

[PM-11369][deps] Tools: Update jsdom to v25 #10742

Merged

1 task

djsmith85 closed this as completed in #10742 Sep 30, 2024

kennycontreras mentioned this issue Oct 3, 2024

CLI installed with brew throws punycode module deprecated warning message #11382

Closed

1 task

djsmith85 reopened this Oct 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

punycode module deprecated message #6689

punycode module deprecated message #6689

mphillippiAPG commented Oct 24, 2023

hseeberger commented Oct 25, 2023

tyler-8 commented Oct 25, 2023

sammbw commented Oct 27, 2023

RoboProgrammer69 commented Oct 28, 2023

maion308 commented Oct 31, 2023

lmerz1 commented Oct 31, 2023 •

edited

Loading

TheUdK commented Oct 31, 2023

saidhammane commented Nov 4, 2023

TheUdK commented Nov 13, 2023

kschat commented Jan 5, 2024

Moulick commented Feb 22, 2024

Hinton commented Feb 23, 2024 •

edited

Loading

luckydonald commented Feb 29, 2024

tolecnal commented Mar 7, 2024

navruz8080 commented Mar 21, 2024

valorisa commented Apr 13, 2024 •

edited

Loading

Servinjesus1 commented Jun 17, 2024 •

edited

Loading

palaueb commented Jul 4, 2024

jzadra commented Jul 8, 2024

gsoneill commented Aug 3, 2024

kniziol commented Aug 11, 2024

ckujau commented Aug 27, 2024

rojosinalma commented Sep 5, 2024

djsmith85 commented Sep 5, 2024

chipschipschips commented Sep 18, 2024 •

edited

Loading

valorisa commented Sep 19, 2024 •

edited

Loading

andrew-chang-dewitt commented Oct 3, 2024

DJAlPee commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

djsmith85 commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

evgenykushnarenko commented Nov 20, 2024

punycode module deprecated message #6689

punycode module deprecated message #6689

Comments

mphillippiAPG commented Oct 24, 2023

Steps To Reproduce

Expected Result

Actual Result

Screenshots or Videos

Additional Context

Operating System

Operating System Version

Shell

Build Version

Issue Tracking Info

hseeberger commented Oct 25, 2023

tyler-8 commented Oct 25, 2023

sammbw commented Oct 27, 2023

RoboProgrammer69 commented Oct 28, 2023

maion308 commented Oct 31, 2023

lmerz1 commented Oct 31, 2023 • edited Loading

TheUdK commented Oct 31, 2023

saidhammane commented Nov 4, 2023

TheUdK commented Nov 13, 2023

kschat commented Jan 5, 2024

Moulick commented Feb 22, 2024

Hinton commented Feb 23, 2024 • edited Loading

luckydonald commented Feb 29, 2024

tolecnal commented Mar 7, 2024

navruz8080 commented Mar 21, 2024

valorisa commented Apr 13, 2024 • edited Loading

Servinjesus1 commented Jun 17, 2024 • edited Loading

palaueb commented Jul 4, 2024

jzadra commented Jul 8, 2024

gsoneill commented Aug 3, 2024

kniziol commented Aug 11, 2024

ckujau commented Aug 27, 2024

rojosinalma commented Sep 5, 2024

djsmith85 commented Sep 5, 2024

chipschipschips commented Sep 18, 2024 • edited Loading

valorisa commented Sep 19, 2024 • edited Loading

andrew-chang-dewitt commented Oct 3, 2024

DJAlPee commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

djsmith85 commented Oct 23, 2024

andrew-chang-dewitt commented Oct 23, 2024

evgenykushnarenko commented Nov 20, 2024

lmerz1 commented Oct 31, 2023 •

edited

Loading

Hinton commented Feb 23, 2024 •

edited

Loading

valorisa commented Apr 13, 2024 •

edited

Loading

Servinjesus1 commented Jun 17, 2024 •

edited

Loading

chipschipschips commented Sep 18, 2024 •

edited

Loading

valorisa commented Sep 19, 2024 •

edited

Loading