feat(utils): add NodeJS profiler by BioPhoton · Pull Request #1219 · code-pushup/cli

BioPhoton · 2026-01-16T18:37:36Z

Related: #1197

This PR includes:

adding NodeJSProfiler class
implemented performanceObserver for NodeJSProfiler
revamp PerformanceObserverSink - add getStatus for better testing, more robust and memory friendly buffer logic

Followup PRs:

fix: add exit handler to profiler #1221

Note

Introduces a Node.js runtime profiler with buffered write-ahead logging and a redesigned performance observer.

Adds NodejsProfiler (extends Profiler) with WAL sink integration, runtime enable/disable, state transitions, flush() and stats access; supports debug transition markers via CP_PROFILER_DEBUG
Replaces PerformanceObserverSink internals with bounded queue, proactive flushing (flushThreshold), maxQueueSize, encode-failure debug marks, and getStats(); validates configuration and handles sink errors gracefully
Expands WAL AppendableSink contract to include isClosed, optional open/close, and recovery APIs; updates mocks to MockAppendableSink/MockTraceEventFileSink
Adds comprehensive unit/integration tests and new profiler.md docs covering configuration, API, and Node.js usage
Minor: default exitOnFatal/exitOnSignal set to false in exit handlers

^{Written by Cursor Bugbot for commit 66523e3. This will update automatically on new commits. Configure here.}

- Add explanation that sink determines output format (DevTools TraceEvent, OpenTelemetry, etc.) - Improve documentation clarity for flexible serialization capabilities - Fix duplicate imports in profiler unit test

- Replace method implementations with vi.fn() spy functions - Add vi import from vitest - Enables better testing with call tracking and assertions

nx-cloud · 2026-01-16T18:38:57Z

View your CI Pipeline Execution ↗ for commit ae5b099

Command	Status	Duration	Result
`nx affected -t int-test --parallel=3`	✅ Succeeded	1m 31s	View ↗

☁️ Nx Cloud last updated this comment at 2026-01-27 14:49:02 UTC

pkg-pr-new · 2026-01-16T18:39:14Z

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1219

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1219

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1219

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1219

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1219

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1219

@code-pushup/axe-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/axe-plugin@1219

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1219

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1219

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1219

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1219

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1219

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1219

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1219

commit: ae5b099

github-actions · 2026-01-16T18:45:52Z

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 61ecb4f with previous commit e677d4f.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Documentation	🔴 46	🟡 53
Performance	🔴 36	🔴 34
Code coverage	🟢 93	🟢 93
Bug prevention	🟡 75	🟡 75
Axe Accessibility	🟡 88	🟡 88
Code style	🟢 100	🟢 100	–
Security	🔴 47	🔴 47	–
Updates	🟡 78	🟡 78	–
Type Safety	🟡 67	🟡 67	–
Miscellaneous	🟡 67	🟡 67	–
Accessibility	🟢 92	🟢 92	–
Best Practices	🟢 100	🟢 100	–
SEO	🟢 92	🟢 92	–

👍 1 group improved, 👎 2 groups regressed, 👍 7 audits improved, 👎 7 audits regressed, 13 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score
JSDocs coverage	Documentation coverage	🔴 46	🟡 53
Lighthouse	Performance	🔴 36	🔴 34
Code coverage	Code coverage metrics	🟢 93	🟢 93

31 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value
Lighthouse	Initial server response time was short	🟩 Root document took 490 ms	🟥 Root document took 630 ms
JSDocs coverage	Properties coverage	🟥 41 undocumented properties	🟥 38 undocumented properties
JSDocs coverage	Methods coverage	🟨 15 undocumented methods	🟨 11 undocumented methods
JSDocs coverage	Classes coverage	🟨 6 undocumented classes	🟨 5 undocumented classes
Lighthouse	Speed Index	🟥 6.8 s	🟥 7.8 s
Lighthouse	First Contentful Paint	🟥 3.1 s	🟥 3.2 s
Lighthouse	Time to Interactive	🟥 13.3 s	🟥 14.1 s
Lighthouse	Total Blocking Time	🟥 1,810 ms	🟥 2,010 ms
JSDocs coverage	Variables coverage	🟥 280 undocumented variables	🟥 273 undocumented variables
JSDocs coverage	Types coverage	🟥 262 undocumented types	🟥 261 undocumented types
JSDocs coverage	Functions coverage	🟥 582 undocumented functions	🟥 582 undocumented functions
Code coverage	Line coverage	🟩 92.6 %	🟩 92.7 %
Code coverage	Branch coverage	🟨 89.2 %	🟨 89.2 %
Code coverage	Function coverage	🟩 94.3 %	🟩 94.3 %
Lighthouse	Avoids enormous network payloads	🟩 Total size was 2,091 KiB	🟩 Total size was 2,087 KiB
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	Minimizes main-thread work	🟥 12.1 s	🟥 11.4 s
Lighthouse	Uses efficient cache policy on static assets	🟨 31 resources found	🟨 31 resources found
Lighthouse	Server Backend Latencies	🟩 660 ms	🟩 290 ms
Lighthouse	Largest Contentful Paint	🟥 11.8 s	🟥 11.4 s
Lighthouse	JavaScript execution time	🟥 4.9 s	🟥 4.6 s
Lighthouse	Max Potential First Input Delay	🟥 1,300 ms	🟥 1,150 ms
Lighthouse	Reduce unused JavaScript	🟥 Potential savings of 226 KiB	🟥 Potential savings of 226 KiB
Lighthouse	Reduce unused CSS	🟥 Potential savings of 125 KiB	🟥 Potential savings of 125 KiB
Lighthouse	Network Round Trip Times	🟩 0 ms	🟩 50 ms
Lighthouse	Remove duplicate modules in JavaScript bundles	🟥 Potential savings of 85 KiB	🟥 Potential savings of 88 KiB
TypeScript	Semantic errors	🟥 25 errors	🟥 36 errors

