bootstrap: use different scripts to setup different configurations

This patch splits the handling of `isMainThread` and
`ownsProcessState` from conditionals in
`lib/internal/bootstrap/node.js` into different scripts under
`lib/internal/bootstrap/switches/`, and call them accordingly
from C++ after `node.js` is run.
This:
- Creates a common denominator of the main thread and the worker
thread bootstrap that can be snapshotted and shared by
both.
- Makes it possible to override the configurations on-the-fly.
PR-URL: #30862
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

Author: joyeecheung

lib/internal/bootstrap/node.js

@@ -3,9 +3,7 @@
 // This file is invoked by `node::RunBootstrapping()` in `src/node.cc`, and is
 // responsible for setting up node.js core before executing main scripts
 // under `lib/internal/main/`.
-// This file is currently run to bootstrap both the main thread and the worker
-// threads. Some setups are conditional, controlled with isMainThread and
-// ownsProcessState.
+//
 // This file is expected not to perform any asynchronous operations itself
 // when being executed - those should be done in either
 // `lib/internal/bootstrap/pre_execution.js` or in main scripts. The majority
@@ -22,16 +20,21 @@
 // module loaders, including `process.binding()`, `process._linkedBinding()`,
 // `internalBinding()` and `NativeModule`.
 //
-// After this file is run, one of the main scripts under `lib/internal/main/`
-// will be selected by C++ to start the actual execution. The main scripts may
-// run additional setups exported by `lib/internal/bootstrap/pre_execution.js`,
-// depending on the execution mode.
+// This file is run to bootstrap both the main thread and the worker threads.
+// After this file is run, certain properties are setup according to the
+// configuration of the Node.js instance using the files in
+// `lib/internal/bootstrap/switches/`.
+//
+// Then, depending on how the Node.js instance is launched, one of the main
+// scripts in `lib/internal/main` will be selected by C++ to start the actual
+// execution. They may run additional setups exported by
+// `lib/internal/bootstrap/pre_execution.js` depending on the runtime states.
 
 'use strict';
 
 // This file is compiled as if it's wrapped in a function with arguments
 // passed by node::RunBootstrapping()
-/* global process, require, internalBinding, isMainThread, ownsProcessState */
+/* global process, require, internalBinding */
 
 setupPrepareStackTrace();
 
@@ -54,48 +57,12 @@ setupBuffer();
 process.domain=null;
 process._exiting=false;
 
-// Bootstrappers for all threads, including worker threads and main thread
-constperThreadSetup=require('internal/process/per_thread');
-// Bootstrappers for the main thread only
-letmainThreadSetup;
-// Bootstrappers for the worker threads only
-letworkerThreadSetup;
-if(ownsProcessState){
-mainThreadSetup=require(
-'internal/process/main_thread_only'
-);
-}else{
-workerThreadSetup=require(
-'internal/process/worker_thread_only'
-);
-}
-
 // process.config is serialized config.gypi
 process.config=JSONParse(internalBinding('native_module').config);
 
+// Bootstrappers for all threads, including worker threads and main thread
+constperThreadSetup=require('internal/process/per_thread');
 constrawMethods=internalBinding('process_methods');
