Commit 505e9a4
lib: fix misleading argument of validateUint32
The type of the argument `positive` was declared as `boolean|number`,
which is misleading because the function treats it as a boolean only.
Some call sites even passed numbers, specifically, either `0` or `1`,
which happen to work as expected because they are interpreted as `false`
and `true`, respectively. However, passing `2` would silently lead to
unexpected behavior. Thus, strictly make the argument a boolean.
PR-URL: #53307
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>1 parent e7f3a3c commit 505e9a4
3 files changed
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -194,7 +194,7 @@ function testMatchesPattern(test, patterns) { | |||
| 194 | 194 | ||
| 195 | 195 | class TestPlan { | |
| 196 | 196 | constructor(count) { | |
| 197 | - validateUint32(count, 'count', 0); | ||
| 197 | + validateUint32(count, 'count'); | ||
| 198 | 198 | this.expected = count; | |
| 199 | 199 | this.actual = 0; | |
| 200 | 200 | } | |
@@ -428,7 +428,7 @@ class Test extends AsyncResource { | |||
| 428 | 428 | ||
| 429 | 429 | switch (typeof concurrency) { | |
| 430 | 430 | case 'number': | |
| 431 | - validateUint32(concurrency, 'options.concurrency', 1); | ||
| 431 | + validateUint32(concurrency, 'options.concurrency', true); | ||
| 432 | 432 | this.concurrency = concurrency; | |
| 433 | 433 | break; | |
| 434 | 434 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -129,7 +129,7 @@ const validateInt32 = hideStackFrames( | |||
| 129 | 129 | * @callback validateUint32 | |
| 130 | 130 | * @param {*} value | |
| 131 | 131 | * @param {string} name | |
| 132 | - * @param {number|boolean} [positive=false] | ||
| 132 | + * @param {boolean} [positive=false] | ||
| 133 | 133 | * @returns {asserts value is number} | |
| 134 | 134 | */ | |
| 135 | 135 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -248,7 +248,7 @@ function getHeapCodeStatistics() { | |||
| 248 | 248 | ||
| 249 | 249 | let heapSnapshotNearHeapLimitCallbackAdded = false; | |
| 250 | 250 | function setHeapSnapshotNearHeapLimit(limit) { | |
| 251 | - validateUint32(limit, 'limit', 1); | ||
| 251 | + validateUint32(limit, 'limit', true); | ||
| 252 | 252 | if (heapSnapshotNearHeapLimitCallbackAdded || | |
| 253 | 253 | getOptionValue('--heapsnapshot-near-heap-limit') > 0 | |
| 254 | 254 | ) { | |
0 commit comments