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

このコミットは、Go言語の公式ツールであるgofixの内部的な修正順序の管理方法を変更するものです。具体的には、これまで明示的にリストで管理されていた各修正（fix）の適用順序を、各修正に付与された日付（dateフィールド）に基づいて暗黙的に決定するように変更しています。これにより、新しい修正の追加や、gofixを利用する他の開発者が独自の修正を組み込む際の柔軟性が向上しています。

コミット

commit d26144be298deeec4474796759073d743faf3bb4
Author: David Symonds <dsymonds@golang.org>
Date:   Fri Nov 4 08:34:37 2011 +1100

    gofix: make fix order implicit by date.
    
    This partially undoes 8fd7e6d070c8, but preserves its semantics.
    More importantly, it results in the data about each fix being
    decentralised, which makes it easier for new fixes to be added,
    and other gofix users to slot new fixes in.
    
    It also adds some useful metadata that could be used in the future.
    
    R=golang-dev, rsc
    CC=golang-dev
    https://golang.org/cl/5306092

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

https://github.com/golang/go/commit/d26144be298deeec4474796759073d743faf3bb4

元コミット内容

gofix: 修正の順序を日付によって暗黙的にする。

これは8fd7e6d070c8の変更を部分的に元に戻すものですが、そのセマンティクスは維持されます。より重要なのは、各修正に関するデータが分散化されることで、新しい修正の追加が容易になり、他のgofixユーザーが新しい修正を組み込みやすくなる点です。

また、将来的に使用できる有用なメタデータも追加されます。

変更の背景

Go言語は、その進化の過程でAPIの変更や言語仕様の調整が行われることがあります。これらの変更は、既存のGoプログラムが新しいバージョンのGoコンパイラでコンパイルできなくなる可能性や、意図しない動作を引き起こす可能性があります。このような互換性の問題を緩和するために、Goプロジェクトはgofixというツールを提供しています。gofixは、古いGoコードを新しいAPIや言語仕様に合わせて自動的に書き換える（修正する）役割を担っています。

このコミット以前のgofixでは、適用すべき修正のリストがsrc/cmd/gofix/fix.goファイル内に明示的に、かつ時系列順にハードコードされていました。コミットメッセージにある8fd7e6d070c8というコミットは、この「時系列順」という制約を導入したものです。これは、複数のAPI変更が連鎖的に発生する場合に、正しい順序で修正を適用する必要があるためです。例えば、あるAPIがAからBに変わり、その後BからCに変わった場合、AからBへの修正を先に適用し、その結果に対してBからCへの修正を適用する必要があります。

しかし、この明示的なリスト管理にはいくつかの課題がありました。

1. 新しい修正の追加の複雑さ: 新しい修正を追加するたびに、fix.goファイルを編集し、正しい時系列の位置に挿入する必要がありました。これは、特に多くの修正が存在する場合や、複数の開発者が同時に修正を追加する場合に、マージの競合やエラーの原因となる可能性がありました。
2. 分散化の欠如: 各修正に関する情報（名前、適用関数、説明など）は、それぞれの修正を定義するファイルに存在しますが、その適用順序に関するメタデータは一元的にfix.goに集約されていました。これにより、修正の定義と順序付けのロジックが分離され、管理が煩雑になっていました。
3. 外部からの利用の困難さ: gofixの内部ロジックを理解し、独自の修正を組み込みたい外部ユーザーにとって、この一元化されたリストは障壁となる可能性がありました。

このコミットは、これらの課題を解決するために、修正の順序を「日付」に基づいて暗黙的に決定するメカニズムを導入します。これにより、各修正は自身の定義ファイル内で自身が導入された日付を持つようになり、gofixツールは実行時にこれらの日付を基に修正をソートして適用するようになります。結果として、修正の追加が容易になり、データが分散化され、将来的な拡張性も向上します。

前提知識の解説

gofixツール

