Merge pull request #326 from TaloDev/continuity

tudddorrr · web-flow · commit 590a74913520 · 2024-08-27T13:22:20.000+01:00
Add continuity middleware + health check api
diff --git a/src/config/api-routes.ts b/src/config/api-routes.ts
@@ -1,5 +1,6 @@
 import Koa, { Context, Next } from 'koa'
 import { service } from 'koa-clay'
+import HealthCheckAPIService from '../services/api/health-check-api.service'
 import GameFeedbackAPIService from '../services/api/game-feedback-api.service'
 import GameConfigAPIService from '../services/api/game-config-api.service'
 import GameStatAPIService from '../services/api/game-stat-api.service'
@@ -13,6 +14,7 @@ import { apiRouteAuthMiddleware, getRouteInfo } from '../middlewares/route-middl
 import apiKeyMiddleware from '../middlewares/api-key-middleware'
 import playerAuthMiddleware from '../middlewares/player-auth-middleware'
 import PlayerAuthAPIService from '../services/api/player-auth-api.service'
+import continunityMiddleware from '../middlewares/continunity-middleware'
 
 export default (app: Koa) => {
   app.use(apiKeyMiddleware)
@@ -27,7 +29,9 @@ export default (app: Koa) => {
 
   app.use(currentPlayerMiddleware)
   app.use(playerAuthMiddleware)
+  app.use(continunityMiddleware)
 
+  app.use(service('/v1/health-check', new HealthCheckAPIService()))
   app.use(service('/v1/game-feedback', new GameFeedbackAPIService()))
   app.use(service('/v1/game-config', new GameConfigAPIService()))
   app.use(service('/v1/game-stats', new GameStatAPIService()))
diff --git a/src/entities/api-key.ts b/src/entities/api-key.ts
@@ -3,6 +3,7 @@ import Game from './game'
 import User from './user'
 
 export enum APIKeyScope {
+  WRITE_CONTINUITY_REQUESTS = 'write:continuityRequests',
   READ_GAME_FEEDBACK = 'read:gameFeedback',
   WRITE_GAME_FEEDBACK = 'write:gameFeedback',
   READ_GAME_CONFIG = 'read:gameConfig',
diff --git a/src/middlewares/continunity-middleware.ts b/src/middlewares/continunity-middleware.ts
@@ -0,0 +1,20 @@
+import { isValid } from 'date-fns'
+import { Context, Next } from 'koa'
+import { APIKeyScope } from '../entities/api-key'
+import { isAPIRoute } from './route-middleware'
+import checkScope from '../policies/checkScope'
+
+export default async (ctx: Context, next: Next): Promise<void> => {
+  if (isAPIRoute(ctx) && checkScope(ctx.state.key, APIKeyScope.WRITE_CONTINUITY_REQUESTS)) {
+    const header = ctx.headers['x-talo-continuity-timestamp']
+
+    if (header) {
+      const date = new Date(Number(header))
+      if (isValid(date)) {
+        ctx.state.continuityDate = date
+      }
+    }
+  }
+
+  await next()
+}
diff --git a/src/migrations/20210725211129InitialMigration.ts b/src/migrations/20210725211129InitialMigration.ts
@@ -26,10 +26,6 @@ export class InitialMigration extends Migration {
     this.addSql('create table `player_alias` (`id` int unsigned not null auto_increment primary key, `service` varchar(255) not null, `identifier` varchar(255) not null, `player_id` varchar(255) null, `created_at` datetime not null, `updated_at` datetime not null) default character set utf8mb4 engine = InnoDB')
     this.addSql('alter table `player_alias` add index `player_alias_player_id_index`(`player_id`)')
 
-    this.addSql('create table `event` (`id` int unsigned not null auto_increment primary key, `name` varchar(255) not null, `props` json not null, `game_id` int(11) unsigned not null, `player_alias_id` int(11) unsigned not null, `created_at` datetime not null, `updated_at` datetime not null) default character set utf8mb4 engine = InnoDB')
-    this.addSql('alter table `event` add index `event_game_id_index`(`game_id`)')
-    this.addSql('alter table `event` add index `event_player_alias_id_index`(`player_alias_id`)')
-
     this.addSql('create table `apikey` (`id` int unsigned not null auto_increment primary key, `scopes` text not null, `game_id` int(11) unsigned not null, `created_by_user_id` int(11) unsigned not null, `created_at` datetime not null, `revoked_at` datetime null) default character set utf8mb4 engine = InnoDB')
     this.addSql('alter table `apikey` add index `apikey_game_id_index`(`game_id`)')
     this.addSql('alter table `apikey` add index `apikey_created_by_user_id_index`(`created_by_user_id`)')
@@ -46,9 +42,6 @@ export class InitialMigration extends Migration {
 
     this.addSql('alter table `player_alias` add constraint `player_alias_player_id_foreign` foreign key (`player_id`) references `player` (`id`) on delete cascade')
 
-    this.addSql('alter table `event` add constraint `event_game_id_foreign` foreign key (`game_id`) references `game` (`id`) on update cascade')
-    this.addSql('alter table `event` add constraint `event_player_alias_id_foreign` foreign key (`player_alias_id`) references `player_alias` (`id`) on update cascade')
-
     this.addSql('alter table `apikey` add constraint `apikey_game_id_foreign` foreign key (`game_id`) references `game` (`id`) on update cascade')
     this.addSql('alter table `apikey` add constraint `apikey_created_by_user_id_foreign` foreign key (`created_by_user_id`) references `user` (`id`) on update cascade')
   }
diff --git a/src/migrations/20211221195514CascadeDeletePlayerAliasEvents.ts b/src/migrations/20211221195514CascadeDeletePlayerAliasEvents.ts
diff --git a/src/migrations/index.ts b/src/migrations/index.ts
@@ -3,7 +3,6 @@ import { CreateDataExportsTable } from './20210926160859CreateDataExportsTable'
 import { CreateLeaderboardsTable } from './20211107233610CreateLeaderboardsTable'
 import { CreateUserTwoFactorAuthTable } from './20211205171927CreateUserTwoFactorAuthTable'
 import { CreateUserRecoveryCodeTable } from './20211209003017CreateUserRecoveryCodeTable'
-import { CascadeDeletePlayerAliasEvents } from './20211221195514CascadeDeletePlayerAliasEvents'
 import { AddLeaderboardEntryHiddenColumn } from './20211224154919AddLeaderboardEntryHiddenColumn'
 import { CreateGameSavesTable } from './20220109144435CreateGameSavesTable'
 import { CreateGameActivitiesTable } from './20220125220401CreateGameActivitiesTable'
@@ -49,10 +48,6 @@ export default [
     name: 'CreateUserRecoveryCodeTable',
     class: CreateUserRecoveryCodeTable
   },
-  {
-    name: 'CascadeDeletePlayerAliasEvents',
-    class: CascadeDeletePlayerAliasEvents
-  },
   {
     name: 'AddLeaderboardEntryHiddenColumn',
     class: AddLeaderboardEntryHiddenColumn
diff --git a/src/services/api/game-feedback-api.service.ts b/src/services/api/game-feedback-api.service.ts
@@ -40,6 +40,9 @@ export default class GameFeedbackAPIService extends APIService {
     const feedback = new GameFeedback(category, req.ctx.state.playerAlias)
     feedback.comment = comment
     feedback.anonymised = category.anonymised
+    if (req.ctx.state.continuityDate) {
+      feedback.createdAt = req.ctx.state.continuityDate
+    }
 
     await em.persistAndFlush(feedback)
 
diff --git a/src/services/api/game-stat-api.service.ts b/src/services/api/game-stat-api.service.ts
@@ -52,6 +52,10 @@ export default class GameStatAPIService extends APIService {
 
     if (!playerStat) {
       playerStat = new PlayerGameStat(req.ctx.state.player, req.ctx.state.stat)
+      if (req.ctx.state.continuityDate) {
+        playerStat.createdAt = req.ctx.state.continuityDate
+      }
+
       em.persist(playerStat)
     }
 
diff --git a/src/services/api/health-check-api.service.ts b/src/services/api/health-check-api.service.ts
@@ -0,0 +1,15 @@
+import { Response, Routes } from 'koa-clay'
+import APIService from './api-service'
+
+@Routes([
+  {
+    method: 'GET'
+  }
+])
+export default class HealthCheckAPIService extends APIService {
+  async index(): Promise<Response> {
+    return {
+      status: 204
+    }
+  }
+}
diff --git a/src/services/api/leaderboard-api.service.ts b/src/services/api/leaderboard-api.service.ts
@@ -37,6 +37,9 @@ export default class LeaderboardAPIService extends APIService {
     const entry = new LeaderboardEntry(req.ctx.state.leaderboard)
     entry.playerAlias = req.ctx.state.playerAlias
     entry.score = req.body.score
+    if (req.ctx.state.continuityDate) {
+      entry.createdAt = req.ctx.state.continuityDate
+    }
 
     await em.persistAndFlush(entry)
 
@@ -67,7 +70,7 @@ export default class LeaderboardAPIService extends APIService {
 
         if ((leaderboard.sortMode === LeaderboardSortMode.ASC && score < entry.score) || (leaderboard.sortMode === LeaderboardSortMode.DESC && score > entry.score)) {
           entry.score = score
-          entry.createdAt = new Date()
+          entry.createdAt = req.ctx.state.continuityDate ?? new Date()
           await em.flush()
 
           updated = true
diff --git a/src/services/billing.service.ts b/src/services/billing.service.ts
@@ -235,7 +235,7 @@ export default class BillingService extends Service {
     )
 
     return {
-      status: 200
+      status: 204
     }
   }
 
diff --git a/tests/middlewares/continuity-middleware.test.ts b/tests/middlewares/continuity-middleware.test.ts
@@ -0,0 +1,47 @@
+import { EntityManager } from '@mikro-orm/mysql'
+import request from 'supertest'
+import createAPIKeyAndToken from '../utils/createAPIKeyAndToken'
+import { APIKeyScope } from '../../src/entities/api-key'
+import GameStatFactory from '../fixtures/GameStatFactory'
+import PlayerFactory from '../fixtures/PlayerFactory'
+import { subHours } from 'date-fns'
+
+describe('Continuity middleware', () => {
+  it('should not set the createdAt of the player stat to the continuity date if the write continuity requests scope isn\'t set', async () => {
+    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_GAME_STATS])
+    const stat = await new GameStatFactory([apiKey.game]).state(() => ({ maxValue: 999, maxChange: 99 })).one()
+    const player = await new PlayerFactory([apiKey.game]).one()
+    await (<EntityManager>global.em).persistAndFlush([stat, player])
+
+    const continuityDate = subHours(new Date(), 1)
+
+    const res = await request(global.app)
+      .put(`/v1/game-stats/${stat.internalName}`)
+      .send({ change: 10 })
+      .auth(token, { type: 'bearer' })
+      .set('x-talo-player', player.id)
+      .set('x-talo-continuity-timestamp', String(continuityDate.getTime()))
+      .expect(200)
+
+    expect(res.body.playerStat.createdAt).not.toBe(continuityDate.toISOString())
+  })
+
+  it('should not set the createdAt of the player stat to the continuity date if the timestamp is invalid', async () => {
+    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_GAME_STATS, APIKeyScope.WRITE_CONTINUITY_REQUESTS])
+    const stat = await new GameStatFactory([apiKey.game]).state(() => ({ maxValue: 999, maxChange: 99 })).one()
+    const player = await new PlayerFactory([apiKey.game]).one()
+    await (<EntityManager>global.em).persistAndFlush([stat, player])
+
+    const continuityDate = subHours(new Date(), 1)
+
+    const res = await request(global.app)
+      .put(`/v1/game-stats/${stat.internalName}`)
+      .send({ change: 10 })
+      .auth(token, { type: 'bearer' })
+      .set('x-talo-player', player.id)
+      .set('x-talo-continuity-timestamp', String(Math.ceil(continuityDate.getTime() / 1000)))
+      .expect(200)
+
+    expect(res.body.playerStat.createdAt).not.toBe(continuityDate.toISOString())
+  })
+})
diff --git a/tests/middlewares/player-auth-middleware.test.ts b/tests/middlewares/player-auth-middleware.test.ts
@@ -125,7 +125,7 @@ describe('Player auth middleware', () => {
     const stat = await new GameStatFactory([apiKey.game]).one()
     const player = await new PlayerFactory([apiKey.game]).withTaloAlias().one()
 
-    player.aliases.add(await new PlayerAliasFactory().one())
+    player.aliases.add(await new PlayerAliasFactory(player).one())
 
     await em.persistAndFlush([stat, player])
     const sessionToken = await player.auth.createSession(player.aliases[0])
diff --git a/tests/services/_api/game-feedback-api/post.test.ts b/tests/services/_api/game-feedback-api/post.test.ts
@@ -4,6 +4,7 @@ import { APIKeyScope } from '../../../../src/entities/api-key'
 import createAPIKeyAndToken from '../../../utils/createAPIKeyAndToken'
 import GameFeedbackCategoryFactory from '../../../fixtures/GameFeedbackCategoryFactory'
 import PlayerFactory from '../../../fixtures/PlayerFactory'
+import { subHours } from 'date-fns'
 
 describe('Game feedback API service - post', () => {
   it('should create feedback if the scope is valid', async () => {
@@ -76,4 +77,25 @@ describe('Game feedback API service - post', () => {
 
     expect(res.body).toStrictEqual({ message: 'Feedback category not found' })
   })
+
+  it('should set the createdAt for the feedback to the continuity date', async () => {
+    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_GAME_FEEDBACK, APIKeyScope.WRITE_CONTINUITY_REQUESTS])
+
+    const feedbackCategory = await new GameFeedbackCategoryFactory(apiKey.game).one()
+    const player = await new PlayerFactory([apiKey.game]).one()
+
+    await (<EntityManager>global.em).persistAndFlush([feedbackCategory, player])
+
+    const continuityDate = subHours(new Date(), 1)
+
+    const res = await request(global.app)
+      .post(`/v1/game-feedback/categories/${feedbackCategory.internalName}`)
+      .send({ comment: 'This is my comment' })
+      .auth(token, { type: 'bearer' })
+      .set('x-talo-alias', String(player.aliases[0].id))
+      .set('x-talo-continuity-timestamp', String(continuityDate.getTime()))
+      .expect(200)
+
+    expect(res.body.feedback.createdAt).toBe(continuityDate.toISOString())
+  })
 })
diff --git a/tests/services/_api/game-stat-api/put.test.ts b/tests/services/_api/game-stat-api/put.test.ts
@@ -7,6 +7,7 @@ import GameStat from '../../../../src/entities/game-stat'
 import PlayerGameStatFactory from '../../../fixtures/PlayerGameStatFactory'
 import createAPIKeyAndToken from '../../../utils/createAPIKeyAndToken'
 import Game from '../../../../src/entities/game'
+import { subHours } from 'date-fns'
 
 describe('Game stats API service - put', () => {
   const createStat = async (game: Game, props: Partial<GameStat>) => {
@@ -228,4 +229,23 @@ describe('Game stats API service - put', () => {
 
     expect(res.body).toStrictEqual({ message: 'Stat not found' })
   })
+
+  it('should set the createdAt of the player stat to the continuity date', async () => {
+    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_GAME_STATS, APIKeyScope.WRITE_CONTINUITY_REQUESTS])
+    const stat = await createStat(apiKey.game, { maxValue: 999, maxChange: 99 })
+    const player = await new PlayerFactory([apiKey.game]).one()
+    await (<EntityManager>global.em).persistAndFlush(player)
+
+    const continuityDate = subHours(new Date(), 1)
+
+    const res = await request(global.app)
+      .put(`/v1/game-stats/${stat.internalName}`)
+      .send({ change: 10 })
+      .auth(token, { type: 'bearer' })
+      .set('x-talo-player', player.id)
+      .set('x-talo-continuity-timestamp', String(continuityDate.getTime()))
+      .expect(200)
+
+    expect(res.body.playerStat.createdAt).toBe(continuityDate.toISOString())
+  })
 })
diff --git a/tests/services/_api/health-check-api/index.test.ts b/tests/services/_api/health-check-api/index.test.ts
@@ -0,0 +1,13 @@
+import request from 'supertest'
+import createAPIKeyAndToken from '../../../utils/createAPIKeyAndToken'
+
+describe('Health check API service - index', () => {
+  it('should return a 204', async () => {
+    const [, token] = await createAPIKeyAndToken([])
+
+    await request(global.app)
+      .get('/v1/health-check')
+      .auth(token, { type: 'bearer' })
+      .expect(204)
+  })
+})
diff --git a/tests/services/_api/leaderboard-api/post.test.ts b/tests/services/_api/leaderboard-api/post.test.ts
@@ -220,4 +220,50 @@ describe('Leaderboard API service - post', () => {
 
     expect(res.body.entry.position).toBe(0)
   })
+
+  it('should set the createdAt for the entry to the continuity date', async () => {
+    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_LEADERBOARDS, APIKeyScope.WRITE_CONTINUITY_REQUESTS])
+    const player = await new PlayerFactory([apiKey.game]).one()
+    const leaderboard = await new LeaderboardFactory([apiKey.game]).one()
+    await (<EntityManager>global.em).persistAndFlush([player, leaderboard])
+
+    const continuityDate = subHours(new Date(), 1)
+
+    const res = await request(global.app)
+      .post(`/v1/leaderboards/${leaderboard.internalName}/entries`)
+      .send({ score: 300 })
+      .auth(token, { type: 'bearer' })
+      .set('x-talo-alias', String(player.aliases[0].id))
+      .set('x-talo-continuity-timestamp', String(continuityDate.getTime()))
+      .expect(200)
+
+    expect(new Date(res.body.entry.createdAt).getHours()).toBe(continuityDate.getHours())
+  })
+
+  it('should update an existing entry\'s created at to the continuity date for unique leaderboards', async () => {
+    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_LEADERBOARDS, APIKeyScope.WRITE_CONTINUITY_REQUESTS])
+    const player = await new PlayerFactory([apiKey.game]).one()
+    const leaderboard = await new LeaderboardFactory([apiKey.game]).state(() => ({ unique: true, sortMode: LeaderboardSortMode.DESC })).one()
+
+    const originalDate = subHours(new Date(), 2)
+    const continuityDate = subHours(new Date(), 1)
+
+    const entry = await new LeaderboardEntryFactory(leaderboard, [player]).state(() => ({
+      score: 100,
+      createdAt: originalDate,
+      playerAlias: player.aliases[0]
+    })).one()
+
+    await (<EntityManager>global.em).persistAndFlush([player, leaderboard, entry])
+
+    const res = await request(global.app)
+      .post(`/v1/leaderboards/${leaderboard.internalName}/entries`)
+      .send({ score: 300 })
+      .auth(token, { type: 'bearer' })
+      .set('x-talo-alias', String(player.aliases[0].id))
+      .set('x-talo-continuity-timestamp', String(continuityDate.getTime()))
+      .expect(200)
+
+    expect(new Date(res.body.entry.createdAt).getHours()).toBe(continuityDate.getHours())
+  })
 })

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,10 @@ export default class GameStatAPIService extends APIService {`
`52`	`52`
`53`	`53`	`if (!playerStat) {`
`54`	`54`	`playerStat = new PlayerGameStat(req.ctx.state.player, req.ctx.state.stat)`
	`55`	`+ if (req.ctx.state.continuityDate) {`
	`56`	`+ playerStat.createdAt = req.ctx.state.continuityDate`
	`57`	`+ }`
	`58`	`+`
`55`	`59`	`em.persist(playerStat)`
`56`	`60`	`}`
`57`	`61`