GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — process: make process.config read only · nodejs/node@e0ab8dd

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • doc/api
    • deprecations.md
    • process.md
  • lib/internal/bootstrap
    • node.js
  • test
    • abort
      • test-abort-fatal-error.js
    • fixtures
      • overwrite-config-preload-module.js
    • parallel
      • test-process-config.js
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎doc/api/deprecations.md‎

Copy file name to clipboardExpand all lines: doc/api/deprecations.md
+4-1Lines changed: 4 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -2889,12 +2889,15 @@ Prefer [`message.socket`][] over [`message.connection`][].
28892889

28902890
<!-- YAML
28912891
changes:
2892+
- version: REPLACEME
2893+
pr-url: https://github.com/nodejs/node/pull/43627
2894+
description: End-of-Life.
28922895
- version: v16.0.0
28932896
pr-url: https://github.com/nodejs/node/pull/36902
28942897
description: Runtime deprecation.
28952898
-->
28962899

2897-
Type: Runtime
2900+
Type: End-of-Life
28982901

28992902
The `process.config` property provides access to Node.js compile-time settings.
29002903
However, the property is mutable and therefore subject to tampering. The ability
Collapse file

‎doc/api/process.md‎

Copy file name to clipboardExpand all lines: doc/api/process.md
+7-12Lines changed: 7 additions & 12 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1041,17 +1041,20 @@ This feature is not available in [`Worker`][] threads.
10411041
<!-- YAML
10421042
added: v0.7.7
10431043
changes:
1044+
- version: REPLACEME
1045+
pr-url: https://github.com/nodejs/node/pull/43627
1046+
description: The `process.config` object is now frozen.
10441047
- version: v16.0.0
10451048
pr-url: https://github.com/nodejs/node/pull/36902
10461049
description: Modifying process.config has been deprecated.
10471050
-->
10481051

10491052
* {Object}
10501053

1051-
The `process.config` property returns an `Object` containing the JavaScript
1052-
representation of the configure options used to compile the current Node.js
1053-
executable. This is the same as the `config.gypi` file that was produced when
1054-
running the `./configure` script.
1054+
The `process.config` property returns a frozen `Object` containing the
1055+
JavaScript representation of the configure options used to compile the current
1056+
Node.js executable. This is the same as the `config.gypi` file that was produced
1057+
when running the `./configure` script.
10551058

10561059
An example of the possible output looks like:
10571060

