GameCreator関係のAPIとDBスキーマ定義 #1443

ikura-hamu · 2025-12-05T13:13:05Z

仕様の詳細は #1415 を参照。
game_creator_jobs テーブルにはあらかじめ値を入れておくが、どんなjobをデフォルトで使えるようにするかの検討はまだしていないので、まだ入れない。

✨ gameCreator関連APIの追加
✨ /usersでの凍結済みユーザー取得対応
🩹 GameCreatorJobKindを使わないようにする
🏭 OpenAPIコード生成
⬆️ atlasのgorm providerの更新
✨ creators関連のDBスキーマ定義
🏭 マイグレーションの生成
🩹 handlerでビルドが通るように空のメソッドを置く

github-actions · 2025-12-05T13:13:31Z

Migrate lint ✅

Lint output

Analyzing changes from version 20250711133437 to 20251205124540 (1 migration in total):

  -- analyzing version 20251205124540
    -- no diagnostics found
  -- ok (20.309µs)

  -------------------------
  -- 276.914481ms
  -- 1 version ok
  -- 4 schema changes

codecov · 2025-12-05T13:16:45Z

Codecov Report

❌ Patch coverage is 0% with 93 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.40%. Comparing base (bcef6df) to head (45d9c71).

Files with missing lines	Patch %	Lines
src/handler/v2/openapi/openapi.gen.go	0.00%	79 Missing ⚠️
src/handler/v2/game_creator.go	0.00%	8 Missing ⚠️
src/repository/gorm2/schema/v2.go	0.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1443      +/-   ##
==========================================
- Coverage   52.89%   52.40%   -0.49%     
==========================================
  Files         136      137       +1     
  Lines       10003    10096      +93     
==========================================
  Hits         5291     5291              
- Misses       4398     4491      +93     
  Partials      314      314

☔ 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.

Copilot

Pull request overview

This PR implements the GameCreator feature by adding API endpoints and database schema for managing game creators and their associated jobs. It also adds support for fetching suspended users through the /users endpoint and updates the Atlas GORM provider dependency.

Key Changes:

Added database schema for game creators with support for predefined and custom jobs
Added 4 new API endpoints for managing game creators (GET, PATCH, DELETE operations)
Extended /users endpoint with includeSuspended query parameter
Updated atlas-provider-gorm from v0.5.0 to v0.6.0 and related dependencies

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
`src/repository/gorm2/schema/v2.go`	Added GORM table definitions for game_creators, game_creator_jobs, game_creator_custom_jobs, and their relation table
`migrations/20251205124540_create_game_creators.sql`	SQL migration creating 4 new tables with indexes and foreign key constraints
`migrations/atlas.sum`	Updated checksum to include new migration
`docs/openapi/v2.yaml`	Added OpenAPI spec for 3 new game creator endpoints, updated users endpoint documentation, and defined related schemas
`src/handler/v2/openapi/openapi.gen.go`	Auto-generated code from OpenAPI spec including new types, handlers, and routes
`src/handler/v2/game_creator.go`	Placeholder handler implementations returning StatusNotImplemented for 4 new endpoints
`src/handler/v2/api.go`	Registered GameCreator handler in API struct
`go.mod`	Updated atlas-provider-gorm and multiple indirect dependencies to newer versions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-05T13:19:47Z

src/repository/gorm2/schema/v2.go

