errors.Asを使ってDBエラーのハンドリングをする

goで受け取ったエラーがDBエラーかどうかを判定してハンドリングしたい場面があった。
こういうケースどうしたらいいんだっけと思った時にerrors.Asを使ったらいい感じにやりたいことができたので記載しておく。

errors.Isとerrors.Asはもうすでにいくつか記事があるが、goのエラーハンドリングの仕方についてあまり精通していなく、自分なりに使った上で深掘って調査したことを載せておきたかったのでここで。

動作環境
go: 1.18

やりたかったこと

クリーンアーキテクチャっぽい構成にしており、依存関係はcontroller → interactor → databaseとなっている。(interfaceは簡略化のため省略)

この状況で以下のような要件を満たしたかった

・databaseでエラーが起こった時にinteractorでそのエラーをwrapしてcontrollerに返す
・controllerではエラーの内容で処理を変える
　　・DBエラーの場合はその内容に応じてレスポンスを変える
　　・DBエラーじゃない場合は500エラーにする

つまりcotnrollerでエラーハンドリングする際に、DBで起こったエラーなのかどうなのかということを判定した上でハンドリングしたかった。

DBエラーの内容をもう少し具体的に言及しておくと、insert処理の時にprimary keyが重複していてエラーになったかどうかを判別したい。

errors.Asを使う

結論errors.Asを使えばうまくできたのだが、それぞれのレイヤーでエラーをどう扱っているかを順番に見ていく

dabatases層

単に発生したエラーをinteractorに返すだけ。

interactors層

エラーが発生した場合にどこで発生したかのスタックトレースが追えるようにxerrorsを使ってwrapした上でcontrollerに返している。

err := i.Repository.Create(userID)
if err != nil {
		return xerrors.Errorf("failed to Create: %w", err)
}

controllers層

いよいよ本命。
errが存在した時にその内容に応じてレスポンスを返したい。
まず、DBエラーかどうかを判定したい。DBエラーじゃない場合は全て500エラーにする。

今回はmysqlを使っていたのでエラーが起こった場合はmysql.MySQLErrorが返されている。
以下のようにして、errors.Asでmysqlエラーかどうかを判定して、そうだった場合はさらにエラーコードで条件分岐をしている。

1062はprimary keyの重複で既にデータが作成されていることを示す。
今回はこの場合エラーではなく204を返すこととしている。それ以外のDBエラーは400エラーにしている。
(実際には1062はconstで変数定義している)

var dbErr *mysql.MySQLError
if errors.As(err, &dbErr) {
	if dbErr.Number == 1062 {
		ctx.JSON(http.StatusNoContent, nil)
		return
	}
	ctx.JSON(http.StatusBadRequest, map[string]interface{}{"message": dbErr.Message})
	return
}

errors.Asやerrors.Isは受け取ったエラーでの比較がfalseだった場合にはUnwrapした上で再評価を繰り返すようになっているので、今回のようにinteractorsでエラーをwrapしていても問題なく使えた。

このエラーの時にログを送るとしてもinteractorsでxerrorsを使ってエラーをラップしているので、どこでエラーが起きたかをちゃんとスタックトレースで追うことができるようになっている。

errors.Asの挙動

errors.Asは第一引数に判定したいエラーそのものを、第二引数に判定したいエラーの型のポインタをtargetとして渡すようになっている。
一つ疑問だったのがこれがtrueだった場合に、その中ではtargetの方を使って条件分岐の判定を行なっていること。(dbErr.Numberの部分)

var dbErr *mysql.MySQLError
if errors.As(err, &dbErr) {
	if dbErr.Number == 1062 {
		...
	}
}

最初に初期化しているので、あたかもerrの中身がこのtargetであるdbErrにコピーされているみたいな挙動になっている。
これは実際その通りで、ちゃんとドキュメントにも書いてあった。

As finds the first error in err’s chain that matches target, and if one is found, sets target to that error value and returns true.

https://pkg.go.dev/errors#As

実装を見てもそれっぽい箇所が見つかった。

val := reflectlite.ValueOf(target)
...
val.Elem().Set(reflectlite.ValueOf(err))

確かにそうしないと元のエラーをわざわざキャストしなきゃいけなくて使いにくそう。
かしこ。

実装する上で調査・考慮したこと

gormでのエラーコード

今回はDBエラーだった場合にそのエラーの内容をMySQLのエラーコードで判定するようにした。
gormを使っていて、SELECTした時に該当のレコードが見つからなかった場合は、以下のようにgormのエラー定義を使ってerrors.Isで判定するのが一般的かと思う。

if erros.Is(err, gorm.ErrRecordNotFound) {
	...
}

なので、今回もgorm側でいい感じに判定できないかなと思ったのだがどうやらgormで用意しているエラー定義は限られたものだけっぽい。

GitHub

gorm/errors.go at master · go-gorm/gorm The fantastic ORM library for Golang, aims to be developer friendly - go-gorm/gorm

issueを見てみると今回みたいにMySQLのエラーコードで判定しているものがあったのでその方法を採用した。

GitHub

How to check if error type is DUPLICATE KEY · Issue #4037 · go-gorm/gorm Your Question I have unique index key and when i try to insert duplicate record i get this error ERROR: duplicate key value violates unique constraint "idx_item...

errors.Isとの違い

これもいろんなところで既にまとめられてたりするが改めて。

errors.Isは値そのものを比較している。構造体で比較する場合は内容が同じでも参照が異なる場合はfalseになる。
従って以下のように中身が同じ構造体を用意して比較してもfalseになった。

myErr := &mysql.MySQLError{Number: 1062, Message: "Duplicate entry '1-1' for key 'index_foo'"}
if errors.Is(err, myErr) {  // 中身が同じでもfalseになる
	...
}

内部実装を見てみたが、errors.Isでgorm.ErrRecordNotFoundが比較できるのは、内部で作成した同じ変数を比較しているからだと思われる。

// package logger
var ErrRecordNotFound = errors.New("record not found")

// package gorm
var ErrRecordNotFound = logger.ErrRecordNotFound

errors.Asは型としての比較なので内容が異なっていてもtrueとなる。
むしろ今回見たようにtargetとして用意したものに中身がコピーされる。

いくつか記事を見ているとerrors.Isはwrapしたものについては使えないという記述がちらほら見られたがこれは誤りだと思う。
そういった挙動に見えるのはおそらく上記のように参照が異なるケースが大半ではないだろうか。
そもそもerrors.Isの実装を見るとUnwrapして比較してるので、wrapしたものが使えないとこの実装の意味がなくなってしまう。

エラーハンドリングのレイヤー

今回はcontorllerでエラーの内容に応じてレスポンスを変更するようにした。
責務的にはこれでいいかなとは思っているのだが、とはいえinteractorsでエラーを返すのは様々なケースがありそうなのでcontrollerで全てのケースのエラーハンドリングをするのは厳しい気もしている。

interactorsでエラーを返す時にstatus code込みで返せば解決するだろうが責務的にどうなんだという気もして悩ましい。
今回みたいにcontrollerで事足りる場合はcontroller、厳しい場合はinteractorというのも一貫性がなくて気持ち悪い。

そもそもinteractorsでエラー返すようにすれば、dbエラーかどうかはinteractorsがその場で判断できるので今回みたいなerrors.Asとかする必要もない。

この辺はやりながらどういう形が良さそうかもう少し考えていきたい。

まとめ

errors.Isはこれまで何度か使ったことがあったが、errors.Asはどう使っていいかふわふわしてたのでちゃんと使い方が理解できたし、ついでにerrors.Isの挙動もちゃんと深ぼって理解できた。

標準パッケージ含んだ処理もデバッガーで追いながら動作確認できるの非常に理解が進むのでよい。

この記事が参考になったからコーヒーくらいおごってもいいぜという方は、以下からサポートいただけると次の記事書くモチベになりますのでよろしくお願いします

参考