@@ -1084,14 +1087,6 @@ An example of the possible output looks like:
10841087
}
10851088
```
10861089

1087-
The `process.config` property is **not** read-only and there are existing
1088-
modules in the ecosystem that are known to extend, modify, or entirely replace
1089-
the value of `process.config`.
1090-
1091-
Modifying the `process.config` property, or any child-property of the
1092-
`process.config` object has been deprecated. The `process.config` will be made
1093-
read-only in a future release.
1094-
10951090
## `process.connected`
10961091

10971092
<!-- YAML
Collapse file

‎lib/internal/bootstrap/node.js‎

Copy file name to clipboardExpand all lines: lib/internal/bootstrap/node.js
+8-67Lines changed: 8 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,8 @@ const {
4646
JSONParse,
4747
ObjectDefineProperty,
4848
ObjectGetPrototypeOf,
49-
ObjectPreventExtensions,
5049
ObjectSetPrototypeOf,
51-
ReflectGet,
52-
ReflectSet,
50+
ObjectFreeze,
5351
SymbolToStringTag,
5452
globalThis,
5553
} = primordials;
@@ -91,75 +89,18 @@ process._exiting = false;
9189
// process.config is serialized config.gypi
9290
const nativeModule = internalBinding('builtins');
9391

94-
// TODO(@jasnell): Once this has gone through one full major
95-
// release cycle, remove the Proxy and setter and update the
96-
// getter to either return a read-only object or always return
97-
// a freshly parsed version of nativeModule.config.
98-
99-
const deprecationHandler = {
100-
warned: false,
101-
message: 'Setting process.config is deprecated. ' +
102-
'In the future the property will be read-only.',
103-
code: 'DEP0150',
104-
maybeWarn() {
105-
if (!this.warned) {
106-
process.emitWarning(this.message, {
107-
type: 'DeprecationWarning',
108-
code: this.code
109-
});
110-
this.warned = true;
111-
}
112-
},
113-
114-
defineProperty(target, key, descriptor) {
115-
this.maybeWarn();
116-
return ObjectDefineProperty(target, key, descriptor);
117-
},
118-
119-
deleteProperty(target, key) {
120-
this.maybeWarn();
121-
delete target[key];
122-
},
123-
124-
preventExtensions(target) {
125-
this.maybeWarn();
126-
return ObjectPreventExtensions(target);
127-
},
128-
129-
set(target, key, value) {
130-
this.maybeWarn();
131-
return ReflectSet(target, key, value);
132-
},
133-
134-
get(target, key, receiver) {
135-
const val = ReflectGet(target, key, receiver);
136-
if (val != null && typeof val === 'object') {
137-
// eslint-disable-next-line node-core/prefer-primordials
138-
return new Proxy(val, deprecationHandler);
139-
}
140-
return val;
141-
},
142-
143-
setPrototypeOf(target, proto) {
144-
this.maybeWarn();
145-
return ObjectSetPrototypeOf(target, proto);
146-
}
147-
};
148-
149-
// eslint-disable-next-line node-core/prefer-primordials
150-
let processConfig = new Proxy(
151-
JSONParse(nativeModule.config),
152-
deprecationHandler);
92+
const processConfig = JSONParse(nativeModule.config, (_key, value) => {
93+
// The `reviver` argument of the JSONParse method will visit all the values of
94+
// the parsed config, including the "root" object, so there is no need to
95+
// explicitly freeze the config outside of this method
96+
return ObjectFreeze(value);
97+
});
15398

15499
ObjectDefineProperty(process, 'config', {
155100
__proto__: null,
156101
enumerable: true,
157102
configurable: true,
158-
get() { return processConfig; },
159-
set(value) {
160-
deprecationHandler.maybeWarn();
161-
processConfig = value;
162-
}
103+
value: processConfig,
163104
});
164105

165106
require('internal/worker/js_transferable').setup();
Collapse file

‎test/abort/test-abort-fatal-error.js‎

Copy file name to clipboardExpand all lines: test/abort/test-abort-fatal-error.js
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const assert = require('assert');
2828
const exec = require('child_process').exec;
2929

3030
let cmdline = `ulimit -c 0; ${process.execPath}`;
31-
cmdline += ' --max-old-space-size=4 --max-semi-space-size=1';
31+
cmdline += ' --max-old-space-size=16 --max-semi-space-size=4';
3232
cmdline += ' -e "a = []; for (i = 0; i < 1e9; i++) { a.push({}) }"';
3333

3434
exec(cmdline, function(err, stdout, stderr) {
Collapse file

‎test/fixtures/overwrite-config-preload-module.js‎

Copy file name to clipboardExpand all lines: test/fixtures/overwrite-config-preload-module.js
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
const common = require('../common');
33
common.skipIfInspectorDisabled();
44

5+
delete process.config;
56
process.config = {};
Collapse file

‎test/parallel/test-process-config.js‎

Copy file name to clipboardExpand all lines: test/parallel/test-process-config.js
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ assert(Object.hasOwn(process, 'config'));
3636
// Ensure that `process.config` is an Object.
3737
assert.strictEqual(Object(process.config), process.config);
3838

39+
// Ensure that you can't change config values
40+
assert.throws(() => { process.config.variables = 42; }, TypeError);
41+
3942
const configPath = path.resolve(__dirname, '..', '..', 'config.gypi');
4043

4144
if (!fs.existsSync(configPath)) {

0 commit comments

Comments
0 (0)
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.