Merge pull request #1420 from traPtitech/hotfix/delete_playlog

playlogを削除できるようにする

Author: ikura-hamu

docs/openapi/v2.yaml

@@ -211,3 +211,20 @@ func (gpl *GamePlayLog) GetEditionPlayStats(c echo.Context, editionIDPath openap
 
 	return c.JSON(http.StatusOK, res)
 }
+
+func (gpl *GamePlayLog) DeleteGamePlayLog(c echo.Context, editionIDPath openapi.EditionIDInPath, gameIDPath openapi.GameIDInPath, playLogIDPath openapi.PlayLogIDInPath) error {
+	editionID := values.NewLauncherVersionIDFromUUID(editionIDPath)
+	gameID := values.NewGameIDFromUUID(gameIDPath)
+	playLogID := values.GamePlayLogIDFromUUID(playLogIDPath)
+
+	err := gpl.gamePlayLogService.DeleteGamePlayLog(c.Request().Context(), editionID, gameID, playLogID)
+	if errors.Is(err, service.ErrInvalidPlayLogID) {
+		return echo.NewHTTPError(http.StatusNotFound, "play log not found")
+	}
+	if err != nil {
+		log.Printf("error: failed to delete game play log: %v\n", err)
+		return echo.NewHTTPError(http.StatusInternalServerError, "failed to delete game play log")
+	}
+
+	return c.NoContent(http.StatusOK)
+}

src/handler/v2/game_play_log.go

@@ -773,3 +773,70 @@ func TestGetGamePlayStats(t *testing.T) {
 		})
 	}
 }
+
+func TestDeleteGamePlayLog(t *testing.T) {
+	t.Parallel()
+
+	ctrl := gomock.NewController(t)
+
+	testCases := map[string]struct {
+		editionID            values.LauncherVersionID
+		gameID               values.GameID
+		playLogID            values.GamePlayLogID
+		DeleteGamePlayLogErr error
+		isError              bool
+		statusCode           int
+	}{
+		"正常系": {
+			editionID:  values.NewLauncherVersionID(),
+			gameID:     values.NewGameID(),
+			playLogID:  values.NewGamePlayLogID(),
+			statusCode: http.StatusOK,
+		},
+		"ErrInvalidPlayLogIDなので404": {
+			editionID:            values.NewLauncherVersionID(),
+			gameID:               values.NewGameID(),
+			playLogID:            values.NewGamePlayLogID(),
+			DeleteGamePlayLogErr: service.ErrInvalidPlayLogID,
+			isError:              true,
+			statusCode:           http.StatusNotFound,
+		},
+		"その他のエラーなので500": {
+			editionID:            values.NewLauncherVersionID(),
+			gameID:               values.NewGameID(),
+			playLogID:            values.NewGamePlayLogID(),
+			DeleteGamePlayLogErr: assert.AnError,
+			isError:              true,
+			statusCode:           http.StatusInternalServerError,
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			serviceMock := mock.NewMockGamePlayLogV2(ctrl)
+			h := NewGamePlayLog(serviceMock)
+
+			serviceMock.EXPECT().
+				DeleteGamePlayLog(gomock.Any(), testCase.editionID, testCase.gameID, testCase.playLogID).
+				Return(testCase.DeleteGamePlayLogErr)
+
+			url := fmt.Sprintf("/editions/%s/games/%s/plays/%s",
+				uuid.UUID(testCase.editionID).String(), uuid.UUID(testCase.gameID).String(), uuid.UUID(testCase.playLogID).String())
+			c, _, rec := setupTestRequest(t, http.MethodDelete, url, nil)
+
+			err := h.DeleteGamePlayLog(c, openapi.EditionIDInPath(testCase.editionID), openapi.GameIDInPath(testCase.gameID), openapi.PlayLogIDInPath(testCase.playLogID))
+
+			if testCase.isError {
+				var httpError *echo.HTTPError
+				assert.ErrorAs(t, err, &httpError)
+				assert.Equal(t, testCase.statusCode, httpError.Code)
+				return
+			}
+
+			assert.NoError(t, err)
+			assert.Equal(t, testCase.statusCode, rec.Code)
+		})
+	}
+}

