-
Notifications
You must be signed in to change notification settings - Fork 12.8k
Improve inference for context sensitive functions within reverse mapped types #54029
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
base: main
Are you sure you want to change the base?
Changes from all commits
e90edb3
557cd99
4774f8f
b7eae05
a0804b5
57b54c9
fae5ae6
34d675a
a8e8a24
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -431,6 +431,7 @@ import { | |
InternalSymbolName, | ||
IntersectionType, | ||
IntersectionTypeNode, | ||
IntraExpressionInferenceSite, | ||
intrinsicTagNameToString, | ||
IntrinsicType, | ||
introducesArgumentsExoticObject, | ||
|
@@ -13123,12 +13124,13 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker { | |
const modifiers = getMappedTypeModifiers(type.mappedType); | ||
const readonlyMask = modifiers & MappedTypeModifiers.IncludeReadonly ? false : true; | ||
const optionalMask = modifiers & MappedTypeModifiers.IncludeOptional ? 0 : SymbolFlags.Optional; | ||
const indexInfos = indexInfo ? [createIndexInfo(stringType, inferReverseMappedType(indexInfo.type, type.mappedType, type.constraintType), readonlyMask && indexInfo.isReadonly)] : emptyArray; | ||
const indexInfos = indexInfo ? [createIndexInfo(stringType, inferReverseMappedType(indexInfo.type, type.mappedType, type.constraintType, /*sourceValueDeclaration*/ undefined), readonlyMask && indexInfo.isReadonly)] : emptyArray; | ||
const members = createSymbolTable(); | ||
for (const prop of getPropertiesOfType(type.source)) { | ||
const checkFlags = CheckFlags.ReverseMapped | (readonlyMask && isReadonlySymbol(prop) ? CheckFlags.Readonly : 0); | ||
const inferredProp = createSymbol(SymbolFlags.Property | prop.flags & optionalMask, prop.escapedName, checkFlags) as ReverseMappedSymbol; | ||
inferredProp.declarations = prop.declarations; | ||
inferredProp.valueDeclaration = prop.valueDeclaration; | ||
inferredProp.links.nameType = getSymbolLinks(prop).nameType; | ||
inferredProp.links.propertyType = getTypeOfSymbol(prop); | ||
if (type.constraintType.type.flags & TypeFlags.IndexedAccess | ||
|
@@ -23933,7 +23935,9 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker { | |
if (!inference.isFixed) { | ||
// Before we commit to a particular inference (and thus lock out any further inferences), | ||
// we infer from any intra-expression inference sites we have collected. | ||
inferFromIntraExpressionSites(context); | ||
if (context.intraExpressionInferenceSites) { | ||
inferFromIntraExpressionSites(context.inferences, context.intraExpressionInferenceSites); | ||
} | ||
clearCachedInferences(context.inferences); | ||
inference.isFixed = true; | ||
} | ||
|
@@ -23972,17 +23976,14 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker { | |
// arrow function. This happens automatically when the arrow functions are discrete arguments (because we | ||
// infer from each argument before processing the next), but when the arrow functions are elements of an | ||
// object or array literal, we need to perform intra-expression inferences early. | ||
function inferFromIntraExpressionSites(context: InferenceContext) { | ||
if (context.intraExpressionInferenceSites) { | ||
for (const { node, type } of context.intraExpressionInferenceSites) { | ||
const contextualType = node.kind === SyntaxKind.MethodDeclaration ? | ||
getContextualTypeForObjectLiteralMethod(node as MethodDeclaration, ContextFlags.NoConstraints) : | ||
getContextualType(node, ContextFlags.NoConstraints); | ||
if (contextualType) { | ||
inferTypes(context.inferences, type, contextualType); | ||
} | ||
function inferFromIntraExpressionSites(inferences: InferenceInfo[], intraExpressionInferenceSites: IntraExpressionInferenceSite[]) { | ||
for (const { node, type } of intraExpressionInferenceSites) { | ||
const contextualType = node.kind === SyntaxKind.MethodDeclaration ? | ||
getContextualTypeForObjectLiteralMethod(node as MethodDeclaration, ContextFlags.NoConstraints) : | ||
getContextualType(node, ContextFlags.NoConstraints); | ||
if (contextualType) { | ||
inferTypes(inferences, type, contextualType); | ||
} | ||
context.intraExpressionInferenceSites = undefined; | ||
} | ||
} | ||
|
||
|
@@ -24106,29 +24107,19 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker { | |
return type; | ||
} | ||
|
||
// We consider a type to be partially inferable if it isn't marked non-inferable or if it is | ||
// an object literal type with at least one property of an inferable type. For example, an object | ||
// literal { a: 123, b: x => true } is marked non-inferable because it contains a context sensitive | ||
// arrow function, but is considered partially inferable because property 'a' has an inferable type. | ||
function isPartiallyInferableType(type: Type): boolean { | ||
return !(getObjectFlags(type) & ObjectFlags.NonInferrableType) || | ||
isObjectLiteralType(type) && some(getPropertiesOfType(type), prop => isPartiallyInferableType(getTypeOfSymbol(prop))) || | ||
isTupleType(type) && some(getElementTypes(type), isPartiallyInferableType); | ||
} | ||
|
||
function createReverseMappedType(source: Type, target: MappedType, constraint: IndexType) { | ||
// We consider a source type reverse mappable if it has a string index signature or if | ||
// it has one or more properties and is of a partially inferable type. | ||
if (!(getIndexInfoOfType(source, stringType) || getPropertiesOfType(source).length !== 0 && isPartiallyInferableType(source))) { | ||
// it has one or more properties | ||
if (!getIndexInfoOfType(source, stringType) && !getPropertiesOfType(source).length) { | ||
return undefined; | ||
} | ||
// For arrays and tuples we infer new arrays and tuples where the reverse mapping has been | ||
// applied to the element type(s). | ||
if (isArrayType(source)) { | ||
return createArrayType(inferReverseMappedType(getTypeArguments(source)[0], target, constraint), isReadonlyArrayType(source)); | ||
return createArrayType(inferReverseMappedType(getTypeArguments(source)[0], target, constraint, /*sourceValueDeclaration*/ undefined), isReadonlyArrayType(source)); | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not fond of the cast to I'm not sure what's the codebase policy around stuff like that so if you have any suggestions on how this should be done here I'm all ears There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you're looking for Debug.assertNode? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the tip, I pushed out a change to use it |
||
if (isTupleType(source)) { | ||
const elementTypes = map(getElementTypes(source), t => inferReverseMappedType(t, target, constraint)); | ||
const elementTypes = map(getElementTypes(source), t => inferReverseMappedType(t, target, constraint, /*sourceValueDeclaration*/ undefined)); | ||
const elementFlags = getMappedTypeModifiers(target) & MappedTypeModifiers.IncludeOptional ? | ||
sameMap(source.target.elementFlags, f => f & ElementFlags.Optional ? ElementFlags.Required : f) : | ||
source.target.elementFlags; | ||
|
@@ -24146,16 +24137,31 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker { | |
function getTypeOfReverseMappedSymbol(symbol: ReverseMappedSymbol) { | ||
const links = getSymbolLinks(symbol); | ||
if (!links.type) { | ||
links.type = inferReverseMappedType(symbol.links.propertyType, symbol.links.mappedType, symbol.links.constraintType); | ||
links.type = inferReverseMappedType(symbol.links.propertyType, symbol.links.mappedType, symbol.links.constraintType, symbol.valueDeclaration); | ||
} | ||
return links.type; | ||
} | ||
|
||
function inferReverseMappedType(sourceType: Type, target: MappedType, constraint: IndexType): Type { | ||
function inferReverseMappedType(sourceType: Type, target: MappedType, constraint: IndexType, sourceValueDeclaration: Declaration | undefined): Type { | ||
const typeParameter = getIndexedAccessType(constraint.type, getTypeParameterFromMappedType(target)) as TypeParameter; | ||
const templateType = getTemplateTypeFromMappedType(target); | ||
const inference = createInferenceInfo(typeParameter); | ||
inferTypes([inference], sourceType, templateType); | ||
if (sourceValueDeclaration && getObjectFlags(sourceType) & (ObjectFlags.FreshLiteral | ObjectFlags.ArrayLiteral)) { | ||
const initializerDeclaration = sourceValueDeclaration.kind === SyntaxKind.PropertyAssignment ? | ||
(sourceValueDeclaration as PropertyAssignment).initializer : | ||
sourceValueDeclaration; | ||
const intraExpressionInferenceSites = getInferenceContext(initializerDeclaration)?.intraExpressionInferenceSites?.filter(site => isNodeDescendantOf(site.node, initializerDeclaration)); | ||
if (intraExpressionInferenceSites?.length) { | ||
const templateType = (getApparentTypeOfContextualType(initializerDeclaration.parent.parent as Expression, ContextFlags.NoConstraints) as MappedType).templateType; | ||
if (templateType) { | ||
Debug.assertNode(initializerDeclaration, isExpressionNode); | ||
pushContextualType(initializerDeclaration as any as Expression, templateType, /*isCache*/ false); | ||
inferFromIntraExpressionSites([inference], intraExpressionInferenceSites); | ||
popContextualType(); | ||
} | ||
} | ||
} | ||
return getTypeFromInference(inference) || unknownType; | ||
} | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7539,13 +7539,14 @@ export function getCheckFlags(symbol: Symbol): CheckFlags { | |
|
||
/** @internal */ | ||
export function getDeclarationModifierFlagsFromSymbol(s: Symbol, isWrite = false): ModifierFlags { | ||
if (s.valueDeclaration) { | ||
const checkFlags = getCheckFlags(s); | ||
if (!(checkFlags & CheckFlags.ReverseMapped) && s.valueDeclaration) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since I added There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Basically, this change just maintains compatibility with the old behavior as |
||
const declaration = (isWrite && s.declarations && find(s.declarations, isSetAccessorDeclaration)) | ||
|| (s.flags & SymbolFlags.GetAccessor && find(s.declarations, isGetAccessorDeclaration)) || s.valueDeclaration; | ||
const flags = getCombinedModifierFlags(declaration); | ||
return s.parent && s.parent.flags & SymbolFlags.Class ? flags : flags & ~ModifierFlags.AccessibilityModifier; | ||
} | ||
if (getCheckFlags(s) & CheckFlags.Synthetic) { | ||
if (checkFlags & CheckFlags.Synthetic) { | ||
// NOTE: potentially unchecked cast to TransientSymbol | ||
const checkFlags = (s as TransientSymbol).links.checkFlags; | ||
const accessModifier = checkFlags & CheckFlags.ContainsPrivate ? ModifierFlags.Private : | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
intraExpressionInferencesReverseMappedTypes.ts(67,21): error TS18046: 'x' is of type 'unknown'. | ||
intraExpressionInferencesReverseMappedTypes.ts(71,21): error TS18046: 'x' is of type 'unknown'. | ||
intraExpressionInferencesReverseMappedTypes.ts(80,21): error TS18046: 'x' is of type 'unknown'. | ||
intraExpressionInferencesReverseMappedTypes.ts(86,21): error TS18046: 'x' is of type 'unknown'. | ||
intraExpressionInferencesReverseMappedTypes.ts(95,21): error TS18046: 'x' is of type 'unknown'. | ||
intraExpressionInferencesReverseMappedTypes.ts(101,21): error TS18046: 'x' is of type 'unknown'. | ||
|
||
|
||
==== intraExpressionInferencesReverseMappedTypes.ts (6 errors) ==== | ||
// repro cases based on https://github.com/microsoft/TypeScript/issues/53018 | ||
|
||
declare function f<T>( | ||
arg: { | ||
[K in keyof T]: { | ||
produce: (n: string) => T[K]; | ||
consume: (x: T[K]) => void; | ||
}; | ||
} | ||
): T; | ||
|
||
const res1 = f({ | ||
a: { | ||
produce: (n) => n, | ||
consume: (x) => x.toLowerCase(), | ||
}, | ||
b: { | ||
produce: (n) => ({ v: n }), | ||
consume: (x) => x.v.toLowerCase(), | ||
}, | ||
}); | ||
|
||
const res2 = f({ | ||
a: { | ||
produce: function () { | ||
return "hello"; | ||
}, | ||
consume: (x) => x.toLowerCase(), | ||
}, | ||
b: { | ||
produce: function () { | ||
return { v: "hello" }; | ||
}, | ||
consume: (x) => x.v.toLowerCase(), | ||
}, | ||
}); | ||
|
||
const res3 = f({ | ||
a: { | ||
produce() { | ||
return "hello"; | ||
}, | ||
consume: (x) => x.toLowerCase(), | ||
}, | ||
b: { | ||
produce() { | ||
return { v: "hello" }; | ||
}, | ||
consume: (x) => x.v.toLowerCase(), | ||
}, | ||
}); | ||
|
||
declare function f2<T extends unknown[]>( | ||
arg: [ | ||
...{ | ||
[K in keyof T]: { | ||
produce: (n: string) => T[K]; | ||
consume: (x: T[K]) => void; | ||
}; | ||
} | ||
] | ||
): T; | ||
|
||
const res4 = f2([ | ||
{ | ||
produce: (n) => n, | ||
consume: (x) => x.toLowerCase(), | ||
~ | ||
!!! error TS18046: 'x' is of type 'unknown'. | ||
}, | ||
{ | ||
produce: (n) => ({ v: n }), | ||
consume: (x) => x.v.toLowerCase(), | ||
~ | ||
!!! error TS18046: 'x' is of type 'unknown'. | ||
}, | ||
]); | ||
|
||
const res5 = f2([ | ||
{ | ||
produce: function () { | ||
return "hello"; | ||
}, | ||
consume: (x) => x.toLowerCase(), | ||
~ | ||
!!! error TS18046: 'x' is of type 'unknown'. | ||
}, | ||
{ | ||
produce: function () { | ||
return { v: "hello" }; | ||
}, | ||
consume: (x) => x.v.toLowerCase(), | ||
~ | ||
!!! error TS18046: 'x' is of type 'unknown'. | ||
}, | ||
]); | ||
|
||
const res6 = f2([ | ||
{ | ||
produce() { | ||
return "hello"; | ||
}, | ||
consume: (x) => x.toLowerCase(), | ||
~ | ||
!!! error TS18046: 'x' is of type 'unknown'. | ||
}, | ||
{ | ||
produce() { | ||
return { v: "hello" }; | ||
}, | ||
consume: (x) => x.v.toLowerCase(), | ||
~ | ||
!!! error TS18046: 'x' is of type 'unknown'. | ||
}, | ||
]); | ||
|
||
declare function f3<T>( | ||
arg: { | ||
[K in keyof T]: { | ||
other: number, | ||
produce: (n: string) => T[K]; | ||
consume: (x: T[K]) => void; | ||
}; | ||
} | ||
): T; | ||
|
||
const res7 = f3({ | ||
a: { | ||
other: 42, | ||
produce: (n) => n, | ||
consume: (x) => x.toLowerCase(), | ||
}, | ||
b: { | ||
other: 100, | ||
produce: (n) => ({ v: n }), | ||
consume: (x) => x.v.toLowerCase(), | ||
}, | ||
}); | ||
|
||
declare function f4<T>( | ||
arg: { | ||
[K in keyof T]: [ | ||
(n: string) => T[K], | ||
(x: T[K]) => void | ||
]; | ||
} | ||
): T; | ||
|
||
const res8 = f4({ | ||
a: [ | ||
(n) => n, | ||
(x) => x.toLowerCase(), | ||
], | ||
b: [ | ||
(n) => ({ v: n }), | ||
(x) => x.v.toLowerCase(), | ||
], | ||
}); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
.filter
here is unfortunate but my current goal is to make it correct and only after that I can try to make it fast 😉The goal here is to only try to infer from the intra expression inference sites relevant for this specific reverse mapped symbol. Perhaps the simplest and good enough solution would be to get an appropriate trailing slice of all
intraExpressionInferenceSites
.They are "aggregated" throughout the call to
checkExpressionWithContextualType
so when encountering a first context sensitive function it's a single-element array and when encountering a second one it's a two-element array and so on.inferFromIntraExpressionSites
happens while pushing items intointraExpressionInferenceSites
so that's why the producer has to always come first before the consumer (TS playground):And thus, by extension... if we'd look for "relevant" nodes from the end we could slice the trailing elements until we meet one that is not relevant. Because intra intra expression inference sites are dependent on source order this should work just fine as it should be guaranteed that by using such a trailing slice we use all current "relevant" nodes and nothing else
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But doesn't this all just imply we should store intra-expression inference sites in a per-property map or something?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do u mean properties of the reverse mapped type? IIRC we might not know if a property is going to end up as property of such - or I don't know how to check that. So I don't know how to aggregate such a structure since I don't know when it should be created in the first place.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since I opened this PR I got a way better understanding of how the whole intra-expression inference works. What is in this PR right now isn't ideal on the high level of things since it comes with a perf penalty cost. I'm trying to figure out how to best store those sites to accommodate the needs of this change and I'm hitting the wall.
Some things to understand about this inference type:
a
even though we already inferred froma.b
and there is no mechanism to "skip over" this slice of the object. So I didn't end up pursuing this optimization as it seems that it's only a partial one.main
is that those intra-expression inference sites are cleared before the reverse mapped type has a chance to infer from it.So I'm looking for some way to store/read/clear those sites without hitting any of the mentioned drawbacks and for two different/similar-ush purposes but I can't figure this out so far. cc @jakebailey