プレビューを開き、閉じて、もう一度開く。すると次の更新でコールバックが2回呼ばれます。アプリを再起動すれば直りますが、同じ操作でまた発生します。イベントの送信側を変更する前に、最初のプレビューが何を残したかを調べましょう。
複数のプレビューが、個々のビューより長く生きるイベントバスを共有しているとします。小さな Node.js の例なら、ウィンドウを描画せずに開閉を再現できます。各段階でどの購読が残っているかを追うのがポイントです。
開き直す前後で購読を数える
開き直した後に change を1回だけ発行します。リスナー数と、更新を受け取ったビューの両方を記録します。
| 操作 | 不具合のある実装のリスナー数 | 修正版のリスナー数 |
|---|---|---|
| 開く前 | 0 | 0 |
| 最初のビューを開く | 1 | 1 |
| 最初のビューを閉じる | 1 | 0 |
| 次のビューを開く | 2 | 1 |
| イベントを1回発行 | 両方のビューが受信 | 次のビューだけが受信 |
最初に疑うべき変化は、最初のビューを閉じた場面です。そこで購読が消えるはずでした。更新ハンドラーだけを読んでいては、その前に起きた問題を見落とします。
この例では listenerCount('change') で数を調べ、emit でコールバックを同期的に呼びます。タイマーも連打も使わずに、重複した通知を再現できます。
関数の見た目ではなく参照を追う
次のマウント関数には不具合があります。戻り値の関数は、呼び出し元がビューを閉じるときに実行する想定です。
export function mountUnsafeView(bus, publish) {
bus.on('change', (value) => publish(value));
return () => bus.off('change', (value) => publish(value));
}
on と off に渡すアロー関数は同じ見た目ですが、それぞれの式を評価すると別の関数オブジェクトが作られます。解除時に探すのは新しいオブジェクトなので、元の購読は残ります。最初のコールバックは、最初に渡された通知先にも引き続きアクセスできます。
Node の off は、指定したリスナーを削除する removeListener の別名です。ここでは Events API リファレンスを確認します。この EventEmitter の例では、イベント名と関数本体が同じだけでは足りず、登録した関数そのものの参照が必要です。
マウントごとに解除関数を返す
コールバックを一度だけ作り、解除用クロージャーに同じ参照を保持させます。
export function mountView(bus, publish) {
const onChange = (value) => publish(value);
bus.on('change', onChange);
let disposed = false;
return function dispose() {
if (disposed) return;
disposed = true;
bus.off('change', onChange);
};
}
各マウントが独自の onChange を作ります。返された dispose は、そのマウントの購読だけを解除し、2回目以降は何もしません。フラグが繰り返し呼び出しの動作を明示し、別々の関数参照がマウントを区別します。
2つのビューに同じ publish を渡しても、ラッパー関数はそれぞれ別なので購読は独立します。両方のビューが publish をそのまま on に渡すと同じ関数が2回登録され、off 1回では片方しか外れません。最後の再現テストがこの状況を示します。解除関数は、それを作ったビューと一緒に保持してください。閉じる前に破棄したり上書きしたりすれば、修正版でも自動的には解除できません。
他の購読者がいる状態で解除をテストする
他に購読のないバスで、閉じた後のリスナー数がゼロか確かめるテストは有用ですが、それだけでは不十分です。removeAllListeners に置き換えても通ってしまい、共有バスを使う他の処理まで更新を受け取れなくなります。
そこで例では、独立したオブザーバーを登録してから古いビューを開閉し、新しいビューを開きます。その後で古い解除関数をもう一度呼び、イベントの受信先を調べます。
| 確認する場面 | 必要な結果 |
|---|---|
| 古い解除関数を再度呼んだ後の更新 | オブザーバーと新しいビューが受信 |
| 新しいビューを2回閉じた後の更新 | オブザーバーだけが受信 |
| 同じ通知関数を使う2つのビューの片方を閉じる | 残ったビューは受信を続ける |
| 開閉を3回繰り返す | 開いている間は各1回、閉じた後は受信しない |
数だけでなく、実際の受信先もアサートします。1つ残っていても、それがオブザーバーか古いビューかは数だけでは分かりません。新しいマウントの後で古い dispose を呼ぶと、解除処理が共有の可変状態を参照してしまう問題も検出できます。
実際の呼び出し元から終了経路まで読む
知らないコードも、同じ順序で読み進めます。
- イベントバスの作成場所を探し、画面遷移をまたいで生きるのか、1つのビューだけに属するのか調べる。
- すべての登録箇所を探し、開く操作、描画、再接続でそれぞれ何回通るか確認する。
- 登録から解除まで、同じコールバック参照を追う。
mountViewの呼び出し元が戻り値をどこに保存するか確認する。- ビューの置き換えや初期化失敗も含め、関連する終了経路から
disposeの呼び出しを探す。
登録箇所の横に、管理する側と終了箇所を書き留めます。解除関数を一度も呼ばない問題と、違う参照で呼ぶ問題では修正が異なります。コールバックが非同期処理を始めるなら、その先も追います。購読の解除では、すでに始めた処理は取り消せません。非同期 UI 状態を追う記事がその続きを扱います。
実行して、適用範囲を確認する
event-listener-lifecycle.mjs をダウンロードし、Node.js 22 以降で実行します。
node --test event-listener-lifecycle.mjs
5件すべてのテストが通ります。reproduce: で始まる2件は、再度開いた後の購読の残留と、同じ関数を2回登録して1回だけ解除した場合の残留を意図的に確認します。残りの3件は解除、繰り返し呼び出し、購読者同士の独立性を確認します。追加の依存関係もタイマーも不要です。
この演習は EventEmitter でビューの寿命を模擬します。ブラウザーは再現しておらず、DOM EventTarget と同じ動作を保証するものではありません。登録はマウントごとに1回、解除はイベント発行の間に行います。発行中の解除、フレームワークのエフェクト、実行中の処理のキャンセルは、実際の API に沿って別途確認してください。
Yenpo では入口と解除処理のファイルを開いたまま、保存されたコールバックを両方の箇所で追うところから始められます。