src/handler/v2/game_play_log_test.go

@@ -355,3 +355,21 @@ func (g *GamePlayLogV2) GetEditionPlayStats(ctx context.Context, editionID value
 		hourlyStats,
 	), nil
 }
+
+func (g *GamePlayLogV2) DeleteGamePlayLog(ctx context.Context, playLogID values.GamePlayLogID) error {
+	db, err := g.db.getDB(ctx)
+	if err != nil {
+		return fmt.Errorf("get db: %w", err)
+	}
+
+	result := db.Unscoped().
+		Delete(&schema.GamePlayLogTable{}, "id = ?", uuid.UUID(playLogID))
+	if result.RowsAffected == 0 {
+		return repository.ErrNoRecordDeleted
+	}
+	if result.Error != nil {
+		return fmt.Errorf("delete game play log: %w", result.Error)
+	}
+
+	return nil
+}

src/handler/v2/openapi/openapi.gen.go

@@ -1466,3 +1466,123 @@ func TestGetEditionPlayStats(t *testing.T) {
 		})
 	}
 }
+
+func TestDeleteGamePlayLog(t *testing.T) {
+	t.Parallel()
+
+	ctx := t.Context()
+	db, err := testDB.getDB(ctx)
+	require.NoError(t, err)
+
+	playLogID := values.NewGamePlayLogID()
+
+	game1 := &schema.GameTable2{
+		ID:                     uuid.New(),
+		Name:                   "Test Game for DeleteGamePlayLog",
+		Description:            "description",
+		VisibilityTypeID:       1,
+		CreatedAt:              time.Now(),
+		LatestVersionUpdatedAt: time.Now(),
+	}
+	gameImage1 := &schema.GameImageTable2{
+		ID:          uuid.New(),
+		GameID:      game1.ID,
+		ImageTypeID: 1,
+		CreatedAt:   time.Now(),
+	}
+	gameVideo1 := &schema.GameVideoTable2{
+		ID:          uuid.New(),
+		GameID:      game1.ID,
+		VideoTypeID: 1,
+		CreatedAt:   time.Now(),
+	}
+	gameVersion1 := &schema.GameVersionTable2{
+		ID:          uuid.New(),
+		GameID:      game1.ID,
+		GameImageID: gameImage1.ID,
+		GameVideoID: gameVideo1.ID,
+		Name:        "v1.0",
+		Description: "First version",
+		CreatedAt:   time.Now(),
+	}
+	edition1 := &schema.EditionTable{
+		ID:        uuid.New(),
+		Name:      "Edition for DeleteGamePlayLog",
+		CreatedAt: time.Now(),
+	}
+	require.NoError(t, db.Create(game1).Error)
+	t.Cleanup(func() { require.NoError(t, testDB.db.Session(&gorm.Session{}).Unscoped().Delete(game1).Error) })
+	require.NoError(t, db.Create(gameImage1).Error)
+	t.Cleanup(func() { require.NoError(t, testDB.db.Session(&gorm.Session{}).Unscoped().Delete(gameImage1).Error) })
+	require.NoError(t, db.Create(gameVideo1).Error)
+	t.Cleanup(func() { require.NoError(t, testDB.db.Session(&gorm.Session{}).Unscoped().Delete(gameVideo1).Error) })
+	require.NoError(t, db.Create(gameVersion1).Error)
+	t.Cleanup(func() { require.NoError(t, testDB.db.Session(&gorm.Session{}).Unscoped().Delete(gameVersion1).Error) })
+	require.NoError(t, db.Create(edition1).Error)
+	t.Cleanup(func() { require.NoError(t, testDB.db.Session(&gorm.Session{}).Unscoped().Delete(edition1).Error) })
+
+	playLog1 := &schema.GamePlayLogTable{
+		ID:            playLogID.UUID(),
+		EditionID:     edition1.ID,
+		GameID:        game1.ID,
+		GameVersionID: gameVersion1.ID,
+		StartTime:     time.Now().Add(-10 * time.Minute),
+		EndTime:       sql.NullTime{Time: time.Now(), Valid: true},
+		CreatedAt:     time.Now(),
+		UpdatedAt:     time.Now(),
+	}
+
+	testCases := map[string]struct {
+		playLogID      values.GamePlayLogID
+		beforePlayLogs []*schema.GamePlayLogTable
+		afterPlayLogs  []*schema.GamePlayLogTable
+		err            error
+	}{
+		"正しく削除できる": {
+			playLogID:      playLogID,
+			beforePlayLogs: []*schema.GamePlayLogTable{playLog1},
+			afterPlayLogs:  []*schema.GamePlayLogTable{},
+		},
+		"存在しないIDを指定した場合ErrNoRecordDeletedが返る": {
+			playLogID:      values.NewGamePlayLogID(),
+			beforePlayLogs: []*schema.GamePlayLogTable{playLog1},
+			afterPlayLogs:  []*schema.GamePlayLogTable{playLog1},
+			err:            repository.ErrNoRecordDeleted,
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+
+			err := db.Create(testCase.beforePlayLogs).Error
+			require.NoError(t, err)
+
+			t.Cleanup(func() {
+				err := db.Unscoped().Delete(testCase.beforePlayLogs).Error
+				require.NoError(t, err)
+			})
+
+			gamePlayLogRepository := NewGamePlayLogV2(testDB)
+
+			err = gamePlayLogRepository.DeleteGamePlayLog(t.Context(), testCase.playLogID)
+
+			if testCase.err != nil {
+				assert.ErrorIs(t, err, testCase.err)
+				return
+			}
+
+			assert.NoError(t, err)
+
+			var resultAfterPlayLogs []*schema.GamePlayLogTable
+			beforePlayLogIDs := make([]uuid.UUID, len(testCase.beforePlayLogs))
+			for i, log := range testCase.beforePlayLogs {
+				beforePlayLogIDs[i] = log.ID
+			}
+			err = db.Where("id IN ?", beforePlayLogIDs).Find(&resultAfterPlayLogs).Error
+			require.NoError(t, err)
+
+			assert.Equal(t, testCase.afterPlayLogs, resultAfterPlayLogs)
+
+		})
+	}
+}

