fix(zod): adopt upstream lazy-bind memory optimization (colinhacks/zod#5897) by gsoldevila · Pull Request #266343 · elastic/kibana

gsoldevila · 2026-04-29T09:43:28Z

Summary

Adopts the memory optimization implemented by Colin McDonnell in colinhacks/zod#5897 as a patch-package patch, ahead of the next official zod release. Also fixes colinhacks/zod#5760.

Background

The previous patch (#263121) introduced a shadow-proto architecture that shared builder methods on a hidden prototype layer. While it reduced per-schema heap cost by ~80%, it introduced a breaking change: detached method calls stopped working.

const opt = schema.optional;  // extracts method reference
opt();                         // ❌ previously threw — `this` was undefined

The root cause was that _initProto used Object.assign to copy methods as plain value properties onto the prototype. Detaching such a property loses the this context.

This PR

Replaces _initProto with Colin's _installLazyMethods approach from colinhacks/zod#5897:

function _installLazyMethods(inst, group, methods) {
  // ... one-time setup per (proto, group) ...
  for (const key in methods) {
    const fn = methods[key];
    Object.defineProperty(proto, key, {
      configurable: true,
      enumerable: false,
      get() {
        const bound = fn.bind(this);
        // Cache on the instance — subsequent accesses skip the getter
        Object.defineProperty(this, key, {
          configurable: true, writable: true, enumerable: true,
          value: bound,
        });
        return bound;
      },
      set(v) {
        Object.defineProperty(this, key, {
          configurable: true, writable: true, enumerable: true,
          value: v,
        });
      },
    });
  }
}

How it works:

Builder methods live as non-enumerable getters on each concrete schema's prototype
On first access per instance, the getter allocates fn.bind(this) and caches it as an own property — subsequent accesses skip the getter entirely
Detached calls (const m = schema.optional; m()) work because m is a bound function with this already resolved
Parse-family methods (parse, safeParse, etc.) stay as eager per-instance closures — they're the hot path and most-detached methods

Memory characteristics are unchanged: builder methods are not own properties until first accessed, so V8 keeps schema instances in fast-property mode. Per Colin's numbers: -40% heap per instance, -25% construction time vs Zod 4.3.6 baseline.

Why `patch-package`

Upstream zod CI has been broken for months and there is no scheduled release. patch-package allows us to ship the fix now. Once a new zod version including colinhacks/zod#5897 is released, this patch can be dropped.

Changes

patches/zod+4.3.6.patch — replaces the previous shadow-proto patch with Colin's _installLazyMethods approach (only touches v4/classic/schemas.cjs and v4/classic/schemas.js)
src/platform/packages/shared/kbn-zod/v4/detached_methods.test.ts — behavioural unit tests proving detached calls work and that the lazy-cache correctly returns the same bound function on repeated access

Test plan

node scripts/jest src/platform/packages/shared/kbn-zod/v4/detached_methods.test.ts — 5/5 pass
Full CI green

infra-vault-gh-plugin-prod · 2026-04-29T09:47:35Z

Pinging @elastic/kibana-core (Team:Core)

Replaces `Object.assign(proto, methods)` in the `_initProto` helper (added by the previous shadow-proto patch) with a `Object.defineProperty` getter loop: for (const [k, fn] of Object.entries(methods)) { Object.defineProperty(proto, k, { get() { return fn.bind(this); }, configurable: true, enumerable: false, }); } When a method is accessed on an instance (e.g. `schema.optional`), the getter returns a copy bound to `this`, so detached calls — including destructuring and variable extraction — continue to work: const opt = schema.optional; opt(); // previously threw; now works correctly The memory benefits of the shadow-proto approach are fully preserved: builder methods are still not own properties, so V8 keeps schema instances in fast-property mode. Adds a behavioural unit test in `@kbn/zod` that covers the main detached-call scenarios and documents the known trade-off (each getter access allocates a new bound function). Made-with: Cursor

kibanamachine · 2026-04-29T12:08:50Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 83ebee2

Failed CI Steps

Test Failures

[job] [logs] Jest Tests #2 / ChartContextMenu it invokes onReset when the Reset group by fields menu item clicked
[job] [logs] affected Scout: [ security / security_solution ] plugin / local-stateful-classic - Attacks navigation - updates side nav based on attacks alignment advanced setting

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`stackConnectors`	1.8MB	1.8MB	-12.0B
`workflowsManagement`	2.3MB	2.3MB	-12.0B
total			-24.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`kbnUiSharedDeps-npmDll`	7.3MB	7.3MB	-2.5KB

History

💔 Build #435540 failed 32c559b

kibanamachine · 2026-04-29T14:09:44Z

Starting backport for target branches: 9.4

https://github.com/elastic/kibana/actions/runs/25113849876

kibanamachine · 2026-04-29T14:18:31Z

💚 All backports created successfully

Status	Branch	Result
✅	9.4

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2026-04-29T14:23:27Z

Starting backport for target branches: 9.4

https://github.com/elastic/kibana/actions/runs/25114569158

kibanamachine · 2026-04-29T14:23:31Z

Starting backport for target branches: 9.4

https://github.com/elastic/kibana/actions/runs/25114569023

kibanamachine · 2026-04-29T14:33:00Z

💔 All backports failed

Status	Branch	Result
❌	9.4	An unhandled error occurred. Please see the logs for details

Manual backport

To create the backport manually run:

node scripts/backport --pr 266343

Questions ?

Please refer to the Backport tool documentation

…d#5897) (elastic#266343) ## Summary Adopts the memory optimization implemented by Colin McDonnell in [colinhacks/zod#5897](colinhacks/zod#5897) as a `patch-package` patch, ahead of the next official zod release. Also fixes [colinhacks/zod#5760](colinhacks/zod#5760). ### Background The previous patch (elastic#263121) introduced a **shadow-proto** architecture that shared builder methods on a hidden prototype layer. While it reduced per-schema heap cost by ~80%, it introduced a breaking change: **detached method calls** stopped working. ```ts const opt = schema.optional; // extracts method reference opt(); // ❌ previously threw — `this` was undefined ``` The root cause was that `_initProto` used `Object.assign` to copy methods as plain value properties onto the prototype. Detaching such a property loses the `this` context. ### This PR Replaces `_initProto` with Colin's `_installLazyMethods` approach from [colinhacks/zod#5897](colinhacks/zod#5897): ```js function _installLazyMethods(inst, group, methods) { // ... one-time setup per (proto, group) ... for (const key in methods) { const fn = methods[key]; Object.defineProperty(proto, key, { configurable: true, enumerable: false, get() { const bound = fn.bind(this); // Cache on the instance — subsequent accesses skip the getter Object.defineProperty(this, key, { configurable: true, writable: true, enumerable: true, value: bound, }); return bound; }, set(v) { Object.defineProperty(this, key, { configurable: true, writable: true, enumerable: true, value: v, }); }, }); } } ``` **How it works:** - Builder methods live as non-enumerable getters on each concrete schema's prototype - On first access per instance, the getter allocates `fn.bind(this)` and caches it as an own property — subsequent accesses skip the getter entirely - Detached calls (`const m = schema.optional; m()`) work because `m` is a bound function with `this` already resolved - Parse-family methods (`parse`, `safeParse`, etc.) stay as eager per-instance closures — they're the hot path and most-detached methods **Memory characteristics are unchanged:** builder methods are not own properties until first accessed, so V8 keeps schema instances in fast-property mode. Per Colin's numbers: -40% heap per instance, -25% construction time vs Zod 4.3.6 baseline. ## Why `patch-package` Upstream zod CI has been broken for months and there is no scheduled release. `patch-package` allows us to ship the fix now. Once a new zod version including [colinhacks/zod#5897](colinhacks/zod#5897) is released, this patch can be dropped. ## Changes - `patches/zod+4.3.6.patch` — replaces the previous shadow-proto patch with Colin's `_installLazyMethods` approach (only touches `v4/classic/schemas.cjs` and `v4/classic/schemas.js`) - `src/platform/packages/shared/kbn-zod/v4/detached_methods.test.ts` — behavioural unit tests proving detached calls work and that the lazy-cache correctly returns the same bound function on repeated access ## Test plan - [x] `node scripts/jest src/platform/packages/shared/kbn-zod/v4/detached_methods.test.ts` — 5/5 pass - [ ] Full CI green --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit a9ecabf)

kibanamachine · 2026-04-29T14:33:09Z

💚 All backports created successfully

Status	Branch	Result
✅	9.4

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…cks/zod#5897) (#266343) (#266401) # Backport This will backport the following commits from `main` to `9.4`: - [fix(zod): adopt upstream lazy-bind memory optimization (colinhacks/zod#5897) (#266343)](#266343)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) Made with [Cursor](https://cursor.com) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

colinhacks · 2026-04-30T02:32:03Z

Zod 4.4 has been released

…types (#267326) ### Summary Cleanup pass on `@kbn/evals-common` and the `evals` plugin, mirroring what was done for `@kbn/inbox-common` in #265634. No functional changes for end users, but the OAS docs generated from these routes are now correct, and the in-memory cost of the Zod schemas drops via the upstream lazy-bind optimization. ### Changes - **Switch to canonical `buildRouteValidationWithZod` from `@kbn/zod-helpers/v4`** - Deleted the local copy in `kbn-evals-common/impl/schemas/common.ts` and its re-export from `kbn-evals-common/index.ts`. - Updated all 18 evals route files to import the helper from `@kbn/zod-helpers/v4`. - Pruned `@kbn/zod-helpers` and `@kbn/core` from `kbn-evals-common`'s `moon.yml` / `tsconfig.json`; added `@kbn/zod-helpers` to the `evals` plugin's instead. - The canonical helper attaches `_sourceSchema` to the returned validator (added in #263354), which `kbn-router-to-openapispec` unwraps so route `params` / `query` / `body` actually appear in generated OAS docs. The local copy did not, so any OAS doc generation for these routes was silently dropping schema info. - **Regenerated OAS types** (`yarn openapi:generate` in `kbn-evals-common`) - Picks up the `lazySchema(() => …)` wrappers introduced by #264125 and tuned in #266343 (upstream `colinhacks/zod#5897` lazy-bind memory optimization). 19 `.gen.ts` files updated; pattern matches the prior inbox regen exactly. - **README cleanup** — pointed at the new helper location and dropped the obsolete "after regenerating, you may need to fix unused imports" workaround (no longer needed thanks to the OAS-generator `fix_eslint.ts` fix from #265634, which forces the non-editor branch when invoked from agent/IDE terminals). _PR developed with Cursor + Claude Opus 4.7 Super Duper xHigh Thinking++_

gsoldevila added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Apr 29, 2026

gsoldevila marked this pull request as ready for review April 29, 2026 09:47

gsoldevila requested a review from a team as a code owner April 29, 2026 09:47

infra-vault-gh-plugin-prod Bot deleted a comment from elasticmachine Apr 29, 2026

gsoldevila force-pushed the zod-memory-optimization-auto-bind-getters branch from 204e413 to 32c559b Compare April 29, 2026 10:16

gsoldevila changed the title ~~fix(zod): upgrade shadow-proto patch to use auto-bind getters~~ fix(zod): adopt upstream lazy-bind memory optimization (colinhacks/zod#5897) Apr 29, 2026

gsoldevila force-pushed the zod-memory-optimization-auto-bind-getters branch from 32c559b to 378e5a2 Compare April 29, 2026 10:54

rudolf approved these changes Apr 29, 2026

View reviewed changes

Changes from node scripts/eslint_all_files --no-cache --fix

83ebee2

gsoldevila added backport:version Backport to applied version labels v9.4.0 and removed backport:skip This PR does not require backporting labels Apr 29, 2026

gsoldevila mentioned this pull request Apr 29, 2026

[9.4] fix(zod): adopt upstream lazy-bind memory optimization (colinhacks/zod#5897) (#266343) #266401

Merged

gsoldevila added the ci:build-cloud-image label Apr 29, 2026

gsoldevila merged commit a9ecabf into elastic:main Apr 29, 2026
53 checks passed

kibanamachine added the v9.5.0 label Apr 29, 2026

gsoldevila added backport:skip This PR does not require backporting and removed backport:version Backport to applied version labels labels Apr 29, 2026

kibanamachine mentioned this pull request Apr 29, 2026

[9.4] fix(zod): adopt upstream lazy-bind memory optimization (colinhacks/zod#5897) (#266343) #266411

Closed

gsoldevila added backport:version Backport to applied version labels and removed backport:skip This PR does not require backporting labels Apr 29, 2026

gsoldevila added backport:skip This PR does not require backporting and removed backport:version Backport to applied version labels labels Apr 29, 2026

kibanamachine mentioned this pull request Apr 29, 2026

[Entity Store] Implement logs pagination in CCS #266307

Merged

spong mentioned this pull request May 1, 2026

[kbn-evals] Adopt canonical @kbn/zod-helpers/v4 and regenerate OAS types #267326

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(zod): adopt upstream lazy-bind memory optimization (colinhacks/zod#5897)#266343

fix(zod): adopt upstream lazy-bind memory optimization (colinhacks/zod#5897)#266343
gsoldevila merged 2 commits intoelastic:mainfrom
gsoldevila:zod-memory-optimization-auto-bind-getters

gsoldevila commented Apr 29, 2026 •

edited by kibanamachine

Loading

Uh oh!

infra-vault-gh-plugin-prod Bot commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

colinhacks commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

gsoldevila commented Apr 29, 2026 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Background

This PR

Why patch-package

Changes

Test plan

Uh oh!

infra-vault-gh-plugin-prod Bot commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Async chunks

Page load bundle

History

Uh oh!

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

💚 All backports created successfully

Questions ?

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

Uh oh!

kibanamachine commented Apr 29, 2026

💔 All backports failed

Manual backport

Questions ?

Uh oh!

kibanamachine commented Apr 29, 2026

💚 All backports created successfully

Questions ?

Uh oh!

colinhacks commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gsoldevila commented Apr 29, 2026 •

edited by kibanamachine

Loading

Why `patch-package`