Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 13526] ファイルの概要

このコミットは、Goプロジェクトのコードレビューダッシュボードにおける、Change List (CL) の状態管理に関する修正です。具体的には、レビュー担当者がゼロになったCLを「クローズ済み」として解釈するロジックが追加されました。これにより、CLの作者以外の人物によってCLが提出された後、作者がクライアントを同期する前の状態でも、ダッシュボード上でCLが正しくクローズ済みとして表示されるようになります。

コミット

commit 482ceeda6df719004f15068c93d4ed17a83f3869
Author: David Symonds <dsymonds@golang.org>
Date:   Mon Jul 30 13:51:21 2012 +1000

    misc/dashboard/codereview: interpret zero reviewers as the CL being closed.
    
    This is the state when the CL has been submitted by someone other than
    the CL author, but before the CL author has synched their client.
    
    R=golang-dev, rsc
    CC=golang-dev
    https://golang.org/cl/6458044

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/482ceeda6df719004f15068c93d4ed17a83f3869

元コミット内容

misc/dashboard/codereview: interpret zero reviewers as the CL being closed.

This is the state when the CL has been submitted by someone other than
the CL author, but before the CL author has synched their client.

R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/6458044

変更の背景

この変更の背景には、Goプロジェクトが利用していたコードレビューシステム（おそらくGoogleのGerritベース、またはそれに類似したシステム）における、Change List (CL) の状態管理の課題がありました。

通常、コードレビュープロセスでは、提案された変更（CL）に対してレビュー担当者が割り当てられ、彼らがコードをレビューし、承認または却下を行います。CLが最終的に承認され、メインブランチにマージ（提出）されると、そのCLは「クローズ済み」の状態になります。

しかし、特定のシナリオ、特に「CLの作者以外の人物によってCLが提出された場合」に問題が発生していました。このような状況では、CLは実際に提出されていても、コードレビューシステムがその状態を正しく反映せず、ダッシュボード上ではまだ「オープン」な状態として表示されてしまうことがありました。これは、CLの作者が自身のローカルクライアントを同期するまで、レビュー担当者のリストがクリアされない、あるいはダッシュボードがその状態変化を即座に認識できないことに起因していたと考えられます。

この不整合は、開発者がダッシュボードを見てCLの実際の状態を誤解する原因となり、混乱を招く可能性がありました。そのため、レビュー担当者がゼロになったCLは、それが提出済みであるか、あるいは手動でレビュー担当者が削除された結果であるかにかかわらず、「クローズ済み」として扱うことで、ダッシュボードの表示と実際のCLの状態との乖離を解消する必要がありました。

前提知識の解説

このコミットを理解するためには、以下の概念について理解しておく必要があります。

  • Goプロジェクトのコードレビュープロセス: Goプロジェクトは、Googleの内部ツールであるGerritをベースとしたコードレビューシステムを使用しています。開発者は変更を提案する際に「Change List (CL)」を作成し、これをレビューシステムにアップロードします。他の開発者（レビュー担当者）がそのCLをレビューし、コメントや承認を行います。最終的にCLが承認され、メインリポジトリにマージされると、そのCLはクローズされます。
  • Change List (CL): Gitのコミットに相当する概念ですが、Goのコードレビューシステムでは「変更のまとまり」を指します。一つのCLは一つ以上のコミットを含むことができ、レビューと承認の単位となります。
  • Go Dashboard: Goプロジェクトの様々な側面（ビルドの状態、テスト結果、コードレビューの状況など）を可視化するためのウェブインターフェースです。このコミットで修正されているのは、コードレビューの状況を表示する部分（misc/dashboard/codereview）です。
  • Google App Engine (GAE): Googleが提供するPaaS (Platform as a Service) で、ウェブアプリケーションやモバイルバックエンドを構築・ホストするためのプラットフォームです。Goのダッシュボードは、Google App Engine上で動作していることが、コード内の appengine.Context の使用から推測されます。GAEは、スケーラブルなアプリケーションを簡単にデプロイできる特徴があります。
  • JSON (JavaScript Object Notation): 軽量なデータ交換フォーマットです。ウェブAPIとの間でデータをやり取りする際によく用いられます。このコミットでは、APIからのレスポンスをGoの構造体にマッピングするためにJSONタグが使用されています。
  • Go言語の構造体とJSONタグ: Go言語では、構造体のフィールドにjson:"field_name"のようなタグを付けることで、JSONデータと構造体のフィールドをマッピングできます。これにより、JSONのキー名とGoの構造体のフィールド名を異なるものにしたり、特定のフィールドをJSONに含めないようにしたりする制御が可能です。
  • len()関数: Go言語の組み込み関数で、スライス、配列、マップ、文字列などの長さを返します。このコミットでは、レビュー担当者のスライス（apiResp.Reviewers）の要素数をチェックするために使用されています。

