インスタントリプレイでバグ報告。もう起きてしまったバグを保存
更新日
Midge のインスタントリプレイを使えば、バグが起きた後からでも報告できます。サイトでオンにしておくと、Midge はページの直近 30〜120 秒を常に記録し続け、ワンクリックでその範囲をバグ報告として保存します。コンソールログ、ネットワークリクエスト、ユーザー操作も添付されます。初期設定はオフで、サイトごと、またはすべてのサイトでオンにできます。
たまにしか起きないバグの厄介な点は、タイミングです。ドロップダウンがちらつく、トーストに間違ったメッセージが出る、テーブルがガクッと動く。録画ツールを起動するころには、もう消えています。インスタントリプレイがあれば、再現する必要はありません。すでに手元にあるのです。
仕組み
インスタントリプレイは動画を撮りません。記録するのはページそのもの、つまりブラウザが描画する要素とテキストの構造である DOM です。Midge はページのスナップショットを保存し、そこからノードの追加、クラスの切り替え、テキストの更新といったあらゆる変化を、スクロールやクリックとともに記録します。リプレイプレイヤーは、その記録からページを 1 ステップずつ組み立て直します。
バッファの長さは 30〜120 秒の範囲で選べます。新しい変化が入るたびに古いものから押し出されるので、メモリ使用量には上限があります。リプレイを保存するためにクリックすると、Midge はその時点のバッファを取り出し、同じ期間のコンソールログとネットワークログを加えて、レポートを作成できるようにします。
なぜ動画を撮り続けないのか
画面を常に録画して直近 2 分を残す方法も検討しました。採用しなかった理由は 2 つあります。
- キャプチャ中、Chrome は共有インジケーターを表示し続けます。 「このタブを共有しています」というバーが常に出ていると気が散りますし、本来は安全のためにある警告を無視する癖がついてしまいます。
- 動画は CPU、メモリ、バッテリーを消費します。 使っているすべてのタブで休みなくフレームをエンコードすれば、ブラウザが遅くなります。デバッグツールがやるべきこととは正反対です。
DOM の記録なら、どちらの問題も避けられます。ただし、ページの内容のコピーを保持するため、ログの記録よりは重くなります。だから、使いたいと決めるまではオフにしてあります。
オンにする方法
インスタントリプレイの初期設定はオフです。次のどちらかでオンにできます。
- 毎日さまざまなアプリをテストしているなら、すべてのサイトで。
- たとえば
staging.yourapp.comとlocalhostだけなど、サイトごとに。
記録しないサイトのリストが常に優先されます。そのリストにあるサイトでは、リプレイも含めて Midge はまったく動作しません。おすすめの初期設定は、ステージング環境とローカル開発用のホストでリプレイをオンにし、それ以外はオフのままにして、銀行とメールを記録しないサイトのリストに追加しておくことです。
リプレイのレポートに含まれるもの
保存したリプレイは、完全な Midge のレポートです。すべての録画に、コンソールログ、ネットワークリクエスト、ユーザー操作、デバイス情報が含まれます。リプレイも例外ではありません。リンクを開いた開発者が見られるのは次のとおりです。
- プレイヤーで再生されるページ。
- 同じ 30〜120 秒間のコンソールメッセージ。キャッチされなかったエラーも含みます(コンソールログを参照)。
- ボディとタイミング付きの fetch、XHR、WebSocket の通信(ネットワークログを参照)。
- クリック、ページの変化、入力した欄。入力したテキストそのものは含みません。
- ブラウザ、OS、ウインドウサイズ、ページの URL。
リプレイのプライバシー
リプレイにはページの内容が含まれるため、タブ録画の動画よりも厳しいルールを適用しています。
- すべての入力値がマスクされます。 どの欄に何を入力したかは、リプレイに表示されません。
- ページ上のテキストもスキャンされます。 ログと同じパターンで、JWT、Luhn チェックを通るカード番号、API キー、秘密鍵が取り除かれ、メールアドレスと国際電話番号は一部だけマスクされます。
- ログも伏せられます。 パスワード、カード番号、トークン、Cookie は、デバイスから送信される前にブラウザ内で伏せられます。
すべてのルールはマスキングのページに載せています。マスキングはルールベースなので、画面にプレーンテキストで表示された珍しい形式の機密情報は認識されない可能性があります。チームは独自のフィールド名を追加できます。
知っておきたい制限
DOM のリプレイは再構成であり、ピクセル単位のコピーではありません。ほとんどのページは忠実に再生されますが、canvas への描画やページ内で再生されるメディアなど、DOM で表現されない内容は、元とまったく同じには見えないことがあります。そういった見た目に関わるバグなら、代わりに画面録画を使ってください。
また、リプレイが記録できるのは動作していた時間だけです。1 分前にそのサイトでオンにしたのなら、バッファに入っているのは最大でもその 1 分間です。
インスタントリプレイが向いている場面
- 狙って再現できない、不安定な UI のバグ。
- 起きてみて初めてバグだとわかる、探索的テスト。
- ステージング環境でのデモやウォークスルーで、同僚の目の前で何かが壊れたとき。
いつでも再現できるバグなら、通常の録画や注釈付きのスクリーンショットで十分なことが多いです。どちらの場合でも何を含めるべきかの一般的なアドバイスは、「バグの報告方法」をお読みください。また、Midge を使っていなかったチームメイトから、ある出来事のネットワーク側の情報だけが欲しい場合は、HAR ファイルを送ってもらい、チケットに入れる前に無料の HAR サニタイザーできれいにしてください。
Midge は無料で、録画数は無制限、動画は最長 15 分、透かしも入りません。
よくある質問
- インスタントリプレイは動画ですか?
- いいえ。ページの構造(DOM)の変化を記録し、リプレイプレイヤーで組み立て直します。動画より軽く、Chrome の画面共有インジケーターが出っぱなしになることもありません。
- インスタントリプレイは最初からオンになっていますか?
- いいえ。オンにするまではオフのままです。すべてのサイトでオンにするか、選んだサイトだけでオンにできます。コンソールとネットワークの記録は、リプレイなしでも動作します。
- どのくらい前までさかのぼれますか?
- 30〜120 秒の範囲で選べます。リプレイを保存すると、クリックした時点からその秒数だけさかのぼった分が残ります。
- インスタントリプレイは入力した内容も記録しますか?
- いいえ。リプレイではすべての入力値がマスクされます。ページ上のテキストにもログと同じマスキングルールが適用されるため、トークンやカード番号などの値は取り除かれます。