microsoft / microsoft/TypeScript

Property lookups on arguments to type parameters constrained by string index signatures can violate other constraints because undefined is included for optional properties

Offen
#63,709 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Cursed? Domain: Indexed Access Types Possible Improvement
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

### 🔎 Search Terms

index signature, indexed types, mapped types, lookup types, optional properties, generic constraints

### 🕗 Version & Regression Information

- It's only been possible to assign optional properties to string index signature since version 4.2 (see #41921)
- The bug has existed ever since

### ⏯ Playground Link

https://www.typescriptlang.org/play/?#code/C4TwDgpgBAkgznArhAPAFShAHsCA7AEzigG8oBtLALijmACcBLPAcwF0a9EBbAIwnoBuKAF8AfFAC8UAHI8BjAMbpyAawggA9gDMoaNmMEBYAFChIs+U2UzMOfEShc+AidJnGz4aAA0psBGQUMgBDAH5OHn56UUMgA

### 💻 Code

```ts
type Issue = Numeric;
type Numeric = N;
type X = Issue<{ a?: 0 }>;
```

### 🙁 Actual behavior

During the evaluation of `X`, `T[keyof T]` becomes `{ a?: 0 }['a']`, which in turn is evaluated as `0 | undefined` because `a` is an optional property. Therefore, the argument passed to `Numeric` is `0 | undefined`. This type doesn't satisfy the `extends number` constraint and therefore should not be permitted. However, the compiler doesn't report any errors.

### 🙂 Expected behavior

An error is reported on line 1, saying that the `N extends number` constraint might be violated.

### Additional information about the issue

The same happens with the mapped type `{ [x in string]: number; }`.

The problem only exists for string index signatures: for both `{ [x: number]: number; }` and `{ [x: symbol]: number; }`, there are errors reported.

#41921 might've been a mistake. Perhaps a new tsconfig option could be introduced that would revert the change so that the rule for assignment of optional properties to string index signatures is more strict and consistent to how number / symbol index signatures are handled again? With `"exactOptionalPropertyTypes": true` at least, the original issue #41418 should not cause trouble anymore. Actually, I think that the introduction of `exactOptionalPropertyTypes` is exactly how the issue should have been solved back then. Unfortunately, the setting was only introduced later (in version 4.4).

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere den Fall im verlinkten TypeScript Playground und verfolge anschließend die Auswertung von Issue, T[keyof T] und Numeric im Type-Checking-Code des Compilers. Vergleiche Index-Signaturen für string, number und symbol sowie die mapped-type-Variante; die Aufgabe ist erledigt, wenn die Fälle mit string-Index-Signatur 0 | undefined mit der erwarteten Constraint-Diagnose ablehnen, ohne dass die bestehenden Fälle regressieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.