Песочница

Меняйте входные данные. Смотрите, как отвечает restate.

Семь экспериментов запускают настоящий пакет. Контроллер слева принадлежит этому сайту; пример справа получает только props, поэтому его код — ровно то, что написали бы вы.

Контроллер — только для сайтаprops — мостПример — код, который вы копируете

Два экрана, одно хранилище

Нескольким компонентам нужно одно и то же значение. Объявите его один раз и читайте где угодно.

На что смотреть

Нажмите кнопку шага: все читатели одновременно покажут новое число.
Измените число читателей: новый читатель стартует с текущего значения.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Читателиreaders
Шагstep

<Example
  readers={3}
  step={1}
/>

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

App.jsx

import { restate } from '@kkwaenggwari/restate';
import './styles.css';

const useCount = restate(0);

function Reader({ name }) {
  const count = useCount();

  return (
    <section className="card">
      <span>{name}</span>
      <output>{count}</output>
    </section>
  );
}

export default function Example({ readers = 3, step = 1 }) {
  return (
    <main>
      <div className="grid">
        {Array.from({ length: readers }, (_, index) => (
          <Reader key={index} name={`Экран ${index + 1}`} />
        ))}
      </div>
      <div className="actions">
        <button onClick={() => useCount.set((count) => count + step)}>+{step}</button>
        <button onClick={() => useCount.reset()}>Сбросить</button>
      </div>
    </main>
  );
}

Начало

Перерисовывается только изменившееся

Большое хранилище не должно перерисовывать каждый компонент при каждой правке.

На что смотреть

Измените открытку: перерисовывается только карточка всего хранилища.
Добавьте товар: перерисовываются товары и итог; карточка купона не трогается.
Выключите shallow: итог перерисовывается при каждой правке, потому что его selector каждый раз возвращает новый объект.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Сравнивать итог через shallowshallowSummary

<Example
  shallowSummary={true}
/>

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

App.jsx

import { memo, useRef } from 'react';
import { restate, shallow } from '@kkwaenggwari/restate';
import './styles.css';

const useCart = restate({ items: ['Book'], coupon: '', note: '' });

function Card({ title, value }) {
  const renders = useRef(0);
  renders.current += 1;

  return (
    <section className="card">
      <span>{title}</span>
      <output>{value}</output>
      <small>{`Рендеров: ${renders.current}`}</small>
    </section>
  );
}

const ItemCount = memo(function ItemCount() {
  const count = useCart((cart) => cart.items.length);
  return <Card title="Товары" value={count} />;
});

const Coupon = memo(function Coupon() {
  const coupon = useCart((cart) => cart.coupon);
  return <Card title="Купон" value={coupon || 'нет'} />;
});

const Summary = memo(function Summary({ compare }) {
  const summary = useCart((cart) => ({ count: cart.items.length, coupon: cart.coupon }), compare);
  return <Card title="Итог" value={`${summary.count} · ${summary.coupon || '-'}`} />;
});

const Whole = memo(function Whole() {
  const cart = useCart();
  return <Card title="Всё хранилище" value={cart.note.length} />;
});

export default function Example({ shallowSummary = true }) {
  return (
    <main>
      <div className="grid">
        <ItemCount />
        <Coupon />
        <Summary compare={shallowSummary ? shallow : undefined} />
        <Whole />
      </div>
      <div className="actions">
        <button onClick={() => useCart.set((cart) => ({ ...cart, items: [...cart.items, 'Pen'] }))}>
          Добавить товар
        </button>
        <button
          onClick={() => useCart.set((cart) => ({ ...cart, coupon: cart.coupon ? '' : 'SPRING' }))}
        >
          Переключить купон
        </button>
        <button onClick={() => useCart.set((cart) => ({ ...cart, note: cart.note + '!' }))}>
          Изменить открытку
        </button>
      </div>
    </main>
  );
}

Подписывайтесь только на нужное

Много изменений, одно уведомление

Если обновлять два хранилища по очереди, подписчик может увидеть промежуточное состояние.

На что смотреть

Очистить по отдельности: подписчик видит 0 товаров вместе со старым купоном.
Очистить через batch: подписчик срабатывает один раз, после того как изменились оба хранилища.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Товарыquantity
Купонcoupon

<Example
  quantity={3}
  coupon="SPRING"
/>

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

App.jsx

import { useEffect, useState } from 'react';
import { batch, restate } from '@kkwaenggwari/restate';
import './styles.css';

