Skip to content

Use tuple context based on apparent type of the contextual type uninstantiated by return mapper #62174

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.

Sign up for GitHub

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

Use tuple context based on apparent type of the contextual type uninstantiated by return mapper #62174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32613,7 +32613,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
// types as well as arguments to the left in a function call.
return instantiateInstantiableTypes(contextualType, inferenceContext.nonFixingMapper);
}
if (inferenceContext?.returnMapper) {
if (!(contextFlags! & ContextFlags.SkipReturnMapper) && inferenceContext?.returnMapper) {
// For other purposes (e.g. determining whether to produce literal types) we only
// incorporate inferences made from the return type in a function call. We remove
// the 'boolean' type from the contextual type such that contextually typed boolean
Expand Down Expand Up @@ -33208,6 +33208,10 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
return isSpreadElement(parent) && isCallOrNewExpression(parent.parent);
}

function givesTupleContext(type: Type | undefined) {
return !!type && someType(type, t => isTupleLikeType(t) || isGenericMappedType(t) && !t.nameType && !!getHomomorphicTypeVariable(t.target as MappedType || t));
}

function checkArrayLiteral(node: ArrayLiteralExpression, checkMode: CheckMode | undefined, forceTuple: boolean | undefined): Type {
const elements = node.elements;
const elementCount = elements.length;
Expand All @@ -33217,7 +33221,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
const inDestructuringPattern = isAssignmentTarget(node);
const inConstContext = isConstContext(node);
const contextualType = getApparentTypeOfContextualType(node, /*contextFlags*/ undefined);
const inTupleContext = isSpreadIntoCallOrNew(node) || !!contextualType && someType(contextualType, t => isTupleLikeType(t) || isGenericMappedType(t) && !t.nameType && !!getHomomorphicTypeVariable(t.target as MappedType || t));
const inTupleContext = isSpreadIntoCallOrNew(node) || givesTupleContext(contextualType) || givesTupleContext(getApparentTypeOfContextualType(node, ContextFlags.SkipReturnMapper));

let hasOmittedExpression = false;
for (let i = 0; i < elementCount; i++) {
Expand Down
1 change: 1 addition & 0 deletions src/compiler/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5529,6 +5529,7 @@ export const enum ContextFlags {
NoConstraints = 1 << 1, // Don't obtain type variable constraints
Completions = 1 << 2, // Ignore inference to current node and parent nodes out to the containing call for completions
SkipBindingPatterns = 1 << 3, // Ignore contextual types applied by binding patterns
SkipReturnMapper = 1 << 4,
}

// NOTE: If modifying this enum, must modify `TypeFormatFlags` too!
Expand Down
12 changes: 6 additions & 6 deletions tests/baselines/reference/inferFromGenericFunctionReturnTypes3.types
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,20 +615,20 @@ type F = () => Promise<Array<Player>>;
const f1: F = () => {
>f1 : F
> : ^
>() => { return Promise.all([ { name: "David Gomes", age: 23, position: "GOALKEEPER", }, { name: "Cristiano Ronaldo", age: 33, position: "STRIKER", } ]);} : () => Promise<({ name: string; age: number; position: "GOALKEEPER"; } | { name: string; age: number; position: "STRIKER"; })[]>
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>() => { return Promise.all([ { name: "David Gomes", age: 23, position: "GOALKEEPER", }, { name: "Cristiano Ronaldo", age: 33, position: "STRIKER", } ]);} : () => Promise<[{ name: string; age: number; position: "GOALKEEPER"; }, { name: string; age: number; position: "STRIKER"; }]>
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

return Promise.all([
>Promise.all([ { name: "David Gomes", age: 23, position: "GOALKEEPER", }, { name: "Cristiano Ronaldo", age: 33, position: "STRIKER", } ]) : Promise<({ name: string; age: number; position: "GOALKEEPER"; } | { name: string; age: number; position: "STRIKER"; })[]>
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>Promise.all([ { name: "David Gomes", age: 23, position: "GOALKEEPER", }, { name: "Cristiano Ronaldo", age: 33, position: "STRIKER", } ]) : Promise<[{ name: string; age: number; position: "GOALKEEPER"; }, { name: string; age: number; position: "STRIKER"; }]>
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>Promise.all : { <T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>; <T extends readonly unknown[] | []>(values: T): Promise<{ -readonly [P in keyof T]: Awaited<T[P]>; }>; }
> : ^^^ ^^ ^^ ^^^ ^^^ ^^^^^^^^^ ^^ ^^ ^^^ ^^^
>Promise : PromiseConstructor
> : ^^^^^^^^^^^^^^^^^^
>all : { <T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>; <T extends readonly unknown[] | []>(values: T): Promise<{ -readonly [P in keyof T]: Awaited<T[P]>; }>; }
> : ^^^ ^^ ^^ ^^^ ^^^ ^^^^^^^^^ ^^ ^^ ^^^ ^^^
>[ { name: "David Gomes", age: 23, position: "GOALKEEPER", }, { name: "Cristiano Ronaldo", age: 33, position: "STRIKER", } ] : ({ name: string; age: number; position: "GOALKEEPER"; } | { name: string; age: number; position: "STRIKER"; })[]
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>[ { name: "David Gomes", age: 23, position: "GOALKEEPER", }, { name: "Cristiano Ronaldo", age: 33, position: "STRIKER", } ] : [{ name: string; age: number; position: "GOALKEEPER"; }, { name: string; age: number; position: "STRIKER"; }]
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
{
>{ name: "David Gomes", age: 23, position: "GOALKEEPER", } : { name: string; age: number; position: "GOALKEEPER"; }
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
134 changes: 134 additions & 0 deletions tests/baselines/reference/returnTypeContextualTupleTyping1.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
//// [tests/cases/compiler/returnTypeContextualTupleTyping1.ts] ////

=== returnTypeContextualTupleTyping1.ts ===
// https://github.com/microsoft/TypeScript/issues/62071

declare function getNum(): Promise<number>;
>getNum : Symbol(getNum, Decl(returnTypeContextualTupleTyping1.ts, 0, 0))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2018.promise.d.ts, --, --))

declare function getStr(): Promise<string>;
>getStr : Symbol(getStr, Decl(returnTypeContextualTupleTyping1.ts, 2, 43))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2018.promise.d.ts, --, --))

declare function useTuple(tuple: [number, string]): void;
>useTuple : Symbol(useTuple, Decl(returnTypeContextualTupleTyping1.ts, 3, 43))
>tuple : Symbol(tuple, Decl(returnTypeContextualTupleTyping1.ts, 4, 26))

const p = Promise.resolve([])
>p : Symbol(p, Decl(returnTypeContextualTupleTyping1.ts, 6, 5))
>Promise.resolve([]) .then(() => Promise.all([getNum(), getStr()])) .then : Symbol(Promise.then, Decl(lib.es5.d.ts, --, --))
>Promise.resolve([]) .then : Symbol(Promise.then, Decl(lib.es5.d.ts, --, --))
>Promise.resolve : Symbol(PromiseConstructor.resolve, Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2018.promise.d.ts, --, --))
>resolve : Symbol(PromiseConstructor.resolve, Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --))

.then(() => Promise.all([getNum(), getStr()]))
>then : Symbol(Promise.then, Decl(lib.es5.d.ts, --, --))
>Promise.all : Symbol(PromiseConstructor.all, Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2018.promise.d.ts, --, --))
>all : Symbol(PromiseConstructor.all, Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --))
>getNum : Symbol(getNum, Decl(returnTypeContextualTupleTyping1.ts, 0, 0))
>getStr : Symbol(getStr, Decl(returnTypeContextualTupleTyping1.ts, 2, 43))

