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

Abierto
#63,709 3 comentarios 0 reacciones 0 asignados Ver en GitHub
Cursed? Domain: Indexed Access Types Possible Improvement
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Reproduce el caso en el TypeScript Playground enlazado y, a continuación, rastrea la evaluación de Issue, T[keyof T] y Numeric en el código de comprobación de tipos del compilador. Compara las firmas de índice de string, number y symbol, así como la variante mapped-type; el trabajo estará terminado cuando los casos con firma de índice de string rechacen 0 | undefined con el diagnóstico de restricción esperado, sin introducir regresiones en los casos existentes.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.