Skip to content

refactor(downgrader): follow a propertyNames $ref through one $ref only - #321

Merged
dinwwwh merged 20 commits into
mainfrom
claude/project-thread-h3q238
Nov 1, 2026
Merged

dinwwwh merged 20 commits into
mainfrom
claude/project-thread-h3q238

Conversation

@dinwwwh

@dinwwwh dinwwwh commented Nov 1, 2026

Copy link
Copy Markdown
Member

Requested by dinwwwh · project thread

What

Simplifies #315, following the request for the simplest approach with minimal logic.

A record keyed by an enum becomes one property per name. #315 made enumNames walk a chain of propertyNames $refs, one annotated $ref at a time with a visited set, so that it stopped at a $ref with a narrowing keyword beside it. That set was allocated for every schema, which the review of #315 measured at about 6% on the schema benchmarks.

enumNames now follows one $ref beside only annotations, as it did before #315, but with resolvePointer instead of resolve. A target that is a $ref again fails the existing hasOnly check, so it holds no names. The record then loses its key names and counts as loose, the same as any other propertyNames it cannot read.

Tests

The #315 test now expects a record keyed through an alias of an alias to lose its key names (additionalProperties stays as written), and a not over a record keyed through a narrowed $ref still becomes {}. pnpm check, pnpm test and coverage (100%) pass.

Tradeoffs

  • Output. A record keyed through a chain of two or more $refs, such as a described alias of a reusable enum, no longer gets one property per name. 3.0 then allows any key there. A single $ref, as Zod and Valibot write for a reusable enum, still converts as before.
  • Speed. No allocation per schema any more.

Generated by Claude Code

claude added 20 commits November 1, 2026 05:44
… no oneOf branch apart, and takes null

Where several $refs enter the same cycle, the first copy made is reused, so
a later one can hold a $ref that was cut to {} while another target was
being inlined. isDisjoint and the nullable pair merge read such a $ref in
the input, saw its target's type or tag, and kept a oneOf that the {} then
let a value match twice. The holders of cut $refs are now recorded, and
follow() and throughRef() read them as keeping nothing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…operties beside other properties, out of enum merging

A oneOf rejects a value two of its branches share, so mergeEnums keeps a
oneOf whose literals repeat one. It compared them serialized, which tells
equal objects with their keys in another order apart, so it merged such a
oneOf into an enum that took the shared value. A oneOf of object or array
literals now stays as it is. And an additionalProperties in a literal branch
counted as repeating the one around it although that one sits beside other
properties, which it then let through, so it repeats only beside the same
properties.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…side annotations

enumNames read the names at the end of the propertyNames $ref chain, past a
$ref with an enum, maxLength or other keyword beside it that narrows the
names further. The record then got a property for each name of the last
enum, allowing keys the input rejects, and counted as converted exactly, so a
not or oneOf over it stayed. The chain now stops at such a $ref, so the
record loses its key names and counts as loose.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…iction around an alias component or a cycle of objects

#309 converts the input again when a not or oneOf read a $ref's target
before that target lost a restriction around a cycle. It missed two cycles.
A component that is only a $ref, an alias, has no output of its own, so the
output recorded for it was undefined; it now records the output of the target
its chain of kept $refs ends at. And a dereferenced document closes a cycle
with the object itself rather than a $ref; convertObject now tells
convertSchema when it meets a schema again, and one that was not loose then
but is once converted makes the next pass read it as loose. First visits pay
nothing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…ed-union $refs

The rerun recorded nothing for an alias whose chain passes through a $ref the
conversion inlines, such as one into $defs, or that is a $ref to a tagged union
beside only annotations, so a not over it around a cycle was kept over a target
that lost a restriction. sharedOutput now follows every $ref convertSchema
treats as an alias, and reads an inlined hop's output from its inlined copy.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…form

A schema that loses a restriction around a cycle made the conversion run
again, so a not or oneOf that read it too early could drop or widen. Only
such a choice changes when more schemas read as loose, so a pass that kept
no not, and no oneOf without a loose branch, needs no other. A document with
a recursive schema that loses a restriction and no not or oneOf now converts
in one pass, about half the time.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…y property as loose

