Twilio CLI prints punycode module deprecation warning on every launch

Question

Twilio CLI prints punycode module deprecation warning on every launch

Opened this issue 10 months ago · 19 comments

elyscape commented 10 months ago

Issue Summary

When installed via Homebrew, all invocations of the Twilio CLI print a deprecation error.

Steps to Reproduce

Run any twilio command
There is no second step

Log

$ twilio version
(node:78395) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
twilio-cli/5.16.2 darwin-arm64 node-v21.2.0

Technical Analysis

While the installation docs state that the Twilio CLI only supports Node.js 18, the Homebrew formula for the Twilio CLI depends on the node formula, which resolves to the current stable version of Node.js. At time of writing, that means version 21.2.0.

Node.js' built-in punycode module was documented as deprecated in version 7.0.0, but for version 21.0.0 the deprecation was upgraded to a runtime deprecation. As a result, any code running on Node.js 21 that imports the punycode module will cause the runtime to log a deprecation warning.

The long-term solution here is to figure out what library depends on the built-in punycode module and either get rid of it or upgrade it. However, the Homebrew formula should be updated to actually use the version of Node.js that you intend for it to support. That can be done by making it look something like this:

class Twilio < Formula
  # [...]
  depends_on "node@18"

  def install
    inreplace "bin/twilio", /^CLIENT_HOME=/, "export TWILIO_OCLIF_CLIENT_HOME=#{lib/"client"}\nCLIENT_HOME="
    libexec.install Dir["*"]
    (bin/"twilio").write_env_script libexec/"bin/twilio", PATH: "#{Formula["node@18"].opt_bin}:$PATH"
  end

  def post_install
    node = Formula["node@18"].opt_bin/"node"
    pid = spawn("#{node} #{libexec}/welcome.js")
    Process.wait pid
  end
end

Technical details:

twilio-cli version: 5.16.2
node version: 21.2.0

Answer 1 · 2023-12-29T09:02:41.000Z

This issue is stale because it has been open for 30 days with no activity. Please remove stale label or comment or this issue will be closed in 30 days.

Answer 2 · 2023-12-31T03:00:34.000Z

Still present.

Answer 3 · 2024-01-30T09:02:35.000Z

This issue is stale because it has been open for 30 days with no activity. Please remove stale label or comment or this issue will be closed in 30 days.

Answer 4 · 2024-02-12T23:54:52.000Z

Still here.

Answer 5 · 2024-03-12T20:09:22.000Z

This is still an issue. However, I found a workaround in bitwarden/clients#6689 (comment)

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'

this worked for me for the time being! thanks @kschat for this one

Answer 6 · 2024-04-12T09:03:35.000Z

This issue is stale because it has been open for 30 days with no activity. Please remove stale label or comment or this issue will be closed in 30 days.

Answer 7 · 2024-04-12T11:16:13.000Z

Go away stale bot. An issue doesn't magically fix itself when no one replies.

Answer 8 · 2024-04-15T09:39:12.000Z

Looking at it now

Answer 9 · 2024-04-23T17:55:05.000Z

IIRC I worked around this by manually installing brew install node@20 and uninstalling the version installed as a dependency using brew uninstall --ignore-dependencies node so:

brew install node@20
brew tap twilio/brew && brew install twilio
brew uninstall --ignore-dependencies node

Answer 10 · 2024-05-24T09:03:36.000Z

This issue is stale because it has been open for 30 days with no activity. Please remove stale label or comment or this issue will be closed in 30 days.

Answer 11 · 2024-05-25T01:06:19.000Z

Has this been fixed?

Answer 12 · 2024-06-01T00:37:58.000Z

@tiwarishubham635 I submitted a PR back in November that fixes this (twilio/homebrew-brew#36). It's out of date now but could be trivially updated to work. Can we get some movement on this?

Answer 13 · 2024-07-01T09:04:09.000Z

This issue is stale because it has been open for 30 days with no activity. Please remove stale label or comment or this issue will be closed in 30 days.

Answer 14 · 2024-07-01T09:40:11.000Z

Not stale and very annoying. Most annoying thing is that the fix is there for the taking (thanks @elyscape) but maintainers are nowhere to be seen. :( Oh and Twilio is a paid service so the gripe is warranted.

Answer 15 · 2024-07-01T10:01:31.000Z

Hi @elyscape! Since twilio-cli has moved completly to node18, I think this change should be good to go. Can you update your PR? I have checked it and will approve it right away. Sorry for the delay everyone.

Answer 16 · 2024-07-09T00:11:02.000Z

@tiwarishubham635 PR updated.

Answer 17 · 2024-07-16T23:03:21.000Z

@elyscape - Your PR seems to have fixed it for me. I pinged @tiwarishubham635 to see if he can review and push the change. Thanks for your contribution!

Answer 18 · 2024-07-22T02:51:16.000Z

Since the changes are pushed to homebrew repo, that should fix it. We can close this issue after the next release

Answer 19 · 2024-08-21T09:03:18.000Z

This issue is stale because it has been open for 30 days with no activity. Please remove stale label or comment or this issue will be closed in 30 days.