-
Notifications
You must be signed in to change notification settings - Fork 13.5k
Adjust TypeFact calculation for intersections to omit negative typeof facts when an equivalent positive fact is present #39016
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
Changes from 3 commits
20b6302
109a3f0
269f5ba
3de676e
161dda3
5369921
5425753
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 |
|---|---|---|
|
|
@@ -73,7 +73,7 @@ namespace ts { | |
| TypeofNEString = 1 << 8, // typeof x !== "string" | ||
| TypeofNENumber = 1 << 9, // typeof x !== "number" | ||
| TypeofNEBigInt = 1 << 10, // typeof x !== "bigint" | ||
| TypeofNEBoolean = 1 << 11, // typeof x !== "boolean" | ||
| TypeofNEBoolean = 1 << 11, // typeof x !== "boolean" | ||
| TypeofNESymbol = 1 << 12, // typeof x !== "symbol" | ||
| TypeofNEObject = 1 << 13, // typeof x !== "object" | ||
| TypeofNEFunction = 1 << 14, // typeof x !== "function" | ||
|
|
@@ -90,6 +90,7 @@ namespace ts { | |
| // The following members encode facts about particular kinds of types for use in the getTypeFacts function. | ||
| // The presence of a particular fact means that the given test is true for some (and possibly all) values | ||
| // of that kind of type. | ||
| NegativeTypeofFacts = TypeofNEString | TypeofNENumber | TypeofNEBigInt | TypeofNEBoolean | TypeofNESymbol | TypeofNEObject | TypeofNEFunction | TypeofNEHostObject, | ||
| BaseStringStrictFacts = TypeofEQString | TypeofNENumber | TypeofNEBigInt | TypeofNEBoolean | TypeofNESymbol | TypeofNEObject | TypeofNEFunction | TypeofNEHostObject | NEUndefined | NENull | NEUndefinedOrNull, | ||
| BaseStringFacts = BaseStringStrictFacts | EQUndefined | EQNull | EQUndefinedOrNull | Falsy, | ||
| StringStrictFacts = BaseStringStrictFacts | Truthy | Falsy, | ||
|
|
@@ -19701,11 +19702,18 @@ namespace ts { | |
| return declaredType; | ||
| } | ||
|
|
||
| function getTypeFactsOfTypes(types: Type[]): TypeFacts { | ||
| function getTypeFactsOfTypes(types: Type[], isUnion: boolean): TypeFacts { | ||
| let result: TypeFacts = TypeFacts.None; | ||
| for (const t of types) { | ||
| result |= getTypeFacts(t); | ||
| } | ||
| if (!isUnion) { | ||
| // Get the set of positive facts for the intersection by masking with the negative set shifted left, | ||
| // then shift those present positive facts into the negative fact value range, and unset any of those | ||
| // bits (by negating that mask and then intersecting it with the original value) | ||
| const positiveFacts = result & (TypeFacts.NegativeTypeofFacts >> 8); | ||
|
Member
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. It seems like the test coverage here is not adequate to ensure that this math continues to work for all cases in the future. Let's have a testcase that makes sure that e.g. someone reordering the EQ members without also pairwise reordering the NE members sees a baseline diff.
Contributor
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 quite sure how to make a baseline for that, but a unittest can be made if the describe("getTypeFactsOfTypes", () => {
// See: https://github.com/microsoft/TypeScript/pull/39016
it("correctly can strip NegativeTypeofFacts when there are PositiveTypeofFacts of the same type via bitmask logic", () => {
const TypeFacts = (ts as any).TypeFacts;
// For a set of facts, which include both the positive and negative of each other
let ExampleFacts = TypeFacts.TypeofEQNumber | TypeFacts.TypeofNENumber | TypeFacts.TypeofNEBigInt;
// Using this line of code (with the 8 which effectively represents the number of EQ types)
const positiveFacts = ExampleFacts & (TypeFacts.NegativeTypeofFacts >> 8);
// Then this should drop the negative version of the same type
ExampleFacts &= ~(positiveFacts << 8);
assert.isTrue((ExampleFacts & TypeFacts.TypeofNENumber) === 0);
// And it keeps the rest
assert.isTrue((ExampleFacts & TypeFacts.TypeofEQNumber) !== 0);
assert.isTrue((ExampleFacts & TypeFacts.TypeofNEBigInt) !== 0);
// If this test has failed, you _probably_ need to adjust the 8 here, and in
// getTypeFactsOfTypes.
});
});``` |
||
| result &= ~(positiveFacts << 8); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
|
|
@@ -19780,7 +19788,7 @@ namespace ts { | |
| return getTypeFacts(getBaseConstraintOfType(type) || unknownType); | ||
| } | ||
| if (flags & TypeFlags.UnionOrIntersection) { | ||
| return getTypeFactsOfTypes((<UnionOrIntersectionType>type).types); | ||
| return getTypeFactsOfTypes((<UnionOrIntersectionType>type).types, !!(flags & TypeFlags.Union)); | ||
| } | ||
| return TypeFacts.All; | ||
| } | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| //// [controlFlowTypeofFunctionElseNarrowing.ts] | ||
| // regression for https://github.com/microsoft/TypeScript/issues/32928 | ||
| // Callable | ||
| type F = (...args: any[]) => any; | ||
| // Callable but intersected | ||
| type F2 = F & { inject?: string[] } | ||
|
|
||
| declare const a: string | F2 | ||
|
|
||
| if (typeof a == 'function') { | ||
| // only F2 | ||
| a | ||
| } else { | ||
| // Should be only a string | ||
| a | ||
| } | ||
|
|
||
| //// [controlFlowTypeofFunctionElseNarrowing.js] | ||
| if (typeof a == 'function') { | ||
| // only F2 | ||
| a; | ||
| } | ||
| else { | ||
| // Should be only a string | ||
| a; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| === tests/cases/conformance/controlFlow/controlFlowTypeofFunctionElseNarrowing.ts === | ||
| // regression for https://github.com/microsoft/TypeScript/issues/32928 | ||
| // Callable | ||
| type F = (...args: any[]) => any; | ||
| >F : Symbol(F, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 0, 0)) | ||
| >args : Symbol(args, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 2, 10)) | ||
|
|
||
| // Callable but intersected | ||
| type F2 = F & { inject?: string[] } | ||
| >F2 : Symbol(F2, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 2, 33)) | ||
| >F : Symbol(F, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 0, 0)) | ||
| >inject : Symbol(inject, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 4, 15)) | ||
|
|
||
| declare const a: string | F2 | ||
| >a : Symbol(a, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 6, 13)) | ||
| >F2 : Symbol(F2, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 2, 33)) | ||
|
|
||
| if (typeof a == 'function') { | ||
| >a : Symbol(a, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 6, 13)) | ||
|
|
||
| // only F2 | ||
| a | ||
| >a : Symbol(a, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 6, 13)) | ||
|
|
||
| } else { | ||
| // Should be only a string | ||
| a | ||
| >a : Symbol(a, Decl(controlFlowTypeofFunctionElseNarrowing.ts, 6, 13)) | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| === tests/cases/conformance/controlFlow/controlFlowTypeofFunctionElseNarrowing.ts === | ||
| // regression for https://github.com/microsoft/TypeScript/issues/32928 | ||
| // Callable | ||
| type F = (...args: any[]) => any; | ||
| >F : F | ||
| >args : any[] | ||
|
|
||
| // Callable but intersected | ||
| type F2 = F & { inject?: string[] } | ||
| >F2 : F2 | ||
| >inject : string[] | ||
|
|
||
| declare const a: string | F2 | ||
| >a : string | F2 | ||
|
|
||
| if (typeof a == 'function') { | ||
| >typeof a == 'function' : boolean | ||
| >typeof a : "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | ||
| >a : string | F2 | ||
| >'function' : "function" | ||
|
|
||
| // only F2 | ||
| a | ||
| >a : F2 | ||
|
|
||
| } else { | ||
| // Should be only a string | ||
| a | ||
| >a : string | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| // regression for https://github.com/microsoft/TypeScript/issues/32928 | ||
| // Callable | ||
| type F = (...args: any[]) => any; | ||
| // Callable but intersected | ||
| type F2 = F & { inject?: string[] } | ||
|
|
||
| declare const a: string | F2 | ||
|
|
||
| if (typeof a == 'function') { | ||
| // only F2 | ||
| a | ||
| } else { | ||
| // Should be only a string | ||
| a | ||
| } |
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.
NegativeTypeofFacts is only ever used to left-shift 8 bits. It would be easier to read if it were just PositiveTypeofFacts, which would need shifting