gofixは、Go言語のソースコードを自動的に書き換えるためのコマンドラインツールです。Go言語のバージョンアップに伴うAPIの変更や言語仕様の変更に対応するために使用されます。例えば、Go 1.0リリース前の開発段階では、APIが頻繁に変更されていたため、既存のコードを新しいAPIに適合させるためにgofixが不可欠でした。gofixは、Goの抽象構文木（AST）を解析し、定義されたルールに基づいてコードを変換します。

Go言語のAPI進化と後方互換性

Go言語は、安定したAPIを提供することを目指していますが、初期の段階や、より良い設計が発見された場合には、APIの変更が行われることがあります。このような変更は、既存のコードベースに影響を与えるため、gofixのようなツールが提供されることで、開発者がコードを最新のGoバージョンに容易に移行できるよう支援しています。

抽象構文木 (AST)

gofixのようなコード変換ツールは、通常、ソースコードを直接文字列として操作するのではなく、抽象構文木（AST）を介して操作します。ASTは、プログラムのソースコードの抽象的な構文構造を木構造で表現したものです。Go言語には、go/astパッケージがあり、GoのソースコードをASTにパースし、そのASTを操作するための機能を提供しています。gofixの各「fix」は、このASTを走査し、特定のパターンに合致するノードを見つけて、それを新しい構文に書き換える関数として実装されています。

gofixにおける「Fix」の概念

gofixにおける「fix」とは、特定のAPI変更や言語仕様の変更に対応するためのコード変換ルール一式を指します。各fixは、以下のような情報を持つ構造体として定義されます。

• 名前 (name): 修正を一意に識別するための文字列（例: error, netdial）。
• 適用関数 (f): 実際にASTを走査し、コードを書き換えるロジックを含む関数。
• 説明 (desc): その修正が何を行うのかを説明するテキスト。

このコミットでは、このfix構造体に新たにdateフィールドが追加され、修正が導入された日付を保持するようになります。

技術的詳細

このコミットの主要な技術的変更点は以下の通りです。

