Пісочниця

Змінюйте вхідні дані. Дивіться, як відповідає 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>
  );
}

Стан, що належить компоненту