lib: allow skipping source maps in node_modules #56639

legendecas · 2025-01-17T11:45:20Z

Files in node_modules are not authored by the user directly and the
original sources are less relevant to the user.

Skipping source maps in node_modules improves the general
performance. Add module.setSourceMapsSupport(enabled, options) to
skip source maps in node_modules if it is needed. This moves
all source maps related API to node:module and this a step to
promote the source maps API to stable.

nodejs-github-bot · 2025-01-17T11:45:25Z

Review requested:

@nodejs/loaders
@nodejs/performance
@nodejs/startup

doc/api/module.md

lib/internal/source_map/source_map_cache.js

joyeecheung

Considering many enable source maps via --enable-source-maps I think it also warrants something like --disable-source-maps-in-node-modules or some other flag with a better name? Otherwise end users have to preload a script that invokes the API which is a bit of a hassle. We can set it to false by default for existing releases and in the next major release, flip it to true.

codecov · 2025-01-17T14:23:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.21%. Comparing base (bf59539) to head (cf84bcb).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #56639   +/-   ##
=======================================
  Coverage   89.21%   89.21%           
=======================================
  Files         662      662           
  Lines      191934   191961   +27     
  Branches    36945    36947    +2     
=======================================
+ Hits       171227   171266   +39     
+ Misses      13543    13542    -1     
+ Partials     7164     7153   -11

Files with missing lines	Coverage Δ
lib/internal/bootstrap/node.js	`99.57% <100.00%> (+<0.01%)`	⬆️
lib/internal/modules/esm/module_job.js	`99.25% <100.00%> (ø)`
lib/internal/process/pre_execution.js	`91.79% <100.00%> (+0.09%)`	⬆️
lib/module.js	`100.00% <100.00%> (ø)`

... and 43 files with indirect coverage changes

Files in `node_modules` are not authored by the user directly and the original sources are less relevant to the user. Skipping source maps in `node_modules` improves the general performance. Add `module.setSourceMapsSupport(enabled, options)` to skip source maps in `node_modules` if it is needed. This moves all source maps related API to `node:module` and this a step to promote the source maps API to stable.

legendecas · 2025-01-22T11:32:48Z

Updated with --enable-source-maps and process.setSourceMapsEnabled(true) implies module.setSourceMapsSupport(true, { nodeModules: true, generatedCode: true }), reducing the impacts.

The new API module.setSourceMapsSupport will still have the options default to false.

aduh95 · 2025-01-22T11:56:21Z

doc/api/process.md

+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/56639
+    description: the `process.setSourceMapsEnabled` has been deprecated.


Suggested change

changes:

- version: REPLACEME

pr-url: https://github.com/nodejs/node/pull/56639

description: the `process.setSourceMapsEnabled` has been deprecated.

aduh95 · 2025-01-22T11:56:36Z

doc/api/process.md

+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/56639
+    description: the `process.sourceMapsEnabled` has been deprecated.


Suggested change

changes:

- version: REPLACEME

pr-url: https://github.com/nodejs/node/pull/56639

description: the `process.sourceMapsEnabled` has been deprecated.

aduh95

Can you please add an entry in deprecations.md?

legendecas · 2025-01-22T12:01:22Z

Can you please add an entry in deprecations.md?

process.setSourceMapsEnabled and its friend APIs are experimental APIs, I think it is not necessary to add a deprecation code as per #55740?

aduh95 · 2025-01-22T12:07:49Z

You're right, I miss that! In that case, we should not use the word "deprecated" and keep it as experimental in that case

aduh95 · 2025-01-22T12:10:59Z

doc/api/process.md

 -->

-> Stability: 1 - Experimental
+> Stability: 0 - Deprecated: Use [`module.getSourceMapsSupport()`][] instead.


Suggested change

> Stability: 0 - Deprecated: Use [`module.getSourceMapsSupport()`][] instead.

> Stability: 1 - Experimental: Use [`module.getSourceMapsSupport()`][] instead.

aduh95 · 2025-01-22T12:12:09Z