技術的詳細

このコミットは、GoのコードレビューダッシュボードがCLの状態を判断するロジックを改善することを目的としています。ダッシュボードは、コードレビューシステムからCLの情報をAPI経由で取得し、それを表示しています。

問題は、CLが提出されたにもかかわらず、ダッシュボードがそのCLを「クローズ済み」と認識しないケースがあったことです。これは特に、CLの作者ではない別のユーザーがCLを提出した場合に顕著でした。このような状況では、APIから返されるCL情報において、レビュー担当者のリストが空になることがありましたが、ダッシュボードはその状態を「クローズ済み」とは解釈していませんでした。

この修正では、以下の技術的な変更が加えられました。

  1. APIレスポンス構造体の拡張: コードレビューシステムからCL情報を取得する際に使用されるGoの構造体 apiResp に、Reviewers というフィールドが追加されました。このフィールドは、CLに割り当てられているレビュー担当者のメールアドレスの文字列スライス（[]string）を保持します。json:"reviewers" タグにより、APIレスポンスのreviewersというJSONキーに対応付けられます。
  2. 「レビュー担当者ゼロ」の解釈ロジックの追加: updateCL 関数内で、APIから取得したCL情報（apiResp）の Reviewers フィールドの長さをチェックするロジックが追加されました。具体的には、len(apiResp.Reviewers) == 0、つまりレビュー担当者が一人もいない場合、そのCLは「クローズ済み」であると判断し、ダッシュボードの内部表現である cl.Closed フィールドを true に設定します。

この変更により、CLが提出されてレビュー担当者がいなくなった場合でも、ダッシュボードがその状態を正しく「クローズ済み」として表示できるようになりました。コミットメッセージにあるように、これはCLが提出されたが作者がまだクライアントを同期していない状態や、手動でレビュー担当者が削除されたCLにも対応します。

コアとなるコードの変更箇所

変更は misc/dashboard/codereview/dashboard/cl.go ファイルに対して行われました。

