You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
fix(pacer): only run devtools integration in development - #308
Since 0.5, @tanstack/devtools-event-client turns EventClient into a no-op unless process.env.NODE_ENV === 'development'. Pacer's own devtools code around it had no such check, so production builds still shipped and ran it:
On every state change of a keyed util, emitChange stored the instance in a module-level map that is never cleared, and deep-cloned its state and options with JSON.parse(JSON.stringify()) before passing them to the no-op emit.
Keyed utils subscribed to d-* events in their constructors.
pacerEventClient was created at module load from a subclass, so bundlers could not drop it or @tanstack/devtools-event-client.
This PR puts the same NODE_ENV === 'development' check in front of emitChange and the constructor subscriptions. It also creates pacerEventClient as a /* @__PURE__ */ new EventClient(...) without the subclass, because esbuild keeps an unused class extends. The guards check key first, so unkeyed utils in unbundled Node skip the process.env lookup.
Exports and development behaviour are unchanged. Events never reached devtools in production before this change, so the only production difference is that the registry and cloning no longer run.
Bundle of new Throttler(...).maybeExecute() with NODE_ENV=production and minification:
before
after
esbuild
6619 B (2551 gzip)
5822 B (2217 gzip)
rolldown
6655 B (2516 gzip)
5842 B (2190 gzip)
After the change, neither bundle contains event client code.
I did not use @__NO_SIDE_EFFECTS__ on emitChange. Its return value is never used, so bundlers would remove every call, including in development. I checked this with rolldown: devtools stopped receiving updates.
A new event-client.test.ts covers both modes. The existing registry tests now stub NODE_ENV=development, because vitest runs with test.
I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
I fully understand the code in this pull request, including any code generated with AI assistance.
🚀 Release Impact
This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).
Summary by CodeRabbit
Improvements
Devtools integration now runs only in development. In production, keyed utilities no longer register devtools listeners or emit devtools events, helping reduce production bundle size.
Documentation
Updated references to describe the development-only devtools behavior and the event client.
No actionable comments were generated in the recent review.
Walkthrough
Keyed Pacer devtools listeners and event emission now require development mode. The event client uses a plain EventClient, and TypeScript documentation configurations include the ambient NODE_ENV declaration. Tests and reference documentation reflect these changes.
Changes: Development-only devtools
Layer / File(s)
Summary
Declare NODE_ENV for package and docs builds packages/pacer/src/process-env.d.ts, packages/*-pacer/tsconfig.docs.json
Adds an ambient type for process.env.NODE_ENV and includes it in the framework packages’ documentation TypeScript configurations.
Keyed utility listeners and event emission require development mode. The event client is a plain EventClient configured with the Pacer plugin ID and reconnect interval. Tests check development and production behavior; references and the changeset describe the update.
Devtools integration now runs only in development, and production skips the event-client work. No remaining merge-blocking risk was found.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title names the main change: Pacer's devtools integration now runs only in development. The change set gates emitChange, keyed-util subscriptions, and the pacerEventClient setup on NODE_ENV === 'd…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Description check
The description follows the repository template. It has the Changes section, the Checklist, and the Release Impact section. The Changes section explains the problem and the fix. It names the affected …
Full details: Title check
Explanation
The title names the main change: Pacer's devtools integration now runs only in development. The change set gates emitChange, keyed-util subscriptions, and the pacerEventClient setup on NODE_ENV === 'development'. The title uses the conventional 'fix(pacer):' prefix and is concise. It does not mention the bundle-size or pure-annotation details, which is acceptable.
Full details: Description check
Explanation
The description follows the repository template. It has the Changes section, the Checklist, and the Release Impact section. The Changes section explains the problem and the fix. It names the affected code paths: emitChange, keyed-util constructor subscriptions, and pacerEventClient creation. It explains why the key check runs before the environment lookup. It reports bundle size results for esbuild and rolldown, and it explains why @__NO_SIDE_EFFECTS__ was not used. It states that exports and development behavior are unchanged. All three checklist items are ticked, and the Release Impact section marks the changeset item. The description does not mention the later tsconfig and process type changes listed in the commit summary, which affect docs builds and type-checking. Those changes are part of the PR but are not described in the author text.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Reviewing files that changed from the base of the PR and between 34d6213 and 7054b8d.
Files selected for processing: 31
.changeset/pacer-gate-devtools-production.md
docs/reference/functions/emitChange.md
docs/reference/variables/pacerEventClient.md
packages/alpine-pacer/tsconfig.docs.json
packages/angular-pacer/tsconfig.docs.json
packages/ember-pacer/tsconfig.docs.json
packages/lit-pacer/tsconfig.docs.json
packages/octane-pacer/tsconfig.docs.json
packages/pacer/src/async-batcher.ts
packages/pacer/src/async-debouncer.ts
packages/pacer/src/async-queuer.ts
packages/pacer/src/async-rate-limiter.ts
packages/pacer/src/async-throttler.ts
packages/pacer/src/batcher.ts
packages/pacer/src/debouncer.ts
packages/pacer/src/event-client.ts
packages/pacer/src/process-env.d.ts
packages/pacer/src/queuer.ts
packages/pacer/src/rate-limiter.ts
packages/pacer/src/throttler.ts
packages/pacer/tests/async-debouncer.test.ts
packages/pacer/tests/async-queuer.test.ts
packages/pacer/tests/async-rate-limiter.test.ts
packages/pacer/tests/async-retryer.test.ts
packages/pacer/tests/async-throttler.test.ts
packages/pacer/tests/event-client.test.ts
packages/preact-pacer/tsconfig.docs.json
packages/react-pacer/tsconfig.docs.json
packages/solid-pacer/tsconfig.docs.json
packages/svelte-pacer/tsconfig.docs.json
packages/vue-pacer/tsconfig.docs.json
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
TypeScript 6 no longer loads @types/node by default, and the docs
tsconfigs don't include the config files that pull it in. The new
`process.env.NODE_ENV` checks then failed type-checking in typedoc,
which made generate-docs wipe every reference docs folder without
writing new output.
Declare a minimal `process` type in pacer (same as
preact-pacer-devtools) and include it in the framework docs tsconfigs,
which compile pacer from source.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 Changes
Since 0.5,
@tanstack/devtools-event-clientturnsEventClientinto a no-op unlessprocess.env.NODE_ENV === 'development'. Pacer's own devtools code around it had no such check, so production builds still shipped and ran it:emitChangestored the instance in a module-level map that is never cleared, and deep-cloned its state and options withJSON.parse(JSON.stringify())before passing them to the no-opemit.d-*events in their constructors.pacerEventClientwas created at module load from a subclass, so bundlers could not drop it or@tanstack/devtools-event-client.This PR puts the same
NODE_ENV === 'development'check in front ofemitChangeand the constructor subscriptions. It also createspacerEventClientas a/* @__PURE__ */ new EventClient(...)without the subclass, because esbuild keeps an unusedclass extends. The guards checkkeyfirst, so unkeyed utils in unbundled Node skip theprocess.envlookup.Exports and development behaviour are unchanged. Events never reached devtools in production before this change, so the only production difference is that the registry and cloning no longer run.
Bundle of
new Throttler(...).maybeExecute()withNODE_ENV=productionand minification:After the change, neither bundle contains event client code.
I did not use
@__NO_SIDE_EFFECTS__onemitChange. Its return value is never used, so bundlers would remove every call, including in development. I checked this with rolldown: devtools stopped receiving updates.A new
event-client.test.tscovers both modes. The existing registry tests now stubNODE_ENV=development, because vitest runs withtest.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit