Technology

GitHubのコード差分表示、コメントの高さ計算を分離

この記事のポイント

  1. 実現したこと

    GitHub Copilot appの差分表示は、必要な行だけを生成し、画面外の行も含む長い変更をスクロールできる。

  2. 実現の仕組み

    高さが決まっているコード行と、表示後に高さが変わるコメントを別々に管理する。

  3. 得られた結果

    GitHubは、2,200ファイル、100万行超の変更、400件超のコメントを含むプルリクエストを開いた。

  4. 従来との違い

    コメントごとの監視処理が高さを直接書き戻す設計を退け、スクロール停止後に画面付近を計測する処理へ切り替えた。

明るい背景のコード差分に、行位置に結び付いた高さの異なるレビューコメントが並び、表示範囲内のコメントだけが計測されている概念図。
AI生成画像

コード差分の表示で、事前に高さが分かるコード行と、折り返しや画像で高さが変わるコメントの配置計算を分離した。GitHub Copilot appは、コード行の計算を保ったままコメントの高さを更新し、計測対象も画面付近に絞る。

コード行の仮想化にコメントの高さが加わる

GitHubが再構築した開発支援アプリGitHub Copilot appのプルリクエスト表示は、画面内とその周辺の行だけを生成する。スクロールに合わせてDOM要素を再利用する仮想化により、すべての行を同時に生成せずに長いコード差分を表示する。

コード行は既知の行高から位置を事前計算できる。一方、行の間に入るレビューコメントは、文章の折り返しや返信入力欄、画像の読み込みによって表示後も高さが変わるため、コード行と同じ前提では配置できない。

GitHubは、この表示機構で2,200ファイル、100万行超の変更、400件超のインラインレビューコメントを含む公開プルリクエストを開いたとしている。対象はコード行だけの長い差分ではなく、高さが変わるコメントも多数含む変更だった。

コメントが伸びてもコード行の計算を保つ

新しい構成は、コード行の高さと、レビューコメントや返信入力欄などの可変高ブロックの高さを別々の索引で管理する。コメントが伸び縮みしてもコード行側の配置計算を作り直さず、変わったブロックの高さを独立して扱う。

各ブロックには、内容の読み込みを挟んでも維持される安定したキーを付ける。位置はピクセル座標ではなくファイル、行、差分の左右の側に結び付け、再配置が起きても、どのコードに対応するコメントかを追えるようにした。

内容と幅が合う計測値を再利用する

可変高ブロックの配置に使う高さは、有効な実測値があればそれを優先する。実測値を使えない場合も、内容や展開状態などの識別情報と幅の条件が合うキャッシュ値があれば再利用し、それもなければ推定値を使う。

高さを測った際の幅は、細かな値をそのまま記録せず区間に丸める。この記録方法によって、通常のウィンドウサイズ変更で文書全体の計測値が一斉に無効になることを避けている。

高さの計測をスクロール停止後と画面付近に絞る

GitHubは当初、要素のサイズ変化を監視するResizeObserverが各ブロックの高さを直接レイアウトへ書き戻す設計を検討した。書き戻しが再び監視処理を呼び起こす循環につながり得るため、この設計は採用しなかった。

代わりに採用した計測処理は、表示範囲が落ち着いたときに動き、スクロール中は待機する。スクロールが止まると再び計測し、移動中に高さの更新が重なることを避ける。

計測候補も、表示領域からおよそ2,400ピクセル以内のブロックに限定する。遠くのコメントには推定高を使い続け、画面へ近づいた段階で高さを補正する。