fix(form-core): bump devtools-event-client to 0.5.0 #2410
main fromrefs/pull/2410/head·opened 🎯 Changes#
Bumps @tanstack/devtools-event-client in form-core from ^0.4.1 to ^0.5.0.
Since 0.5.0 (TanStack/devtools#471) the root EventClient export is a no-op unless NODE_ENV is development, and bundlers drop the real client. Pacer already made the same bump. On 0.4.x the first form emit fires tanstack-connect and starts a retry interval even with no devtools installed, which also keeps a Node SSR process alive for about 5s after rendering a form.
v2 alpha already removes the event client from form-core, so this is only for 1.x. One side effect: react-form-devtools/production won't get form events in production builds anymore, same as Pacer after its bump.
Added a test that mounts a form and checks nothing is sent to the devtools bus. It fails on 0.4.3. I also checked a minified production bundle of form-core (35.8 kB to 32.0 kB, no tanstack-connect left), and a Node script that mounts a form now exits right away instead of after ~5s.
Fixes #2132
✅ Checklist#
- I have followed the steps in the Contributing guide.
- I have tested code changes locally with
pnpm 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#
- Bug Fixes
- Form-core no longer connects to the TanStack Devtools event bus outside development. The event-bus connection remains available during development, while non-development environments no longer register the connection listener. No changes to the public form API are included.
- 1
Navigate logical layers of code changes, visualize relationships, and explore their blast radius.
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository: TanStack/form/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID:
7f21a146-d0e9-4124-9678-c75844a9ef59📥 Commits
Reviewing files that changed from the base of the PR and between 555509cd941ae6ea3a2966ef3c879a322b3b383c and b80ec8d13a5fe9b154b6a127aac511d7080d52f9.
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (3)
.changeset/quiet-forms-sleep.mdpackages/form-core/package.jsonpackages/form-core/tests/EventClient.spec.ts
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.
📝 Walkthrough
Walkthrough#
form-core updates its
@tanstack/devtools-event-clientdependency range to^0.5.0. A new test mounts a form and checks that thetanstack-connectlistener is not called. A patch changeset records the dependency update.Changes#
Form-core event client
Layer / File(s) Summary Dependency update and connection-event test
packages/form-core/package.json,packages/form-core/tests/EventClient.spec.ts,.changeset/quiet-forms-sleep.mdThe dependency range changes from ^0.4.1to^0.5.0. The test checks that mounting a form does not call thetanstack-connectlistener. The changeset records a patch release.Priority: ➖ Normal
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Bug fix · Severity of issue fixed: Medium
Merge Risk: ⚪ Minimal · up to
b80ecThe updated client does not start a connection retry outside development, and the dependency resolution matches the update. No issue identified here prevents merging after normal checks.
Architecture Summary#
Architecture risk: 🔵 Low · up to
b80ecThe change affects 1 system.
Changed systems:
packages/form-coreArchitecture concerns No architecture-level concerns identified.
Review details
Systems and components
- observed — packages/form-core (library) was modified; 2 changed files map to changed impact.
Before / after behavior
- observed — Modified behavior in packages/form-core/package.json: The
@tanstack/devtools-event-clientdependency range changes from^0.4.1to^0.5.0. - observed — Modified behavior in packages/form-core/tests/EventClient.spec.ts: Adds a test that listens for
tanstack-connect, mounts a form with an emptynamedefault value, removes the listener, and expects it not to have been called. - observed — Modified behavior in .changeset/quiet-forms-sleep.md: Adds a patch changeset for
@tanstack/form-coredescribing the@tanstack/devtools-event-client0.5.0 bump and its stated effect on devtools event-bus connections outside development.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation Title check ✅ Passed The title clearly and concisely identifies the main change: updating the form-core devtools event client dependency to version 0.5.0. Description check ✅ Passed The description explains the change, motivation, effects, testing, linked issue, checklist completion, and changeset release impact. It satisfies the required template sections. Linked Issues check ✅ Passed Issue [ #2132] requires removal of production devtools event-client activity fromform-core. The PR upgrades@tanstack/devtools-event-clientfrom^0.4.1to^0.5.0. The reported 0.5.0 behavior m…Out of Scope Changes check ✅ Passed The reviewed changes are limited to the dependency update, its changeset, and an automated regression test. These changes directly support issue [ #2132]. No unrelated source, API, or feature changes a…Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1… ✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create a new PR
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.
Comment `@coderabbitai help` to get the list of available commands.Thanks for putting this together. I ran into the same code path from the memory side, and I think it adds a reason to land this for 1.x, so I'm sharing what I found in case it helps.
What I found#
On
@tanstack/form-core@1.33.5with@tanstack/devtools-event-client@0.4.4, everynew FormApi()emitsform-apiwith{ id, state, options }. Until the client connects, that event is pushed into#queuedEventson the module-levelFormEventClient, so each form's state and options stay reachable from it. A heap snapshot shows the chain asFormEventClient --#queuedEvents--> Array --> { type: 'form-devtools:form-api', payload }. NoFormApiinstances survive GC, only the queued payloads do.Where
CustomEventexists, this is bounded: the client retries every 1000 ms, gives up after 5 attempts (about 5 seconds), andstopConnectLoop()clears the queue. So in a normal Node ≥ 19 server or a browser, only forms created in the first few seconds are held, and only temporarily.Without a global
CustomEvent,emit()queues the event but never starts the connect loop, so the client never gives up and the queue grows for the lifetime of the process.Measurements#
Node 26, 10,000 forms, measured after GC and after letting timers run (the script is below):
CustomEventavailableNo global CustomEvent0.4.4, NODE_ENV=production3 B per form 1,264 B per form 0.5.1, NODE_ENV=production(via override)4 B per form 5 B per form 0.5.1, NODE_ENV=development3 B per form 1,266 B per form (dev only) React and Vue SSR behave the same way, since this lives in form-core.
Which environments lack
CustomEvent#- Node < 19 (the global was added in 19).
- React Native before 0.86, as far as I can tell from its source: 0.79.7, 0.81.5, 0.84.1 and 0.85.3 don't install a global
CustomEvent, and 0.86.0 adds one insetUpDOM. I haven't tested this on a device, and I haven't checked whether Expo polyfills it, so please treat this as a likely impact rather than a confirmed one. If it holds, a long-running RN app keeps every form's state and options in memory, including production builds on 0.4.x.
This PR#
Forcing
@tanstack/devtools-event-client@0.5.1under form-core 1.33.5 removed the retention in production in both cases above, and basic validate / submit / reset still worked. form-core only callsemitandon, and the no-op client implements both. Until a release, an override ("@tanstack/devtools-event-client": "^0.5.1") seems to work as a workaround.Repro script
// node --expose-gc repro.mjs [--no-custom-event] if (process.argv.includes('--no-custom-event')) delete globalThis.CustomEvent const { FormApi } = await import('@tanstack/form-core') const heap = () => (global.gc(), global.gc(), process.memoryUsage().heapUsed) for (let i = 0; i < 200; i++) new FormApi({ defaultValues: { name: '' } }) await new Promise((r) => setTimeout(r, 6000)) // let the connect loop give up const before = heap() for (let i = 0; i < 10_000; i++) new FormApi({ defaultValues: { name: '' } }) await new Promise((r) => setTimeout(r, 6000)) console.log(`${Math.round((heap() - before) / 10_000)} B retained per form`) process.exit(0)Happy to open a separate issue for the memory side if that's easier to track.
TiagoGranelli(GitHub profile, opens in a new tab) linked this to fix #2132
Sign in to join this conversation.
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
Security
View full report