Chrome DevToolsのヒープスナップショットでメモリリークを探す

​​Chrome DevTools​JavaScript

パネルを開いて閉じるたびにメモリが少しずつ増えていく、という JavaScript のメモリリークは、Chrome DevTools のヒープスナップショットで原因を探せます。操作の前と後で2回スナップショットを撮り、Comparison の表示で比べると、操作のたびに残っていくものの数が分かります。さらに Retainers の欄を見ると、それをつかんで離さないコードの行までたどれます。ここでは、閉じたはずのパネルが残る小さなページを作って、原因を見つけ、直したことを確かめるまでを試しました。

補足

検証環境は Ubuntu 24.04、Chrome for Testing 153.0.8010.12(Playwright に入っているもの)です。DevTools はウィンドウの下に置いて(Dock to bottom)使いました。DevTools の画面は英語の表示だったので、メニューやボタンは英語の表記で書いています。ページは手元で起動した HTTP サーバー(http://localhost:8080/)で配りました。Allocations on timeline などほかの記録の種類、React などのライブラリで作ったページ、macOS と Windows の Chrome は試していません。

閉じたパネルが残るページを用意する

「お届け日を選ぶ」ボタンを押すと、100 行のリストと「閉じる」ボタンが入ったパネルが開くページです。app.js は次のとおりです。

js
function openPanel() {
  const panel = document.createElement('div');
  panel.id = 'panel';
  const close = document.createElement('button');
  close.textContent = '閉じる';
  panel.appendChild(close);
  const list = document.createElement('ul');
  for (let i = 1; i <= 100; i++) {
    const li = document.createElement('li');
    li.textContent = `${i} 日後にお届け`;
    list.appendChild(li);
  }
  panel.appendChild(list);

  function fitPanel() {
    panel.style.width = `${Math.min(window.innerWidth - 48, 260)}px`;
  }
  window.addEventListener('resize', fitPanel);

  close.addEventListener('click', () => {
    panel.remove();
  });
  document.getElementById('slot').appendChild(panel);
}

document.getElementById('open').addEventListener('click', openPanel);

ウィンドウの幅が変わったときにパネルの幅を合わせるため、開くたびに window へ resize のリスナー fitPanel を登録しています。閉じるときには panel.remove() でパネルをページから外しますが、リスナーは外していません。

開いて閉じるのを5回くり返しても、ページ上の見た目は元どおりで、#panel の要素も 0 個でした。画面を見ているだけでは、何かが残っているとは分かりません。

操作の前と後で、スナップショットを2回撮る

ヒープスナップショットは、DevTools の Memory パネルで撮ります。タブの並びに Memory が見当たらないときは、コマンドメニュー(Ctrl+Shift+P)で Show Memory を選んでも開けます。手順は、公式ドキュメントのヒープスナップショットの説明にある、Comparison view の節と同じ流れです。

  1. ページを開いたら、Memory パネルで Heap snapshot が選ばれていることを確かめ、Take snapshot を押す(Snapshot 1)
  2. 漏れていそうな操作を何回かくり返す。ここでは「お届け日を選ぶ」→「閉じる」を5回
  3. 左の一覧の Profiles を押して最初の画面に戻り、もう一度 Take snapshot を押す(Snapshot 2)

左の一覧には、撮ったスナップショットが大きさ付きで並びます。今回は「Snapshot 1(1.5 MB)」と「Snapshot 2(1.8 MB)」でした。公式ドキュメントによると、スナップショットを撮るときは、必ず先にガベージコレクションが走ります。そして、どこからもたどれなくなったものは入りません。つまり、Snapshot 2 に残っているのは、まだどこかから参照されているものだけです。

くり返す回数は、きりのよい数にしておくと、表が読みやすくなります。5回なら、5や500のような数が並んだときに、操作のたびに残っているものだと見当を付けられます。

Comparison で、増えたものを数える

Snapshot 2 を選んだ状態で、表の左上の Summary を Comparison に切り替えます。Filter by class の欄の右には、比べる相手のスナップショットを選ぶ欄があります。ここが Snapshot 1 になっていれば、2回のスナップショットの差が表に並びます。

切り替えた直後の表には、(compiled code) や (object shape) のような、ページのコードとは関係の薄い行も多く並びました。そこで、Filter by class の欄に Detached と入れて、行を絞ります。「Detached」は、ページの DOM から外されたのに、JavaScript からはまだ参照されている要素(と、それに付いているブラウザの内部のデータ)に付く名前です。公式ドキュメントの、DOM から外れた要素(detached DOM tree)を探す節にも、こうした要素はメモリリークのよくある原因だと書かれています。

Comparison の表。Filter by class に Detached と入り、Detached <li> の # New が 500、Detached <div> と Detached <ul> と Detached <button> の # New が 5、どの行も # Deleted は 0
漏れているページで、Detached の行だけを残した Comparison の表

絞った後の表は、次のようになりました(主な行と列だけを抜き出しています)。

Constructor # New # Deleted # Delta Size delta
Detached <li> 500 0 +500 +52.0 kB
Detached Text 505 0 +505 +40.4 kB
Detached <button> 5 0 +5 +880 B
Detached <div> 5 0 +5 +520 B
Detached <ul> 5 0 +5 +520 B

New は Snapshot 1 の後に新しくできて残っている数、# Deleted は Snapshot 1 にあって消えた数、# Delta はその差です。<div>、<ul>、<button> がちょうど5個ずつ、<li> が 500 個増えていて、1つも消えていません。パネル1つに <div>、<ul>、<button> が1個ずつと <li> が 100 個あるので、閉じた5回分のパネルが、中身ごと全部残っていると分かります。Text の 505 も、<li> 500 個と「閉じる」ボタン5個の、文字の部分(テキストノード)の数と合います。

Retainers で、つかんでいるコードを探す

次に、何がパネルを離さないのかを調べます。表を Summary に戻すと、Filter by class の Detached は入ったままで、Detached <div> の行に「×5」と出ています。この行の左の三角を押すか、行を選んで → キーを押して開くと、Detached <div id="panel"> が5つ並びます。そのうちの1つを選ぶと、下の Retainers の欄に、その要素を参照しているものが木の形で並びます。いちばん上が、その要素を直接参照しているものです。

上の表で Detached <div id="panel"> の1つを選び、下の Retainers の欄に、panel in system / Context、context in fitPanel() と app.js:15、V8EventListener、EventListener と続き、Window / http://localhost:8080 まで並んでいる
閉じたパネルを選んだときの Retainers の欄

Retainers の欄の先頭は次のとおりでした(@ の後ろの数字は省いています)。

text
panel in system / Context / scope
  context in fitPanel()          app.js:15
    [1] in V8EventListener
      [1] in EventListener
        [1] in blink::RegisteredEventListener
          …
                  [25] in Window / http://localhost:8080

上から読むと、パネルは変数 panel として関数のスコープ(Context)に入っていて、そのスコープを fitPanel() が使っています。fitPanel() はイベントリスナー(EventListener)として登録されていて、さらに下へたどると Window に行き着きます。window に登録した resize のリスナーが残っているので、そのリスナーが使っている panel も消せない、という流れが読み取れます。

fitPanel() の行の右に出る app.js:15 は、その関数が書かれている場所です。app.js の15行目は、function fitPanel() { の行でした。

Retainers の欄の下のほうには、blink:: で始まる、ブラウザの内部の名前も並びます。すべてを読む必要はありません。自分のコードに出てくる変数名や関数名(ここでは panel と fitPanel())と、行き着く先(ここでは Window)を探すと、どこを直せばよいかの見当が付きます。

リスナーを外して、もう一度比べる

原因は、閉じるときに resize のリスナーを外していないことでした。閉じるボタンの処理に removeEventListener() を1行足します。

diff
   close.addEventListener('click', () => {
+    window.removeEventListener('resize', fitPanel);
     panel.remove();
   });

直したページで、同じ手順をもう一度試しました。Chrome は新しいプロファイルで起動し直しています。スナップショットの大きさは「Snapshot 1(1.5 MB)」と「Snapshot 2(1.6 MB)」でした。Comparison に切り替えて Filter by class に Detached と入れると、表には1行も出ませんでした。Summary に戻しても同じでした。

Comparison の表。Filter by class に Detached と入っているが、表の見出しの下に行が1つもない
直したページで、同じように Detached で絞った Comparison の表
ポイント

直した後も、Snapshot 2 は Snapshot 1 より 0.1 MB 大きく、フィルターなしの Comparison には (compiled code) の +416 などの行が残りました。この行は直す前のページでも同じように出ていたので、パネルの漏れとは別のものです。スナップショット全体の大きさの差だけで判断せず、Comparison で「操作の回数に合わせて増えているもの」を探すと、本当に漏れているものが見つかります。

​Posted by 86