.then(useTuple); // ok
>then : Symbol(Promise.then, Decl(lib.es5.d.ts, --, --))
>useTuple : Symbol(useTuple, Decl(returnTypeContextualTupleTyping1.ts, 3, 43))

// same as above but without relying as much on builtin libs
interface MyPromise<T> {
>MyPromise : Symbol(MyPromise, Decl(returnTypeContextualTupleTyping1.ts, 8, 18))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 11, 20))

then<
>then : Symbol(MyPromise.then, Decl(returnTypeContextualTupleTyping1.ts, 11, 24))

TResult1 = T, // outer type parameter used as default here is important for the test
>TResult1 : Symbol(TResult1, Decl(returnTypeContextualTupleTyping1.ts, 12, 7))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 11, 20))

TResult2 = never,
>TResult2 : Symbol(TResult2, Decl(returnTypeContextualTupleTyping1.ts, 13, 17))

>(
onfulfilled?:
>onfulfilled : Symbol(onfulfilled, Decl(returnTypeContextualTupleTyping1.ts, 15, 4))

| ((value: T) => TResult1 | PromiseLike<TResult1>)
>value : Symbol(value, Decl(returnTypeContextualTupleTyping1.ts, 17, 10))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 11, 20))
>TResult1 : Symbol(TResult1, Decl(returnTypeContextualTupleTyping1.ts, 12, 7))
>PromiseLike : Symbol(PromiseLike, Decl(lib.es5.d.ts, --, --))
>TResult1 : Symbol(TResult1, Decl(returnTypeContextualTupleTyping1.ts, 12, 7))

| undefined
| null,
onrejected?:
>onrejected : Symbol(onrejected, Decl(returnTypeContextualTupleTyping1.ts, 19, 13))

