プレイグラウンド

入力を変えて、restate の反応を見てみましょう。

7 つの実験が本物のパッケージで動いています。左のコントローラーはこのサイトのもので、右のサンプルは props を受け取るだけです。だからそのコードは、あなたが書くコードそのままです。

コントローラー — サイト専用props — 橋渡しサンプル — コピーするコード

2 つの画面で 1 つのストア

複数のコンポーネントが同じ値を必要としています。一度宣言すれば、どこからでも読めます。

注目するところ

ステップのボタンを押してください。すべての読み手が同時に新しい数値を表示します。
読み手の数を変えてください。新しい読み手は現在の値から始まります。

コントローラーサンプルコードには含まれません。値は 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 としてサンプルに渡されます。

概要を shallow で比較shallowSummary

<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>
  );
}

必要な部分だけを購読する

変更は多くても、通知は 1 回

2 つのストアを 1 つずつ更新すると、購読者が途中の中途半端な状態を見てしまいます。

注目するところ

別々にクリア: 購読者には、商品 0 件と古いクーポンが同時に見えます。
batch でクリア: 両方のストアが変わった後に、購読者が 1 回だけ実行されます。

コントローラーサンプルコードには含まれません。値は 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);
  },
};

保存は自分のタイミングで

速く打っても、書き込みは 1 回

キーを押すたびに保存すると、ストレージがあふれます。autoSave は入力が止まるのを待ちます。

注目するところ

文章を入力する: 編集回数はどんどん増え、書き込みは入力が止まるたびに 1 つ増えるだけ。
「変更ごと」を選ぶ: 編集のたびに書き込みますが、保存済みの値に戻す編集では何も書き込みません。

コントローラーサンプルコードには含まれません。値は props としてサンプルに渡されます。

autoSave の待ち時間delayMs

<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 がデータを守り、問題を報告する様子が見られます。

注目するところ

遅延を大きくして 3 回保存する: リクエストは 1 回の書き込みを共有するので、pending は 1 のままで、3 つの結果が同時に返ってきます。
書き込み失敗をオンにして保存する: 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();
          }}
        >
          3 回保存
        </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);
  },
};

信頼性の設計

ドキュメントごとの状態

開いているドキュメントにはそれぞれ専用の状態が必要で、ドキュメントを閉じたら解放されるべきです。

注目するところ

ドキュメント 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>
  );
}

コンポーネントが所有する状態