module: add module.stripTypeScriptTypes

[marco-ippolito]

This PR introduces a new api in node:module.

Fixes: #54300

[nodejs-github-bot]

Review requested:

• @nodejs/loaders
• @nodejs/vm

[joyeecheung]

I think it makes more sense for it to be just in its own API as a function, which can be used to strip the type before the text is passed into any of the vm.Script/vm.SourceTextModule/vm.compileFunction APIs. That'll also be useful for those who want to transform the text but not compile it at all. The transform option being ignored without the flag could be somewhat surprising, especially paired with cachedData which only has a length check, so it could lead to crashes when V8 tries to reparse the untransformed source for error reporting.

[devsnek]

there's also #54250

[marco-ippolito]

there's also #54250

Unfortunately it seems to have been stalled for a while.
Anyways good to review, I'm just not sure whether to be strict and throw when mode is strip-only and sourceMap is passed, otherwise will be ignored and could be counter-intuitive

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.42%. Comparing base (7b5d660) to head (8532f1e).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #55282   +/-   ##
=======================================
  Coverage   88.41%   88.42%           
=======================================
  Files         653      654    +1     
  Lines      187476   187552   +76     
  Branches    36083    36087    +4     
=======================================
+ Hits       165763   165839   +76     
- Misses      14946    14951    +5     
+ Partials     6767     6762    -5     

Files with missing lines	Coverage Δ
lib/internal/main/eval_string.js	80.00% <100.00%> (ø)
lib/internal/modules/cjs/loader.js	97.64% <100.00%> (+0.05%)	⬆️
lib/internal/modules/esm/get_format.js	89.32% <100.00%> (+0.04%)	⬆️
lib/internal/modules/esm/translators.js	93.09% <100.00%> (ø)
lib/internal/modules/helpers.js	98.84% <100.00%> (-0.17%)	⬇️
lib/internal/modules/typescript.js	100.00% <100.00%> (ø)
lib/module.js	100.00% <100.00%> (ø)

... and 28 files with indirect coverage changes

[legendecas]

I think this could be benefited from a dedicated module parser (name bikeshed welcome), instead of vm since the updated PR doesn't involve with any code evaluation. This module could provide additional helpers to address similar needs on manipulating JS source codes.

[joyeecheung]

Maybe putting it on module also makes sense? Or module.typescript if we can foresee adding other typescript-related utilities in the future

[marco-ippolito]

I think this could be benefited from a dedicated module parser (name bikeshed welcome), instead of vm since the updated PR doesn't involve with any code evaluation. This module could provide additional helpers to address similar needs on manipulating JS source codes.

I'm ok with a new module, I think parser is ok, I'd like to hear more opinions about it
I wouldnt call it typescript and leave it more generic, maybe someone wants to add ast manipulation or bundling etc... could be the right place

[marco-ippolito]

If we decide to ship it I'll drop the vm commits
Pinging TSC as adding a new module seems like a big deal @nodejs/tsc

[joyeecheung]

If this needs to be a new module, then it should be added to

node/lib/internal/bootstrap/realm.js

Line 130 in b4e8f1b

const schemelessBlockList = new SafeSet([

to block require('parser') without the node: prefix, otherwise it breaks https://www.npmjs.com/package/parser or anyone creating an alias of parser in node_modules.

[nodejs-github-bot]

Commit Queue failed

- Loading data for nodejs/node/pull/55282
✔  Done loading data for nodejs/node/pull/55282
----------------------------------- PR info ------------------------------------
Title      module: add module.stripTypeScriptTypes (#55282)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     marco-ippolito:vm-strip-types -> nodejs:main
Labels     semver-minor, author ready, needs-ci, strip-types
Commits    1
 - module: add module.stripTypeScriptTypes
Committers 1
 - Marco Ippolito <marcoippolito54@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/55282
Fixes: https://github.com/nodejs/node/issues/54300
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/55282
Fixes: https://github.com/nodejs/node/issues/54300
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 05 Oct 2024 16:28:53 GMT
   ✔  Approvals: 6
   ✔  - Yagiz Nizipli (@anonrig) (TSC): https://github.com/nodejs/node/pull/55282#pullrequestreview-2391013128
   ✔  - Joyee Cheung (@joyeecheung) (TSC): https://github.com/nodejs/node/pull/55282#pullrequestreview-2350567333
   ✔  - Chemi Atlow (@atlowChemi): https://github.com/nodejs/node/pull/55282#pullrequestreview-2354092903
   ✔  - Paolo Insogna (@ShogunPanda) (TSC): https://github.com/nodejs/node/pull/55282#pullrequestreview-2391920279
   ✔  - Chengzhong Wu (@legendecas) (TSC): https://github.com/nodejs/node/pull/55282#pullrequestreview-2380232467
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/55282#pullrequestreview-2380688805
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2024-10-24T09:47:58Z: https://ci.nodejs.org/job/node-test-pull-request/63238/
- Querying data for job/node-test-pull-request/63238/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 55282
fatal: couldn't find remote ref refs/pull/55282/merge

https://github.com/nodejs/node/actions/runs/11498595438

[marco-ippolito]

Downloading patch for 55282fatal: couldn't find remote ref refs/pull/55282/merge
same error when trying manually with git node land

Let me try rebase and see if it makes difference

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/63275/

[richardlau]

Downloading patch for 55282fatal: couldn't find remote ref refs/pull/55282/merge same error when trying manually with git node land

Let me try rebase and see if it makes difference

FWIW Prior to the rebase I was seeing:

$ git ls-remote upstream refs/pull/55282/*
c1c262a134f21bb350e0dfe4c8c50e2009195a04        refs/pull/55282/head
$

which was consistent with the error (no refs/pull/55282/merge). After the rebase:

$ git ls-remote upstream refs/pull/55282/*
8532f1e1e07538901a102c1880700f767d0e6686        refs/pull/55282/head
efb62871253f691abd0ac770e7361f20af13d1d2        refs/pull/55282/merge
$

🤞

[nodejs-github-bot]

Landed in 53b1050