Reactで重い処理をscheduler.yieldで区切る方法

​​React​flushSync,Playwright,scheduler.yield,TypeScript

重い処理をループでそのまま回すと、終わるまで入力欄に文字が出ず、画面も止まります。ループの途中で await scheduler.yield() を挟むと、ブラウザが入力や描画を先に済ませてから、続きの処理に戻ってきます。

ただし React では、ループの中で setState するだけだと、進み具合の表示が処理の終わるまで変わりませんでした。進み具合を出すには、flushSync を50ミリ秒に1回だけ使います。途中で中止する書き方も合わせて示します。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、CPU は4コアです。使ったのは react / react-dom 19.3.1、@types/react 19.3.0、typescript 7.0.2、esbuild 0.28.2、Playwright 1.63.0 です。.tsx を tsc で型チェックしてから、esbuild で本番用にビルドしました。ブラウザは Playwright で動かした Chromium 153 で、ヘッドレスのほか、Xvfb の上で画面ありでも一部を測りました。Firefox、Safari、実機のスマホ、CPU の遅い端末は試していません。時間は、画面の描画(ペイント)の時刻ではなく、requestAnimationFrame(以下 rAF)が呼ばれた時刻で測っています。

区切らずに回すと、1.7秒のあいだ入力が画面に出ない

検証には、1件あたり約6ミリ秒かかる処理を300件続けて実行するコンポーネントを使いました。「処理を始める」ボタンを押すとループが始まり、「処理済み 0 / 300」の数字が進みます。下には入力欄があり、入力した文字を「入力:」のあとにそのまま表示します。

ループを区切らずに回すと、全体で約1.7秒かかりました(5回の中央値で1,682ミリ秒)。そのあいだ rAF は一度も呼ばれず、画面は止まったままです。処理の途中で送ったキーの文字が画面に出るまでには、中央値で1,217ミリ秒かかりました。文字が出たのは、どれもループが終わった直後でした。

scheduler.yield() をループの中で待つ

scheduler.yield() は、いったんメインスレッドをブラウザに返し、続きを後から実行するためのメソッドです。返ってくる Promise を await すると、そのあいだにブラウザが入力の処理などを済ませ、そのあとに続きの行から再開します。

MDN の互換性の表では、Chrome は129から、Firefox は142から対応していて、Safari は対応していません。そのため、使えないブラウザでは setTimeout に切り替える関数を用意しました。MDN の Prioritized Task Scheduling API の説明にも、同じように setTimeout に切り替える例があります。

ts
// yieldToMain.ts
export function yieldToMain(): Promise<void> {
  if (typeof globalThis.scheduler?.yield === 'function') {
    return globalThis.scheduler.yield();
  }
  return new Promise((resolve) => setTimeout(resolve, 0));
}

TypeScript 7.0.2 の DOM の型には scheduler と yield() がすでに入っていて、型を自分で書き足さなくても tsc が通りました。window.scheduler を消した状態で動かすと、この関数は setTimeout のほうに切り替わり、処理は最後まで進みました。

ループの中では、1件ごとに yieldToMain() を待つようにしました。

tsx
for (let i = 0; i < TOTAL; i++) {
  heavyItem(i);
  setDone(i + 1);
  await yieldToMain();
}

こうすると、処理の途中で送ったキーの文字は、中央値7ミリ秒で画面に出ました。全体の時間は中央値で1,730ミリ秒で、区切らない場合とほとんど変わりません。

setState だけでは、進み具合の数字が終わるまで「1」のまま

入力欄は動くようになりましたが、「処理済み」の数字は進みませんでした。文字を入力せずに3回動かしたところ、処理中に見えた数字はどの回も「1」だけで、ループが終わった瞬間に「300」に変わりました。

画面に出た「処理済み」の件数を、ボタンを押してからの時間で並べたグラフ。setStateのままyieldした場合は1.75秒まで1のままで、最後に300へ跳ぶ。50ミリ秒ごとにflushSyncしてからyieldした場合は、約0.1秒ごとに階段状に増え、1.74秒で300になる。setTimeoutで区切った場合はなめらかに増えるが、300になるのは約3秒後
rAFごとに記録した「処理済み」の表示。ピンクがsetStateのままyieldした場合

React の再レンダリングは、react-dom が使う scheduler パッケージ(ブラウザの scheduler とは別のもの)が予約します。このパッケージは、ブラウザでは MessageChannel を使ってタスクを予約します。一方、scheduler.yield() の続きは、MDN の説明にあるとおり、同じ優先度の postTask() のタスクより前に実行される、優先度を上げたキューに入ります。仕様の注記にも、既定の優先度の yield() の続きは、ほかの多くのタスクより重要なものとして扱う想定だと書かれています。

検証では、文字を入力しなかった場合、処理中も rAF は約0.1秒ごとに呼ばれていましたが、「処理済み」の表示は終わるまで「1」のままでした。

処理の途中で文字を入力した場合は、5回とも、処理中に見えた数字が4種類(始める前の0と終わったあとの300を除く)だけでした。

flushSync で、区切る前に描画を済ませる

flushSync で setState を包むと、React はその場で描画を済ませ、DOM を更新します。そのあとで yieldToMain() を待てば、ブラウザが更新済みの DOM を画面に出します。

tsx
for (let i = 0; i < TOTAL; i++) {
  heavyItem(i);
  flushSync(() => setDone(i + 1));
  await yieldToMain();
}