OAS 3.0 applies a required readOnly property to responses only and a
required writeOnly property to requests only, while 3.1 requires it both
ways. The 3.0 output so loses that restriction, so a not or oneOf over
such an object must not keep it, and the property tells no oneOf branch
apart. The property is read through a chain of $refs too, as 3.0 reads
each target in its place.

Such a schema in a cycle, as a recursive DTO with a required readOnly id,
makes a document that keeps a not or oneOf convert twice, which the README
performance note now says.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
… or a set per name

CodSpeed read the order schema bench 19% slower with the check. It now loops
over `required` once per schema, reads each property's fields directly, and
makes a visited set only past the first `$ref`. Instructions per conversion of
that schema drop from 4% over main to 2% under callgrind with CodSpeed's V8
flags. A cycle of `$ref`s, which never reaches a schema, is tested too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
Marking the schema itself loose lets a $ref to it, and every object around
it, read as loose through the existing checks, so no walk over required
names is needed. Only the tag check still reads through $refs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…stead of converting again

A $ref or object cycle that reaches a schema before its conversion is done
cannot know yet what that schema loses, so it now counts as loose. This
replaces the second pass (#309, #316) and its skip (#317) with two checks,
at the cost of a recursive schema always counting as loose: a not over it is
removed, and a oneOf with it becomes anyOf unless its branches are disjoint.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
…ties with its target

Checking which items or additionalProperties the conversion replaces needed
a walk over the pointer and a lookup of each holder. Replacing every $ref
into either keeps the same values accepted, with one regex test.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
A target that is a $ref again now holds no names, so the record loses its
key names, as it does for any other propertyNames it cannot read. This
replaces the walk along a chain of annotated $refs and its visited set,
which every schema allocated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VVaw7NmVyQoYtVBNPuE4uV
@dinwwwh dinwwwh self-assigned this Nov 1, 2026
@codecov

codecov Bot commented Nov 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@codspeed

codspeed Bot commented Nov 1, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

1 warning

⚠️ 1 benchmark is dominated by system calls

System calls cannot be simulated consistently and are left out of the measure. The reported value understates the real cost. Switch to the Walltime instrument to measure them.

Learn more about system calls

See affected benchmarks

✅ 29 untouched benchmarks
⏩ 2 skipped benchmarks1


Comparing claude/project-thread-h3q238 (3c7ab4b) with main (24d36dc)

Open in CodSpeed

Footnotes

  1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes

This reverses the visited-guarded chain walk that #315 added to enumNames, following a propertyNames $ref through at most one hop so no per-schema set is allocated.

  • enumNames collapses to a single $ref hop — packages/downgrader/src/v3.1-to-v3.0.ts drops the loop for one getRef + isAnnotatedRef + resolvePointer step. A target that is a $ref again now falls through hasOnly (a $ref key is neither an annotation, enum, const, nor type) and yields undefined, so the record loses its key names and counts as loose.
  • Test reworked to pin the new contract — packages/downgrader/tests/v3.1-to-v3.0.test.ts:2433 now expects a record keyed through an alias-of-an-alias (ByAlias) to lose key names while NotEnglish still collapses to {}.

I traced the behavior against the previous code: for depth ≤ 1 (a direct $ref, an inline enum/const, a $ref with a non-annotation sibling, and a $ref with an undefined-valued sibling, which hasOnly treats as missing) the new code is identical to the old; the only divergence is a two-or-more-hop chain of annotated $refs, which is the tradeoff described in the PR. enumNames is consumed by losesRestriction('propertyNames'), finishSchema, and isIntoReplaced, all keyed off the same predicate, so they stay consistent. The README already documents only "a $ref to one", so no doc drift. Ran pnpm test (357 passed, including the 130 in the touched test file).

Pullfrog  | View workflow run | Using deepseek-v4.1-flash (free via Pullfrog for OSS) | 𝕏

@dinwwwh
dinwwwh merged commit 6aeeb95 into main Nov 1, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants