Fix punycode deprecation warning

[willosborne]

Bug Report

Running the CALM CLI on my machine gives me the following warning:

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

This indicates one of the transitive dependencies is still using the bundled version of the punycode library, that will be removed eventually. Presumably this will then break the CLI.

Steps to Reproduce:

Run the validate command on Node version 21.7.2

➜  pattern git:(pattern-only-validation) ✗ node --version
v21.7.2
➜  pattern git:(pattern-only-validation) ✗ calm validate -p api-gateway.json
info:    Loading meta schema(s) from [REDACTED]/architecture-as-code/cli/dist/calm/meta
info:    Loading pattern from : api-gateway.json
(node:16102) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
info:    The JSON Schema is valid

Expected Result:

No warning

Actual Result:

Deprecation warning. With the --trace-deprecation flag:

➜ pattern git:(pattern-only-validation) ✗ node --trace-deprecation ../../cli/dist/index.js validate -p api-gateway.json
info: Loading meta schema(s) from [REDACTED]/architecture-as-code/cli/dist/calm/meta
info: Loading pattern from : api-gateway.json
(node:16351) [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:104:7)
at Module._load (node:internal/modules/cjs/loader:999:17)
at Module.require (node:internal/modules/cjs/loader:1230:19)
at require (node:internal/modules/helpers:179:18)
at Object. ([REDACTED]/architecture-as-code/cli/node_modules/node-fetch/node_modules/whatwg-url/lib/url-state-machine.js:2:18)
at Module._compile (node:internal/modules/cjs/loader:1368:14)
at Module._extensions..js (node:internal/modules/cjs/loader:1426:10)
info: The JSON Schema is valid
➜ pattern git:(pattern-only-validation) ✗

Environment:

OS: Ubuntu 22.04.4 LTS
Node version: 21.7.2

[oliviajanejohns]

Happy to pick this up! Unable to assign unfortunately

[markscott-ms]

This is still a problem:

$ npm ls punycode
@finos/calm-workspace@0.0.0 [redacted]/architecture-as-code
├─┬ @finos/calm-cli@0.7.9 -> ./cli
│ ├─┬ eslint@9.27.0
│ │ └─┬ ajv@6.12.6
│ │   └─┬ uri-js@4.4.1
│ │     └── punycode@2.3.1
│ └─┬ tsup@8.5.0
│   └─┬ source-map@0.8.0-beta.0
│     └─┬ whatwg-url@7.1.0
│       └─┬ tr46@1.0.1
│         └── punycode@2.3.1 deduped
├─┬ @finos/calm-shared@0.2.2 -> ./shared
│ └─┬ msw@2.8.4
│   └─┬ @bundled-es-modules/tough-cookie@0.1.6
│     └─┬ tough-cookie@4.1.4
│       ├─┬ psl@1.15.0
│       │ └── punycode@2.3.1 deduped
│       └── punycode@2.3.1 deduped
└─┬ calm-hub-ui@0.2.0 -> ./calm-hub-ui
  └─┬ jsdom@26.1.0
    └─┬ whatwg-url@14.2.0
      └─┬ tr46@5.1.1
        └── punycode@2.3.1 deduped

[markscott-ms]

It's not tr46. jsdom/tr46#63

The issue suggests whatwg-url < 12.0.1 may be the cause, and we have 7.1.0 above.

[markscott-ms]

source-map has this issue: mozilla/source-map#515 , and this fix mozilla/source-map#400 as the solution.

Looks like when source-map 0.7.5 release is pushed to NPM, and when tsup updates its dependency, it will solve the punycode deprecation warning.

[markscott-ms]

tsup has PR egoist/tsup#1358 to update dependency of source-map to 0.7.6.

[markscott-ms]

tsup now has a deprecation notice, encouraging use of tsdown. It is unclear whether tsup PR 1358 will ever get merged.

[markscott-ms]

It was merged last week!

But eslint depends on ajv which depends on uri-js, which hasn't been updated in over 4 years. It has an open PR for two of those to fix the punycode deprecation warning.

Node 22 is suppressing the punycode deprecation warning due to pains above - nodejs/node#56632

As such I'm closing this issue.