この書き方では、文字を入力しなくても、処理中に16〜17通りの数字が順に見えました。ただし、react.dev には、flushSync はまれにしか使わないもので、アプリの性能を大きく落とすことがあると書かれています。1件ごとに呼ぶと、300件で300回、その場で描画することになります。

そこで、区切る間隔を時間で決め、区切るときだけ flushSync を呼ぶことにしました。区切りの目安は、Long Tasks API の仕様が「長いタスク」とする50ミリ秒にそろえました。ただし、次の書き方では1件ごとに経過時間を確かめるので、区切りと区切りのあいだは50ミリ秒を少し超えます(超えるのは、最大で1件分と flushSync の分です)。

50ミリ秒ごとに区切る完成形

完成形のコンポーネントです。50ミリ秒を超えたら、数字を flushSync で描画してから yieldToMain() を待ちます。

tsx
// HeavyTask.tsx
import { useRef, useState } from 'react';
import { flushSync } from 'react-dom';
import { heavyItem } from './work';
import { yieldToMain } from './yieldToMain';

const TOTAL = 300;

export function HeavyTask() {
  const [done, setDone] = useState(0);
  const [running, setRunning] = useState(false);
  const [text, setText] = useState('');
  const controllerRef = useRef<AbortController | null>(null);

  async function start() {
    controllerRef.current?.abort();
    const controller = new AbortController();
    controllerRef.current = controller;
    setRunning(true);
    setDone(0);

    let lastYield = performance.now();
    for (let i = 0; i < TOTAL; i++) {
      heavyItem(i);
      if (performance.now() - lastYield > 50) {
        flushSync(() => setDone(i + 1));
        await yieldToMain();
        if (controller.signal.aborted) return;
        lastYield = performance.now();
      }
    }
    setDone(TOTAL);
    setRunning(false);
  }

  function cancel() {
    controllerRef.current?.abort();
    setRunning(false);
  }

  return (
    <div>
      <button onClick={start}>処理を始める</button>
      <button onClick={cancel} disabled={!running}>中止</button>
      <progress value={done} max={TOTAL} />
      <p id="progress">処理済み {done} / {TOTAL}</p>
      <input value={text} onChange={(e) => setText(e.target.value)} placeholder="ここに入力" />
      <p id="echo">入力:{text}</p>
    </div>
  );
}

5回動かしたところ、ボタンを押してから「300 / 300」が出るまでは1,670〜1,796ミリ秒でした。処理中の数字は、約0.1秒ごとに進みました。処理の途中で送ったキーの文字は、16〜40ミリ秒で画面に出ました。1件ごとに setState して yield した場合(中央値7ミリ秒)よりは長くなりますが、区切らない場合の1秒以上と比べると、ずっと短く収まりました。

中止ボタンと、途中でのやり直し

scheduler.yield() そのものには、止めるための引数がありません(postTask() の中で呼んだ場合は、そのタスクの中止に従います)。そこで完成形では、AbortController を自分で持ち、yieldToMain() から戻るたびに signal.aborted を見てループを抜けています。

処理が始まって約0.5秒のところで「中止」を押したところ、数字は「96 / 300」で止まり、2.5秒待っても変わりませんでした。処理の途中で「中止」ボタンが押せる状態になっていることも確かめました。

処理の途中でもう一度「処理を始める」を押すと、まず前の AbortController を中止してから、新しいループを始めます。134件まで進んだところで押し直したところ、数字は9、29、50……と最初から数え直し、最後は300で終わりました。前のループの数字が混ざって表示が行き来することはありませんでした。

setTimeout で区切った場合との違い

同じ300件の処理を、scheduler.yield() の代わりに setTimeout(resolve, 0) で1件ごとに区切って比べました。数字は5回の中央値です。「50ミリ秒ごとに flushSync して yield」の行は、完成形と同じ区切り方を、比べるための測定用コンポーネントで測った数字です。

書き方 全体の時間 キーを送ってから文字が出るまで rAF が呼ばれる間隔 処理中の数字
区切らない 1,682ミリ秒 1,217ミリ秒 処理中は呼ばれない 進まない
1件ごとに yield(setState のまま) 1,730ミリ秒 7ミリ秒 102ミリ秒 ほとんど進まない
50ミリ秒ごとに flushSync して yield 1,674ミリ秒 24ミリ秒 104ミリ秒 進む
1件ごとに setTimeout 2,985ミリ秒 13ミリ秒 17ミリ秒 進む

setTimeout で区切ると、全体の時間が約1.3秒延びました。1件ごとに flushSync して yieldToMain() を待つ書き方で、scheduler.yield() がない状態を Chromium で再現したところ、全体で3,004ミリ秒かかりました。

setTimeout を入れ子で呼び続けたときの決まりとして、MDN の setTimeout の説明には、入れ子の setTimeout が5回続くと、ブラウザは最低4ミリ秒の待ち時間を入れると書かれています。

一方で、scheduler.yield() で区切ったときは、rAF が約100ミリ秒に1回しか呼ばれませんでした。setTimeout で区切ったときは約17ミリ秒に1回です。この差は、ヘッドレスでも、Xvfb の上の画面ありの Chromium でも同じでした。処理中の数字は約0.1秒ごとに進むので、進み具合を見せるには足ります。ただ、rAF で動かすアニメーションは、処理中は約0.1秒に1回しか進みません。

​Posted by 86