const useItems = restate([]);
const useCoupon = restate('');

export default function Example({ quantity = 3, coupon = 'SPRING' }) {
  const items = useItems();
  const code = useCoupon();
  const [notices, setNotices] = useState([]);

  useEffect(() => {
    useItems.set(Array.from({ length: quantity }, (_, index) => `#${index + 1}`));
    useCoupon.set(coupon);
    setNotices([]);
  }, [quantity, coupon]);

  useEffect(
    () =>
      useItems.subscribe((next) => {
        const notice = `Уведомление: товаров ${next.length} · купон ${useCoupon.get() || '-'}`;
        setNotices((list) => [...list, notice]);
      }),
    [],
  );

  const clear = () => {
    useItems.set([]);
    useCoupon.set('');
  };

  return (
    <main>
      <div className="grid">
        <section className="card">
          <span>Товары</span>
          <output>{items.length}</output>
        </section>
        <section className="card">
          <span>Купон</span>
          <output>{code || '-'}</output>
        </section>
      </div>
      <div className="actions">
        <button onClick={clear}>Очистить по отдельности</button>
        <button onClick={() => batch(clear)}>Очистить через batch</button>
      </div>
      <h2>Что увидел подписчик</h2>
      <ol className="log">
        {notices.length ? (
          notices.map((notice, index) => <li key={index}>{notice}</li>)
        ) : (
          <li>Уведомлений пока нет.</li>
        )}
      </ol>
    </main>
  );
}

Подписывайтесь только на нужное

Сохраняйте, когда решите

Правка меняет память. Сохранение — явное действие, а статус показывает, что происходит.

На что смотреть

Печатайте: dirty включается, но пока ничего не записывается.
Увеличьте задержку и сохраните: operation показывает save, пока идёт запись.
Повторите пример: сохранённый черновик восстанавливается из IndexedDB.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Задержка хранилищаlatency

<Example
  latency={600}
/>

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

App.jsx

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

const useDraft = persistedRestate('', { key: 'playground-draft', storage: slowStorage });

export default function Example({ latency = 600 }) {
  useEffect(() => {
    settings.latency = latency;
  }, [latency]);

  const text = useDraft();
  const { dirty, operation, pending, lastSavedAt } = useDraft.useStatus();
  // A failed save keeps dirty and records status.error.
  const save = () => useDraft.save().catch(() => {});
  const revert = () => useDraft.restore().catch(() => {});

  return (
    <main>
      <label>
        Черновик
        <textarea value={text} onChange={(event) => useDraft.set(event.target.value)} />
      </label>
      <div className="actions">
        <button disabled={!dirty} onClick={save}>
          Сохранить
        </button>
        <button disabled={!dirty} onClick={revert}>
          Отменить правки
        </button>
      </div>
      <dl className="status">
        <dt>dirty</dt>
        <dd className={dirty ? 'warn' : 'ok'}>{dirty ? 'несохранённые правки' : 'сохранено'}</dd>
        <dt>operation</dt>
        <dd>{operation ?? 'нет'}</dd>
        <dt>pending</dt>
        <dd>{pending}</dd>
        <dt>lastSavedAt</dt>
        <dd>{lastSavedAt ? new Date(lastSavedAt).toLocaleTimeString() : 'ещё нет'}</dd>
      </dl>
    </main>
  );
}

storage.js

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

// IndexedDB with an adjustable delay, to watch operations in progress.
const indexedDB = createIndexedDBStorage();
export const settings = { latency: 0 };
const wait = () => new Promise((resolve) => setTimeout(resolve, settings.latency));

export const slowStorage = {
  async getItem(key) {
    await wait();
    return indexedDB.getItem(key);
  },
  async setItem(key, value) {
    await wait();
    return indexedDB.setItem(key, value);
  },
  async removeItem(key) {
    await wait();
    return indexedDB.removeItem(key);
  },
};

Сохраняйте, когда решите

Печатайте быстро, пишите один раз

Сохранение на каждое нажатие клавиши перегружает хранилище. autoSave ждёт паузы.

На что смотреть

Наберите фразу: правки растут быстро, а записи прибавляются по одной после каждой паузы.
Выберите «При каждой правке»: каждая правка записывается, но возврат к сохранённому значению ничего не пишет.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Ожидание autoSavedelayMs

<Example
  delayMs={800}
/>

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

App.jsx

