restate / v1.0.0

Spolehlivost by design

Co restate zaručuje, když je úložiště pomalé, selhává nebo chybí, a jak číst chyby, které hlásí.

Na této stránce

Záruky Uložení v pořadí Vyzkoušejte Když načítání selže Uložit a zavřít Žádné úložiště k dispozici Validace a migrace uložených dat Vlastní úložiště Limity a časové limity Kódy chyb

Záruky

Toto chování je součástí kontraktu 1.0 a pokrývají ho testy balíčku.

Situace	Co restate udělá
`Několik uložení za sebou`	Provede je v pořadí pro každý store; uložení ve frontě zapíše nejnovější hodnotu.
`Záznam se nenačetl`	autoSave a hromadná uložení ho přeskočí s LOAD_FAILED; nahradí ho jen explicitní save().
`Komponenta se během uložení odpojí`	Vyžádané uložení se dokončí; pozdější zápisy do zničeného store se ignorují.
`Úložiště není dostupné`	Store funguje v paměti, status().available je false a uložení se odmítají.
`Adaptér se zasekne`	Operaci vyprší čas po operationTimeoutMs a další práce počká, až adaptér skončí.
`Příliš mnoho čekající práce`	Nové operace se odmítnou s QUEUE_FULL, místo aby fronta rostla bez omezení.

Uložení v pořadí

Operace jednoho store se nikdy nepřekrývají. Uložení spuštěné, zatímco jiné čeká, vezme nejnovější hodnotu, takže ukládání při každé změně zapíše poslední stav bez zahlcení 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

Vyzkoušejte

Zpomalte úložiště, nechte zápisy selhávat nebo úložiště úplně odeberte.

OvladačNení součástí kódu příkladu. Hodnoty se do příkladu dostávají jako props.

Latencelatency
Selhávající zápisyfailWrites
Úložiště nedostupnéunavailable

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

Příprava příkladu…

Živé příklady potřebují JavaScript. Kód níže si můžete přečíst tak, jak 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ženo: ${JSON.stringify(value)}`, ...list]),
      (reason) => setResults((list) => [`Selhalo: ${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žit</button>
        <button
          onClick={() => {
            save();
            save();
            save();
          }}
        >
          Uložit třikrá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);
  },
};

Když načítání selže

restateManager.ready se odmítne s BULK_OPERATION_FAILED a vypíše každý store, který selhal. Dokud se ten záznam nenačte, autoSave a saveAll ho nenahradí a nahlásí LOAD_FAILED.

Zkuste to znovu přes initialize(), chcete-li úpravy zachovat a uložit, zavolejte restore(), chcete-li je zahodit, nebo save(), chcete-li záznam záměrně přepsat.

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žit a zavřít

Uložení vyžádané před odpojením se i tak dokončí, takže obsluha „Uložit a zavřít“ nemusí čekat.

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

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

Žádné úložiště k dispozici

Renderování na serveru a úložiště zablokované prohlížečem nejsou chyby při spuštění. Kontrolujte available, abyste uživatelům řekli, že úpravy zůstávají jen 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.');
}

Validace a migrace uložených dat

version, migrate a validate vás chrání před starými nebo poškozenými záznamy. validate se spouští před uložením a po obnovení či migraci.

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žiště

Poslouží jakýkoli objekt s getItem, setItem a removeItem. Metody mohou vracet hodnoty nebo Promise; isAvailable je volitelné.

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, jak dlouho smí operace trvat, kolik jich smí čekat a jak velká smí být hodnota.

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

Kódy chyb

Chyby vytvořené restate mají name RestateError, code a u ukládaných store také key. Adaptéry úložiště a vaše callbacky mohou odmítat vlastními chybami.

Kód	Význam
`BULK_OPERATION_FAILED`	Hromadné volání jako restateManager.ready nebo saveAll mělo chyby; viz error.failures.
`INDEXEDDB_ABORTED`	Transakce IndexedDB byla přerušena.
`INDEXEDDB_BLOCKED`	Otevření databáze zablokovalo připojení v jiné kartě.
`INDEXEDDB_CONNECTION_CLOSING`	Připojení k databázi se zavíralo, když požadavek začal.
`INDEXEDDB_OPEN_FAILED`	Databázi se nepodařilo otevřít.
`INDEXEDDB_REQUEST_FAILED`	Požadavek IndexedDB selhal.
`INDEXEDDB_STORE_MISSING`	V již vytvořené databázi chybí object store.
`INVALID_STORAGE_RECORD`	Uložený záznam není platný záznam restate.
`INVALID_STORED_VALUE`	Hodnota neprošla validate.
`LIFECYCLE_LIMIT`	Updater se opakovaně spouštěl a zastavoval.
`LOAD_FAILED`	Záznam se nepodařilo načíst, takže ho automatické ani hromadné uložení nenahradilo.
`MMKV_UNAVAILABLE`	react-native-mmkv se nepodařilo načíst.
`MULTIPLE_ERRORS`	V jedné operaci selhalo více callbacků; viz error.errors.
`NOTIFICATION_LIMIT`	Pozorovatelé v cyklu stále plánovali změny.
`OBSERVER_ERROR`	Posluchač nebo callback životního cyklu vyhodil chybu.
`OPERATION_ABORTED`	Operace s úložištěm byla zrušena.
`QUEUE_FULL`	Čekalo více operací, než dovoluje maxPendingOperations.
`REENTRANT_SETTER`	Updater stavu se během svého běhu pokusil změnit tentýž store.
`SCOPE_DESTROYED`	K vytvoření store byl použit zničený scope.
`SEQUENCE_EXHAUSTED`	Vnitřní sekvenci došly identifikátory.
`STORAGE_BLOCKED`	Předchozí volání adaptéru se po vypršení času nebo zrušení nedokončilo.
`STORAGE_TIMEOUT`	Operace trvala déle než operationTimeoutMs.
`STORAGE_UNAVAILABLE`	Úložiště zde nelze použít; store dál funguje v paměti.
`STORAGE_VALUE_TOO_LARGE`	Zakódovaná hodnota překračuje maxStorageCharacters.
`STORAGE_VERSION_MISMATCH`	Záznam má jinou verzi a žádná funkce migrate ji neobsluhuje.
`STORE_DESTROYED`	Došlo k odběru zničeného store nebo byl požádán o použití úložiště.

Napsáno pro API restate 1.0