Branding Drafts on Type level

Offen
  • Stimmt etwas nicht?
#1,232 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 4 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Ruhig
Tech-Stack
typescript
Bereich
developer-experience

Rechercherichtung

Beginne mit dem TypeScript Playground-Proof-of-Concept und vergleiche dessen Verhalten in Bezug auf branded Draft, MaybeDraft, current, isDraft und produce mit den bestehenden Typsignaturen von Immer. Das Issue nennt keine Repository-Dateien oder Tests; für den Abschluss wäre eine abgestimmte Entscheidung darüber erforderlich, ob Branding zur Compile-Zeit wünschenswert ist, sowie ein definierter Implementierungsumfang.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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)
Vorherrschende Sprache
JavaScript
Sterne
29k
Forks
905
Ø Merge
3 T. 16 Std.
Gemergte PRs (30 T.)
22

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus immerjs/immer

Alle Issues in immerjs/immer

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

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