restate / v1.0.0

Spoľahlivosť by design

Čo restate zaručuje, keď je úložisko pomalé, zlyháva alebo chýba, a ako čítať chyby, ktoré hlási.

Na tejto stránke

Záruky Uloženia v poradí Vyskúšajte Keď načítanie zlyhá Uložiť a zavrieť Žiadne úložisko k dispozícii Validácia a migrácia uložených údajov Vlastné úložisko Limity a časové limity Kódy chýb

Záruky

Toto správanie je súčasťou kontraktu 1.0 a pokrývajú ho testy balíka.

Situácia	Čo restate urobí
`Niekoľko uložení za sebou`	Vykoná ich v poradí pre každý store; uloženie vo fronte zapíše najnovšiu hodnotu.
`Záznam sa nenačítal`	autoSave a hromadné uloženia ho preskočia s LOAD_FAILED; nahradí ho len explicitné save().
`Komponent sa počas uloženia odpojí`	Vyžiadané uloženie sa dokončí; neskoršie zápisy do zničeného store sa ignorujú.
`Úložisko nie je dostupné`	Store funguje v pamäti, status().available je false a uloženia sa odmietajú.
`Adaptér sa zasekne`	Operácii vyprší čas po operationTimeoutMs a ďalšia práca počká, kým adaptér skončí.
`Priveľa čakajúcej práce`	Nové operácie sa odmietnu s QUEUE_FULL namiesto toho, aby fronta rástla bez obmedzenia.

Uloženia v poradí

Operácie jedného store sa nikdy neprekrývajú. Uloženie spustené, kým iné čaká, vezme najnovšiu hodnotu, takže ukladanie pri každej zmene zapíše posledný stav bez zahltenia fronty.

useDraft.set('A');
const first = useDraft.save(); // writes "A"
useDraft.set('B');
const second = useDraft.save(); // waits in the queue
useDraft.set('C');
const third = useDraft.save(); // joins the waiting save

await Promise.all([first, second, third]); // ['A', 'C', 'C'] — two writes

Vyskúšajte

Spomaľte úložisko, nechajte zápisy zlyhávať alebo úložisko úplne odoberte.

OvládačNie je súčasťou kódu príkladu. Hodnoty sa do príkladu dostávajú ako props.

Latencialatency
Zlyhávajúce zápisyfailWrites
Úložisko nedostupnéunavailable

<Example
  latency={700}
  failWrites={false}
  unavailable={false}
/>

Príprava príkladu…

Živé príklady potrebujú JavaScript. Kód nižšie si môžete prečítať tak, ako je.

App.jsx

import { useEffect, useState } from 'react';
import { persistedRestate } from '@kkwaenggwari/restate';
import { flakyStorage, settings } from './storage.js';
import './styles.css';

const useNote = persistedRestate('', { key: 'lab-note', storage: flakyStorage });

export default function Example({ latency = 700, failWrites = false, unavailable = false }) {
  useEffect(() => {
    Object.assign(settings, { latency, failWrites, unavailable });
  }, [latency, failWrites, unavailable]);

  const note = useNote();
  const { dirty, operation, pending, error } = useNote.useStatus();
  const [results, setResults] = useState([]);

  const save = () =>
    useNote.save().then(
      (value) => setResults((list) => [`Uložené: ${JSON.stringify(value)}`, ...list]),
      (reason) => setResults((list) => [`Zlyhalo: ${reason.code ?? reason.message}`, ...list]),
    );

  return (
    <main>
      <label>
        Poznámka
        <input value={note} onChange={(event) => useNote.set(event.target.value)} />
      </label>
      <div className="actions">
        <button onClick={save}>Uložiť</button>
        <button
          onClick={() => {
            save();
            save();
            save();
          }}
        >
          Uložiť trikrát
        </button>
      </div>
      <dl className="status">
        <dt>dirty</dt>
        <dd className={dirty ? 'warn' : 'ok'}>{String(dirty)}</dd>
        <dt>operation</dt>
        <dd>{operation ?? '-'}</dd>
        <dt>pending</dt>
        <dd>{pending}</dd>
        <dt>error</dt>
        <dd className={error ? 'bad' : ''}>{error ? (error.code ?? error.message) : '-'}</dd>
      </dl>
      <h2>Výsledky</h2>
      <ol className="log">
        {results.length ? (
          results.map((result, index) => <li key={results.length - index}>{result}</li>)
        ) : (
          <li>-</li>
        )}
      </ol>
    </main>
  );
}

storage.js

// A storage adapter whose speed and failures you can change.
const records = new Map();
export const settings = { latency: 0, failWrites: false, unavailable: false };
const wait = () => new Promise((resolve) => setTimeout(resolve, settings.latency));

export const flakyStorage = {
  isAvailable: () => !settings.unavailable,
  async getItem(key) {
    await wait();
    return records.get(key) ?? null;
  },
  async setItem(key, value) {
    await wait();
    if (settings.failWrites) throw new Error('Disk je plný');
    records.set(key, value);
  },
  async removeItem(key) {
    await wait();
    records.delete(key);
  },
};

Keď načítanie zlyhá

restateManager.ready sa odmietne s BULK_OPERATION_FAILED a vypíše každý store, ktorý zlyhal. Kým sa ten záznam nenačíta, autoSave a saveAll ho nenahradia a nahlásia LOAD_FAILED.

Skúste to znova cez initialize(), ak chcete úpravy zachovať a uložiť, zavolajte restore(), ak ich chcete zahodiť, alebo save(), ak chcete záznam zámerne prepísať.

try {
  await restateManager.ready;
} catch (error) {
  // BULK_OPERATION_FAILED: one entry per store that could not load.
  for (const { store, error: cause } of error.failures) {
    console.error(store.key, cause.code);
  }
}

