Skip to content

Discard types that reduce to never before discriminating by discriminable items #62275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24855,7 +24855,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {

function discriminateTypeByDiscriminableItems(target: UnionType, discriminators: (readonly [() => Type, __String])[], related: (source: Type, target: Type) => boolean | Ternary) {
const types = target.types;
const include: Ternary[] = types.map(t => t.flags & TypeFlags.Primitive ? Ternary.False : Ternary.True);
const include: Ternary[] = types.map(t => t.flags & TypeFlags.Primitive || getReducedType(t).flags & TypeFlags.Never ? Ternary.False : Ternary.True);
for (const [getDiscriminatingType, propertyName] of discriminators) {
// If the remaining target types include at least one with a matching discriminant, eliminate those that
// have non-matching discriminants. This ensures that we ignore erroneous discriminators and gradually
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
//// [tests/cases/compiler/contextuallyTypedByDiscriminableUnion2.ts] ////

=== contextuallyTypedByDiscriminableUnion2.ts ===
// https://github.com/microsoft/TypeScript/issues/62256

type Identifiable = { id: string };
>Identifiable : Symbol(Identifiable, Decl(contextuallyTypedByDiscriminableUnion2.ts, 0, 0))
>id : Symbol(id, Decl(contextuallyTypedByDiscriminableUnion2.ts, 2, 21))

interface EnableA {
>EnableA : Symbol(EnableA, Decl(contextuallyTypedByDiscriminableUnion2.ts, 2, 35))

readonly enableA: true;
>enableA : Symbol(EnableA.enableA, Decl(contextuallyTypedByDiscriminableUnion2.ts, 4, 19))

// this introduces a conflicting property with some of the other members of MyComponentProps
// making relevant final union members reduced nevers
readonly enableB: true;
>enableB : Symbol(EnableA.enableB, Decl(contextuallyTypedByDiscriminableUnion2.ts, 5, 25))
}

interface DisableA {
>DisableA : Symbol(DisableA, Decl(contextuallyTypedByDiscriminableUnion2.ts, 9, 1))

readonly enableA?: false;
>enableA : Symbol(DisableA.enableA, Decl(contextuallyTypedByDiscriminableUnion2.ts, 11, 20))
}

interface EnableB {
>EnableB : Symbol(EnableB, Decl(contextuallyTypedByDiscriminableUnion2.ts, 13, 1))

readonly enableB?: true;
>enableB : Symbol(EnableB.enableB, Decl(contextuallyTypedByDiscriminableUnion2.ts, 15, 19))
}

interface DisableB {
>DisableB : Symbol(DisableB, Decl(contextuallyTypedByDiscriminableUnion2.ts, 17, 1))

readonly enableB: false;
>enableB : Symbol(DisableB.enableB, Decl(contextuallyTypedByDiscriminableUnion2.ts, 19, 20))
}

export interface EnableD<I extends Identifiable> {
>EnableD : Symbol(EnableD, Decl(contextuallyTypedByDiscriminableUnion2.ts, 21, 1))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 23, 25))
>Identifiable : Symbol(Identifiable, Decl(contextuallyTypedByDiscriminableUnion2.ts, 0, 0))

readonly enableD: true;
>enableD : Symbol(EnableD.enableD, Decl(contextuallyTypedByDiscriminableUnion2.ts, 23, 50))

readonly value: I["id"] | null;
>value : Symbol(EnableD.value, Decl(contextuallyTypedByDiscriminableUnion2.ts, 24, 25))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 23, 25))

readonly setItem: (item: I | null) => void;
>setItem : Symbol(EnableD.setItem, Decl(contextuallyTypedByDiscriminableUnion2.ts, 25, 33))
>item : Symbol(item, Decl(contextuallyTypedByDiscriminableUnion2.ts, 26, 21))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 23, 25))
}

export interface DisableD<I extends Identifiable> {
>DisableD : Symbol(DisableD, Decl(contextuallyTypedByDiscriminableUnion2.ts, 27, 1))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 29, 26))
>Identifiable : Symbol(Identifiable, Decl(contextuallyTypedByDiscriminableUnion2.ts, 0, 0))

readonly enableD: false;
>enableD : Symbol(DisableD.enableD, Decl(contextuallyTypedByDiscriminableUnion2.ts, 29, 51))

readonly value: I["id"];
>value : Symbol(DisableD.value, Decl(contextuallyTypedByDiscriminableUnion2.ts, 30, 26))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 29, 26))

readonly setItem: (item: I) => void;
>setItem : Symbol(DisableD.setItem, Decl(contextuallyTypedByDiscriminableUnion2.ts, 31, 26))
>item : Symbol(item, Decl(contextuallyTypedByDiscriminableUnion2.ts, 32, 21))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 29, 26))
}

