microsoft / microsoft/TypeScript
Assertion methods (`asserts this is`) are not CFA'd without error
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 4.0.5, 4.1.0-beta, 4.2.0-dev.20201112
Search Terms:
- Multiple assertion methods
- "asserts this is"
- assertion "cfa"
Code
class X<T, Locked extends boolean> {
public x: null | T | (Locked extends true ? 1 : 2) = null
public assert<U>(): asserts this is X<U, Locked> { }
public lock(): asserts this is X<T, true> {}
}
const x: X<string | number, false> = new X<string | number, false>()
x.assert<string>()
// x is X<string, false> here
x.lock()
Expected behavior:
Either:
- After
x.lock(),xis narrowed toX<string, true> - Or, the
x.lock()line throws at compile-time due to not being CFA'd
Actual behavior:
After x.lock(), x is narrowed to X<string, false> & X<string | number, true>.
Analysis:
x being typed as X<string, false> & X<string | number, true> shows that the x.lock() narrows from the original type (X<string | number, false>) instead of the narrowed type at that position (X<string, false>).
If instead a "top-level" assertion function is used the type is properly narrowed:
class X<T, Locked extends boolean> {
public x: null | T | (Locked extends true ? 1 : 2) = null
public assert<U>(): asserts this is X<U, Locked> { }
public lock(): asserts this is X<T, true> {}
}
const x: X<string | number, false> = new X<string | number, false>()
x.assert<string>()
// x is X<string, false> here
declare function lock<T>(v: X<T, boolean>): asserts v is X<T, true>
lock(x)
This leads me to believe this is an issue with the x.lock() call not being CFA'd, in which case the correct behavior would be to throw ts(2775) on the x.lock() line.
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
Start by running the supplied TypeScript Playground reproduction and compare the control-flow narrowing after x.assert<string>() and x.lock(). Investigate the compiler's handling of asserts this is methods and the reported intersection type. Done means the second assertion either narrows to X<string, true> or reports the expected compile-time error, with regression coverage for the example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100