アルパカ三銃士

〜アルパカに酔いしれる獣たちへ捧げる〜

gRPC Application のエラー設計

Web アプリケーションで error code, error message を返したくなる時があるはずです。HTTP JSON API とかでたまに見るのは status code が 200 なのに error が返ってくるものです。gRPC ではどうすれば良いのでしょうか。基本をおさらいしつつ浅く考えてみます。

Status Code

成功すると response と status code OK が返ってきます。

何かしらのエラーが発生すると OK 以外のエラー status code が返ってきます。statuscodes.md にも記載されてますが、これらのコードは必ずしも server から返るわけではなく、client 自身が返す場合もあります。

基本的には gRPC アプリケーションで発生したエラーによって status code を変更するような設計にするかと思います。しかし、時には gRPC server (low level) で発生したエラーとアプリケーションのロジックで発生したエラーを分けたい & client にそのエラーの詳細を伝えたいといった事があるかと思います。そのような時は Richer error model を採用しましょう。

Error Details

Google では開発に使用しているエラーモデルが存在します。このモデルに記述されている details がどんなエラーが発生していたのかを詳しく表現できるようなフィールドになってます。Google では一般的なエラーのニーズ(リトライ情報、不正なパラメータの情報など)をカバーできるように proto が定義されてます。これらのような proto を details のフィールドへ格納することで表現することができます。

gRPC ではこのモデルに沿ってエラーを返せるようになってます。エラー詳細は response に付属される metadata 内に details というキーに対して格納されて返ってきます。

  • エラーコード
    • status code
  • エラーメッセージ (ライブラリの実装に依存するとのこと)
    • Go や Nodejs では error として手に入る
    • Go (server) -> PHP (client) だと details に string として含まれて手に入る
      • 例: {"metadata":{},"code":5,"details":"sql: no rows in result set"}
  • エラー詳細: gRPC の response に付属される metadata に details というキーに対して格納されて返ってくる

もちろん Google が定義した proto メッセージではなく、自前で proto を定義するのもありでしょう。

まとめ

  • gRPC では OK 以外はエラーとして扱うことを推奨されてる
  • エラー詳細は response の metadata を使う。details というキーに対して格納していく。

お試し

gRPC の server, client の挙動の確認ができる testing-grpc というものを作りました。このプロジェクトは grpc/grpc-go を使って開発されてますが、他の言語で(例えば PHP)実装された gRPC server, client にも同様の知識を応用できるのではないかと考えてます。

(もし宜しければ github star をお待ちしてます)

github.com

asciicast

xcode をインストールしてない macOS で lldb を使うまで

mac を開発端末にしたいけど xcode をインストールしたくないという場合、xcode を appstore からインストールするのではなく、command line tools のみをインストールする必要がある。

インストールするために xcode-select -- install を実行する。これをやることで mac 上で homebrew が使えるようになったりする。

私の環境には homebrew 経由でインストールした lldb (/usr/local/opt/llvm/bin/lldb) があった。最近 neovim のコードを読むことにハマってるので久しぶりにデバッグするしようとしたら次のエラーメッセージが表示された。

$ lldb -p $(pgrep nvim)
(lldb) process attach --pid 35912
error: attach failed: unable to locate debugserver

今まで xcode をインストールした状態でデバッグを行ってたので、このケースに初めて遭遇した。debugserver がないとのこと。検索すると command line tools をインストールしてるなら /Library/Developer/CommandLineTools/Library/PrivateFrameworks/LLDB.framework/Versions/A/Resources/debugserver に存在するという情報を入手した。(確かにあった)

それで今度はこの debugserver を lldb に認識して貰う必要があるが、検索してもなかなかヒットせずかなり困った。

続きを読む

プリエンプティブな GCE インスタンスの外部 IP を固定する

最近 iPad Pro を購入したため、これを開発環境のとしても活用できると良いなと思い、GCP でプリエンプティブな GCE インスタンスを作成した。

インスタンスhttps://github.com/<username>.keys 経由で取得できる github に登録した自分の公開鍵を設定した。こうすることで秘密鍵github に使っているものを利用することができる。