1. fix構造体へのdateフィールドの追加: src/cmd/gofix/fix.go内のfix構造体に、date stringフィールドが追加されました。このフィールドは、修正が導入された日付をYYYY-MM-DD形式で保持します。

   --- a/src/cmd/gofix/fix.go
   +++ b/src/cmd/gofix/fix.go
   @@ -24,6 +24,7 @@ import (
   
    type fix struct {
    	name string
   +	date string // date that fix was introduced, in YYYY-MM-DD format
    	f    func(*ast.File) bool
    	desc string
    }
   

2. fixesリストの変更とregister関数の導入: これまでfix.go内に明示的にハードコードされていたfixesというfixlist型のグローバル変数（各修正が時系列順に並べられていた）が、単なる[]fix型のスライスに変更されました。そして、各修正をこのfixesスライスに登録するためのregister関数が導入されました。

   --- a/src/cmd/gofix/fix.go
   +++ b/src/cmd/gofix/fix.go
   @@ -24,45 +24,29 @@ import (
   
    type fix struct {
    	name string
   +	date string // date that fix was introduced, in YYYY-MM-DD format
    	f    func(*ast.File) bool
    	desc string
    }
   
   -// main runs sort.Sort(fixes) before printing list of fixes.
   -type fixlist []fix
   -
   -func (f fixlist) Len() int           { return len(f) }
   -func (f fixlist) Swap(i, j int)      { f[i], f[j] = f[j], f[i] }
   -func (f fixlist) Less(i, j int) bool { return f[i].name < f[j].name }
   -
   -var fixes = fixlist{
   -	// NOTE: This list must be in chronological order,
   -	// so that code using APIs that changed multiple times
   -	// can be updated in the correct order.
   -	// Add new fixes to bottom of list.  Do not sort.
   -	httpserverFix,
   -	procattrFix,
   -	netdialFix,
   -	netlookupFix,
   -	tlsdialFix,
   -	osopenFix,
   -	reflectFix,
   -	httpFinalURLFix,
   -	httpHeadersFix,
   -	oserrorstringFix,
   -	sortsliceFix,
   -	filepathFix,
   -	httpFileSystemFix,
   -	stringssplitFix,
   -	signalFix,
   -	sorthelpersFix,
   -	urlFix,
   -	netudpgroupFix,
   -	imagenewFix,
   -	mathFix,
   -	ioCopyNFix,
   -	imagecolorFix,
   -	mapdeleteFix,
   +// main runs sort.Sort(byName(fixes)) before printing list of fixes.
   +type byName []fix
   +
   +func (f byName) Len() int           { return len(f) }\n+func (f byName) Swap(i, j int)      { f[i], f[j] = f[j], f[i] }\n+func (f byName) Less(i, j int) bool { return f[i].name < f[j].name }\n+
   +// main runs sort.Sort(byDate(fixes)) before applying fixes.
   +type byDate []fix
   +
   +func (f byDate) Len() int           { return len(f) }\n+func (f byDate) Swap(i, j int)      { f[i], f[j] = f[j], f[i] }\n+func (f byDate) Less(i, j int) bool { return f[i].date < f[j].date }\n+
   +var fixes []fix
   +
   +func register(f fix) {
   +	fixes = append(fixes, f)
    }
   

3. 各修正ファイルでのinit関数とregisterの利用: src/cmd/gofixディレクトリ内の各修正（例: error.go, filepath.goなど）のファイルに、init関数が追加されました。このinit関数内で、それぞれのfix構造体が定義され、新しく導入されたregister関数を使ってグローバルなfixesスライスに登録されるようになりました。また、各fix構造体の定義には、その修正が導入された日付がdateフィールドとして追加されています。

   例: src/cmd/gofix/error.go

   --- a/src/cmd/gofix/error.go
   +++ b/src/cmd/gofix/error.go
   @@ -11,11 +11,12 @@ import (
    )
   
    func init() {
   -\tfixes = append(fixes, errorFix)
   +\tregister(errorFix)
    }
   
    var errorFix = fix{
    	\"error\",
   +\t\"2011-11-02\",
    \terrorFn,
    \t`Use error instead of os.Error.
   

4. main.goでのソートロジックの変更: src/cmd/gofix/main.goにおいて、gofixが実際に修正を適用する前に、fixesスライスをdateフィールドに基づいてソートするようになりました。これにより、明示的なリスト順序ではなく、日付順に修正が適用されることが保証されます。

   --- a/src/cmd/gofix/main.go
   +++ b/src/cmd/gofix/main.go
   @@ -54,6 +54,8 @@ func main() {
    	flag.Usage = usage
    	flag.Parse()
   
   +\tsort.Sort(byDate(fixes))
   +\n \tif *allowedRewrites != \"\" {
    \t\tallowed = make(map[string]bool)\n     \t\tfor _, f := range strings.Split(*allowedRewrites, \",\") {
   

   また、利用可能な修正を一覧表示する際には、これまで通り名前順でソートされるように、sort.Sort(byName(fixes))が使用されています。

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

このコミットのコアとなる変更は、以下の3つのファイルに集約されています。

1. src/cmd/gofix/fix.go:

   • fix構造体にdateフィールドが追加されました。
   • fixesグローバル変数が、明示的なリストから空のスライス[]fixに変更されました。
   • register(f fix)関数が追加され、各修正をfixesスライスに動的に追加するメカニズムが提供されました。
   • byDateという新しいsort.Interface実装が追加され、fix構造体をdateフィールドでソートできるようになりました。

2. src/cmd/gofix/*.go (各修正ファイル):

   • 各修正ファイル（例: error.go, filepath.goなど）にfunc init()ブロックが追加されました。
   • このinit関数内で、そのファイルで定義されているfix構造体（例: errorFix）がregister()関数に渡され、グローバルなfixesスライスに登録されるようになりました。
   • 各fix構造体の定義に、その修正が導入された日付を示すdateフィールドが追加されました。

3. src/cmd/gofix/main.go:

   • main関数内で、実際に修正を適用する前にsort.Sort(byDate(fixes))が呼び出され、修正が日付順にソートされるようになりました。

コアとなるコードの解説

fix構造体とdateフィールド

type fix struct {
	name string
	date string // date that fix was introduced, in YYYY-MM-DD format
	f    func(*ast.File) bool
	desc string
}

dateフィールドは、この修正がGoのAPIや言語仕様に導入された日付をYYYY-MM-DD形式で記録します。この日付が、gofixが複数の修正を適用する際の順序を決定するための主要なキーとなります。これにより、修正の定義と順序付けのロジックが各修正ファイルに分散され、中央集権的なリスト管理が不要になります。

register関数とinit関数

// src/cmd/gofix/fix.go
var fixes []fix

func register(f fix) {
	fixes = append(fixes, f)
}

// src/cmd/gofix/error.go (例)
func init() {
	register(errorFix)
}

Go言語のinit関数は、パッケージが初期化される際に自動的に実行される特別な関数です。各修正ファイルにinit関数を定義し、その中でregister関数を呼び出すことで、そのファイルで定義されたfix構造体が、プログラムの起動時に自動的にグローバルなfixesスライスに追加されます。これにより、開発者は新しい修正を追加する際に、単に新しい修正ファイルを作成し、その中にfix構造体とinit関数を記述するだけでよくなり、既存のfix.goファイルを変更する必要がなくなります。これは、モジュール性と拡張性を大幅に向上させます。

byDateソートインターフェース

// src/cmd/gofix/fix.go
type byDate []fix

func (f byDate) Len() int           { return len(f) }
func (f byDate) Swap(i, j int)      { f[i], f[j] = f[j], f[i] }
func (f byDate) Less(i, j int) bool { return f[i].date < f[j].date }

byDate型は、Goのsort.Interfaceインターフェース（Len, Swap, Lessメソッドを持つ）を実装しています。Lessメソッドは、2つのfix要素のdateフィールドを比較し、日付が古い方が「小さい」と判断します。これにより、sort.Sort(byDate(fixes))を呼び出すと、fixesスライス内のすべての修正が、その導入日付の古い順にソートされることが保証されます。これは、APIの変更が時系列で発生し、その順序で修正を適用する必要があるというgofixのセマンティクスを維持するために不可欠です。

main.goでのソート適用

// src/cmd/gofix/main.go
func main() {
	// ...
	sort.Sort(byDate(fixes))
	// ...
}

main関数内でsort.Sort(byDate(fixes))が呼び出されることで、gofixが実際にユーザーのコードに修正を適用する前に、すべての修正が日付順に並べ替えられます。これにより、gofixは常に正しい順序で修正を適用し、APIの連鎖的な変更に適切に対応できるようになります。

この変更は、gofixの内部アーキテクチャをより堅牢で拡張性の高いものにし、Go言語の進化に対応するためのツールとしての柔軟性を高めるものです。

関連リンク

• GitHubコミットページ: https://github.com/golang/go/commit/d26144be298deeec4474796759073d743faf3bb4
• Go Code Review (CL): https://golang.org/cl/5306092

参考にした情報源リンク

• Go言語のgofixツールに関する一般的な情報:
  • Go言語の公式ドキュメントやブログ記事（gofixの歴史や目的について）
  • Go言語のソースコード（特にsrc/cmd/gofixディレクトリ）
• Go言語のinit関数に関する情報:
  • Go言語の公式ドキュメント: https://go.dev/doc/effective_go#init
• Go言語のsort.Interfaceに関する情報:
  • Go言語の公式ドキュメント: https://pkg.go.dev/sort#Interface
• 抽象構文木 (AST) に関する一般的な情報:
  • Go言語のgo/astパッケージのドキュメント: https://pkg.go.dev/go/ast
• コミットメッセージに記載されている以前のコミット 8fd7e6d070c8 の内容（gofixの修正順序に関する背景理解のため）
  • GitHubコミットページ: https://github.com/golang/go/commit/8fd7e6d070c8
• Go言語のAPI変更履歴に関する情報（gofixの必要性を理解するため）
  • Go言語のリリースノートや互換性に関するドキュメント
• Go言語のgofixツールに関する議論や記事（Stack Overflow, Goコミュニティのブログなど）

これらの情報源は、gofixの機能、Go言語のAPI進化の背景、およびこのコミットが導入した技術的な変更の意義を深く理解するために参照されました。