+
+type GameCreatorTable struct {
+	ID        uuid.UUID `gorm:"type:varchar(36);not null;primaryKey"`
+	GameID    uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id;index"` // GameIDとUserIDの組み合わせをuniqueにする


Missing foreign key constraint for GameID field. The GameCreatorTable should have a foreign key relationship to the games table to ensure referential integrity. Consider adding: GameTable GameTable2 \gorm:"foreignKey:GameID"`` to maintain consistency with other schema definitions in this file.

Copilot · 2025-12-05T13:19:47Z

src/repository/gorm2/schema/v2.go

+type GameCreatorTable struct {
+	ID        uuid.UUID `gorm:"type:varchar(36);not null;primaryKey"`
+	GameID    uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id;index"` // GameIDとUserIDの組み合わせをuniqueにする
+	UserID    uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`


Missing database index on UserID field. Since UserID is part of a unique composite index with GameID, and there will likely be queries filtering by user (e.g., "get all games a user created"), consider adding a separate index on UserID alone for query performance: \gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id;index"``

Suggested change

UserID uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`

UserID uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id;index"`

Copilot · 2025-12-05T13:19:48Z

src/repository/gorm2/schema/v2.go

+type GameCreatorTable struct {
+	ID        uuid.UUID `gorm:"type:varchar(36);not null;primaryKey"`
+	GameID    uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id;index"` // GameIDとUserIDの組み合わせをuniqueにする
+	UserID    uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`


The UserName field stores denormalized data that could become stale if the user changes their name in traQ. Consider either:

Removing this field and fetching the username dynamically from the user service when needed

Adding documentation explaining the rationale for denormalization and how stale data is handled

Implementing a mechanism to keep this field synchronized with traQ user data

This is important for data consistency and maintainability.

Suggested change

UserID uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`

UserID uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`

// UserName stores a denormalized copy of the user's name from traQ at the time of record creation.

// Note: This field may become stale if the user changes their name in traQ.

// Rationale: Denormalization is used for historical record-keeping and to avoid extra joins.

// If up-to-date usernames are required, fetch them dynamically from the user service.

Copilot · 2025-12-05T13:19:48Z

migrations/20251205124540_create_game_creators.sql

+  `created_at` datetime NOT NULL DEFAULT (current_timestamp()),
+  PRIMARY KEY (`id`),
+  INDEX `idx_game_creator_custom_jobs_game_creator_id` (`game_creator_id`),
+  CONSTRAINT `fk_game_creators_custom_creator_jobs` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT


Foreign key constraint should specify ON DELETE CASCADE behavior. When a game creator is deleted, their associated custom jobs should also be deleted. The current ON DELETE RESTRICT prevents deletion of a game creator if they have custom jobs. Consider changing to:

CONSTRAINT `fk_game_creators_custom_creator_jobs` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE CASCADE ON DELETE CASCADE

Suggested change

CONSTRAINT `fk_game_creators_custom_creator_jobs` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT

CONSTRAINT `fk_game_creators_custom_creator_jobs` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE CASCADE ON DELETE CASCADE

Copilot · 2025-12-05T13:19:49Z

docs/openapi/v2.yaml

+        ゲームクリエイターのjob情報を表します。
+        ユーザーが独自に定義したjobの場合、kindは指定されません。
+      example:
+        kind: programmer


Inconsistent example in documentation. The example shows a kind field with value "programmer", but the schema properties don't include a kind field - only id, displayName, and isCustomJob. Either update the example to match the schema or add the kind field to the schema if it's intentional.

Suggested change

kind: programmer

Copilot · 2025-12-05T13:19:49Z

migrations/20251205124540_create_game_creators.sql

+  `user_name` varchar(32) NOT NULL,
+  `created_at` datetime NOT NULL DEFAULT (current_timestamp()),
+  PRIMARY KEY (`id`),
+  INDEX `idx_game_creators_game_id` (`game_id`),


Missing index on user_id column. While there's a unique composite index on (game_id, user_id), queries that filter by user_id alone (e.g., "find all games created by this user") would benefit from a separate index on user_id. Consider adding:

INDEX `idx_game_creators_user_id` (`user_id`)

Suggested change

INDEX `idx_game_creators_game_id` (`game_id`),

INDEX `idx_game_creators_game_id` (`game_id`),

INDEX `idx_game_creators_user_id` (`user_id`),

Copilot · 2025-12-05T13:19:49Z

migrations/20251205124540_create_game_creators.sql

+  CONSTRAINT `fk_game_creator_job_relations_game_creator_job_table` FOREIGN KEY (`job_id`) REFERENCES `game_creator_jobs` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT,
+  CONSTRAINT `fk_game_creator_job_relations_game_creator_table` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT


Foreign key constraints should specify ON DELETE CASCADE behavior. When a game creator or job is deleted, the relation entries should also be deleted. The current ON DELETE RESTRICT prevents deletion. Consider changing both constraints to use ON DELETE CASCADE:

CONSTRAINT `fk_game_creator_job_relations_game_creator_job_table` FOREIGN KEY (`job_id`) REFERENCES `game_creator_jobs` (`id`) ON UPDATE CASCADE ON DELETE CASCADE, CONSTRAINT `fk_game_creator_job_relations_game_creator_table` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE CASCADE ON DELETE CASCADE

Suggested change

CONSTRAINT `fk_game_creator_job_relations_game_creator_job_table` FOREIGN KEY (`job_id`) REFERENCES `game_creator_jobs` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT,

CONSTRAINT `fk_game_creator_job_relations_game_creator_table` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT

CONSTRAINT `fk_game_creator_job_relations_game_creator_job_table` FOREIGN KEY (`job_id`) REFERENCES `game_creator_jobs` (`id`) ON UPDATE RESTRICT ON DELETE CASCADE,

CONSTRAINT `fk_game_creator_job_relations_game_creator_table` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE RESTRICT ON DELETE CASCADE

Copilot · 2025-12-05T13:19:50Z

docs/openapi/v2.yaml

+        - TrapMemberAuth: []
+      responses:
+        '200':
+          description: 'ゲームクリエイターあらかじめ用意されたジョブ一覧の取得に成功した際に返されます。'


Typo in description: "ゲームクリエイターあらかじめ用意されたジョブ" is missing the particle "の". It should be "ゲームクリエイターのあらかじめ用意されたジョブ一覧の取得に成功した際に返されます。"

Suggested change

description: 'ゲームクリエイターあらかじめ用意されたジョブ一覧の取得に成功した際に返されます。'

description: 'ゲームクリエイターのあらかじめ用意されたジョブ一覧の取得に成功した際に返されます。'

Copilot · 2025-12-05T13:19:50Z

docs/openapi/v2.yaml

+        jobs:
+          type: array
+          items:
+            oneOf:
+              - type: object
+                properties:
+                  id:
+                    $ref: '#/components/schemas/GameCreatorJobID'
+                required:
+                  - id
+              - type: object
+                properties:
+                  customDisplayName:
+                    $ref: '#/components/schemas/GameCreatorJobDisplayName'
+                required:
+                  - customDisplayName
+                example:
+                  customDisplayName: カスタムjobName
+          minItems: 1


The minItems: 1 constraint ensures at least one job is required, but there's no validation preventing duplicate jobs in the request. Consider adding documentation or validation to prevent a user from being assigned the same job multiple times, which could cause database constraint violations or inconsistent data.

Copilot · 2025-12-05T13:19:51Z

src/handler/v2/game_creator.go

+type GameCreator struct{}
+
+// ゲームクリエイターのジョブ一覧の取得
+// (GET /creators/jobs)
+func (gc *GameCreator) GetGameCreatorJobs(c echo.Context) error {
+	return c.NoContent(http.StatusNotImplemented)
+}
+
+// ゲームクリエイター一覧の取得
+// (GET /games/{gameID}/creators)
+func (gc *GameCreator) GetGameCreators(c echo.Context, _ openapi.GameIDInPath) error {
+	return c.NoContent(http.StatusNotImplemented)
+}
+
+// ゲームクリエイター一覧の更新
+// (PATCH /games/{gameID}/creators)
+func (gc *GameCreator) PatchGameCreators(c echo.Context, _ openapi.GameIDInPath) error {
+	return c.NoContent(http.StatusNotImplemented)
+}
+
+// ゲームクリエイターの削除
+// (DELETE /games/{gameID}/creators/{userID})
+func (gc *GameCreator) DeleteGameCreator(c echo.Context, _ openapi.GameIDInPath, _ openapi.UserIDInPath) error {
+	return c.NoContent(http.StatusNotImplemented)
+}


Missing test coverage for new GameCreator handlers. All other handlers in this directory have corresponding _test.go files (e.g., game_test.go, game_file_test.go, etc.), but there's no game_creator_test.go. Consider adding tests for:

GetGameCreatorJobs

GetGameCreators

PatchGameCreators

DeleteGameCreator

This is especially important since these handlers currently return StatusNotImplemented and will need tests once the actual implementation is added.

ikura-hamu added 8 commits December 5, 2025 22:01

✨ gameCreator関連APIの追加

73a58ee

✨ /usersでの凍結済みユーザー取得対応

b4d029c

🩹 GameCreatorJobKindを使わないようにする

01287d7

🏭 OpenAPIコード生成

0e3b257

⬆️ atlasのgorm providerの更新

481e1ff

✨ creators関連のDBスキーマ定義

9b54dba

🏭 マイグレーションの生成

cb491ba

🩹 handlerでビルドが通るように空のメソッドを置く

45d9c71

ikura-hamu requested a review from Copilot December 5, 2025 13:13

Copilot started reviewing on behalf of ikura-hamu December 5, 2025 13:14 View session

Copilot finished reviewing on behalf of ikura-hamu December 5, 2025 13:16

Copilot AI reviewed Dec 5, 2025

View reviewed changes

	UserID uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`
	UserID uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id;index"`

-	UserID    uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`
+	UserID    uuid.UUID `gorm:"type:varchar(36);not null;uniqueIndex:idx_unique_game_id_user_id"`
+	// UserName stores a denormalized copy of the user's name from traQ at the time of record creation.
+	// Note: This field may become stale if the user changes their name in traQ.
+	// Rationale: Denormalization is used for historical record-keeping and to avoid extra joins.
+	// If up-to-date usernames are required, fetch them dynamically from the user service.

	CONSTRAINT `fk_game_creators_custom_creator_jobs` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT
	CONSTRAINT `fk_game_creators_custom_creator_jobs` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE CASCADE ON DELETE CASCADE

	INDEX `idx_game_creators_game_id` (`game_id`),
	INDEX `idx_game_creators_game_id` (`game_id`),
	INDEX `idx_game_creators_user_id` (`user_id`),

		CONSTRAINT `fk_game_creator_job_relations_game_creator_job_table` FOREIGN KEY (`job_id`) REFERENCES `game_creator_jobs` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT,
		CONSTRAINT `fk_game_creator_job_relations_game_creator_table` FOREIGN KEY (`game_creator_id`) REFERENCES `game_creators` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT

	description: 'ゲームクリエイターあらかじめ用意されたジョブ一覧の取得に成功した際に返されます。'
	description: 'ゲームクリエイターのあらかじめ用意されたジョブ一覧の取得に成功した際に返されます。'

GameCreator関係のAPIとDBスキーマ定義 #1443

Are you sure you want to change the base?

GameCreator関係のAPIとDBスキーマ定義 #1443

Uh oh!

Conversation

ikura-hamu commented Dec 5, 2025

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

codecov bot commented Dec 5, 2025

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants