マイグレーションをAtlasに移行 #1216

ikura-hamu · 2025-05-05T09:07:12Z

マイグレーションに Atlas を使うように変更した

🩹 atlas のツール
🔧 localhostからdbにアクセスできるようにする
🏭 現在のスキーマを生成
✨ atlasをアプリに組み込む
✅ データ入れる系マイグレーションのテスト
🩹 wireの設定
🔧 ローカル環境の設定
🩹 本番のイメージにatlas入れる
🩹 データ入れる系のmigrationをSQLでやる
🚧 既存の構造体をいったんコピー
🔧 atlasのローカルの設定
🩹 diffが少なくなるように
🏭 gormの構造体にあわせるマイグレーション
🩹 migrateパッケージの構造体に型エイリアス貼る
🔧 ホットリロードにSQLも含める
🔧 CIでmigrationのLint
🔧 Taskfileにmigrate関係のコマンド追加
📝 マイグレーションのドキュメントを追加

Copilot

Pull Request Overview

This PR migrates the database migration mechanism to use Atlas, updates the DB initialization, and adjusts configuration and CI to support the new migration workflow.

Updated table aliases in Gorm migration files to point to new Atlas schema definitions.
Integrated migration configuration into DB initialization and tests.
Enhanced Docker, Taskfile, and CI configurations for Atlas migration and linting.

Reviewed Changes

Copilot reviewed 24 out of 31 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/repository/gorm2/migrate/current.go	Updated table aliases to reference the new Atlas schema definitions
src/repository/gorm2/db_test.go	Added migration configuration mocks for Atlas integration tests
src/repository/gorm2/db.go	Updated DB initialization to incorporate migration configuration and Atlas
src/config/v1/migration.go, env.go	Introduced migration configuration interface and environment variables
src/config/migration.go	Added migration interface definition
migrations/export.go	Incorporated migration file export using embed.FS
docs/migration.md	Updated documentation for Atlas migration usage
docker/dev/compose.yaml, docker/base/compose.yaml	Adjusted Docker configs to support Atlas migration and DB access
Taskfile.yml	Added new tasks for migration management
.github/workflows/ci.yaml	Added a CI job for Atlas migration linting

Files not reviewed (7)

atlas.hcl: Language not supported
docker/dev/Dockerfile: Language not supported
docker/production/Dockerfile: Language not supported
go.mod: Language not supported
migrations/20250327121655.sql: Language not supported
migrations/20250505054607_organize_indices.sql: Language not supported
migrations/atlas.sum: Language not supported

Comments suppressed due to low confidence (1)

src/repository/gorm2/migrate/current.go:7

[nitpick] The alias 'GameTable' for a v1 table now references 'schema.GameTable2', which could be confusing. Consider clarifying the naming or adding a comment to indicate that v1 and v2 share the same underlying table.

GameTable                   = schema.GameTable2

src/repository/gorm2/db.go

docker/base/compose.yaml

github-actions · 2025-05-05T09:28:54Z

Migrate lint

Lint output

Error: git diff: exit status 128

codecov · 2025-05-05T09:30:50Z

Codecov Report

Attention: Patch coverage is 1.35135% with 146 lines in your changes missing coverage. Please review.

Project coverage is 49.15%. Comparing base (b52eeb4) to head (8207614).
Report is 23 commits behind head on main.

Files with missing lines	Patch %	Lines
src/repository/gorm2/schema/migrate.go	0.00%	69 Missing ⚠️
src/repository/gorm2/schema/v2.go	0.00%	30 Missing ⚠️
src/repository/gorm2/schema/schema.go	0.00%	26 Missing ⚠️
src/config/v1/migration.go	0.00%	18 Missing ⚠️
src/wire/wire_gen.go	0.00%	2 Missing ⚠️
src/repository/gorm2/db.go	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1216      +/-   ##
==========================================
- Coverage   49.78%   49.15%   -0.64%     
==========================================
  Files         123      127       +4     
  Lines       11157    11301     +144     
==========================================
  Hits         5555     5555              
- Misses       5304     5448     +144     
  Partials      298      298

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2025-05-05T09:36:28Z

Migrate lint

Lint output

Analyzing changes until version 20250505054607 (2 migrations in total):

-- analyzing version 20250327121655
  -- no diagnostics found
-- ok (440.421µs)

