Skip to content

build: include minimal V8 headers in distribution #37570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
targos wants to merge 1 commit into from
Closed

build: include minimal V8 headers in distribution #37570

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
build: include minimal V8 headers in distribution 
Because Node.js currently distributes all V8 headers, it is not clear
which ones are part of our API and ABI compatibility contract. V8 may
add, remove, or change headers at any time, preventing us sometimes
from updating because the change could affect addons which may depend
on them. Moreover, the `cppgc` library, included in V8, is exposed
even though it is still in active development and doesn't have a
stable API.
Node.js should choose exactly which headers are exposed and part of
our native API, so that it's easier to reason about changes during V8
updates and to prevent us from automatically increasing the API
surface when new headers are added by V8.
Instead of specifically excluding v8-inspector, only include `v8.h`,
`v8-platform.h` (used in `node.h`) and `v8-profiler.h`.
  • Loading branch information
@targos
targos committed Mar 10, 2021
commit a97b42cd42a6546d291b892d6f1a61784017e349
17 changes: 11 additions & 6 deletions tools/install.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,17 @@ def files(action):
headers(action)

def headers(action):
def ignore_inspector_headers(files_arg, dest):
inspector_headers = [
'deps/v8/include/v8-inspector.h',
'deps/v8/include/v8-inspector-protocol.h'
def wanted_v8_headers(files_arg, dest):
v8_headers = [
'deps/v8/include/cppgc/common.h',
'deps/v8/include/v8.h',
'deps/v8/include/v8-internal.h',
'deps/v8/include/v8-platform.h',
'deps/v8/include/v8-profiler.h',
'deps/v8/include/v8-version.h',
'deps/v8/include/v8config.h',
]
files_arg = [name for name in files_arg if name not in inspector_headers]
files_arg = [name for name in files_arg if name in v8_headers]
action(files_arg, dest)

action([
Expand All @@ -182,7 +187,7 @@ def ignore_inspector_headers(files_arg, dest):
if sys.platform.startswith('aix'):
action(['out/Release/node.exp'], 'include/node/')

subdir_files('deps/v8/include', 'include/node/', ignore_inspector_headers)
subdir_files('deps/v8/include', 'include/node/', wanted_v8_headers)

if 'false' == variables.get('node_shared_libuv'):
subdir_files('deps/uv/include', 'include/node/', action)
Expand Down