Doneの定義

下記のメッセージが表示されないようになっていること

http: superfluous response.WriteHeader call  ...

補足情報

HTTP レスポンスの Writeの後に WriteHeader が実行されているため、上記のメッセージが表示されてしまっている

Doneの定義

• matryer/moq が導入され、既存の mock コードが moq によって自動生成されたコードに置き換わっていること
• moq による mock の自動生成の方法が README に記載されていること

Doneの定義

• 表題の通り

補足情報

#20 の対応で MySQL のコンテナを Docker ネットワーク上で起動するように変更したため、Mac上でテストを実行するとエラーとなってしまう。
テストも Docker で実行できるように対応する。

Doneの定義

表題の通り

Doneの定義

• ECS タスクの定義が lgtm-cat-api で管理される状態となっていること

補足情報

ECS タスクの定義を Terraform で管理しているが、以下の課題があるためアプリケーション側に寄せる方針とした

• ECR イメージタグを変更不可にしたことで、Terraform によるタスクの変更（環境変数の追加など）のあとに、アプリケーションの変更をせずにデプロイするとエラーになってしまう（ECR へのプッシュでエラーになる）
• ECS タクスの変更はアプリケーションの変更に合わせて頻繁に発生するから、lgtm-cat-api に定義されていた方が開発しやすい
• Terraform でタスクの定義を更新してもアプリケーションのデプロイを行わない場合、古いリビジョンのタスクの定義が利用され続ける可能性がある

Doneの定義

• Node.js 12 actions are deprecated. の warning が表示されなくなっていること

補足情報

https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

Doneの定義

• usecaseのテストコードが作成されている事
• DBのテストは実データを使ったテストが実行出来るようになっている事

Doneの定義

• Linterの実行が可能になっている事

補足情報

参考

• https://zenn.dev/sanpo_shiho/books/61bc1e1a30bf27/viewer/eb3425
• https://github.com/nekochans/portfolio-backend/blob/main/.golangci.yml

Doneの定義

表題の通り

補足情報

現状はログが構造化されていないため、JSON形式で出力されるように変更する

Doneの定義

• https://github.com/go-chi/chi のREADMEの通り github.com/go-chi/chi/v5 を利用するように変更されている事

補足情報

IFは変わらないのでおそらくそれほど改修に時間はかからないと思われる。

Doneの定義

表題の通り

Doneの定義

• エラーをラップする形でエラーの発生箇所が特定出来るようになっている事

補足情報

#11 (comment) のコメントで議論した内容

Doneの定義

Lambda から ECS への移行に必要な対応がされていること

• ヘルスチェックエンドポイントの作成
• Docker イメージの作成
• ミドルウェア Nginx の追加

完了の定義

• Base64形式の画像を受け取り nekochans/lgtm-cat-terraform#12 で作成したS3バケットに画像データが保存される事
• .jpg, .png を受け付けるようになっている事

参考資料

https://future-architect.github.io/articles/20200927/

Doneの定義

• 下記の記事を参考に、エラーの設計が変更されていること

https://kaminashi-developer.hatenablog.jp/entry/2022/12/15/093000

Doneの定義

• main ブランチへのマージ時にステージング環境にデプロイされるようになっている事
• GitTagが追加されたタイミングで本番環境にデプロイされるようになっている事

Doneの定義

• 環境構築と動作確認方法がドキュメント化されている事
• CONTRIBUTING.md にリリース方法が記載されている事

Doneの定義

表題の通り

補足情報

#74 の対応で API Gateway のオーサライザーを利用できなくなるため、アプリケーションでアクセストークンの検証を行う必要が発生した。

Doneの定義

表題の通り

補足情報

panic 発生時に panic のリカバリを行わないとクライアントにレスポンスを返すことができないため。

参考
https://moneyforward.com/engineers_blog/2020/09/09/goroutine-panic-handling/

Doneの定義

• テストでreflect.DeepEqual の代わりに google/go-cmp を利用して構造体の比較が行われるようになっていること

補足情報

現時点では複雑な構造体を比較するケースは存在しないが、go-cmp を利用することでテスト結果のDiffが見やすくなるだけでも生産性が上がると考えられるため導入する。

Doneの定義

net/httpパッケージ内部のロガーが独自のロガーに変更され、JSON形式のログが出力されるように変更されていること

補足情報

参考: 『O’Reilly 実用Go言語』(p.286 net/httpのエラーログをカスタマイズ)

net/http パッケージのHTTPサーバーはコネクションを受け付けやハンドラーで予 エラーが発生した場合、標準エラー出力にエラーログを出力するようになっています。デフォルトでは logパッケージのロガーを用いてエラーログを出力します。

Doneの定義

表題の通り

補足情報

