lib: add util.getCallSite() API by RafaelGSS · Pull Request #54380 · nodejs/node · GitHub

This pull request introduces a new API method, util.getCallSite(), which provides a way to capture and inspect the call stack within a Node.js application. The method returns an array of CallSite objects, so developers can retrieve information about each function call in the stack trace.

Previously, they could reach the same behaviour by using Error.prepareStackTrace but, this API isn't that friendly IMO.

Codecov Report

Attention: Patch coverage is 95.91837% with 2 lines in your changes missing coverage. Please review.

Project coverage is 87.60%. Comparing base (298dea0) to head (aa11f56).
Report is 250 commits behind head on main.

Files with missing lines	Patch %	Lines
src/node_util.cc	94.59%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #54380      +/-   ##
==========================================
- Coverage   87.61%   87.60%   -0.01%     
==========================================
  Files         650      650              
  Lines      182829   182878      +49     
  Branches    35382    35390       +8     
==========================================
+ Hits       160179   160210      +31     
  Misses      15931    15931              
- Partials     6719     6737      +18

Files with missing lines	Coverage Δ
lib/util.js	95.91% <100.00%> (+0.12%)	⬆️
src/node_util.cc	85.77% <94.59%> (+1.61%)	⬆️

... and 29 files with indirect coverage changes

Should we add an option to ignore node:internal?

Also, I think we should pretty print the callsite object, if we console.log it:

[
  CallSite {},
  CallSite {},
  CallSite {},
  CallSite {},
  CallSite {},
  CallSite {},
  CallSite {},
  CallSite {}
]

If we JSON.stringify:

[{},{},{},{},{},{},{},{}]

And maybe we should add some snapshot tests, I know they could break if we change/add the methods that call them but usually they are great to track regressions, I know we have a couple snapshot tests like that in our codebase.

In general, looks great to me to have a utility function like this.

I'd not include an option to ignore it in this initial version - maybe a follow up pr once it's landed?

It's not supposed to be printed via console.log because it's a CallSite representation. I will modify the API so it retrieves the stack trace from C++, and this should address this issue with the new object

I'm fine landing it with this js version, just include a benchmark and then we can evaluate if the new c++ version will be faster.

Also, having some snapshot tests will be good to see what will change when we land the c++ version.

C++ version will be landed on this PR. I didn't have time yet.

Is the new API going to work for events like unhandledRejection?

CI: https://ci.nodejs.org/job/node-test-pull-request/61255/

lgtm

Did you do a benchmark?

lgtm

Did you do a benchmark?

I did, but without having a fair comparison I don't know if it will mean much:

From my local machine

util/get-callsite.js n=1000000: 178,641.08162235853

I suspect the C++ implementation will be slower than the JS one for this particular scenario. We need to iterate over v8::StackTrace to create objects while the JS approach does not compute the values unless the function is called. e.g: .getFileName(). So the comparison will be unfair.

But, remember that we've switched to C++ for a side-effect-less approach. I can optimize this code later.

CI: https://ci.nodejs.org/job/node-test-pull-request/61893/

CI: https://ci.nodejs.org/job/node-test-pull-request/61917/

CI: https://ci.nodejs.org/job/node-test-pull-request/61928/

Landed in 80a989f

PR-URL: #54380 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: James M Snell <jasnell@gmail.com>

Notable changes: lib: * (SEMVER-MINOR) add util.getCallSite() API (Rafael Gonzaga) #54380 repl: * doc-deprecate instantiating `node:repl` classes without `new` (Aviv Keller) #54842 src: * create handle scope in FastInternalModuleStat (Joyee Cheung) #54384 stream: * (SEMVER-MINOR) relocate the status checking code in the onwritecomplete (YoonSoo_Shin) #54032 tls: * (SEMVER-MINOR) add `allowPartialTrustChain` flag (Anna Henningsen) #54790 v8: * Revert "v8: enable maglev on supported architectures (Joyee Cheung) #54384 PR-URL: #54966

RafaelGSS added the semver-minor PRs that contain new features and should be released in the next minor version. label Aug 14, 2024

