Branding Drafts on Type level

Đang mở
  • Có gì không ổn?
#1,232 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 4 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
developer-experience

Hướng nghiên cứu

Bắt đầu với proof of concept của TypeScript Playground và so sánh hành vi liên quan đến branded Draft, MaybeDraft, current, isDraft và produce của nó với các chữ ký kiểu hiện có của Immer. Issue không nêu tên các tệp hoặc test trong repository; để hoàn thành, cần có quyết định được thống nhất về việc branding tại thời điểm biên dịch có đáng mong muốn hay không và xác định phạm vi triển khai.

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

Mô tả

question

🙋‍♂ Question

I was wondering if it would be possible to not just brand at runtime, but branded type at compile time as well?

Cause

I was using redux/toolkit, which uses Immer and had an issue where current(val) was called on a non draft, typechecker was fine, executed it in development, all good, came to production, tried to unwrap a non draft and crashed. Not a big deal, just use isDraft, but it was something technically avoidable if....

Implementation

I could make a PR, I just wanted to figure out if that is even desirable since I assume this question came up already some time ago and was decided against it for a reason to me currently unknown (except maybe that some types are already relatively complex)

Proof of concept

I made a small proof of concept on typescript playground relative quickly to just check out the branding, the idea would be that produce etc return Drafted<T> instead of T hiding a potential source for errors (naming still up for discussion)

I made a small code example on TS playground where I do not duplicate the objects, Proxy them etc for simplicity. If no link should be used, here the snipped:

const brand : unique symbol = Symbol("foobar")

type Draft<T> = T & {[brand]:never}
type MaybeDraft<T> = Draft<T> | T

const a = 32;
const b = {
    a: 32,
    b: "Hello world"
}
const c = [1, 2, 3];
const d = [a,b,c] as const

const draft = <T extends object>(val: T)=> {
    const clone = val
    Object.defineProperty(clone, brand, {configurable: false, enumerable: false, writable: false, value: true})
    return clone as Draft<T>
}


const isDraft = <T extends unknown>(val: T): val is Draft<T> => {
    //@ts-ignore
    if (val[brand]) {
        return true
    }

    return false
}


const B = draft(b)
const C = draft(c)
const D = draft(d)


console.log("A: ", isDraft(a))
console.log("B: ", isDraft(B))
console.log("C: ", isDraft(C))
console.log("D: ", isDraft(D))


/**
 * Accepts a Draft or a Value, but differentiates them on a type level to enforce handling of each of the 2 scenarios
 */
const doSomething = (value: MaybeDraft<number[]>) => {
    //const val = current(value) // Error because value could also not be a draft
    const val = isDraft(value) ? current(value) : value
    return val
}

/**
 * Accepts a Draft or a Value, it doesn't care if it might be a Draft and just uses it
 */
const doSomething2 = (value: number[]) => {
    return value
}

/**
 * Accepts only a Draft, non Drafts are refused on a Type Level at compile time
 */
const current = <T extends object>(value: Draft<T>):T => {
    return value
}

doSomething(C)
doSomething2(C)
//const neverHappend = current(c)
const val = current(C)
Ngôn ngữ chính
JavaScript
Star
29k
Fork
905
Merge trung bình
3 ngày 16 giờ
Pull request đã merge (30 ngày)
22

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của immerjs/immer

Tất cả issue của immerjs/immer

Issue tương tự

Thêm issue về JavaScript

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.