Branding Drafts on Type level

Aperta
  • Qualcosa non va?
#1,232 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
developer-experience

Direzione di ricerca

Inizia con la proof of concept di TypeScript Playground e confronta il comportamento relativo a branded Draft, MaybeDraft, current, isDraft e produce con le firme dei tipi esistenti di Immer. L'issue non indica file o test del repository; per considerarla completata sarebbe necessaria una decisione condivisa sull'opportunità del branding a compile-time e andrebbe definito l'ambito dell'implementazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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)
Lingua principale
JavaScript
Stelle
29k
Fork
905
Merge medio
3g 16h
PR unite (30g)
22

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di immerjs/immer

Tutte le issue di immerjs/immer

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.