-- analyzing version 20250505054607
  -- constraint deletion detected:
    -- L4: Dropping foreign-key constraint
       "fk_edition_game_version_relations_edition_table_v2"
       https://atlasgo.io/lint/analyzers#CD101
    -- L4: Dropping foreign-key constraint
       "fk_edition_game_version_relations_game_version_table2_v2"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint
       "fk_game_genre_relations_game_genre_table_v10"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint
       "fk_game_genre_relations_game_genre_table_v11"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint
       "fk_game_genre_relations_game_genre_table_v12"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint
       "fk_game_genre_relations_game_genre_table_v13"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint "fk_game_genre_relations_game_table2_v11"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint "fk_game_genre_relations_game_table2_v12"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint "fk_game_genre_relations_game_table2_v13"
       https://atlasgo.io/lint/analyzers#CD101
    -- L6: Dropping foreign-key constraint "fk_game_genre_relations_game_table2_v5"
       https://atlasgo.io/lint/analyzers#CD101
    -- L8: Dropping foreign-key constraint
       "fk_game_version_game_file_relations_game_file_table2_v2"
       https://atlasgo.io/lint/analyzers#CD101
    -- L8: Dropping foreign-key constraint
       "fk_game_version_game_file_relations_game_file_table2_v5"
       https://atlasgo.io/lint/analyzers#CD101
    -- L8: Dropping foreign-key constraint
       "fk_game_version_game_file_relations_game_version_table2_v15"
       https://atlasgo.io/lint/analyzers#CD101
    -- L8: Dropping foreign-key constraint
       "fk_game_version_game_file_relations_game_version_table2_v2"
       https://atlasgo.io/lint/analyzers#CD101
    -- L8: Dropping foreign-key constraint
       "fk_game_version_game_file_relations_game_version_table2_v4"
       https://atlasgo.io/lint/analyzers#CD101
    -- L10: Dropping foreign-key constraint "fk_games_game_versions"
       https://atlasgo.io/lint/analyzers#CD101
    -- L12: Dropping foreign-key constraint
       "fk_launcher_version_game_relations_game_table"
       https://atlasgo.io/lint/analyzers#CD101
-- ok (27.892µs)

-------------------------
-- 367.667385ms
-- 1 version ok, 1 with warnings
-- 38 schema changes
-- 17 diagnostics

ikura-hamu · 2025-05-05T09:38:58Z

/review

github-actions · 2025-05-05T09:40:21Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 1139 - PR Code Verified Compliant requirements: マイグレーションをAtlasに移行アプリ起動時の自動マイグレーション実行機能 Requires further human verification: 実際の運用環境でのマイグレーション検証 CIでのLint結果とAtlasバージョン依存の確認
⏱️ Estimated effort to review: 5 🔵🔵🔵🔵🔵
🧪 PR contains tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Connection URL Scheme `buildAtlasURL`で組み立てている`maria://`スキームがAtlasクライアントで正しく解釈されるか確認してください。 url := fmt.Sprintf("maria://%s:%s@%s:%d/%s", user, pass, host, port, database, ) return url, nil Test Field Name テストコードで追加した`GameVersionsV2`フィールドがORMマッピングとスキーマに整合しているかを検証してください。 GameVersionsV2: []migrate.GameVersionTable2{ { ID: uuid.UUID(gameVersionID1), GameID: uuid.UUID(gameID1), GameImageID: uuid.UUID(imageID1), GameVideoID: uuid.UUID(videoID1), Name: "v1.0.0",

ikura-hamu added 18 commits March 31, 2025 20:18

🩹 atlas のツール

caf2125

🔧 localhostからdbにアクセスできるようにする

718db02

🏭 現在のスキーマを生成

ac553a7

✨ atlasをアプリに組み込む

3de4191

✅ データ入れる系マイグレーションのテスト

5e5edeb

🩹 wireの設定

9a0096b

🔧 ローカル環境の設定

03550fc

🩹 本番のイメージにatlas入れる

0a9b689

🩹 データ入れる系のmigrationをSQLでやる

3f59847

🚧 既存の構造体をいったんコピー

6af6461

🔧 atlasのローカルの設定

6fd98d6

🩹 diffが少なくなるように

aba5d64

🏭 gormの構造体にあわせるマイグレーション

d4cef24

🩹 migrateパッケージの構造体に型エイリアス貼る

9e2cfcc

🔧 ホットリロードにSQLも含める

4a1a48a

🔧 CIでmigrationのLint

b34d7a8

🔧 Taskfileにmigrate関係のコマンド追加

2ef2ff2

📝 マイグレーションのドキュメントを追加

8254a2d

ikura-hamu requested a review from Copilot May 5, 2025 09:07

Copilot AI reviewed May 5, 2025

View reviewed changes

src/repository/gorm2/db.go Show resolved Hide resolved

docker/base/compose.yaml Show resolved Hide resolved

ikura-hamu added 3 commits May 5, 2025 18:15

Merge branch 'main' into dev/migrate_atlas_prepare

54bc0c4

Merge branch 'main' into dev/migrate_atlas_prepare

44b8fb1

🩹 CIの修正

24a73bd

🩹 CI修正

8207614

github-actions bot added the Review effort 5/5 label May 5, 2025

ikura-hamu merged commit 82964b1 into main May 5, 2025
10 of 12 checks passed

ikura-hamu deleted the dev/migrate_atlas_prepare branch May 5, 2025 09:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

マイグレーションをAtlasに移行 #1216

マイグレーションをAtlasに移行 #1216

Uh oh!

ikura-hamu commented May 5, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented May 5, 2025

Uh oh!

codecov bot commented May 5, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 5, 2025

Uh oh!

ikura-hamu commented May 5, 2025

Uh oh!

github-actions bot commented May 5, 2025

Uh oh!

Uh oh!

Uh oh!

マイグレーションをAtlasに移行 #1216

マイグレーションをAtlasに移行 #1216

Uh oh!

Conversation

ikura-hamu commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented May 5, 2025

Uh oh!

codecov bot commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented May 5, 2025

Uh oh!

ikura-hamu commented May 5, 2025

Uh oh!

github-actions bot commented May 5, 2025

PR Reviewer Guide 🔍

Uh oh!

Uh oh!

Uh oh!

ikura-hamu commented May 5, 2025 •

edited

Loading

codecov bot commented May 5, 2025 •

edited

Loading