lib: make getCallSites sourceMap option truly optional · nodejs/node@d5a26f6 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 635
• Pull requests 753
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit d5a26f6

Browse filesBrowse the repository at this point in the historyBrowse files

jasnell

authored and

aduh95

committed

lib: make getCallSites sourceMap option truly optional

When calling the `util.getCallSites(...)` API, if the `options` argument is omitted, then the `options.sourceMap` option is defaulted to false. However, if any empty `options` is passed, it would throw an error is `sourceMap` was not explicitly given. This relaxes that so that `sourceMap` can be left unspecified. For instance, before this commit, `getCallSites({})` would throw an error. Also, add more test coverage of this. PR-URL: #57388 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Jason Zhang <xzha4350@gmail.com>

1 parent 30e5658 commit d5a26f6
Copy full SHA for d5a26f6

2 files changed

+20-2Lines changed: 20 additions & 2 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• lib
  • util.js
• test/parallel
  • test-util-getcallsites.js

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎lib/util.js‎

Copy file name to clipboardExpand all lines: lib/util.js

+6-2Lines changed: 6 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -388,7 +388,9 @@ function getCallSites(frameCount = 10, options) {
388	388	// If frameCount is an object, it is the options object
389	389	options = frameCount;
390	390	validateObject(options, 'options');
391		- validateBoolean(options.sourceMap, 'options.sourceMap');
	391	+ if (options.sourceMap !== undefined) {
	392	+ validateBoolean(options.sourceMap, 'options.sourceMap');
	393	+ }
392	394	frameCount = 10;
393	395	} else {
394	396	// If options is not provided, set it to an empty object
@@ -397,7 +399,9 @@ function getCallSites(frameCount = 10, options) {
397	399	} else {
398	400	// If options is provided, validate it
399	401	validateObject(options, 'options');
400		- validateBoolean(options.sourceMap, 'options.sourceMap');
	402	+ if (options.sourceMap !== undefined) {
	403	+ validateBoolean(options.sourceMap, 'options.sourceMap');
	404	+ }
401	405	}
402	406
403	407	// Using kDefaultMaxCallStackSizeToCapture as reference

Collapse file

‎test/parallel/test-util-getcallsites.js‎

Copy file name to clipboardExpand all lines: test/parallel/test-util-getcallsites.js

+14Lines changed: 14 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -172,3 +172,17 @@ const assert = require('node:assert');
172	172	assert.match(output, /test-get-callsite-explicit\.ts/);
173	173	assert.strictEqual(status, 0);
174	174	}
	175	+
	176	+ {
	177	+ // sourceMap must be a boolean
	178	+ assert.throws(() => getCallSites({ sourceMap: 1 }), {
	179	+ code: 'ERR_INVALID_ARG_TYPE'
	180	+ });
	181	+ assert.throws(() => getCallSites(1, { sourceMap: 1 }), {
	182	+ code: 'ERR_INVALID_ARG_TYPE'
	183	+ });
	184	+
	185	+ // Not specifying the sourceMap option should not fail.
	186	+ getCallSites({});
	187	+ getCallSites(1, {});
	188	+ }

0 commit comments

Comments

0 (0)