Add TReturn/TNext to Iterable et al #58243
Open
Conversation
This file contains 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
typescript-bot
added
Author: Team
For Uncommitted Bug
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
@jakebailey, @weswigham: Am I missing something? The bot says there were interesting changes but it links to a clean pipeline result. |
|
@typescript-bot: pack this |
|
Hey @rbuckton, 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 |
weswigham
reviewed
Apr 30, 2024
src/lib/dom.iterable.d.ts
Outdated
| @@ -1,30 +1,30 @@ | |||
| /// <reference lib="dom" /> | |||
|
|
|||
| interface DOMTokenList { | |||
| [Symbol.iterator](): IterableIterator<string>; | |||
| [Symbol.iterator](): IterableIterator<string, void>; | |||
There was a problem hiding this comment.
Presumably this change is going to be reflected in the dom lib generator, too?
There was a problem hiding this comment.
This file isn't one of the generated ones, actually, so I don't think the generator has to change unless one of the *.generated.*.d.ts files are edited.
There was a problem hiding this comment.
Yes, I plan to do that as well.
There was a problem hiding this comment.
The generator will need to change so that we have the correct types on any DOM collections produced by the generator.
There was a problem hiding this comment.
That ends up being a bit tricky if we're also shipping DOM types in a standalone package since older TS wouldn't support TReturn and TNext.
There was a problem hiding this comment.
Presumably this change is going to be reflected in the dom lib generator, too?
| @@ -2,11 +2,12 @@ | |||
|
|
|||
| === YieldStarExpression4_es6.ts === | |||
| function *g() { | |||
| >g : () => Generator<any, void, undefined> | |||
| > : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |||
| >g : () => Generator<any, void, unknown> | |||
There was a problem hiding this comment.
Is it weird to think that it's almost better for the type for an untyped yield result to be void instead of unknown (meaning what we infer, not the default)? I guess it'd be funky seeing the void in the parameter list of the .next call, but it feels like if you wrote function foo*() { return yield val }, having foo's TReturn be void instead of unknown would be kinda nice.
I dunno, probably not terribly important.
There was a problem hiding this comment.
Having TNext default to either void ended up being an even larger breaking change.
| export const Nothing1: Strategy<State> = strategy("Nothing", function*(state: State) { | ||
| ~~~~~~~~ | ||
| !!! error TS2345: Argument of type '(state: State) => Generator<never, State, unknown>' is not assignable to parameter of type '(a: State) => IterableIterator<State, void>'. | ||
| !!! error TS2345: Call signature return types 'Generator<never, State, unknown>' and 'IterableIterator<State, void>' are incompatible. |
There was a problem hiding this comment.
Aside: We should special-case the error messages for comparing a generator/iterable/iterator - this is a really big stack just to say one of the return, next, or yield types don't match.
It only does that check for syntax. Most consumers of iterables are APIs, like In an ideal world the type for |
1 task
Renegade334
reviewed
May 1, 2024
| @@ -9,17 +9,17 @@ interface SymbolConstructor { | |||
| readonly asyncIterator: unique symbol; | |||
| } | |||
|
|
|||
| interface AsyncIterator<T, TReturn = any, TNext = undefined> { | |||
| interface AsyncIterator<T, TReturn = any, TNext = unknown> { | |||
| // NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places. | |||
| next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>; | |||
There was a problem hiding this comment.
Is it worth taking the opportunity to label the tuple element here (and in AsyncIterator/Generator) to avoid args_0 appearing in the computed function signature?
There was a problem hiding this comment.
I just looked into doing this, but it causes the number of types we produce to skyrocket in unionAndIntersectionInference3.ts, so it's probably better to leave it as is for now.
|
@typescript-bot perf test |
|
@rbuckton Here are the results of running the user tests comparing There were infrastructure failures potentially unrelated to your change:
Otherwise... Everything looks good! |
|
Hey @rbuckton, the results of running the DT tests are ready. There were interesting changes: Branch only errors:Package: string.prototype.matchall Package: async-iterable-stream Package: regenerator-runtime Package: es-get-iterator Package: consumable-stream/v1 Package: consumable-stream/v2 Package: consumable-stream |
|
@rbuckton Here are the results of running the user tests comparing Something interesting changed - please have a look. Details
|
|
@rbuckton Here they are:
tscComparison Report - baseline..pr
System info unknown
Hosts
Scenarios
tsserverComparison Report - baseline..pr
System info unknown
Hosts
Scenarios
startupComparison Report - baseline..pr
System info unknown
Hosts
Scenarios
Developer Information: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
@rbuckton Here are the results of running the top 400 repos comparing Something interesting changed - please have a look. Details
|
Renegade334
reviewed
May 7, 2024
|
@typescript-bot: pack this |
|
Hey @rbuckton, 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 |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We avoided making this change in the past as it was very breaky, but at some point we need to address this discrepancy. Having incorrect types here is also causing problems with properly typing the Iterator Helpers proposal.
This also adds a new
BuiltinIteratorReturnintrinsic type whose actual type is determined by the state of thenoUncheckedIndexedAccesscompiler option:"noUncheckedIndexedAccess": false-any(emulates current behavior forIterableIterator)"noUncheckedIndexedAccess": true-undefinedThe new
BuiltinIteratorReturntype is passed as theTReturntype argument for built-ins usingIterableIteratororAsyncIterableIteratorto enable stricter checks against the result of callingnext()on the iterator.A follow-on PR to TypeScript-DOM-lib-generator can be found here: microsoft/TypeScript-DOM-lib-generator#1713
Fixes #33353
Fixes #52998
Fixes #43750
Supersedes #56517
Related #58222