-// Set up methods and events on the process object for the main thread
-if(isMainThread){
-process.abort=rawMethods.abort;
-constwrapped=mainThreadSetup.wrapProcessMethods(rawMethods);
-process.umask=wrapped.umask;
-process.chdir=wrapped.chdir;
-process.cwd=wrapped.cwd;
-
-// TODO(joyeecheung): deprecate and remove these underscore methods
-process._debugProcess=rawMethods._debugProcess;
-process._debugEnd=rawMethods._debugEnd;
-process._startProfilerIdleNotifier=
-rawMethods._startProfilerIdleNotifier;
-process._stopProfilerIdleNotifier=rawMethods._stopProfilerIdleNotifier;
-}else{
-constwrapped=workerThreadSetup.wrapProcessMethods(rawMethods);
-
-process.abort=workerThreadSetup.unavailable('process.abort()');
-process.chdir=workerThreadSetup.unavailable('process.chdir()');
-process.umask=wrapped.umask;
-process.cwd=rawMethods.cwd;
-}
 
 // Set up methods on the process object for all threads
 {
@@ -119,6 +86,11 @@ if (isMainThread) {
 process.memoryUsage=wrapped.memoryUsage;
 process.kill=wrapped.kill;
 process.exit=wrapped.exit;
+
+process.openStdin=function(){
+process.stdin.resume();
+returnprocess.stdin;
+};
 }
 
 constcredentials=internalBinding('credentials');
@@ -128,34 +100,6 @@ if (credentials.implementsPosixCredentials) {
 process.getgid=credentials.getgid;
 process.getegid=credentials.getegid;
 process.getgroups=credentials.getgroups;
-
-if(ownsProcessState){
-constwrapped=mainThreadSetup.wrapPosixCredentialSetters(credentials);
-process.initgroups=wrapped.initgroups;
-process.setgroups=wrapped.setgroups;
-process.setegid=wrapped.setegid;
-process.seteuid=wrapped.seteuid;
-process.setgid=wrapped.setgid;
-process.setuid=wrapped.setuid;
-}else{
-process.initgroups=
-workerThreadSetup.unavailable('process.initgroups()');
-process.setgroups=workerThreadSetup.unavailable('process.setgroups()');
-process.setegid=workerThreadSetup.unavailable('process.setegid()');
-process.seteuid=workerThreadSetup.unavailable('process.seteuid()');
-process.setgid=workerThreadSetup.unavailable('process.setgid()');
-process.setuid=workerThreadSetup.unavailable('process.setuid()');
-}
-}
-
-if(isMainThread){
-const{ getStdout, getStdin, getStderr }=
-require('internal/process/stdio').getMainThreadStdio();
-setupProcessStdio(getStdout,getStdin,getStderr);
-}else{
-const{ getStdout, getStdin, getStderr }=
-workerThreadSetup.createStdioGetters();
-setupProcessStdio(getStdout,getStdin,getStderr);
 }
 
 // Setup the callbacks that node::AsyncWrap will call when there are hooks to
@@ -343,31 +287,6 @@ function setupProcessObject() {
 });
 }
 
