Skip to content

Filtering mapped types declarations #51650

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

Merged
merged 7 commits into from
Feb 16, 2023
Merged

Filtering mapped types declarations #51650

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6791d39
Add declarations to filtering mapped types
Andarist Nov 26, 2022
fde7b0a
update baselines
Andarist Nov 26, 2022
7741604
Update tests/cases/fourslash/goToDefinition_filteringMappedType.ts
Andarist Nov 27, 2022
a1e5700
Add find all references test
Andarist Dec 6, 2022
93f65ac
Merge remote-tracking branch 'origin/main' into filtering-mapped-type…
Andarist Dec 26, 2022
bf58389
Merge remote-tracking branch 'origin/main' into filtering-mapped-type…
Andarist Jan 16, 2023
19e340b
Merge remote-tracking branch 'origin/main' into filtering-mapped-type…
Andarist Feb 13, 2023
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
5 changes: 2 additions & 3 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12881,6 +12881,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
const typeParameter = getTypeParameterFromMappedType(type);
const constraintType = getConstraintTypeFromMappedType(type);
const nameType = getNameTypeFromMappedType(type.target as MappedType || type);
const isFilteringMappedType = nameType && isTypeAssignableTo(nameType, typeParameter);
Copy link
Member

@sandersn sandersn Dec 5, 2022

Choose a reason for hiding this comment

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

This seems like more work than the rest of the function does, so I'm worried about performance problems on mapped types with a nameType. I'll run the perf tests, but I don't know that any such mapped types are in there. @weswigham do you have an idea if this isTypeAssignableTo call is likely to be (relatively) slow here?

Copy link
Contributor Author

@Andarist Andarist Dec 5, 2022

Choose a reason for hiding this comment

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

Note that it's the same check that got used here:
https://github.com/microsoft/TypeScript/pull/48699/files#diff-d9ab6589e714c71e657f601cf30ff51dfc607fc98419bf72e04f6b0fa92cc4b8R15745

That said - that other PR calls this just from within getSimplifiedIndexedAccessType and this is in the resolveMappedTypeMembers so the impact on the perf could still be different as it depends on how frequent are calls to those caller functions

const templateType = getTemplateTypeFromMappedType(type.target as MappedType || type);
const modifiersType = getApparentType(getModifiersTypeFromMappedType(type)); // The 'T' in 'keyof T'
const templateModifiers = getMappedTypeModifiers(type);
Expand Down Expand Up @@ -12927,9 +12928,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
prop.keyType = keyType;
if (modifiersProp) {
prop.syntheticOrigin = modifiersProp;
// If the mapped type has an `as XXX` clause, the property name likely won't match the declaration name and
// multiple properties may map to the same name. Thus, we attach no declarations to the symbol.
prop.declarations = nameType ? undefined : modifiersProp.declarations;
prop.declarations = !nameType || isFilteringMappedType ? modifiersProp.declarations : undefined;
}
members.set(propName, prop);
}
Expand Down
284 changes: 284 additions & 0 deletions tests/baselines/reference/findAllReferencesFilteringMappedTypeProperty.baseline.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
// === /tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts ===
// const obj = { /*FIND ALL REFS*/[|a|]: 1, b: 2 };
// const filtered: { [P in keyof typeof obj as P extends 'b' ? never : P]: 0; } = { [|a|]: 0 };
// filtered.[|a|];

[
{
"definition": {
"containerKind": "",
"containerName": "",
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"kind": "property",
"name": "(property) a: number",
"textSpan": {
"start": 14,
"length": 1
},
"displayParts": [
{
"text": "(",
"kind": "punctuation"
},
{
"text": "property",
"kind": "text"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "a",
"kind": "propertyName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
}
],
"contextSpan": {
"start": 14,
"length": 4
}
},
"references": [
{
"textSpan": {
"start": 14,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"contextSpan": {
"start": 14,
"length": 4
},
"isWriteAccess": true,
"isDefinition": true
},
{
"textSpan": {
"start": 109,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"contextSpan": {
"start": 109,
"length": 4
},
"isWriteAccess": true,
"isDefinition": false
},
{
"textSpan": {
"start": 126,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"isWriteAccess": false,
"isDefinition": false
}
]
}
]

// === /tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts ===
// const obj = { [|a|]: 1, b: 2 };
// const filtered: { [P in keyof typeof obj as P extends 'b' ? never : P]: 0; } = { /*FIND ALL REFS*/[|a|]: 0 };
// filtered.[|a|];

[
{
"definition": {
"containerKind": "",
"containerName": "",
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"kind": "property",
"name": "(property) a: number",
"textSpan": {
"start": 14,
"length": 1
},
"displayParts": [
{
"text": "(",
"kind": "punctuation"
},
{
"text": "property",
"kind": "text"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "a",
"kind": "propertyName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
}
],
"contextSpan": {
"start": 14,
"length": 4
}
},
"references": [
{
"textSpan": {
"start": 14,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"contextSpan": {
"start": 14,
"length": 4
},
"isWriteAccess": true,
"isDefinition": false
},
{
"textSpan": {
"start": 109,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"contextSpan": {
"start": 109,
"length": 4
},
"isWriteAccess": true,
"isDefinition": true
},
{
"textSpan": {
"start": 126,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"isWriteAccess": false,
"isDefinition": false
}
]
}
]

// === /tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts ===
// const obj = { [|a|]: 1, b: 2 };
// const filtered: { [P in keyof typeof obj as P extends 'b' ? never : P]: 0; } = { [|a|]: 0 };
// filtered./*FIND ALL REFS*/[|a|];

[
{
"definition": {
"containerKind": "",
"containerName": "",
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"kind": "property",
"name": "(property) a: number",
"textSpan": {
"start": 14,
"length": 1
},
"displayParts": [
{
"text": "(",
"kind": "punctuation"
},
{
"text": "property",
"kind": "text"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "a",
"kind": "propertyName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
}
],
"contextSpan": {
"start": 14,
"length": 4
}
},
"references": [
{
"textSpan": {
"start": 14,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"contextSpan": {
"start": 14,
"length": 4
},
"isWriteAccess": true
},
{
"textSpan": {
"start": 109,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"contextSpan": {
"start": 109,
"length": 4
},
"isWriteAccess": true
},
{
"textSpan": {
"start": 126,
"length": 1
},
"fileName": "/tests/cases/fourslash/findAllReferencesFilteringMappedTypeProperty.ts",
"isWriteAccess": false
}
]
}
]
Loading