652 other audits are unchanged.

github-actions · 2026-01-16T22:38:36Z

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 61ecb4f with previous commit e677d4f.

💼 Project `utils`

🤨 Code PushUp report has both improvements and regressions.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Documentation	🟡 51	🟡 60
Code coverage	🟢 95	🟢 95

4 other categories are unchanged.

👍 1 group improved, 👎 1 group regressed, 👍 7 audits improved, 👎 2 audits regressed

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
JSDocs coverage	Documentation coverage	🟡 51	🟡 60
Code coverage	Code coverage metrics	🟢 95	🟢 95

13 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value
JSDocs coverage	Properties coverage	🟥 38 undocumented properties	🟥 35 undocumented properties
JSDocs coverage	Methods coverage	🟨 15 undocumented methods	🟨 11 undocumented methods
JSDocs coverage	Classes coverage	🟨 3 undocumented classes	🟨 2 undocumented classes
JSDocs coverage	Variables coverage	🟥 57 undocumented variables	🟥 50 undocumented variables
JSDocs coverage	Types coverage	🟨 56 undocumented types	🟨 55 undocumented types
JSDocs coverage	Functions coverage	🟥 244 undocumented functions	🟥 244 undocumented functions
Code coverage	Branch coverage	🟩 92.2 %	🟩 92 %
Code coverage	Function coverage	🟩 96 %	🟩 95.9 %
Code coverage	Line coverage	🟩 97.9 %	🟩 97.9 %

435 other audits are unchanged.

13 other projects are unchanged.

Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

# Conflicts: # packages/utils/src/lib/profiler/profiler.int.test.ts # packages/utils/src/lib/profiler/profiler.unit.test.ts

Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

# Conflicts: # packages/utils/mocks/sink.mock.ts # packages/utils/src/lib/performance-observer.int.test.ts # packages/utils/src/lib/performance-observer.ts # packages/utils/src/lib/performance-observer.unit.test.ts # packages/utils/src/lib/profiler/constants.ts # packages/utils/src/lib/profiler/profiler.ts # packages/utils/src/lib/profiler/profiler.unit.test.ts # packages/utils/src/lib/sink-source.type.ts

Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

cursor · 2026-01-27T14:21:39Z

You have run out of free Bugbot PR reviews for this billing cycle. This will reset on February 26.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

… into feat/utils/profiler-perf-buffer

Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

BioPhoton added 4 commits January 16, 2026 17:52

feat: add NodeJSProfiler
b71f3c7

docs: clarify that sink defines output format in NodejsProfiler JSDoc
d8d5a93
- Add explanation that sink determines output format (DevTools TraceEvent, OpenTelemetry, etc.) - Improve documentation clarity for flexible serialization capabilities - Fix duplicate imports in profiler unit test

test: convert all MockSink and MockTraceEventFileSink methods to spies
673b5c4
- Replace method implementations with vi.fn() spy functions - Add vi import from vitest - Enables better testing with call tracking and assertions

refactor: add tests
7c14a0b

github-actionsBot assigned BioPhoton Jan 16, 2026

github-actionsBot added 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🧩 utils labels Jan 16, 2026

BioPhoton mentioned this pull request Jan 16, 2026
Implement performance profiling and trace file generation #1197
Open

Merge branch 'main' into feat/utils/profiler-perf-buffer
b6babbe

refactor: fix lint
d328c9f

BioPhoton marked this pull request as ready for review January 16, 2026 22:22

