Allow intersections to be used as valid types for template literal placeholders#54188
Merged
gabritto merged 3 commits intomicrosoft:mainfrom Aug 10, 2023
Conversation
Member
|
Couple of things:
|
sandersn
added
the
For Uncommitted Bug
…valid-types-for-template-literal-placeholders # Conflicts: # tests/baselines/reference/templateLiteralTypesPatterns.errors.txt
Contributor
Author
done
Reading through some of the recent design notes (here)... it's still unclear if/when/how the team is going to pick up this. This PR though doesn't introduce a lot of extra support for those "special intersections" - it fixes assignability issues when they are involved. This is a clear bug from the assignability PoV: function conversionTest(groupName: | "downcast" | "dataDowncast" | "editingDowncast" | `${string & {}}Downcast`) {}
conversionTest("testDowncast"); // error but should be OKSome other cases are improved with it as well, like this one: function foo(str: `${`a${string}` & `${string}a`}Test`) {}
foo("abaTest"); // error but should be OK |
Andarist
force-pushed
the
fix/intersections-as-valid-types-for-template-literal-placeholders
branch
from
0a12f3e to
f5f1403
Compare
This comment was marked as duplicate.
This comment was marked as duplicate.
Member
|
@typescript-bot test this |
Collaborator
|
Heya @gabritto, I've started to run the diff-based top-repos suite (tsserver) on this PR at f5f1403. You can monitor the build here. Update: The results are in! |
Collaborator
Collaborator
|
Heya @gabritto, I've started to run the diff-based user code test suite (tsserver) on this PR at f5f1403. You can monitor the build here. Update: The results are in! |
Collaborator
|
Heya @gabritto, I've started to run the perf test suite on this PR at f5f1403. You can monitor the build here. Update: The results are in! |
Collaborator
|
Heya @gabritto, I've started to run the parallelized Definitely Typed test suite on this PR at f5f1403. You can monitor the build here. Update: The results are in! |
Collaborator
|
Heya @gabritto, I've started to run the diff-based top-repos suite on this PR at f5f1403. You can monitor the build here. Update: The results are in! |
Collaborator
|
Heya @gabritto, I've started to run the diff-based user code test suite on this PR at f5f1403. You can monitor the build here. Update: The results are in! |
Member
|
@typescript-bot pack this |
Collaborator
Collaborator
|
Hey @gabritto, I've packed this into an installable tgz. You can install it for testing by referencing it in your and then running There is also a playground for this build and an npm module you can use via |
Collaborator
|
@gabritto Here are the results of running the user test suite comparing Everything looks good! |
Collaborator
|
@gabritto Here are the results of running the user test suite comparing There were infrastructure failures potentially unrelated to your change:
Otherwise... Something interesting changed - please have a look. Details
|
gabritto
reviewed
Aug 2, 2023
| return true; | ||
| } | ||
| if (target.flags & TypeFlags.Intersection) { | ||
| return every((target as IntersectionType).types, t => t === emptyTypeLiteralType || isValidTypeForTemplateLiteralPlaceholder(source, t)); |
Member
There was a problem hiding this comment.
Why do we need to have t === emptyTypeLiteralType here? Couldn't source not be assignable to {}?
Contributor
Author
There was a problem hiding this comment.
emptyTypeLiteralType isn't a valid type for a template literal placeholder. Without this, we run into problems with what this PR is fixing:
test failures
diff --git a/tests/baselines/reference/templateLiteralTypesPatterns.errors.txt b/tests/baselines/reference/templateLiteralTypesPatterns.errors.txt
index cd82afc839..7bd15a6f82 100644
--- a/tests/baselines/reference/templateLiteralTypesPatterns.errors.txt
+++ b/tests/baselines/reference/templateLiteralTypesPatterns.errors.txt
@@ -55,10 +55,12 @@ templateLiteralTypesPatterns.ts(129,9): error TS2345: Argument of type '"1.1e-10
templateLiteralTypesPatterns.ts(140,1): error TS2322: Type '`a${string}`' is not assignable to type '`a${number}`'.
templateLiteralTypesPatterns.ts(141,1): error TS2322: Type '"bno"' is not assignable to type '`a${any}`'.
templateLiteralTypesPatterns.ts(160,7): error TS2322: Type '"anything"' is not assignable to type '`${number} ${number}`'.
+templateLiteralTypesPatterns.ts(205,16): error TS2345: Argument of type '"testDowncast"' is not assignable to parameter of type '`${string & {}}Downcast` | "downcast" | "dataDowncast" | "editingDowncast"'.
+templateLiteralTypesPatterns.ts(207,17): error TS2345: Argument of type '"testDowncast"' is not assignable to parameter of type '"downcast" | "dataDowncast" | "editingDowncast" | `${{} & string}Downcast`'.
templateLiteralTypesPatterns.ts(211,5): error TS2345: Argument of type '"abcTest"' is not assignable to parameter of type '`${`a${string}` & `${string}a`}Test`'.
-==== templateLiteralTypesPatterns.ts (58 errors) ====
+==== templateLiteralTypesPatterns.ts (60 errors) ====
type RequiresLeadingSlash = `/${string}`;
// ok
@@ -378,8 +380,12 @@ templateLiteralTypesPatterns.ts(211,5): error TS2345: Argument of type '"abcTest
// repro from https://github.com/microsoft/TypeScript/issues/54177#issuecomment-1538436654
function conversionTest(groupName: | "downcast" | "dataDowncast" | "editingDowncast" | `${string & {}}Downcast`) {}
conversionTest("testDowncast");
+ ~~~~~~~~~~~~~~
+!!! error TS2345: Argument of type '"testDowncast"' is not assignable to parameter of type '`${string & {}}Downcast` | "downcast" | "dataDowncast" | "editingDowncast"'.
function conversionTest2(groupName: | "downcast" | "dataDowncast" | "editingDowncast" | `${{} & string}Downcast`) {}
conversionTest2("testDowncast");
+ ~~~~~~~~~~~~~~
+!!! error TS2345: Argument of type '"testDowncast"' is not assignable to parameter of type '"downcast" | "dataDowncast" | "editingDowncast" | `${{} & string}Downcast`'.
function foo(str: `${`a${string}` & `${string}a`}Test`) {}
foo("abaTest"); // okThis was really meant to be a "faster"/more concise version of:
if (target.flags & TypeFlags.Intersection) {
if (areIntersectedTypesAvoidingPrimitiveReduction((target as IntersectionType).types)) {
const primitive = (target as IntersectionType).types[0] === emptyTypeLiteralType ? (target as IntersectionType).types[1] : (target as IntersectionType).types[0];
return isValidTypeForTemplateLiteralPlaceholder(source, primitive);
}
return every((target as IntersectionType).types, t => isValidTypeForTemplateLiteralPlaceholder(source, t));
}Couldn't source not be assignable to {}?
This is a good question. I've tried to end up with such a source and I couldn't figure out a way to hit this. The whole existing test suite also doesn't hit such a case. I won't swear that it's impossible though so maybe it's better to use this alternative version that I posted above?
Member
There was a problem hiding this comment.
Ok, I looked at the code some more and I think this is actually ok (but like you said, I can't prove it's impossible).
Collaborator
|
@gabritto Here they are:
CompilerComparison Report - main..54188
System
Hosts
Scenarios
TSServerComparison Report - main..54188
System
Hosts
Scenarios
StartupComparison Report - main..54188
System
Hosts
Scenarios
Developer Information: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Collaborator
|
@gabritto Here are the results of running the top-repos suite comparing Everything looks good! |
Collaborator
|
@gabritto Here are the results of running the top-repos suite comparing Something interesting changed - please have a look. DetailsServer exited prematurely with code unknown and signal SIGABRTAffected reposcalcom/cal.comRaw error text:RepoResults4/calcom.cal.com.rawError.txt in the artifact folder
Last few requests{"seq":864,"type":"request","command":"updateOpen","arguments":{"changedFiles":[],"closedFiles":[],"openFiles":[{"file":"@PROJECT_ROOT@/apps/swagger/pages/_app.tsx","projectRootPath":"@PROJECT_ROOT@"}]}}
{"seq":865,"type":"request","command":"getOutliningSpans","arguments":{"file":"@PROJECT_ROOT@/apps/swagger/pages/_app.tsx"}}
{"seq":866,"type":"request","command":"updateOpen","arguments":{"changedFiles":[],"closedFiles":["@PROJECT_ROOT@/apps/storybook/components/Title.tsx"],"openFiles":[]}}
{"seq":867,"type":"request","command":"updateOpen","arguments":{"changedFiles":[],"closedFiles":[],"openFiles":[{"file":"@PROJECT_ROOT@/apps/web/components/apps/App.tsx","projectRootPath":"@PROJECT_ROOT@"}]}}
Repro steps
|
Collaborator
|
Hey @gabritto, the results of running the DT tests are ready. |
Member
|
It looks like this PR caused an out of memory error on a repo: #54188 (comment) |
Contributor
Author
|
@gabritto I'm not sure if this failure is related to this PR. I can repro it but I can repro it using the build from |
Member
|
@typescript-bot test tsserver top100 |
Collaborator
|
Heya @gabritto, I've started to run the diff-based top-repos suite (tsserver) on this PR at f5f1403. You can monitor the build here. Update: The results are in! |
Contributor
Author
I might have misinterpreted the results in the rush. I can't repro this with either build (from this PR and from the main). Now I'm interested if the CI job will be able to repro it again 😅 |
Collaborator
|
@gabritto Here are the results of running the top-repos suite comparing Everything looks good! |
Member
|
Seems like CI is fine now? I think this looks good for 5.3. |
gabritto
approved these changes
Aug 4, 2023
This was referenced Nov 15, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #54177 (comment)