import { useState } from 'react';
import { persistedRestate, useRestateScope } from '@kkwaenggwari/restate';
import { countingStorage, useWrites } from './storage.js';
import './styles.css';

function Note({ delayMs }) {
  const useNote = useRestateScope((scope) =>
    persistedRestate('', {
      scope,
      key: 'note',
      storage: countingStorage,
      autoSave: delayMs ? { delayMs } : true,
    }),
  );
  const note = useNote();
  const dirty = useNote.useStatus((status) => status.dirty);
  const writes = useWrites();
  const [edits, setEdits] = useState(0);

  return (
    <>
      <label>
        Заметка
        <textarea
          value={note}
          placeholder="Быстро наберите фразу…"
          onChange={(event) => {
            useNote.set(event.target.value);
            setEdits((count) => count + 1);
          }}
        />
      </label>
      <div className="grid">
        <section className="card">
          <span>Правки</span>
          <output>{edits}</output>
        </section>
        <section className="card accent">
          <span>Записи в хранилище</span>
          <output>{writes}</output>
        </section>
      </div>
      <p className={dirty ? 'badge warn' : 'badge ok'}>{dirty ? 'ждём паузы' : 'сохранено'}</p>
    </>
  );
}

export default function Example({ delayMs = 800 }) {
  // autoSave is part of the declaration: a new delay starts a new scope.
  return (
    <main>
      <Note key={delayMs} delayMs={delayMs} />
    </main>
  );
}

storage.js

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

// An in-memory storage adapter that counts real writes.
const records = new Map();
export const useWrites = restate(0);

export const countingStorage = {
  getItem: (key) => records.get(key) ?? null,
  setItem: (key, value) => {
    records.set(key, value);
    useWrites.set((count) => count + 1);
  },
  removeItem: (key) => {
    records.delete(key);
  },
};

Сохраняйте, когда решите

Лаборатория сбоев

Сделайте хранилище медленным, сломанным или недоступным и посмотрите, как restate сохраняет ваши данные и сообщает о проблеме.

На что смотреть

Увеличьте задержку и сохраните три раза: запросы делят одну запись, поэтому pending остаётся 1, а три результата приходят вместе.
Включите сбой записи и сохраните: dirty остаётся true, а error показывает причину.
Сделайте хранилище недоступным: сохранение отклоняется с STORAGE_UNAVAILABLE, а правка продолжает работать.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Задержкаlatency
Записи с ошибкойfailWrites
Хранилище недоступноunavailable

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

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

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) => [`Сохранено: ${JSON.stringify(value)}`, ...list]),
      (reason) => setResults((list) => [`Ошибка: ${reason.code ?? reason.message}`, ...list]),
    );

  return (
    <main>
      <label>
        Заметка
        <input value={note} onChange={(event) => useNote.set(event.target.value)} />
      </label>
      <div className="actions">
        <button onClick={save}>Сохранить</button>
        <button
          onClick={() => {
            save();
            save();
            save();
          }}
        >
          Сохранить три раза
        </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>Результаты</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('Диск заполнен');
    records.set(key, value);
  },
  async removeItem(key) {
    await wait();
    records.delete(key);
  },
};

Надёжность by design

Состояние для отдельного документа

Каждому открытому документу нужно своё состояние, которое освобождается при закрытии документа.

На что смотреть

Напишите в документе A, затем в B: каждый хранит свой текст.
Закройте документ A и откройте снова: он начинается пустым, потому что его область уничтожена.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Документыdocuments
Документ A открытfirstOpen

<Example
  documents={2}
  firstOpen={true}
/>

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

App.jsx

import { restate, useRestateScope } from '@kkwaenggwari/restate';
import './styles.css';

function Document({ name }) {
  const useText = useRestateScope((scope) => restate('', { scope }));
  const text = useText();

  return (
    <section className="card">
      <span>{name}</span>
      <input
        value={text}
        placeholder="Пишется только здесь"
        onChange={(event) => useText.set(event.target.value)}
      />
      <small>{`Символов: ${text.length}`}</small>
    </section>
  );
}

export default function Example({ documents = 2, firstOpen = true }) {
  const names = ['A', 'B', 'C'].slice(0, documents);

  return (
    <main>
      <div className="grid">
        {names.map((name, index) =>
          index === 0 && !firstOpen ? null : <Document key={name} name={`Документ ${name}`} />,
        )}
      </div>
    </main>
  );
}

Состояние, принадлежащее компоненту