BioPhoton requested review from hanna-skryl and matejchalk January 16, 2026 22:22

hanna-skryl reviewed Jan 16, 2026
View reviewed changes

Comment threadpackages/utils/docs/profiler.md Outdated
Comment threadpackages/utils/src/lib/profiler/profiler.int.test.ts Outdated

BioPhoton commented Jan 17, 2026
View reviewed changes

Comment threadpackages/utils/docs/profiler.md Outdated

Apply suggestions from code review
0af9068
Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

BioPhoton commented Jan 18, 2026
View reviewed changes

Comment threadpackages/utils/docs/profiler.md Outdated
Comment threadpackages/utils/docs/profiler.md Outdated

BioPhotonand others added 7 commits January 18, 2026 05:07

Update packages/utils/docs/profiler.md
f2b374e

Update packages/utils/docs/profiler.md
cb61834

fix: adjust observer logic
27e76f2

docs: update docs
e227c8f

refactor: wip
b347c9d

refactor: fix int tests
0125f7a

refactor: fix lint
8334310

BioPhoton requested a review from hanna-skryl January 18, 2026 17:41

BioPhoton added 3 commits January 26, 2026 21:51

Merge branch 'main' into feat/utils/profiler-perf-buffer
9b6719c
# Conflicts: # packages/utils/src/lib/profiler/profiler.int.test.ts # packages/utils/src/lib/profiler/profiler.unit.test.ts

refactor: wip tests
00bef3e

refactor: wip tests
13019da

BioPhoton requested a review from hanna-skryl January 26, 2026 20:59

refactor: wip
ac4a1fc

hanna-skryl reviewed Jan 26, 2026
View reviewed changes

BioPhotonand others added 4 commits January 27, 2026 00:22

Update packages/utils/mocks/sink.mock.ts
e1b7a1f
Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

Update packages/utils/src/lib/profiler/profiler.int.test.ts
83cbe4b
Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

Update packages/utils/src/lib/performance-observer.ts
343cb56
Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

Update packages/utils/src/lib/performance-observer.ts
eecb612
Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

hanna-skryl mentioned this pull request Jan 26, 2026
feat(utils): add WriteAheadLog classes #1210
Merged

BioPhoton added 2 commits January 27, 2026 00:32

refactor: update JSDocs
30bfdcd

refactor: fix lint
e46f208

BioPhoton requested a review from hanna-skryl January 26, 2026 23:40

BioPhoton added 3 commits January 27, 2026 00:49

refactor: fix merge
8a8903f

refactor: docs
66523e3

hanna-skryl reviewed Jan 27, 2026
View reviewed changes

Comment threadpackages/utils/src/lib/profiler/profiler.ts Outdated
Comment threadpackages/utils/src/lib/profiler/profiler.ts Outdated

Update packages/utils/src/lib/profiler/profiler.ts
2088927
Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

BioPhoton added 2 commits January 27, 2026 15:22

refactor: wip
2ed9b1b

Merge remote-tracking branch 'origin/feat/utils/profiler-perf-buffer'…
c32a0fc
… into feat/utils/profiler-perf-buffer

BioPhoton requested a review from hanna-skryl January 27, 2026 14:25

hanna-skryl reviewed Jan 27, 2026
View reviewed changes

Comment threadpackages/utils/src/lib/profiler/profiler.ts Outdated

Update packages/utils/src/lib/profiler/profiler.ts
ae5b099
Co-authored-by: Hanna Skryl <80118140+hanna-skryl@users.noreply.github.com>

BioPhoton requested a review from hanna-skryl January 27, 2026 14:28

BioPhoton enabled auto-merge (squash) January 27, 2026 14:34

hanna-skryl approved these changes Jan 27, 2026
View reviewed changes

BioPhoton merged commit ea196f9 into mainJan 27, 2026
35 of 36 checks passed

BioPhoton deleted the feat/utils/profiler-perf-buffer branch January 27, 2026 14:49

Uh oh!

Conversation

BioPhoton commented Jan 16, 2026• edited by cursor BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nx-cloudBot commented Jan 16, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-newBot commented Jan 16, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actionsBot commented Jan 16, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

🏷️ Categories

🗃️ Groups

🛡️ Audits

Uh oh!

github-actionsBot commented Jan 16, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

💼 Project utils

🗃️ Groups

🛡️ Audits

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursorBot commented Jan 27, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BioPhoton commented Jan 16, 2026•
edited by cursor Bot
Loading

nx-cloudBot commented Jan 16, 2026•
edited
Loading

pkg-pr-newBot commented Jan 16, 2026•
edited
Loading

github-actionsBot commented Jan 16, 2026•
edited
Loading

github-actionsBot commented Jan 16, 2026•
edited
Loading

💼 Project `utils`