--- a/misc/dashboard/codereview/dashboard/cl.go
+++ b/misc/dashboard/codereview/dashboard/cl.go
@@ -294,12 +294,13 @@ func updateCL(c appengine.Context, n string) error {
 	}\n \n \tvar apiResp struct {\n-\t\tDescription string `json:\"description\"`\n-\t\tCreated     string `json:\"created\"`\n-\t\tOwnerEmail  string `json:\"owner_email\"`\n-\t\tModified    string `json:\"modified\"`\n-\t\tClosed      bool   `json:\"closed\"`\n-\t\tSubject     string `json:\"subject\"`
+\t\tDescription string   `json:\"description\"`
+\t\tReviewers   []string `json:\"reviewers\"`
+\t\tCreated     string   `json:\"created\"`
+\t\tOwnerEmail  string   `json:\"owner_email\"`
+\t\tModified    string   `json:\"modified\"`
+\t\tClosed      bool     `json:\"closed\"`
+\t\tSubject     string   `json:\"subject\"`
 \t\tMessages    []struct {\n \t\t\tText       string   `json:\"text\"`\n \t\t\tSender     string   `json:\"sender\"`
@@ -334,6 +335,13 @@ func updateCL(c appengine.Context, n string) error {\n \tif i := strings.Index(cl.FirstLine, \"\\n\"); i >= 0 {\n \t\tcl.FirstLine = cl.FirstLine[:i]\n \t}\n+\t// Treat zero reviewers as a signal that the CL is completed.\n+\t// This could be after the CL has been submitted, but before the CL author has synced,\n+\t// but it could also be a CL manually edited to remove reviewers.\n+\tif len(apiResp.Reviewers) == 0 {\n+\t\tcl.Closed = true\n+\t}\n+\n \tlgtm := make(map[string]bool)\n \tnotLGTM := make(map[string]bool)\n \trcpt := make(map[string]bool)\n```

## コアとなるコードの解説

このコミットの核となる変更は以下の2点です。

1.  **`apiResp` 構造体への `Reviewers` フィールドの追加**:
    ```go
    var apiResp struct {
        Description string   `json:"description"`
        Reviewers   []string `json:"reviewers"` // 追加された行
        Created     string   `json:"created"`
        OwnerEmail  string   `json:"owner_email"`
        Modified    string   `json:"modified"`
        Closed      bool     `json:"closed"`
        Subject     string   `json:"subject"`
        Messages    []struct { /* ... */ }
    }
    ```
    この変更により、コードレビューシステムからCLの情報を取得する際に、レビュー担当者のリスト（`reviewers`）もJSONレスポンスから `apiResp.Reviewers` フィールドに自動的にマッピングされるようになりました。これにより、Goのプログラム内でレビュー担当者の情報を利用できるようになります。

2.  **レビュー担当者数に基づくCLクローズロジックの追加**:
    ```go
    	// Treat zero reviewers as a signal that the CL is completed.
    	// This could be after the CL has been submitted, but before the CL author has synced,
    	// but it could also be a CL manually edited to remove reviewers.
    	if len(apiResp.Reviewers) == 0 {
    		cl.Closed = true
    	}
    ```
    このコードブロックは、`updateCL` 関数内で実行されます。`apiResp.Reviewers` の長さがゼロである（つまり、レビュー担当者が一人も割り当てられていない）場合、`cl.Closed` フィールドが `true` に設定されます。`cl` はダッシュボードがCLの状態を管理するために使用する内部構造体です。

    このロジックは、以下のシナリオに対応します。
    *   **CLが提出された後**: CLが提出されると、通常はレビュー担当者の割り当てが解除されるため、`Reviewers` リストが空になります。この場合、ダッシュボードはCLをクローズ済みとして認識します。
    *   **CL作者がクライアントを同期する前**: CLが作者以外の人物によって提出された場合、作者のローカルクライアントがまだ同期されていない状態でも、レビュー担当者リストが空になることがあります。この修正により、ダッシュボードは即座にCLをクローズ済みとして表示できます。
    *   **手動でレビュー担当者が削除された場合**: 何らかの理由で手動でレビュー担当者がCLから削除された場合でも、このロジックによりCLがクローズ済みとして扱われる可能性があります。これは、レビュー担当者がいないCLは、もはやアクティブなレビューが必要ないという一般的な仮定に基づいています。

このシンプルな変更により、ダッシュボードのCL状態表示の正確性が向上し、開発者がCLのライフサイクルをより正確に把握できるようになりました。

## 関連リンク

*   GitHub上のコミットページ: [https://github.com/golang/go/commit/482ceeda6df719004f15068c93d4ed17a83f3869](https://github.com/golang/go/commit/482ceeda6df719004f15068c93d4ed17a83f3869)
*   Go Code Review CL: [https://golang.org/cl/6458044](https://golang.org/cl/6458044)

## 参考にした情報源リンク

*   Go Code Review Comments: [https://go.dev/doc/contribute#code_reviews](https://go.dev/doc/contribute#code_reviews) (Goのコードレビュープロセスに関する一般的な情報)
*   Google App Engine Documentation: [https://cloud.google.com/appengine/docs](https://cloud.google.com/appengine/docs) (Google App Engineに関する一般的な情報)
*   JSON and Go: [https://go.dev/blog/json](https://go.dev/blog/json) (GoにおけるJSONの扱いに関する公式ブログ記事)
*   Gerrit Code Review: [https://www.gerritcodereview.com/](https://www.gerritcodereview.com/) (Goプロジェクトが利用しているコードレビューシステムのベースとなっているGerritに関する情報)
*   Go Dashboard (Source Code): [https://github.com/golang/build/tree/master/cmd/dashboard](https://github.com/golang/build/tree/master/cmd/dashboard) (Goダッシュボードのソースコードリポジトリ。`misc/dashboard` はこのリポジトリの一部である可能性が高い)