gin-study

Go 言語での勉強用 CRUD(TODO 管理)アプリ
gin-study ってレポジトリ名だけど gRPC・DB 接続周り・テスト記述方法の勉強用って感じ

構成案

• バックエンド：Go(Gin GRPC )
• フロントエンド：TypeScript(React)
• DB：MySQL

TODO（勉強がてらやってみたいこと含む）

• MySQL コンテナの立ち上げ（my.cnf 準備含む）
• API 設計(gRPC) https://user-first.ikyu.co.jp/entry/2019/06/17/100000あたりを参考にしてみる
• ダミーのメソッドでサーバー起動（CatServer）
• 実際の API の定義に従って受け口だけ用意
• リクエストのログ出力設定
• interceptor 以外でも zap でログが出せるようにする
• DI 設定　参考：https://christina04.hatenablog.com/entry/google-wire
• 環境変数の読み込み設定
• DB 設定
• GORM 設定
• フォーマットとか lint 系の設定（golangci-lint）
• READ 機能の実装（全取得）
• CREATE 機能の実装
• バリデーション実装する（まずは Create 分）
• gorm の time の警告対応：https://github.com/go-sql-driver/mysql#timetime-supportに書いてある
• UPDATE 機能の実装（バリデーション含む）
• DELETE 機能の実装（バリデーション含む）
• ID によるタスク取得機能の実装
• タスク作成時の RegisterdAt, updatedAt の時刻が ms まで入ってる。秒だけで十分なので直す。
• タスク名での検索
• 重要度での検索
• 検索結果の戻り値に ImportanceName がないので修正
• 検索条件に期限日時が使えるようにする
• 検索機能の全般的な動作確認
• Lint か何かで英単語と日本語の間にスペースが入るようになってしまってるので直す →Prettier のデフォルト設定だしで一旦スルーすることにする
• 例外処理（grpc_recovery のミドルウェア使いつつ）
• マイグレーションツールの設定
• 環境に応じてダミーデータを投入したりしなかったりできるようにする → ダミーデータは make ファイルで適宜入れさせるようにした
• ダミーデータを複数行書いても問題なく投入できるようにする
• ER 図自動生成の設定(SchemaSpy) https://dev.classmethod.jp/articles/schemaspy-doc/あたりを参考にしてみる → schemaspyUser(pass: schemaspyPass)は SELECT 権限のみ付与、mysql_native_password 方式で認証させるようにして useSSL=false・allowPublicKeyRetrieval=true の設定を追加（ローカル実行だし）、schemaspy のイメージに用意されている JDBC ドライバは MySQL6 系なので 8 用の jar ファイルを落としてきてマウントして使わせる　等の作業がいろいろ必要だった・・・。
• DB 定義変更を試してみる
• DB 周辺のテスト記述
• toDTO()は presentation 部分で呼び出した方が、grpc でない時にも presentation 層だけで対応できるしいい気がする
• GitHubAction で push 後自動でテスト実施
• .env.test ファイルをプロジェクトルートに移動（repository_impl のテストでの env ファイル読み込みでエラーが起きないようにパス設定をあれこれ直す必要あり）
• presentation のテスト記述：https://moneyforward.com/engineers_blog/2021/03/08/go-test-mock/を参考にモック用意（インターフェース用意が必要）
• infrastructure のテストで isTest フラグを使っている箇所を除去する。設定必須の環境変数 ENV の値で管理して分岐させることにして、通常コードがテストのことを意識しなくて済むようにする
• usecase のテスト記述　https://zenn.dev/sanpo_shiho/articles/01da627ead98f5あたり参考にしてみる
• usecase のテストは DB 処理まで実際に行わせるので、infra 層のテストと並列実行にならないようにしないとテスト失敗するかも？：infra と usecase は別 DB に接続してテストを行うようにした
• go の version の最新化：https://www.yoshiislandblog.net/2021/10/27/go_go_module_mode/https://tenntenn.dev/ja/posts/2021-06-27-xxenv/https://qiita.com/frozenbonito/items/f8569e7afd17ea76b1ab辺りを参考に
• dockerignore がちゃんと効いているか確認：綴り間違えてたけど修正してちゃんと COPY 対象から除外されていた。
• コメントアウト部分の整理
• アプリも Docker コンテナとして動かす：.env ファイルなどビルド時じゃなくて実行時に必要なファイル類を runner 側にコピーする必要あり。mysql コンテナとアプリ用コンテナが別なので、コンテナ間通信ができるように docker のネットワーク設定が必要。
• Dockerfile の runner を ubuntu ではなく distroless を利用する：debug のイメージ利用だとエラーが出る、、debug じゃなければエラーなく動くけど、、、
• Docker イメージとして動かしつつデバッグできるようにする vscode 上でデバッグが楽だしでまあやらなくていいかな、、
• AWS にデプロイして動かす（CloudFormation 等利用） 別でやる
• ローカルで JMeter で負荷をかけてみる　別でやろう、、
• Cognito で認証機能をつける（基本知識をまずつけるところから）　 CloudFormation と合わせて別で実施

起動メモ

• 起動時引数でどの環境用の環境変数ファイルを読み込むかを指定する（ex. ENV=local とすると.env.local が読み込まれる）