type MyComponentProps<I extends Identifiable> = (EnableA | DisableA) &
>MyComponentProps : Symbol(MyComponentProps, Decl(contextuallyTypedByDiscriminableUnion2.ts, 33, 1))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 35, 22))
>Identifiable : Symbol(Identifiable, Decl(contextuallyTypedByDiscriminableUnion2.ts, 0, 0))
>EnableA : Symbol(EnableA, Decl(contextuallyTypedByDiscriminableUnion2.ts, 2, 35))
>DisableA : Symbol(DisableA, Decl(contextuallyTypedByDiscriminableUnion2.ts, 9, 1))

(EnableB | DisableB) &
>EnableB : Symbol(EnableB, Decl(contextuallyTypedByDiscriminableUnion2.ts, 13, 1))
>DisableB : Symbol(DisableB, Decl(contextuallyTypedByDiscriminableUnion2.ts, 17, 1))

(DisableD<I> | EnableD<I>);
>DisableD : Symbol(DisableD, Decl(contextuallyTypedByDiscriminableUnion2.ts, 27, 1))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 35, 22))
>EnableD : Symbol(EnableD, Decl(contextuallyTypedByDiscriminableUnion2.ts, 21, 1))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 35, 22))

const MyComponent = <I extends Identifiable>(props: MyComponentProps<I>) => {};
>MyComponent : Symbol(MyComponent, Decl(contextuallyTypedByDiscriminableUnion2.ts, 39, 5))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 39, 21))
>Identifiable : Symbol(Identifiable, Decl(contextuallyTypedByDiscriminableUnion2.ts, 0, 0))
>props : Symbol(props, Decl(contextuallyTypedByDiscriminableUnion2.ts, 39, 45))
>MyComponentProps : Symbol(MyComponentProps, Decl(contextuallyTypedByDiscriminableUnion2.ts, 33, 1))
>I : Symbol(I, Decl(contextuallyTypedByDiscriminableUnion2.ts, 39, 21))

declare const item: string | null;
>item : Symbol(item, Decl(contextuallyTypedByDiscriminableUnion2.ts, 41, 13))

MyComponent({
>MyComponent : Symbol(MyComponent, Decl(contextuallyTypedByDiscriminableUnion2.ts, 39, 5))

enableD: true,
>enableD : Symbol(enableD, Decl(contextuallyTypedByDiscriminableUnion2.ts, 43, 13))

value: item,
>value : Symbol(value, Decl(contextuallyTypedByDiscriminableUnion2.ts, 44, 16))
>item : Symbol(item, Decl(contextuallyTypedByDiscriminableUnion2.ts, 41, 13))

setItem: (item) => {},
>setItem : Symbol(setItem, Decl(contextuallyTypedByDiscriminableUnion2.ts, 45, 14))
>item : Symbol(item, Decl(contextuallyTypedByDiscriminableUnion2.ts, 46, 12))

});

136 changes: 136 additions & 0 deletions tests/baselines/reference/contextuallyTypedByDiscriminableUnion2.types
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
//// [tests/cases/compiler/contextuallyTypedByDiscriminableUnion2.ts] ////

=== contextuallyTypedByDiscriminableUnion2.ts ===
// https://github.com/microsoft/TypeScript/issues/62256

type Identifiable = { id: string };
>Identifiable : Identifiable
> : ^^^^^^^^^^^^
>id : string
> : ^^^^^^

interface EnableA {
readonly enableA: true;
>enableA : true
> : ^^^^
>true : true
> : ^^^^

// this introduces a conflicting property with some of the other members of MyComponentProps
// making relevant final union members reduced nevers
readonly enableB: true;
>enableB : true
> : ^^^^
>true : true
> : ^^^^
}

interface DisableA {
readonly enableA?: false;
>enableA : false | undefined
> : ^^^^^^^^^^^^^^^^^
>false : false
> : ^^^^^
}

interface EnableB {
readonly enableB?: true;
>enableB : true | undefined
> : ^^^^^^^^^^^^^^^^
>true : true
> : ^^^^
}

interface DisableB {
readonly enableB: false;
>enableB : false
> : ^^^^^
>false : false
> : ^^^^^
}

export interface EnableD<I extends Identifiable> {
readonly enableD: true;
>enableD : true
> : ^^^^
>true : true
> : ^^^^

readonly value: I["id"] | null;
>value : I["id"] | null
> : ^^^^^^^^^^^^^^

readonly setItem: (item: I | null) => void;
>setItem : (item: I | null) => void
> : ^ ^^ ^^^^^
>item : I | null
> : ^^^^^^^^
}

