fix(core): reject non-JSON-safe layer keys with LayerKeyError#29
Conversation
Fail closed before hashKey so undefined/NaN/null no longer collide via JSON.stringify, and document the JSON-safe key domain.
🦋 Changeset detectedLatest commit: 4e45ecd The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Warning Review limit reached
Next review available in: 17 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (14)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Backtrack WeakSet after walking children; sort into Object.create(null); tighten tests/docs/JSDoc for the JSON-safe key contract.
Summary
LayerKeysegments inhashKey(assertLayerKey); throwLayerKeyError/ narrow withisLayerKeyErrorstring|boolean|null| finitenumber| plain objects/arrays of those; rejectundefined(incl. object props),NaN/±Infinity, bigint, symbol, functions, non-plain objects, cycles[undefined]/[null]/[NaN]→"[null]"collision note; sync throw vs Promise reject in error-handlingBreaking note
Apps using
undefined/NaN/ non-finite numbers / BigInt / cycles / class instances in keys will start throwing. Fix: usenullor explicit sentinels (filterId ?? "none"); omit optional object fields instead of settingundefined.Test plan
bun test packages/core/src/layerStack.test.ts(reject matrix + syncopenthrow)bun run --filter ./packages/core typecheckbun run docs:check --isolated+docs:build