-functionsetupProcessStdio(getStdout,getStdin,getStderr){
-ObjectDefineProperty(process,'stdout',{
-configurable: true,
-enumerable: true,
-get: getStdout
-});
-
-ObjectDefineProperty(process,'stderr',{
-configurable: true,
-enumerable: true,
-get: getStderr
-});
-
-ObjectDefineProperty(process,'stdin',{
-configurable: true,
-enumerable: true,
-get: getStdin
-});
-
-process.openStdin=function(){
-process.stdin.resume();
-returnprocess.stdin;
-};
-}
-
 functionsetupGlobalProxy(){
 ObjectDefineProperty(global,SymbolToStringTag,{
 value: 'global',

lib/internal/bootstrap/pre_execution.js

@@ -37,9 +37,6 @@ function prepareMainThreadExecution(expandArgv1 = false) {
 
 setupDebugEnv();
 
-// Only main thread receives signals.
-setupSignalHandlers();
-
 // Process initial diagnostic reporting configuration, if present.
 initializeReport();
 initializeReportSignalHandlers();// Main-thread-only.
@@ -175,20 +172,7 @@ function setupDebugEnv() {
 }
 }
 
-functionsetupSignalHandlers(){
-const{
- createSignalHandlers
-}=require('internal/process/main_thread_only');
-const{
- startListeningIfSignal,
- stopListeningIfSignal
-}=createSignalHandlers();
-process.on('newListener',startListeningIfSignal);
-process.on('removeListener',stopListeningIfSignal);
-}
-
-// This has to be called after both initializeReport() and
-// setupSignalHandlers() are called
+// This has to be called after initializeReport() is called
 functioninitializeReportSignalHandlers(){
 if(!getOptionValue('--experimental-report')){
 return;

lib/internal/bootstrap/switches/does_not_own_process_state.js

@@ -0,0 +1,18 @@
+'use strict';
+
+constcredentials=internalBinding('credentials');
+
+if(credentials.implementsPosixCredentials){
+// TODO: this should be detached from ERR_WORKER_UNSUPPORTED_OPERATION
+const{ unavailable }=require('internal/process/worker_thread_only');
+
+process.initgroups=unavailable('process.initgroups()');
+process.setgroups=unavailable('process.setgroups()');
+process.setegid=unavailable('process.setegid()');
+process.seteuid=unavailable('process.seteuid()');
+process.setgid=unavailable('process.setgid()');
+process.setuid=unavailable('process.setuid()');
+}
+
+// ---- keep the attachment of the wrappers above so that it's easier to ----
+// ---- compare the setups side-by-side -----

lib/internal/bootstrap/switches/does_own_process_state.js

@@ -0,0 +1,96 @@
+'use strict';
+
+constcredentials=internalBinding('credentials');
+
+if(credentials.implementsPosixCredentials){
+constwrapped=wrapPosixCredentialSetters(credentials);
+
+process.initgroups=wrapped.initgroups;
+process.setgroups=wrapped.setgroups;
+process.setegid=wrapped.setegid;
+process.seteuid=wrapped.seteuid;
+process.setgid=wrapped.setgid;
+process.setuid=wrapped.setuid;
+}
+
+// ---- keep the attachment of the wrappers above so that it's easier to ----
+// ---- compare the setups side-by-side -----
+
+functionwrapPosixCredentialSetters(credentials){
+const{
+ ArrayIsArray,
+}=primordials;
+const{
+codes: {
+ERR_INVALID_ARG_TYPE,
+ERR_UNKNOWN_CREDENTIAL
+}
+}=require('internal/errors');
+const{
+ validateUint32
+}=require('internal/validators');
+
+const{
+initgroups: _initgroups,
+setgroups: _setgroups,
+setegid: _setegid,
+seteuid: _seteuid,
+setgid: _setgid,
+setuid: _setuid
+}=credentials;
+
+functioninitgroups(user,extraGroup){
+validateId(user,'user');
+validateId(extraGroup,'extraGroup');
+// Result is 0 on success, 1 if user is unknown, 2 if group is unknown.
+constresult=_initgroups(user,extraGroup);
+if(result===1){
+thrownewERR_UNKNOWN_CREDENTIAL('User',user);
+}elseif(result===2){
+thrownewERR_UNKNOWN_CREDENTIAL('Group',extraGroup);
+}
+}
+
+functionsetgroups(groups){
+if(!ArrayIsArray(groups)){
+thrownewERR_INVALID_ARG_TYPE('groups','Array',groups);
+}
+for(leti=0;i<groups.length;i++){
+validateId(groups[i],`groups[${i}]`);
+}
+// Result is 0 on success. A positive integer indicates that the
+// corresponding group was not found.
+constresult=_setgroups(groups);
+if(result>0){
+thrownewERR_UNKNOWN_CREDENTIAL('Group',groups[result-1]);
+}
+}
+
+functionwrapIdSetter(type,method){
+returnfunction(id){
+validateId(id,'id');
+// Result is 0 on success, 1 if credential is unknown.
+constresult=method(id);
+if(result===1){
+thrownewERR_UNKNOWN_CREDENTIAL(type,id);
+}
+};
+}
+
+functionvalidateId(id,name){
+if(typeofid==='number'){
+validateUint32(id,name);
+}elseif(typeofid!=='string'){
+thrownewERR_INVALID_ARG_TYPE(name,['number','string'],id);
+}
+}
+
+return{
+ initgroups,
+ setgroups,
+setegid: wrapIdSetter('Group',_setegid),
+seteuid: wrapIdSetter('User',_seteuid),
+setgid: wrapIdSetter('Group',_setgid),
+setuid: wrapIdSetter('User',_setuid)
+};
+}