export interface DisableD<I extends Identifiable> {
readonly enableD: false;
>enableD : false
> : ^^^^^
>false : false
> : ^^^^^

readonly value: I["id"];
>value : I["id"]
> : ^^^^^^^

readonly setItem: (item: I) => void;
>setItem : (item: I) => void
> : ^ ^^ ^^^^^
>item : I
> : ^
}

type MyComponentProps<I extends Identifiable> = (EnableA | DisableA) &
>MyComponentProps : (EnableA & EnableB & DisableD<I>) | (EnableA & EnableB & EnableD<I>) | (DisableA & EnableB & DisableD<I>) | (DisableA & EnableB & EnableD<I>) | (DisableA & DisableB & DisableD<I>) | (DisableA & DisableB & EnableD<I>)
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

(EnableB | DisableB) &
(DisableD<I> | EnableD<I>);

const MyComponent = <I extends Identifiable>(props: MyComponentProps<I>) => {};
>MyComponent : <I extends Identifiable>(props: MyComponentProps<I>) => void
> : ^ ^^^^^^^^^ ^^ ^^ ^^^^^^^^^
><I extends Identifiable>(props: MyComponentProps<I>) => {} : <I extends Identifiable>(props: MyComponentProps<I>) => void
> : ^ ^^^^^^^^^ ^^ ^^ ^^^^^^^^^
>props : (EnableA & EnableB & DisableD<I>) | (EnableA & EnableB & EnableD<I>) | (DisableA & EnableB & DisableD<I>) | (DisableA & EnableB & EnableD<I>) | (DisableA & DisableB & DisableD<I>) | (DisableA & DisableB & EnableD<I>)
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

declare const item: string | null;
>item : string | null
> : ^^^^^^^^^^^^^

MyComponent({
>MyComponent({ enableD: true, value: item, setItem: (item) => {},}) : void
> : ^^^^
>MyComponent : <I extends Identifiable>(props: MyComponentProps<I>) => void
> : ^ ^^^^^^^^^ ^^ ^^ ^^^^^^^^^
>{ enableD: true, value: item, setItem: (item) => {},} : { enableD: true; value: string | null; setItem: (item: Identifiable | null) => void; }
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

enableD: true,
>enableD : true
> : ^^^^
>true : true
> : ^^^^

value: item,
>value : string | null
> : ^^^^^^^^^^^^^
>item : string | null
> : ^^^^^^^^^^^^^

setItem: (item) => {},
>setItem : (item: Identifiable | null) => void
> : ^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>(item) => {} : (item: Identifiable | null) => void
> : ^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>item : Identifiable | null
> : ^^^^^^^^^^^^^^^^^^^

});

51 changes: 51 additions & 0 deletions tests/cases/compiler/contextuallyTypedByDiscriminableUnion2.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// @strict: true
// @noEmit: true

// https://github.com/microsoft/TypeScript/issues/62256

type Identifiable = { id: string };

interface EnableA {
readonly enableA: true;
// this introduces a conflicting property with some of the other members of MyComponentProps
// making relevant final union members reduced nevers
Copy link
Preview

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

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

The comment should be more specific about which members have conflicting properties and how this leads to never types. Consider explaining the specific conflict between EnableA requiring enableB: true and DisableB requiring enableB: false.

Suggested change
// making relevant final union members reduced nevers
// This introduces a conflicting property: EnableA requires enableB: true,
// but DisableB requires enableB: false. As a result, any union member combining
// EnableA and DisableB is reduced to never, since enableB cannot be both true and false.

Copilot uses AI. Check for mistakes.

Copy link
Preview

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

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

This comment contains unclear language. 'reduced nevers' should be 'reduce to never' for grammatical correctness and clarity.

Suggested change
// making relevant final union members reduced nevers
// making relevant final union members reduce to never

Copilot uses AI. Check for mistakes.

readonly enableB: true;
}

interface DisableA {
readonly enableA?: false;
}

interface EnableB {
readonly enableB?: true;
}

interface DisableB {
readonly enableB: false;
}

export interface EnableD<I extends Identifiable> {
readonly enableD: true;
readonly value: I["id"] | null;
readonly setItem: (item: I | null) => void;
}

export interface DisableD<I extends Identifiable> {
readonly enableD: false;
readonly value: I["id"];
readonly setItem: (item: I) => void;
}

type MyComponentProps<I extends Identifiable> = (EnableA | DisableA) &
(EnableB | DisableB) &
(DisableD<I> | EnableD<I>);

const MyComponent = <I extends Identifiable>(props: MyComponentProps<I>) => {};

declare const item: string | null;

MyComponent({
enableD: true,
value: item,
setItem: (item) => {},
});
Loading