util: fix util.getCallSites plurality #55626

legendecas · 2024-10-31T14:22:55Z

util.getCallSite returns an array of call site objects. Rename the
function to reflect that it returns a given count of frames captured
as an array of call site object.

Renames the first parameter frames to be frameCount to indicate
that it specifies the count of returned call sites.

Given that this function is marked as "active development", I believe it is better to rename it early.

nodejs-github-bot · 2024-10-31T14:22:59Z

Review requested:

@nodejs/performance

RafaelGSS

What about using a safe approach and keep a getCallSite function emitting a warning to inform users to use getCallSites instead? We can land it as semver-minor and then in the next release we remove the getCallSite completely

`util.getCallSite` returns an array of call site objects. Rename the function to reflect that it returns a given count of frames captured as an array of call site object. Renames the first parameter `frames` to be `frameCount` to indicate that it specifies the count of returned call sites.

codecov · 2024-10-31T16:38:30Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.43%. Comparing base (4379dfb) to head (b36edf2).
Report is 61 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #55626      +/-   ##
==========================================
- Coverage   88.43%   88.43%   -0.01%     
==========================================
  Files         654      654              
  Lines      187718   187725       +7     
  Branches    36129    36140      +11     
==========================================
+ Hits       166010   166012       +2     
+ Misses      14948    14942       -6     
- Partials     6760     6771      +11

Files with missing lines	Coverage Δ
lib/util.js	`97.32% <100.00%> (+0.03%)`	⬆️
src/node_util.cc	`85.76% <100.00%> (ø)`

... and 28 files with indirect coverage changes

RedYetiDev · 2024-10-31T20:48:04Z

doc/api/deprecations.md

+### DEP0186: `util.getCallSite`
+
+<!-- YAML
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/55626
+    description: Runtime deprecation.
+-->
+
+Type: Runtime
+
+The `util.getCallSite` API has been removed. Please use [`util.getCallSites()`][] instead.


Doesn't this have to be doc deprecated first?

This is an API in active development status, not stable yet. I don't think it is necessary to document deprecated.

We should not deprecate experimental APIs, deprecation is for stable features we want to phase out.

There were deprecation for experimental APIs like https://github.com/nodejs/node/blob/main/doc/api/deprecations.md#dep0173-the-assertcalltracker-class.

I was hesistant about adding a deprecation code for this. But all our toolings like expectWarning expects a deprecation code.

github-actions · 2024-10-31T20:49:58Z

The notable-change PRs with changes that should be highlighted in changelogs. label has been added by @RedYetiDev.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section.

lib/util.js

Co-authored-by: Aviv Keller <[email protected]>

nodejs-github-bot · 2024-11-01T16:26:35Z

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

nodejs-github-bot · 2024-11-02T15:24:57Z

Landed in 68dc15e

`util.getCallSite` returns an array of call site objects. Rename the function to reflect that it returns a given count of frames captured as an array of call site object. Renames the first parameter `frames` to be `frameCount` to indicate that it specifies the count of returned call sites. PR-URL: nodejs#55626 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>

`util.getCallSite` returns an array of call site objects. Rename the function to reflect that it returns a given count of frames captured as an array of call site object. Renames the first parameter `frames` to be `frameCount` to indicate that it specifies the count of returned call sites. PR-URL: #55626 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) #55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) #55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) #55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) #55626 PR-URL: TODO

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) #55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) #55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) #55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) #55626 PR-URL: #55921

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) nodejs#55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) nodejs#55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) nodejs#55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) nodejs#55626 PR-URL: nodejs#1

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) nodejs#55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) nodejs#55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) nodejs#55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) nodejs#55626 PR-URL: https://github.com/nodejs/aduh95/pull/1

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) nodejs#55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) nodejs#55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) nodejs#55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) nodejs#55626 PR-URL: #1

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) #55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) #55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) #55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) #55626 PR-URL: #55921

`util.getCallSite` returns an array of call site objects. Rename the function to reflect that it returns a given count of frames captured as an array of call site object. Renames the first parameter `frames` to be `frameCount` to indicate that it specifies the count of returned call sites. PR-URL: nodejs#55626 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) nodejs#55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) nodejs#55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) nodejs#55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) nodejs#55626 PR-URL: nodejs#55921

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) nodejs#55732 sqlite: * (SEMVER-MINOR) add support for SQLite Session Extension (Bart Louwers) nodejs#54181 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) nodejs#55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) nodejs#55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) nodejs#55626 PR-URL: TODO

Notable changes: doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) nodejs#55732 src: * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) nodejs#55697 util: * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) nodejs#55589 * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) nodejs#55626 PR-URL: nodejs#55921

`util.getCallSite` returns an array of call site objects. Rename the function to reflect that it returns a given count of frames captured as an array of call site object. Renames the first parameter `frames` to be `frameCount` to indicate that it specifies the count of returned call sites. PR-URL: #55626 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>

