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

Ouverte
#63,709 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Cursed? Domain: Indexed Access Types Possible Improvement
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

### 🔎 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).

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Reproduisez le cas dans le TypeScript Playground lié, puis suivez l’évaluation de Issue, T[keyof T] et Numeric dans le code de vérification des types du compilateur. Comparez les signatures d’index string, number et symbol ainsi que la variante mapped-type ; le travail est terminé lorsque les cas avec une signature d’index string rejettent 0 | undefined avec le diagnostic de contrainte attendu, sans régression dans les cas existants.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.