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

Đang mở
#63,709 3 bình luận 0 reaction 0 người được giao Xem trên GitHub
Cursed? Domain: Indexed Access Types Possible Improvement
Ngôn ngữ chính
Go
Star
111k
Fork
14.3k
Merge trung bình
2 ngày 4 giờ
Pull request đã merge (30 ngày)
132

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Tái hiện trường hợp trong TypeScript Playground được liên kết, sau đó theo dõi việc đánh giá Issue, T[keyof T] và Numeric trong mã kiểm tra kiểu của compiler. So sánh các index signature của string, number và symbol cũng như biến thể mapped-type; công việc được hoàn thành khi các trường hợp có string index signature từ chối 0 | undefined với chẩn đoán ràng buộc như mong đợi mà không gây hồi quy cho các trường hợp hiện có.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
typescript
Lĩnh vực
compilers
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.