Notable changes: assert: * (SEMVER-MINOR) make assertion_error use Myers diff algorithm (Giovanni Bucci) #54862 buffer: * (SEMVER-MINOR) make Buffer work with resizable ArrayBuffer (James M Snell) #55377 crypto: * update root certificates to NSS 3.104 (Richard Lau) #55681 doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) #55732 * add jazelly to collaborators (Jason Zhang) #55531 esm: * mark import attributes and JSON module as stable (Nicolò Ribaudo) #55333 http: * (SEMVER-MINOR) add diagnostic channel `http.client.request.created` (Marco Ippolito) #55586 lib: * (SEMVER-MINOR) add UV_UDP_REUSEPORT for udp (theanarkh) #55403 module: * (SEMVER-MINOR) unflag --experimental-require-module (Joyee Cheung) #55085 net: * (SEMVER-MINOR) add UV_TCP_REUSEPORT for tcp (theanarkh) #55408 sqlite: * (SEMVER-MINOR) add support for SQLite Session Extension (Bart Louwers) #54181 tools: * fix root certificate updater (Richard Lau) #55681 util: * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) #55626 PR-URL: TODO

Notable changes: assert: * (SEMVER-MINOR) make assertion_error use Myers diff algorithm (Giovanni Bucci) #54862 buffer: * (SEMVER-MINOR) make Buffer work with resizable ArrayBuffer (James M Snell) #55377 crypto: * update root certificates to NSS 3.104 (Richard Lau) #55681 doc: * enforce strict policy to semver-major releases (Rafael Gonzaga) #55732 * add jazelly to collaborators (Jason Zhang) #55531 esm: * mark import attributes and JSON module as stable (Nicolò Ribaudo) #55333 http: * (SEMVER-MINOR) add diagnostic channel `http.client.request.created` (Marco Ippolito) #55586 lib: * (SEMVER-MINOR) add UV_UDP_REUSEPORT for udp (theanarkh) #55403 module: * (SEMVER-MINOR) unflag --experimental-require-module (Joyee Cheung) #55085 net: * (SEMVER-MINOR) add UV_TCP_REUSEPORT for tcp (theanarkh) #55408 sqlite: * (SEMVER-MINOR) add support for SQLite Session Extension (Bart Louwers) #54181 tools: * fix root certificate updater (Richard Lau) #55681 util: * (SEMVER-MINOR) fix util.getCallSites plurality (Chengzhong Wu) #55626 PR-URL: #56040

legendecas requested a review from RafaelGSS October 31, 2024 14:23

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Oct 31, 2024

RafaelGSS reviewed Oct 31, 2024

View reviewed changes

legendecas mentioned this pull request Oct 31, 2024

util: add sourcemap support to getCallSites #55589

Merged

legendecas force-pushed the util/call-sites branch from bae915c to 1e26b14 Compare October 31, 2024 15:15

RafaelGSS approved these changes Oct 31, 2024

View reviewed changes

RafaelGSS added the deprecations Issues and PRs related to deprecations. label Oct 31, 2024

anonrig approved these changes Oct 31, 2024

View reviewed changes

fixup! util: fix util.getCallSites plurality

249d703

RedYetiDev reviewed Oct 31, 2024

View reviewed changes

RedYetiDev added semver-minor PRs that contain new features and should be released in the next minor version. notable-change PRs with changes that should be highlighted in changelogs. labels Oct 31, 2024

anonrig approved these changes Oct 31, 2024

View reviewed changes

RedYetiDev reviewed Nov 1, 2024

View reviewed changes

lib/util.js Outdated Show resolved Hide resolved

fixup! util: fix util.getCallSites plurality

b36edf2

Co-authored-by: Aviv Keller <[email protected]>

legendecas added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 1, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 1, 2024

marco-ippolito approved these changes Nov 2, 2024

View reviewed changes

marco-ippolito added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 2, 2024

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

nodejs-github-bot merged commit 68dc15e into nodejs:main Nov 2, 2024
59 checks passed

RafaelGSS mentioned this pull request Nov 19, 2024

2024-11-20, Version 23.3.0 (Current), @RafaelGSS #55921

Merged

RafaelGSS mentioned this pull request Nov 22, 2024

2024-11-29, Version 23.3.1 (Current), @RafaelGSS RafaelGSS/node#8

Closed

nodejs-github-bot mentioned this pull request Nov 27, 2024

2024-12-03, Version 22.12.0 'Jod' (LTS) #56040

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: fix util.getCallSites plurality #55626

util: fix util.getCallSites plurality #55626

legendecas commented Oct 31, 2024 •

edited

Loading

nodejs-github-bot commented Oct 31, 2024

RafaelGSS left a comment

codecov bot commented Oct 31, 2024 •

edited

Loading

RedYetiDev Oct 31, 2024

legendecas Oct 31, 2024

aduh95 Nov 6, 2024

legendecas Nov 6, 2024

github-actions bot commented Oct 31, 2024

nodejs-github-bot commented Nov 1, 2024

nodejs-github-bot commented Nov 2, 2024

util: fix util.getCallSites plurality #55626

util: fix util.getCallSites plurality #55626

Conversation

legendecas commented Oct 31, 2024 • edited Loading

nodejs-github-bot commented Oct 31, 2024

RafaelGSS left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 31, 2024 • edited Loading

Codecov Report

RedYetiDev Oct 31, 2024

Choose a reason for hiding this comment

legendecas Oct 31, 2024

Choose a reason for hiding this comment

aduh95 Nov 6, 2024

Choose a reason for hiding this comment

legendecas Nov 6, 2024

Choose a reason for hiding this comment

github-actions bot commented Oct 31, 2024

nodejs-github-bot commented Nov 1, 2024

nodejs-github-bot commented Nov 2, 2024

legendecas commented Oct 31, 2024 •

edited

Loading

codecov bot commented Oct 31, 2024 •

edited

Loading