DeprecationWarning: The punycode module is deprecated

[diego-aquino]

Prerequisites

• I confirm that none of the open issues match my problem
• I confirm that the documentation does not cover a solution to problem

Operating system

Ubuntu 22.04

Runtime

Node.js

Runtime version

22.11.0

Zimic version

0.9.3

Reproduction repository

https://github.com/diego-aquino/zimic-punycode-deprecated

Reproduction steps

1. pnpm install
2. NODE_OPTIONS=--trace-deprecation pnpm typegen:github

Current behavior

Even though the command executes successfully, a warning about punycode being deprecated is shown:

$ NODE_OPTIONS=--trace-deprecation pnpm typegen:github

(node:23082) [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:399:7)
    at BuiltinModule.compileForPublicLoader (node:internal/bootstrap/realm:338:10)
    at loadBuiltinModule (node:internal/modules/helpers:114:7)
    at Function._load (node:internal/modules/cjs/loader:1100:17)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:218:24)
    at Module.require (node:internal/modules/cjs/loader:1340:12)
    at require (node:internal/modules/helpers:141:16)
    at Object.<anonymous> (/home/diegoaquino/www/zimic-punycode-deprecated/node_modules/.pnpm/[email protected]/node_modules/whatwg-url/lib/url-state-machine.js:2:18)
[zimic] ✔ Generated ./src/types/github/typegen/generated.ts (3.06s)

Expected behavior

No deprecation warnings.

[diego-aquino]

This issue is not caused specifically by Zimic, but by whatwg-url through redocly-cli and openapi-typescript.

Related issues:

• punycode deprecation warning in node 21 Redocly/redocly-cli#1332
• punycode deprecated - still need? openapi-ts/openapi-typescript#1939
• Deprecation issue with the 'punycode' module jsdom/whatwg-url#278

For now, Zimic could dynamically import openapi-typescript, so that the warning only appears for zimic typegen openapi instead of all CLI commands.

For a complete fix, we have to wait for Redocly/redocly-cli#1332 and a transitive upgrade in openapi-typescript.

[diego-aquino]

For now, Zimic could dynamically import openapi-typescript, so that the warning only appears for zimic typegen openapi instead of all CLI commands.

Dynamic import implemented in #460.

I'm marking this as blocked by Redocly/redocly-cli#1332 for the full fix.