これで手元の ~/.ssh/config をこんな感じで修正すればもう使えるものだと思ってた。

Host gce
  Hostname <external-ip>
  IdentityFile ~/.ssh/github
  User codehex
  ForwardAgent yes

実際には使えていたが、暫くすると external-ip (以降、外部 IP)が突然変わってしまって毎回 config ファイルを修正していた。しかし、これではしんどいのでちゃんと固定される外部 IP を固定することにした。下記は実際にやった手順を示してる。

続きを読む

Debian 9 stretch に rootless docker をインストールする

f:id:codehex:20200418163433j:plain

root 権限外で docker コンテナを動かしたくなったので rootless docker を利用してみることにした。rootless docker のインストールガイドは下記のリンクで読むことができる。

docs.docker.com

DEBIAN GNU/LINUX といったセクションもあって rootless docker をインストールするために書かれてる事を実行する。

私の場合は、docker-ce をインストール済みだったので apt コマンドで削除し、ユーザー権限も sudo usermod -aG docker codehex みたいな感じで設定済みだったため、stack exchange を参考にしながら sudo gpasswd -d codehex docker といった感じで削除した。

あとはサイトの Install にも書かれてる次のワンライナーを実行するだけでインストールできる。

$ curl -fsSL https://get.docker.com/rootless | sh

しかし、インストール後に肝心の systemctl --user start docker を下記のメッセージが表示されるだけで実行できなかった。

$ systemctl --user start docker
Failed to connect to bus: No such file or directory

これを解決するために https://get.docker.com/rootless の shell script を読んだ。

続きを読む

neovim コメント内で改行した時に自動でコメントされるのを防ぐ

最近 neovim を使い始めていて、vim を使ってる時から気になってた問題に向き合うことにした。この問題がどんな内容かというと

“ vim ファイルでのコメント

といったコメントを記入していてカーソルが行の最後に来た時、エンターキーを入力して改行するはずである。その時に

“ vim ファイルでのコメント
“ 

といった感じで、カーソルの前にコメント文字が勝手に入力されてしまうことである。

この問題を全てのファイルフォーマットに対して解決したかった。ググってみると沢山の情報が出てきた。例えば init.vim

set fo-=c fo-=r fo-=o

を記入すると解決するみたいな内容ばかりで、実際にはどれも解決しなかった。それで Twitter 上でいじけてると、通りすがりの暗黒美無王さんから次のようなヒントをもらった。

続きを読む

homebrew を使って gomod 経由で Go のバイナリをインストールする

Go 1.14 では modules がついに production ready な状態になった。

これまで ghq といったツールを使い、GOPATH 直下に自分のワークスペースを作って開発するといった手法とはお別れになるだろう。開発に関してはとても便利になったが、これまで go getgo install で Go のバイナリをリモートからインストールしていたが、 modules を使っているワークスペース上で行うと、プロジェクトに使われる module としてインストールされてしまうため、良い方法はまだ存在しない。

しかし、global install ができるようしたい!といった issue は既に存在するため将来的には可能になるかもしれない。

そんな中、Go Hacker の一人である @FiloSottile 氏が homebrew と gomod を組み合わせて、上記で記述したやりたいことが実現できるツールを開発していた。

続きを読む

Go で AND, OR 条件付きのテキストマッチを行う

AND, OR 条件付きでテキストがマッチしてるか確認する関数を作る。

PerlPHP 等の PCRE をサポートしてる正規表現を使う場合は、こんな感じでいい。

/(?=.*(hello|world))(?=.*(foo|bar))/

regex101.com

こうすると

hello, foo
hello, bar
world, foo
world, bar

といったそれぞれの文字列にマッチする。「hello または worldかつfoo または bar」にマッチするかどうかという関数を作りたい。

それで、この正規表現を組み立てるようなコードを書いてみたけど、Go ではこの (?=re) といった肯定先読みの表現がサポートされておらず、困ってしまった。

そこで、自力でロジックを書くことにしたが...

続きを読む