fix(plugin): correct enum+nullable handling for Enum | null (and ar…#3544
Merged
kamilmysliwiec merged 3 commits intonestjs:masterfrom Oct 16, 2025
Merged
Conversation
…rays); avoid lazy `type` for enum unions
Context:
When a DTO property used a union like `Enum | null` (or `Enum[] | null`) the plugin sometimes:
- emitted a lazy `type: () => FooEnum` (unnecessary for enums; can cause circular refs), or
- missed `enum: FooEnum` entirely for optional+nullable cases (e.g. `?: Status | null`).
Root cause:
- `createTypePropertyAssignments` didn’t special-case enum unions, so it fell back to a lazy `type`.
- `createEnumPropertyAssignment` could return early when the checker reported a union containing null/undefined or when array unwrapping wasn’t detected up front, dropping the `enum`.
What changed:
1) Handle enum unions in `createTypePropertyAssignments`:
- For unions with exactly one non-nullish member:
* If that member (or its array element) is an enum (including auto-generated enum unions), do **not** emit `type`.
* Only add `nullable: true` when `null` is part of the union.
- This avoids circular resolvers and lets enum metadata be provided solely by `createEnumPropertyAssignment`.
2) Rewrite `createEnumPropertyAssignment` to be union- and optional-safe:
- Unwrap `null`/\`undefined\` from unions before enum detection.
- Treat array unwrapping as optional (don’t bail if not detected initially).
- Resolve auto-generated enum unions (string literal unions) to a referenceable type.
- Preserve and/or re-detect `isArray` after resolving enum-like types.
- Skip enum **members** (e.g., `FooEnum.ONE`) which aren’t referenceable as enum types.
Results:
- `Enum | null` → `{ enum: FooEnum, nullable: true }`
- `Enum[] | null` → `{ enum: FooEnum, isArray: true, nullable: true }`
- `?: Enum | null` → `{ required: false, enum: FooEnum, nullable: true }`
- Non-enum unions (e.g., `string | null`) still emit `type` + `nullable` (as before).
- `undefined` continues to affect `required` (based on `?`), not `nullable` — unchanged.
Tests:
- Fixture `test/plugin/fixtures/nullable.dto.ts` asserts correct transpiled metadata.
- Previously failing spec “should support & understand nullable type unions” now passes.
Affects:
- lib/plugin/visitors/model-class.visitor.ts
- test/plugin/fixtures/nullable.dto.ts
Fixes: nestjs#3519
Member
|
LGTM |
Closed
4 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…rays); avoid lazy
typefor enum unionsContext:
When a DTO property used a union like
Enum | null(orEnum[] | null) the plugin sometimes:type: () => FooEnum(unnecessary for enums; can cause circular refs), orenum: FooEnumentirely for optional+nullable cases (e.g.?: Status | null).Root cause:
createTypePropertyAssignmentsdidn’t special-case enum unions, so it fell back to a lazytype.createEnumPropertyAssignmentcould return early when the checker reported a union containing null/undefined or when array unwrapping wasn’t detected up front, dropping theenum.What changed:
Handle enum unions in
createTypePropertyAssignments:type. * Only addnullable: truewhennullis part of the union.createEnumPropertyAssignment.Rewrite
createEnumPropertyAssignmentto be union- and optional-safe:null/`undefined` from unions before enum detection.isArrayafter resolving enum-like types.FooEnum.ONE) which aren’t referenceable as enum types.Results:
Enum | null→{ enum: FooEnum, nullable: true }Enum[] | null→{ enum: FooEnum, isArray: true, nullable: true }?: Enum | null→{ required: false, enum: FooEnum, nullable: true }string | null) still emittype+nullable(as before).undefinedcontinues to affectrequired(based on?), notnullable— unchanged.Tests:
test/plugin/fixtures/nullable.dto.tsasserts correct transpiled metadata.Affects:
Fixes: #3519
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information