Technology Engineering

178inaba の技術ブログ

gRPC(Go)でタイムアウト時にio.EOFエラーになる件を調査した

Go gRPC

WEB+DB PRESS Vol.110のgRPC特集がおもしろくて手を動かしながら読んでいる。

WEB＋DB　PRESS（Vol．110（2019）） Webアプリケーション開発のためのプログラミング技 特集：名前付け大全／速習gRPC／最新TLS1．3

WEB＋DB　PRESS（Vol．110（2019）） Webアプリケーション開発のためのプログラミング技 特集：名前付け大全／速習gRPC／最新TLS1．3

タイムアウト設定の事も書かれていて、そこに

設定した期限を過ぎた場合、クライアントスタブは応答を待ち受けるのをやめてステータスコードDeadlineExceeded(4)として処理を終了します。

とあったので試したところ、想定と異なった挙動になったのでメモしておく。

現象

一部省略するが、メインとなるコードは下記である。

    c := pb.NewFileServiceClient(conn)

    ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
    defer cancel()

    stream, err := c.Upload(ctx)
    if err != nil {
        log.Fatalf("Could not upload file: %v.", err)
    }

    buf := make([]byte, 1000*1024)
    for {
        n, err := fs.Read(buf)
        if err == io.EOF {
            break
        } else if err != nil {
            log.Fatalf("Could not read file: %v.", err)
        }

        if err := stream.Send(&pb.FileRequest{Name: filepath.Base(name), Data: buf[:n]}); err != nil {
            log.Fatalf("Could not send file: %v.", err)
        }
    }

    res, err := stream.CloseAndRecv()
    if err != nil {
        log.Fatalf("Could not receive response file: %v.", err)
    }

この時、私は stream.Send の部分で DeadlineExceeded エラーが返ると期待していたが実際は io.EOF エラーだった。

調査

気になったのでgrpc-goのコードを辿って調査した。
長くなるので重要だと思った箇所を記載する。

また、私の解釈としてStreaming RPCには接続保持側とストリーミング通信側があると解釈しているので2つに分けて記載する。
例えば上記コードで言うと Upload() が接続保持側で Send() がストリーミング通信側である。

接続保持側

Contextのハンドリングをしているのはこちら側

ここまでで接続保持側の終了処理が完了。

ストリーミング通信側

上記のように DeadlineExceeded ではないエラーが返り終了する。
ストリーミング通信側はContextを見るのではなく、接続保持側からの操作によって終了する。

解決策

Send でエラーが返ってきた場合、 Fatal 等で終了させずに break させて CloseAndRecv() まで実行してエラーハンドリングを行うと良い。
Send のエラーは警告くらいの気持ちで Print だけしておけば良いと思う。

   for {
        n, err := fs.Read(buf)
        if err == io.EOF {
            break
        } else if err != nil {
            log.Fatalf("Could not read file: %v.", err)
        }

        if err := stream.Send(&pb.FileRequest{Name: filepath.Base(name), Data: buf[:n]}); err != nil {
            log.Printf("Could not send file: %v.", err)
            break
        }
    }

    res, err := stream.CloseAndRecv()
    if err != nil {
        log.Fatalf("Could not receive response file: %v.", err)
    }

変更箇所は2行。

       if err := stream.Send(&pb.FileRequest{Name: filepath.Base(name), Data: buf[:n]}); err != nil {
-          log.Fatalf("Could not send file: %v.", err)
+           log.Printf("Could not send file: %v.", err)
+           break
        }

するとこんな感じでログが出る。

2019/04/29 08:18:57 Could not send file: EOF.
2019/04/29 08:18:57 Could not receive response file: rpc error: code = DeadlineExceeded desc = context deadline exceeded.
exit status 1

これでタイムアウトのときに DeadlineExceeded が返るようになった。

まとめ

  • タイムアウトだった場合でも Send() のエラーは io.EOF が返る。
  • Send() でエラーが出てもそこで終了せずに CloseAndRecv() まで実行してエラーを確認。
  • タイムアウトの場合は CloseAndRecv() のエラーで DeadlineExceeded エラーが取れる。

私はgRPCを仕事でも使ったのだが、protoファイルを書くだけでサーバのインタフェースとクライアントのAPIコール関数を生成してくれる。
サーバはインタフェースの実装を書くだけだし、クライアントは関数を呼び出す感覚でAPIコールができる。
これはすごく楽なのではないだろうか。

特にマイクロサービスアーキテクチャを採用している場合にはおすすめです！