楽しく向き合う例外対応

楽しく向き合う例外対応おくつ #phpcon_nagoya 1

$whoami = [ '名前' => 'おくつ', '所属' => '株式会社カオナビ', '職種'
=> 'バックエンドエンジニア', '特技' => '暮らし', '一言' => 'スイカが好きです', ]; #phpcon_nagoya 自己紹介 2

本番環境の例外対応をした経験ありますか？楽しかったですか？以降は、Laravel で構築されたアプリケーションにおける例外の話をします。 #phpcon_nagoya 3

Laravel(11.x) では、アプリケーション内の例外を bootstrap/app.php の withExceptions メソッドを使用して、例外をどのように報告するかを管理できます。以降ではアプリケーション内での例外について、通知したい例外クラスのみ
Slack の特定チャンネルで報告している前提としたいと思います。 #phpcon_nagoya Laravel における例外管理（Exception ） 4

報告原因調査 / 再現確認報告対応振り返り報告
検知対応検討 #phpcon_nagoya 対応の流れ 5

#phpcon_nagoya 検知 6

まずは第一報を上げる原因は分からないが、何かが発生していることを周知することで関係者の確認コストが減ります。発生日時影響範囲( 対象ユーザ・機能) 事象 #phpcon_nagoya 報告 7

具体的なエラーメッセージやスタックトレースを確認直近のデプロイや設定変更の確認 #phpcon_nagoya 原因の確認 8

エラー内容から、直近のデプロイや設定変更の影響であることが明らかな場合、戻します。 #phpcon_nagoya 原因の確認 9

エラーを再現していきます。手がかりを集め、条件や再現手順を特定します。 ( 名探偵になった気持ちで) #phpcon_nagoya 原因調査および再現確認 10

データの問題であるというエラーの場合、データベースの値を確認をします。そのデータの状態があり得るのか、何者かによって変更されたのか判断します。 #phpcon_nagoya 原因調査および再現確認 11

時系列で事象を整理単発の操作では再現できないとき前後のアクセスログを時系列で並べてみます。 #phpcon_nagoya 原因調査および再現確認 12

開発環境では再現できないな本番環境と開発環境の違いによる影響を考えます。たとえば、キャッシュの仕組みが異なるデータベースの構成が異なるなど #phpcon_nagoya 原因調査および再現確認 13

( ※注意：叫ぶ場所は選ぶこと) #phpcon_nagoya 開発環境で再現できました！ 14

回避方法の検討をします。もし、修正がすぐにできなかったとしても回避する方法を用いてユーザの目的が達成できるのであればそれを考えてみます。 #phpcon_nagoya 対応検討 15

コードに問題があるのであれば、修正方法を検討します。 #phpcon_nagoya 対応検討 16

ユーザにとってより良くて、かつ通知が来ない方法がないかという別の観点を考えてみます。データがなかった場合ユーザ入力値に問題がある場合( もしくは不正なリクエスト) ユーザ操作には影響させなくてよい場合 #phpcon_nagoya 対応検討 17

データがなかった場合元 $user = User::find($id); return response()->json([ 'id' => $user->id;
// $userがnullの時、ここでエラーになる ]); #phpcon_nagoya 対応検討 18

データがなかった場合こうする $user = User::find($id); if (!$user) { // データが存在することをチェックする
throw new NotFoundHttpException('該当のユーザは見つかりませんでした。'); } return response()->json(['id' => $user->id;]); ※ Laravel は、あらかじめいくつかのタイプのエラーを無視しています。NotFoundHttpException は無視されています。 #phpcon_nagoya 対応検討 19

ユーザ入力値に問題がある場合( もしくは不正なリクエスト) 元 $user_name = $request->input('user_name'); // usersテーブルのnameにNOT NULL 制約あり
User::create(['name' => $user_name]); リクエストの　'user_name' 　がnull の時... #phpcon_nagoya 対応検討 20

ユーザ入力値に問題がある場合( もしくは不正なリクエスト) こうする // バリデーションで弾かれた場合、ValidationException $request->validate([ 'user_name' => 'required|string|min:3|max:20', ]);
$user_name = $request->input('user_name'); User::create(['name' => $user_name]); ※ レスポンスを受け取る側で、エラーメッセージを表示する仕組みを作る必要があります。 #phpcon_nagoya 対応検討 21

ユーザ操作には影響させなくてよい場合たとえばログ通知の失敗とか、特定のオプション機能の失敗など class MyCustomValidationException extends Exception try { // 何か処理
} catch (MyCustomValidationException $e) { // 独自例外のみ捕捉し、何かする } // その他の例外はそのままthrow #phpcon_nagoya 対応検討 22

発生日時影響範囲( 対象ユーザ・機能) 事象原因回避方法対応目処 #phpcon_nagoya 報告 23

伝わる言葉でユーザの知りたいことを報告します。ユーザが知りたい情報は、自分にどんな影響があるのかどうすれば解決できるのか、あるいは待つしかないのか #phpcon_nagoya 報告 24

対応が完了したら、完了報告します。 #phpcon_nagoya 対応　　→ 　完了報告 25

人への責任のなすりつけ合いではなく、再発防止に目を向けましょう。ノーム・カースの最優先条項今日見つけたものが何であれ、チームの全員が、その時点でわかっていたことやスキルおよび能力、利用可能なリソースを余すことなく使って、置かれた状況下でベストを尽くした、ということを疑ってはならない。 #phpcon_nagoya 振り返りをしよう https://scrapbox.io/iki-iki/
ノーム・カースの最優先条項 26

例外通知対応があるなんて、ユーザが使っている証拠だからありがたいですね楽しく、冷静に、そしてユーザ視点で対応していきましょう！ #phpcon_nagoya まとめ 27

ご清聴ありがとうございました #phpcon_nagoya 28

楽しく向き合う例外対応

楽しく向き合う例外対応

okutsu

Other Decks in Programming

Featured

Transcript