Uložiť a zavrieť

Uloženie vyžiadané pred odpojením sa aj tak dokončí, takže obsluha „Uložiť a zavrieť“ nemusí čakať.

function Document({ onClose }) {
  const useDraft = useRestateScope((scope) => persistedRestate('', { scope, key: 'draft' }));

  const saveAndClose = () => {
    useDraft.save(); // finishes even after this component unmounts
    onClose();
  };
  // …
}

Žiadne úložisko k dispozícii

Renderovanie na serveri a úložisko zablokované prehliadačom nie sú chyby pri spustení. Kontrolujte available, aby ste používateľom povedali, že úpravy zostávajú len v pamäti.

const { available } = useDraft.status();

if (!available) {
  // Server rendering or blocked browser storage: the store works in memory
  // and save() rejects with STORAGE_UNAVAILABLE.
  showNotice('Changes are kept until you close this tab.');
}

Validácia a migrácia uložených údajov

version, migrate a validate vás chránia pred starými alebo poškodenými záznamami. validate sa spúšťa pred uložením a po obnovení či migrácii.

import { persistedRestate } from '@kkwaenggwari/restate';

const useSettings = persistedRestate(
  { theme: 'system' },
  {
    key: 'settings',
    version: 2,
    migrate(value, from, to) {
      if (from === 1 && to === 2 && typeof value?.darkMode === 'boolean') {
        return { theme: value.darkMode ? 'dark' : 'light' };
      }
      throw new Error('Unsupported stored version');
    },
    validate: (value) => ['system', 'light', 'dark'].includes(value?.theme),
  },
);

Vlastné úložisko

Poslúži akýkoľvek objekt s getItem, setItem a removeItem. Metódy môžu vracať hodnoty alebo Promise; isAvailable je voliteľné.

import { persistedRestate } from '@kkwaenggwari/restate';

const sessionStorageAdapter = {
  isAvailable: () => typeof sessionStorage !== 'undefined',
  getItem: (key) => sessionStorage.getItem(key),
  setItem: (key, value) => sessionStorage.setItem(key, value),
  removeItem: (key) => sessionStorage.removeItem(key),
};

export const useFilters = persistedRestate(
  { query: '' },
  {
    key: 'filters',
    storage: sessionStorageAdapter,
  },
);

Limity a časové limity

Nastavte, ako dlho smie operácia trvať, koľko ich smie čakať a aká veľká smie byť hodnota.

persistedRestate(value, {
  key: 'draft',
  operationTimeoutMs: 10_000, // default 30000
  maxPendingOperations: 64, // default 256
  maxStorageCharacters: 1_000_000,
});

Kódy chýb

Chyby vytvorené restate majú name RestateError, code a pri ukladaných store aj key. Adaptéry úložiska a vaše callbacky môžu odmietať vlastnými chybami.

Kód	Význam
`BULK_OPERATION_FAILED`	Hromadné volanie ako restateManager.ready alebo saveAll malo chyby; pozri error.failures.
`INDEXEDDB_ABORTED`	Transakcia IndexedDB bola prerušená.
`INDEXEDDB_BLOCKED`	Otvorenie databázy zablokovalo pripojenie na inej karte.
`INDEXEDDB_CONNECTION_CLOSING`	Pripojenie k databáze sa zatváralo, keď požiadavka začala.
`INDEXEDDB_OPEN_FAILED`	Databázu sa nepodarilo otvoriť.
`INDEXEDDB_REQUEST_FAILED`	Požiadavka IndexedDB zlyhala.
`INDEXEDDB_STORE_MISSING`	V už vytvorenej databáze chýba object store.
`INVALID_STORAGE_RECORD`	Uložený záznam nie je platný záznam restate.
`INVALID_STORED_VALUE`	Hodnota neprešla validate.
`LIFECYCLE_LIMIT`	Updater sa opakovane spúšťal a zastavoval.
`LOAD_FAILED`	Záznam sa nepodarilo načítať, takže ho automatické ani hromadné uloženie nenahradilo.
`MMKV_UNAVAILABLE`	react-native-mmkv sa nepodarilo načítať.
`MULTIPLE_ERRORS`	V jednej operácii zlyhalo viac callbackov; pozri error.errors.
`NOTIFICATION_LIMIT`	Pozorovatelia v cykle stále plánovali zmeny.
`OBSERVER_ERROR`	Poslucháč alebo callback životného cyklu vyhodil chybu.
`OPERATION_ABORTED`	Operácia s úložiskom bola zrušená.
`QUEUE_FULL`	Čakalo viac operácií, než dovoľuje maxPendingOperations.
`REENTRANT_SETTER`	Updater stavu sa počas svojho behu pokúsil zmeniť ten istý store.
`SCOPE_DESTROYED`	Na vytvorenie store bol použitý zničený scope.
`SEQUENCE_EXHAUSTED`	Vnútornej sekvencii došli identifikátory.
`STORAGE_BLOCKED`	Predchádzajúce volanie adaptéra sa po vypršaní času alebo zrušení nedokončilo.
`STORAGE_TIMEOUT`	Operácia trvala dlhšie ako operationTimeoutMs.
`STORAGE_UNAVAILABLE`	Úložisko tu nemožno použiť; store ďalej funguje v pamäti.
`STORAGE_VALUE_TOO_LARGE`	Zakódovaná hodnota prekračuje maxStorageCharacters.
`STORAGE_VERSION_MISMATCH`	Záznam má inú verziu a žiadna funkcia migrate ju neobsluhuje.
`STORE_DESTROYED`	Došlo k odberu zničeného store alebo bol požiadaný o použitie úložiska.

Napísané pre API restate 1.0