doc/api/process.md

 -->

-> Stability: 1 - Experimental
+> Stability: 0 - Deprecated: Use [`module.setSourceMapsSupport()`][] instead.


Suggested change

> Stability: 0 - Deprecated: Use [`module.setSourceMapsSupport()`][] instead.

> Stability: 1 - Experimental: Use [`module.setSourceMapsSupport()`][] instead.

doc/api/module.md

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Jan 17, 2025

legendecas added source maps Issues and PRs related to source map support. and removed lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Jan 17, 2025

legendecas force-pushed the source-maps/node_modules branch 2 times, most recently from fb1a57e to cfc1fd9 Compare January 17, 2025 11:58

legendecas marked this pull request as ready for review January 17, 2025 12:00

H4ad reviewed Jan 17, 2025

View reviewed changes

doc/api/module.md Outdated Show resolved Hide resolved

lib/internal/source_map/source_map_cache.js Show resolved Hide resolved

lib/internal/source_map/source_map_cache.js Show resolved Hide resolved

legendecas force-pushed the source-maps/node_modules branch from cfc1fd9 to 94667aa Compare January 17, 2025 12:51

joyeecheung reviewed Jan 17, 2025

View reviewed changes

legendecas mentioned this pull request Jan 18, 2025

lib: cache source maps in vm sources #52153

Open

legendecas force-pushed the source-maps/node_modules branch from 94667aa to 593b4ff Compare January 22, 2025 11:28

legendecas changed the title ~~lib: skip source maps in node_modules~~ lib: allow skipping source maps in node_modules Jan 22, 2025

legendecas force-pushed the source-maps/node_modules branch from 593b4ff to cf84bcb Compare January 22, 2025 11:30

aduh95 reviewed Jan 22, 2025

View reviewed changes

doc/api/module.md Show resolved Hide resolved

aduh95 reviewed Jan 22, 2025

View reviewed changes

doc/api/module.md Show resolved Hide resolved

H4ad approved these changes Jan 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: allow skipping source maps in node_modules #56639

lib: allow skipping source maps in node_modules #56639

legendecas commented Jan 17, 2025 •

edited

Loading

nodejs-github-bot commented Jan 17, 2025

joyeecheung left a comment •

edited

Loading

codecov bot commented Jan 17, 2025 •

edited

Loading

legendecas commented Jan 22, 2025 •

edited

Loading

aduh95 Jan 22, 2025 •

edited

Loading

aduh95 Jan 22, 2025 •

edited

Loading

aduh95 left a comment

legendecas commented Jan 22, 2025

aduh95 commented Jan 22, 2025

aduh95 Jan 22, 2025 •

edited

Loading

aduh95 Jan 22, 2025

	> Stability: 0 - Deprecated: Use [`module.getSourceMapsSupport()`][] instead.
	> Stability: 1 - Experimental: Use [`module.getSourceMapsSupport()`][] instead.

lib: allow skipping source maps in node_modules #56639

Are you sure you want to change the base?

lib: allow skipping source maps in node_modules #56639

Conversation

legendecas commented Jan 17, 2025 • edited Loading

nodejs-github-bot commented Jan 17, 2025

joyeecheung left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 17, 2025 • edited Loading

Codecov Report

legendecas commented Jan 22, 2025 • edited Loading

aduh95 Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

aduh95 Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

aduh95 left a comment

Choose a reason for hiding this comment

legendecas commented Jan 22, 2025

aduh95 commented Jan 22, 2025

aduh95 Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

aduh95 Jan 22, 2025

Choose a reason for hiding this comment

legendecas commented Jan 17, 2025 •

edited

Loading

joyeecheung left a comment •

edited

Loading

codecov bot commented Jan 17, 2025 •

edited

Loading

legendecas commented Jan 22, 2025 •

edited

Loading

aduh95 Jan 22, 2025 •

edited

Loading

aduh95 Jan 22, 2025 •

edited

Loading

aduh95 Jan 22, 2025 •

edited

Loading