RemixのFlashMessageが、10秒待っても自動で消えなかった
RemixのFlashMessage(5秒後に自動で消える通知)が、E2Eで10秒待っても消えなかった。AIは「コードは正しい」と答えた。key の追加と、useEffect の依存配列から onClose を外すことで動くようになった。原因は推定で、検証していない。
症状
- 【発生環境】: Remix v2(SSR)、Cloudflare Pages/Workers、FlashMessageコンポーネント(自動消去機能つき)。
- 【期待する動作】: 表示から5秒後に消える。
- 【実際の動作】: 10秒待っても消えない。
# 期待: 5秒後に消える
# 現実: 10秒待っても消えない
Expected: not.toBeVisible()
Received: visible最初の実装は次のとおり(元の記録のまま)。
export function FlashMessage({
message,
autoDismiss = true,
autoDismissDelay = 5000,
onClose
}: FlashMessageProps) {
const [isVisible, setIsVisible] = useState(true);
useEffect(() => {
if (!autoDismiss) return;
const timer = setTimeout(() => {
setIsVisible(false);
onClose?.();
}, autoDismissDelay);
return () => clearTimeout(timer);
}, [autoDismiss, autoDismissDelay]);
if (!isVisible) return null;
// ... render JSX
}AIに聞くと、「useEffect でタイマーを設定し、クリーンアップで解除している。依存配列も妥当」という趣旨で、「コードは論理的に正しい」と答えた。依存配列を直しても、クリーンアップを書き足しても、症状は変わらなかった。
原因
【推定(未検証)】: 親から渡される onClose が、レンダリングのたびに新しい関数になる。onClose を依存配列に入れているため、親が再レンダリングされるたびに useEffect が再実行され、タイマーが0秒から数え直される。再レンダリングが5秒より短い間隔で続く限り、タイマーは発火しない。
記録の食い違い: 上の初版コードは依存配列に onClose を含まないが、後述の修正の差分は、onClose を含む版から外す形で書かれている。症状が出たときの実コードがどちらだったかは、残っていない。初版のとおり onClose を含まない版だったなら、この推定では説明できない。
確認していないこと: 再レンダリングの頻度、useEffect の再実行回数、コンポーネントが再マウントされていたか。当初は、SSRのハイドレーションによる再マウントを疑っていたが、それも確かめていない。親の再レンダリングだけでは、Reactは子を再マウントしないため、再マウントが原因だった根拠は弱い。
解決策
次の2つを同時に入れた。どちらが効いたかは、切り分けていない。
{loaderData.flashMessage && (
<FlashMessage
+ key={loaderData.flashMessage}
message={loaderData.flashMessage}
autoDismiss={true}
autoDismissDelay={5000}
/>
)}useEffect(() => {
if (!autoDismiss) return;
const timer = setTimeout(() => {
setIsVisible(false);
onClose?.();
}, autoDismissDelay);
return () => clearTimeout(timer);
- }, [autoDismiss, autoDismissDelay, onClose]);
+ }, [autoDismiss, autoDismissDelay]); // onCloseを除外推定が正しければ、効いたのは onClose の除外のほうである。key は、メッセージが変わったときにだけコンポーネントを作り直す指定で、同じメッセージの間は同一のものとして扱われる。
同じ轍を踏まないよう、CLAUDE.md には次のような追記を想定していた(現在のCLAUDE.mdには入っていない)。
### useEffectのタイマー注意事項
- useEffectのタイマーが動かない場合、依存配列のコールバック(参照が毎回変わる関数)と、コンポーネントの再マウントを疑う
- 条件付きレンダリングのコンポーネントには、同一性の基準になるkeyを付与する学び
- 依存配列に、親から渡されるコールバックを入れると、参照が変わるたびに
useEffectが再実行される。タイマーは、そのたびに0秒へ戻る。 - AIの「論理的に正しい」は、コードを読んだ結果であり、実行時の再実行回数までは見ていない。動かないときは、
useEffectの中にログを置き、再実行されているかを先に確かめる。 - 原因を切り分けずに、複数の修正を同時に入れると、どれが効いたかが残らない。次は、1つずつ入れて確かめる。
関連リソース
- React公式: リストとkey - keyの本来の用途
- Remix公式: ハイドレーション - SSRの制約