nodejs-github-bot added needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Aug 14, 2024

anonrig reviewed Aug 14, 2024

View reviewed changes

Comment thread lib/util.js Outdated

H4ad reviewed Aug 16, 2024

View reviewed changes

H4ad approved these changes Aug 17, 2024

View reviewed changes

RafaelGSS added the blocked PRs that are blocked by other issues or PRs. label Aug 18, 2024

RafaelGSS added wip Issues and PRs that are still a work in progress. and removed blocked PRs that are blocked by other issues or PRs. labels Aug 18, 2024

RafaelGSS force-pushed the add-getCallSite branch from 7c0422f to 8c114c9 Compare August 20, 2024 02:01

RafaelGSS removed the wip Issues and PRs that are still a work in progress. label Aug 20, 2024

RafaelGSS requested review from joyeecheung and mcollina August 20, 2024 02:08

RafaelGSS added request-ci Add this label to start a Jenkins CI on a PR. author ready PRs that have at least one approval, no outstanding review comments, and a CI started. labels Aug 20, 2024

github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 20, 2024

anonrig approved these changes Aug 20, 2024

View reviewed changes

mcollina approved these changes Aug 20, 2024

View reviewed changes

H4ad reviewed Aug 20, 2024

View reviewed changes

Comment thread src/node_util.cc Outdated

H4ad reviewed Aug 20, 2024

View reviewed changes

Comment thread src/node_util.cc Outdated

RafaelGSS added the commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. label Aug 20, 2024

RafaelGSS force-pushed the add-getCallSite branch from 8d9f30a to 72d56c9 Compare August 20, 2024 14:41

RafaelGSS added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 20, 2024

github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 20, 2024

RafaelGSS added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 4, 2024

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 4, 2024

nodejs-github-bot merged commit 80a989f into nodejs:main Sep 4, 2024

avivkeller mentioned this pull request Sep 14, 2024

test: remove getCallSite from common #54947

Closed

RafaelGSS mentioned this pull request Sep 16, 2024

v22.9.0 proposal #54966

Merged

targos added the dont-land-on-v20.x label Sep 22, 2024

RafaelGSS mentioned this pull request Sep 30, 2024

src: apply getCallSite optimization #55174

Closed

This comment was marked as spam.

Sign in to view

This comment was marked as off-topic.

Sign in to view

deokjinkim mentioned this pull request Apr 24, 2026

util.getCallSites(): rationale for 200-frame cap and possibility to make it configurable #62910

Closed

lib: add util.getCallSite() API by RafaelGSS · Pull Request #54380 · nodejs/node · GitHub

Uh oh!

Uh oh!

lib: add util.getCallSite() API - #54380

lib: add util.getCallSite() API#54380nodejs-github-bot merged 9 commits intonodejs:mainnodejs/node:mainfrom RafaelGSS:add-getCallSiteRafaelGSS/node:add-getCallSiteCopy head branch name to clipboard

Conversation

RafaelGSS commented Aug 14, 2024

Uh oh!

Uh oh!

codecov Bot commented Aug 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

H4ad left a comment

Choose a reason for hiding this comment

Uh oh!

RafaelGSS commented Aug 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

H4ad left a comment

Choose a reason for hiding this comment

Uh oh!

RafaelGSS commented Aug 18, 2024

Uh oh!

mugli commented Aug 19, 2024

Uh oh!

nodejs-github-bot commented Aug 20, 2024

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RafaelGSS commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Sep 4, 2024

Uh oh!

nodejs-github-bot commented Sep 4, 2024

Uh oh!

nodejs-github-bot commented Sep 4, 2024

Uh oh!

nodejs-github-bot commented Sep 4, 2024

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as off-topic.

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

lib: add util.getCallSite() API#54380
nodejs-github-bot merged 9 commits into
nodejs:mainfrom
RafaelGSS:add-getCallSite

codecov Bot commented Aug 15, 2024 •
edited
Loading

RafaelGSS commented Aug 17, 2024 •
edited
Loading

RafaelGSS commented Aug 20, 2024 •
edited
Loading