| ((reason: any) => TResult2 | PromiseLike<TResult2>)
>reason : Symbol(reason, Decl(returnTypeContextualTupleTyping1.ts, 21, 10))
>TResult2 : Symbol(TResult2, Decl(returnTypeContextualTupleTyping1.ts, 13, 17))
>PromiseLike : Symbol(PromiseLike, Decl(lib.es5.d.ts, --, --))
>TResult2 : Symbol(TResult2, Decl(returnTypeContextualTupleTyping1.ts, 13, 17))

| undefined
| null,
): MyPromise<TResult1 | TResult2>;
>MyPromise : Symbol(MyPromise, Decl(returnTypeContextualTupleTyping1.ts, 8, 18))
>TResult1 : Symbol(TResult1, Decl(returnTypeContextualTupleTyping1.ts, 12, 7))
>TResult2 : Symbol(TResult2, Decl(returnTypeContextualTupleTyping1.ts, 13, 17))
}

declare function resolve<T>(value: T): MyPromise<Awaited<T>>;
>resolve : Symbol(resolve, Decl(returnTypeContextualTupleTyping1.ts, 25, 1), Decl(returnTypeContextualTupleTyping1.ts, 27, 61))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 27, 25))
>value : Symbol(value, Decl(returnTypeContextualTupleTyping1.ts, 27, 28))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 27, 25))
>MyPromise : Symbol(MyPromise, Decl(returnTypeContextualTupleTyping1.ts, 8, 18))
>Awaited : Symbol(Awaited, Decl(lib.es5.d.ts, --, --))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 27, 25))

declare function resolve<T>(value: T | PromiseLike<T>): MyPromise<Awaited<T>>;
>resolve : Symbol(resolve, Decl(returnTypeContextualTupleTyping1.ts, 25, 1), Decl(returnTypeContextualTupleTyping1.ts, 27, 61))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 28, 25))
>value : Symbol(value, Decl(returnTypeContextualTupleTyping1.ts, 28, 28))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 28, 25))
>PromiseLike : Symbol(PromiseLike, Decl(lib.es5.d.ts, --, --))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 28, 25))
>MyPromise : Symbol(MyPromise, Decl(returnTypeContextualTupleTyping1.ts, 8, 18))
>Awaited : Symbol(Awaited, Decl(lib.es5.d.ts, --, --))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 28, 25))

declare function all<T extends readonly unknown[] | []>(
>all : Symbol(all, Decl(returnTypeContextualTupleTyping1.ts, 28, 78))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 30, 21))

values: T,
>values : Symbol(values, Decl(returnTypeContextualTupleTyping1.ts, 30, 56))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 30, 21))

): MyPromise<{ -readonly [P in keyof T]: Awaited<T[P]> }>;
>MyPromise : Symbol(MyPromise, Decl(returnTypeContextualTupleTyping1.ts, 8, 18))
>P : Symbol(P, Decl(returnTypeContextualTupleTyping1.ts, 32, 26))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 30, 21))
>Awaited : Symbol(Awaited, Decl(lib.es5.d.ts, --, --))
>T : Symbol(T, Decl(returnTypeContextualTupleTyping1.ts, 30, 21))
>P : Symbol(P, Decl(returnTypeContextualTupleTyping1.ts, 32, 26))

const p2 = resolve([])
>p2 : Symbol(p2, Decl(returnTypeContextualTupleTyping1.ts, 34, 5))
>resolve([]) .then(() => all([getNum(), getStr()])) .then : Symbol(MyPromise.then, Decl(returnTypeContextualTupleTyping1.ts, 11, 24))
>resolve([]) .then : Symbol(MyPromise.then, Decl(returnTypeContextualTupleTyping1.ts, 11, 24))
>resolve : Symbol(resolve, Decl(returnTypeContextualTupleTyping1.ts, 25, 1), Decl(returnTypeContextualTupleTyping1.ts, 27, 61))

.then(() => all([getNum(), getStr()]))
>then : Symbol(MyPromise.then, Decl(returnTypeContextualTupleTyping1.ts, 11, 24))
>all : Symbol(all, Decl(returnTypeContextualTupleTyping1.ts, 28, 78))
>getNum : Symbol(getNum, Decl(returnTypeContextualTupleTyping1.ts, 0, 0))
>getStr : Symbol(getStr, Decl(returnTypeContextualTupleTyping1.ts, 2, 43))

.then(useTuple); // ok
>then : Symbol(MyPromise.then, Decl(returnTypeContextualTupleTyping1.ts, 11, 24))
>useTuple : Symbol(useTuple, Decl(returnTypeContextualTupleTyping1.ts, 3, 43))

Loading
Loading