https://github.com/nekochans/lgtm-cat-api/blob/main/domain/create_lgtm_image_usecase.go#L47

Doneの定義

PlanetScaleに接続可能となっていること

補足情報

https://planetscale.com/docs/concepts/secure-connections#certificate-authorities

Doneの定義

表題の通り。

補足情報

同階層にテストを作成する場合に名前が衝突するのを防ぐために、ユースケース毎に別々のパッケージに分ける

Doneの定義

• テスト用のDBに接続するusecaseのテストケースが追加されていること

完了の定義

• 表題のAPIが実装されている事

Doneの定義

• PR作成時にLinterの実行が行われるようになっている事
• PR作成時にテストコードが実行されるようになっている事

Doneの定義

• 慣例にならってエラーに関する変数の名前が変更されていること
  • Error インターフェースを満たす Error 型として振る舞う型の名前は接尾語にErrorをつける
  • エラーの変数は Err から始める

完了の定義

• Hello WorldレベルのAPIが作成されている事
• 上記がデプロイ出来る状態になっている事

Doneの定義

• 表題の件が実施されている事

補足情報

golangci/golangci-lint#2374 が解決しないと golangci-lint が利用出来ないのでそれが終わってから実施する。

これが対応されれば対応自体はそれほど時間がかからないハズ。

Doneの定義

表題の通り。

補足情報

Decoder()メソッドは io. Reader インタフェースを満たしている型のデータを元にデコー ドできるので、httpRequest.Body などは json.NewDecoder を利用できる。

Doneの定義

• 利用するGoのバージョンが1.17系に変更されている事

完了の定義

• アクセストークンがないリクエストは403エラーを返すように設定されている事

補足情報

APIGateway v2のJWT AuthとCognitoUserPoolを利用する。

https://github.com/keitakn/go-cognito-lambda

Doneの定義

• docker-composeでローカルで環境構築が出来る状態になっている事
• ホットリロード、デバッカーが利用出来る状態になっている事

補足情報

cmd/local/main.go 等のローカルで動作させる為のファイルを作成するのが楽そう。

https://github.com/nekochans/portfolio-backend/blob/main/docker/go/Dockerfile

Doneの定義

• 新着順にLGTM画像が取得出来るようになっている事

Doneの定義

表題の通り

Doneの定義

表題の通り

補足情報

• 関数名は NewXxx()とする

Doneの定義

• 補足情報に記載してある画像（3.7MB）がアップロード出来ない原因が判明し必要に応じて修正用のissueが作成されている事（このissueの見積もり内で解決しそうであればこのissueで解決してもOK）

補足情報

以下の画像を利用。

Doneの定義にも書いてあるが https://github.com/nekochans/lgtm-cat-image-recognition に定義されているねこ画像判定APIだと問題ないが画像アップロードAPIの場合は500エラーを返してしまう。

echo '{"image" : "'"$( base64 ./mop.png)"'", "imageExtension": ".png"}' | \
curl -v -X POST -H "Content-Type: application/json" \
-H "Authorization: Bearer 発行したアクセストークン" \
-d @- https://image-recognition-api.lgtmeow.com/cat-images/validation-results | jq

{
  "isAcceptableCatImage": true
}

同じAPI GatewayV2を使っているのでpayloadサイズの限界とは違うと思うので原因を調査したほうが良さそう。

またこの現象が解消する事でユーザーがより大きなサイズの画像をアップロード出来るようになるのでその意味でも解決する価値はそれなりにあると考えている。

Doneの定義

• S3やRDSの接続に失敗した場合、アプリケーションで定義したエラーがレスポンスとして返ること
  ( context でタイムアウトを30秒以内に設定することで回避する)

補足情報

S3へのアップロードやRDSへの接続に失敗した場合、API Gateway のタイムアウト時間内にLambdaの処理が終わらないのでエラー 503 { "message": "Service Unavailable" }となる。
Lambda自体のタイムアウトは15分となっている。

なお、LambdaのタイムアウトをAPI Gatewayyより短くしLambdaがタイムアウトになった場合、500 { "message": "Internal Server Error" }になる。

Doneの定義

表題の通り

補足情報

#69 の対応で Table Driven Test に変更可能なテストケースになったため。
Table Driven Test の方が可読性、保守性が高いと考えられるため テストケースを Table Driven Test に変更する。

Doneの定義

• https://docs.aws.amazon.com/ja_jp/apigateway/latest/developerguide/http-api-cors.html を参考にCORSに必要なHTTP レスポンス Headerが追加されている事

補足情報

https://github.com/go-chi/cors を追加する事で実現出来そう。

本件の実施理由に関しては nekochans/lgtm-cat-terraform#73 を参照。

また本件は nekochans/lgtm-cat-frontend#146 を解決する為に実施する。