microsoft / microsoft/TypeScript
Error span incorrect when `this` constraint on member function fails
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
🔎 Search Terms
- error span
this: never- this chain
- builder pattern
🕗 Version & Regression Information
- This is the behavior in every version I tried (including the latest 5.7.2)
⏯ Playground Link
💻 Code
/**
* Member function based case
*/
class FunctionBasedBuilder<Step extends number=1> {
step1(this: Step extends 1 ? this : never): FunctionBasedBuilder<2> {
return this as any;
}
step2(this: Step extends 2 ? this : never): FunctionBasedBuilder<3> {
return this as any;
}
// skip step 3 explicitly to demonstrate the error
step4(this: Step extends 4 ? this : never): FunctionBasedBuilder<5> {
return this as any;
}
}
/**
* Member variable based case
*/
class VariableBasedBuilder<Step extends number=1> {
step1: (Step extends 1 ? () => VariableBasedBuilder<2> : never) = (() => {
return this as any;
}) as any;
step2: (Step extends 2 ? () => VariableBasedBuilder<3> : never) = (() => {
return this as any;
}) as any;
// skip step 3 explicitly to demonstrate the error
step4: (Step extends 4 ? () => VariableBasedBuilder<5> : never) = (() => {
return this as any;
}) as any;
}
const funcBuilder = new FunctionBasedBuilder();
// all of `foo.step1().step2()` turns into an unhelpful error message
funcBuilder.step1().step2().step4();
const varBuilder = new VariableBasedBuilder();
// the error properly appears only on step 4
varBuilder.step1().step2().step4();
🙁 Actual behavior
In the function case, the entire span from foo.step1().step2() gets marked as an error instead of only step4() which is what actually caused the error
🙂 Expected behavior
Just like in the member variable case, it would be better if the error was shown on step4()
Additional information about the issue
I think this ends up being equivalent to #28159 so I'm not sure it can be solved without introducing the "curse" mentioned in #60140
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked TypeScript Playground and compare the function-based and variable-based builder cases, focusing on the diagnostic span for the final step4 call. Review the possible relationship to issues #28159 and #60140. Done means the function-based case highlights only step4(), matching the variable-based case, without regressing the reported error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 30/100