src/repository/gorm2/v2_game_play_log.go

@@ -35,4 +35,8 @@ type GamePlayLogV2 interface {
 	// 統計データが存在しない場合でも空の統計を返すようにする。エラーは発生しない
 	// editionNameも含めて返すため、editionsテーブルとのJOINが必要
 	GetEditionPlayStats(ctx context.Context, editionID values.LauncherVersionID, start, end time.Time) (*domain.EditionPlayStats, error)
+	// DeleteGamePlayLog
+	// 指定されたプレイログを削除する。
+	// 条件に当てはまるプレイログが存在しない場合、ErrNoRecordDeletedを返す。
+	DeleteGamePlayLog(ctx context.Context, playLogID values.GamePlayLogID) error
 }

src/repository/gorm2/v2_game_play_log_test.go

@@ -169,3 +169,35 @@ func (g *GamePlayLog) GetEditionPlayStats(ctx context.Context, editionID values.
 
 	return stats, nil
 }
+
+func (g *GamePlayLog) DeleteGamePlayLog(ctx context.Context, editionID values.LauncherVersionID, gameID values.GameID, playLogID values.GamePlayLogID) error {
+	err := g.db.Transaction(ctx, nil, func(ctx context.Context) error {
+		playLog, err := g.gamePlayLogRepository.GetGamePlayLog(ctx, playLogID)
+		if errors.Is(err, repository.ErrRecordNotFound) {
+			return service.ErrInvalidPlayLogID
+		}
+		if err != nil {
+			return fmt.Errorf("get game play log: %w", err)
+		}
+
+		if playLog.GetEditionID() != editionID || playLog.GetGameID() != gameID {
+			return service.ErrInvalidPlayLogID
+		}
+
+		err = g.gamePlayLogRepository.DeleteGamePlayLog(ctx, playLogID)
+		if errors.Is(err, repository.ErrNoRecordDeleted) {
+			return service.ErrInvalidPlayLogID
+		}
+		if err != nil {
+			return fmt.Errorf("delete game play log: %w", err)
+		}
+
+		return nil
+	})
+
+	if err != nil {
+		return err
+	}
+
+	return nil
+}