Skip to content

gyp: put filenames in variables - #46965

Closed
zcbenz wants to merge 1 commit into
nodejs:mainfrom
zcbenz:patch-5
Closed

gyp: put filenames in variables#46965
zcbenz wants to merge 1 commit into
nodejs:mainfrom
zcbenz:patch-5

Conversation

@zcbenz

Copy link
Copy Markdown
Contributor

This PR move source code filenames from the sources field to variables in gyp files.

With this, it becomes much easier extracting the filenames from the gyp files with tools like gypi_to_gn.py, and it significantly eases the work of compiling Node.js with another build system. Chromium was doing the exact same thing during their migration from GYP to GN.

Other than helping embedders, doing this also improves the readability of the gyp files, and actually quite a lot of places in node's gyp files are already doing it.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/gyp
  • @nodejs/http
  • @nodejs/http2
  • @nodejs/net
  • @nodejs/url
  • @nodejs/wasi

@nodejs-github-botnodejs-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 Mar 6, 2023
@gengjiawengengjiawen added the request-ci Add this label to start a Jenkins CI on a PR. label Mar 6, 2023
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Mar 6, 2023
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@bnoordhuis

Copy link
Copy Markdown
Member

I won't block this but I'm pretty meh on this approach. Maybe it helps downstream projects but it just adds another layer of indirection for us.

@zcbenz

Copy link
Copy Markdown
ContributorAuthor

A few places are already doing this: ngtcp2.gyp , node_inspector.gypi, and the deps_files and library_files variables in node.gyp (I'm leaving out the tons of openssl's gyp files since it is a special case). As someone not familiar with node's gyp files, I personally find it easier understanding what the gyp file does with all the filenames moved out of the target.

Also probably the only other projects largely used GYP, Chromium chose to put the filenames in variables: content_browser.gypi, and so did Electron. But they abandoned GYP eventually so it may be not very persuading.

For targets that only have one or two files, I agree this is unnecessary indirection, but having a united style feels better, and additionally it helps us embedders.

@zcbenz

Copy link
Copy Markdown
ContributorAuthor

Also another thing to consider is, whether node will stick to GYP for forever. If the answer is no, then reorganizing gyp files for easy scripting is something that node will do eventually. The cost is almost none, and arguably improves readability.

A live example of how node's gyp files are reused in another build system can be checked at: https://github.com/photoionization/node_with_gn/blob/main/gn_files/node/deps/ngtcp2/BUILD.gn#L53-L57.

@targostargos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the change. I think it makes the config easier to read without big lists of files in the middle.
@zcbenz could you please fix the conflict?

@gengjiawengengjiawen added the request-ci Add this label to start a Jenkins CI on a PR. label Mar 13, 2023
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Mar 13, 2023
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@gengjiawengengjiawen added commit-queue Add this label to land a pull request using GitHub Actions. request-ci Add this label to start a Jenkins CI on a PR. labels Mar 16, 2023
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Mar 16, 2023
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 16, 2023
@targos

Copy link
Copy Markdown
Member

Depends on #44004 to land on v19.x

@ruyadornoruyadorno mentioned this pull request Sep 8, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 6, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 14, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 15, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 16, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 16, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 21, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 21, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 22, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 22, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 28, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 28, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 29, 2023
codebytere added a commit to electron/electron that referenced this pull request Nov 29, 2023
jkleinsc pushed a commit to electron/electron that referenced this pull request Nov 30, 2023
* chore: upgrade to Node.js v20
* src: allow embedders to override NODE_MODULE_VERSION
nodejs/node#49279
* src: fix missing trailing ,
nodejs/node#46909
* src,tools: initialize cppgc
nodejs/node#45704
* tools: allow passing absolute path of config.gypi in js2c
nodejs/node#49162
* tools: port js2c.py to C++
nodejs/node#46997
* doc,lib: disambiguate the old term, NativeModule
nodejs/node#45673
* chore: fixup Node.js BSSL tests
* nodejs/node#49492
* nodejs/node#44498
* deps: upgrade to libuv 1.45.0
nodejs/node#48078
* deps: update V8 to 10.7
nodejs/node#44741
* test: use gcUntil() in test-v8-serialize-leak
nodejs/node#49168
* module: make CJS load from ESM loader
nodejs/node#47999
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* chore: address changes to CJS/ESM loading
* module: make CJS load from ESM loader (nodejs/node#47999)
* lib: improve esm resolve performance (nodejs/node#46652)
* bootstrap: optimize modules loaded in the built-in snapshot
nodejs/node#45849
* test: mark test-runner-output as flaky
nodejs/node#49854
* lib: lazy-load deps in modules/run_main.js
nodejs/node#45849
* url: use private properties for brand check
nodejs/node#46904
* test: refactor `test-node-output-errors`
nodejs/node#48992
* assert: deprecate callTracker
nodejs/node#47740
* src: cast v8::Object::GetInternalField() return value to v8::Value
nodejs/node#48943
* test: adapt test-v8-stats for V8 update
nodejs/node#45230
* tls: ensure TLS Sockets are closed if the underlying wrap closesnodejs/node#49327
* test: deflake test-tls-socket-closenodejs/node#49575
* net: fix crash due to simultaneous close/shutdown on JS Stream Sockets
nodejs/node#49400
* net: use asserts in JS Socket Stream to catch races in future
nodejs/node#49400
* lib: fix BroadcastChannel initialization location
nodejs/node#46864
* src: create BaseObject with node::Realm
nodejs/node#44348
* src: implement DataQueue and non-memory resident Blob
nodejs/node#45258
* sea: add support for V8 bytecode-only caching
nodejs/node#48191
* chore: fixup patch indices
* gyp: put filenames in variables
nodejs/node#46965
* build: modify js2c.py into GN executable
* fix: (WIP) handle string replacement of fs -> original-fs
* [v20.x] backport vm-related memory fixesnodejs/node#49874
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* src: avoid copying string in fs_permission
nodejs/node#47746
* look upon my works ye mighty
and dispair
* chore: patch cleanup
* [api] Remove AllCan Read/Write
https://chromium-review.googlesource.com/c/v8/v8/+/5006387
* fix: missing include for NODE_EXTERN
* chore: fixup patch indices
* fix: fail properly when js2c fails in Node.js
* build: fix js2c root_gen_dir
* fix: lib/fs.js -> lib/original-fs.js
* build: fix original-fs file xforms
* fixup! module: make CJS load from ESM loader
* build: get rid of CppHeap for now
* build: add patch to prevent extra fs lookup on esm load
* build: greatly simplify js2c modifications
Moves our original-fs modifications back into a super simple python script action, wires up the output of that action into our call to js2c
* chore: update to handle moved internal/modules/helpers file
* test: update @types/node test
* feat: enable preventing cppgc heap creation
* feat: optionally prevent calling V8::EnableWebAssemblyTrapHandler
* fix: no cppgc initialization in the renderer
* gyp: put filenames in variables
nodejs/node#46965
* test: disable single executable tests
* fix: nan tests failing on node headers missing file
* tls,http2: send fatal alert on ALPN mismatch
nodejs/node#44031
* test: disable snapshot tests
* nodejs/node#47887
* nodejs/node#49684
* nodejs/node#44193
* build: use deps/v8 for v8/tools
Node.js hard depends on these in their builtins
* test: fix edge snapshot stack traces
nodejs/node#49659
* build: remove js2c //base dep
* build: use electron_js2c_toolchain to build node_js2c
* fix: don't create SafeSet outside packageResolve
Fixes failure in parallel/test-require-delete-array-iterator:
=== release test-require-delete-array-iterator ===
Path: parallel/test-require-delete-array-iterator
node:internal/per_context/primordials:426
constructor(i) { super(i); } // eslint-disable-line no-useless-constructor
^
TypeError: object is not iterable (cannot read property Symbol(Symbol.iterator))
at new Set (<anonymous>)
at new SafeSet (node:internal/per_context/primordials:426:22)
* fix: failing crashReporter tests on Linux
These were failing because our change from node::InitializeNodeWithArgs to
node::InitializeOncePerProcess meant that we now inadvertently called
PlatformInit, which reset signal handling. This meant that our intentional
crash function ElectronBindings::Crash no longer worked and the renderer process
no longer crashed when process.crash() was called. We don't want to use Node.js'
default signal handling in the renderer process, so we disable it by passing
kNoDefaultSignalHandling to node::InitializeOncePerProcess.
* build: only create cppgc heap on non-32 bit platforms
* chore: clean up util:CompileAndCall
* src: fix compatility with upcoming V8 12.1 APIs
nodejs/node#50709
* fix: use thread_local BuiltinLoader
* chore: fixup v8 patch indices
---------
Co-authored-by: Keeley Hammond <vertedinde@electronjs.org>
Co-authored-by: Samuel Attard <marshallofsound@electronjs.org>
MrHuangJser pushed a commit to MrHuangJser/electron that referenced this pull request Dec 11, 2023
* chore: upgrade to Node.js v20
* src: allow embedders to override NODE_MODULE_VERSION
nodejs/node#49279
* src: fix missing trailing ,
nodejs/node#46909
* src,tools: initialize cppgc
nodejs/node#45704
* tools: allow passing absolute path of config.gypi in js2c
nodejs/node#49162
* tools: port js2c.py to C++
nodejs/node#46997
* doc,lib: disambiguate the old term, NativeModule
nodejs/node#45673
* chore: fixup Node.js BSSL tests
* nodejs/node#49492
* nodejs/node#44498
* deps: upgrade to libuv 1.45.0
nodejs/node#48078
* deps: update V8 to 10.7
nodejs/node#44741
* test: use gcUntil() in test-v8-serialize-leak
nodejs/node#49168
* module: make CJS load from ESM loader
nodejs/node#47999
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* chore: address changes to CJS/ESM loading
* module: make CJS load from ESM loader (nodejs/node#47999)
* lib: improve esm resolve performance (nodejs/node#46652)
* bootstrap: optimize modules loaded in the built-in snapshot
nodejs/node#45849
* test: mark test-runner-output as flaky
nodejs/node#49854
* lib: lazy-load deps in modules/run_main.js
nodejs/node#45849
* url: use private properties for brand check
nodejs/node#46904
* test: refactor `test-node-output-errors`
nodejs/node#48992
* assert: deprecate callTracker
nodejs/node#47740
* src: cast v8::Object::GetInternalField() return value to v8::Value
nodejs/node#48943
* test: adapt test-v8-stats for V8 update
nodejs/node#45230
* tls: ensure TLS Sockets are closed if the underlying wrap closesnodejs/node#49327
* test: deflake test-tls-socket-closenodejs/node#49575
* net: fix crash due to simultaneous close/shutdown on JS Stream Sockets
nodejs/node#49400
* net: use asserts in JS Socket Stream to catch races in future
nodejs/node#49400
* lib: fix BroadcastChannel initialization location
nodejs/node#46864
* src: create BaseObject with node::Realm
nodejs/node#44348
* src: implement DataQueue and non-memory resident Blob
nodejs/node#45258
* sea: add support for V8 bytecode-only caching
nodejs/node#48191
* chore: fixup patch indices
* gyp: put filenames in variables
nodejs/node#46965
* build: modify js2c.py into GN executable
* fix: (WIP) handle string replacement of fs -> original-fs
* [v20.x] backport vm-related memory fixesnodejs/node#49874
* src: make BuiltinLoader threadsafe and non-global
nodejs/node#45942
* src: avoid copying string in fs_permission
nodejs/node#47746
* look upon my works ye mighty
and dispair
* chore: patch cleanup
* [api] Remove AllCan Read/Write
https://chromium-review.googlesource.com/c/v8/v8/+/5006387
* fix: missing include for NODE_EXTERN
* chore: fixup patch indices
* fix: fail properly when js2c fails in Node.js
* build: fix js2c root_gen_dir
* fix: lib/fs.js -> lib/original-fs.js
* build: fix original-fs file xforms
* fixup! module: make CJS load from ESM loader
* build: get rid of CppHeap for now
* build: add patch to prevent extra fs lookup on esm load
* build: greatly simplify js2c modifications
Moves our original-fs modifications back into a super simple python script action, wires up the output of that action into our call to js2c
* chore: update to handle moved internal/modules/helpers file
* test: update @types/node test
* feat: enable preventing cppgc heap creation
* feat: optionally prevent calling V8::EnableWebAssemblyTrapHandler
* fix: no cppgc initialization in the renderer
* gyp: put filenames in variables
nodejs/node#46965
* test: disable single executable tests
* fix: nan tests failing on node headers missing file
* tls,http2: send fatal alert on ALPN mismatch
nodejs/node#44031
* test: disable snapshot tests
* nodejs/node#47887
* nodejs/node#49684
* nodejs/node#44193
* build: use deps/v8 for v8/tools
Node.js hard depends on these in their builtins
* test: fix edge snapshot stack traces
nodejs/node#49659
* build: remove js2c //base dep
* build: use electron_js2c_toolchain to build node_js2c
* fix: don't create SafeSet outside packageResolve
Fixes failure in parallel/test-require-delete-array-iterator:
=== release test-require-delete-array-iterator ===
Path: parallel/test-require-delete-array-iterator
node:internal/per_context/primordials:426
constructor(i) { super(i); } // eslint-disable-line no-useless-constructor
^
TypeError: object is not iterable (cannot read property Symbol(Symbol.iterator))
at new Set (<anonymous>)
at new SafeSet (node:internal/per_context/primordials:426:22)
* fix: failing crashReporter tests on Linux
These were failing because our change from node::InitializeNodeWithArgs to
node::InitializeOncePerProcess meant that we now inadvertently called
PlatformInit, which reset signal handling. This meant that our intentional
crash function ElectronBindings::Crash no longer worked and the renderer process
no longer crashed when process.crash() was called. We don't want to use Node.js'
default signal handling in the renderer process, so we disable it by passing
kNoDefaultSignalHandling to node::InitializeOncePerProcess.
* build: only create cppgc heap on non-32 bit platforms
* chore: clean up util:CompileAndCall
* src: fix compatility with upcoming V8 12.1 APIs
nodejs/node#50709
* fix: use thread_local BuiltinLoader
* chore: fixup v8 patch indices
---------
Co-authored-by: Keeley Hammond <vertedinde@electronjs.org>
Co-authored-by: Samuel Attard <marshallofsound@electronjs.org>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lib / srcIssues and PRs related to general changes in the lib or src directory.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@zcbenz@nodejs-github-bot@bnoordhuis@targos@gengjiawen@danielleadams