add WRITE_CONTINUITY_REQUESTS scope

Author: tudddorrr

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',

src/middlewares/continunity-middleware.ts

@@ -1,13 +1,18 @@
 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> => {
-  const header = ctx.headers['x-talo-continuity-timestamp']
+  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
+    if (header) {
+      const date = new Date(Number(header))
+      if (isValid(date)) {
+        ctx.state.continuityDate = date
+      }
     }
   }
 

src/services/api/health-check-api.service.ts

@@ -1,4 +1,4 @@
-import { Response, Request, Routes } from 'koa-clay'
+import { Response, Routes } from 'koa-clay'
 import APIService from './api-service'
 
 @Routes([
@@ -7,9 +7,7 @@ import APIService from './api-service'
   }
 ])
 export default class HealthCheckAPIService extends APIService {
-  async index(req: Request): Promise<Response> {
-    console.log(req.ctx.state.continuityDate)
-
+  async index(): Promise<Response> {
     return {
       status: 200
     }

src/services/player.service.ts

@@ -84,10 +84,6 @@ export default class PlayerService extends Service {
     const game = await em.getRepository(Game).findOne(req.ctx.state.game)
 
     const player = new Player(game)
-    if (req.ctx.state.continuityDate) {
-      player.createdAt = req.ctx.state.continuityDate
-    }
-
     if (aliases) {
       for await (const alias of aliases) {
         if (await em.getRepository(PlayerAlias).count({ service: alias.service, identifier: alias.identifier }) > 0) {
@@ -102,10 +98,6 @@ export default class PlayerService extends Service {
         const alias = new PlayerAlias()
         alias.service = item.service
         alias.identifier = item.identifier
-        if (req.ctx.state.continuityDate) {
-          alias.createdAt = req.ctx.state.continuityDate
-        }
-
         return alias
       }))
     }

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())
+  })
+})

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])

tests/services/_api/game-feedback-api/post.test.ts

@@ -79,7 +79,7 @@ describe('Game feedback API service - post', () => {
   })
 
   it('should set the createdAt for the feedback to the continuity date', async () => {
-    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_GAME_FEEDBACK])
+    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()

tests/services/_api/game-stat-api/put.test.ts

@@ -231,7 +231,7 @@ describe('Game stats API service - put', () => {
   })
 
   it('should set the createdAt of the player stat to the continuity date', async () => {
-    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_GAME_STATS])
+    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)

tests/services/_api/leaderboard-api/post.test.ts

@@ -222,7 +222,7 @@ describe('Leaderboard API service - post', () => {
   })
 
   it('should set the createdAt for the entry to the continuity date', async () => {
-    const [apiKey, token] = await createAPIKeyAndToken([APIKeyScope.WRITE_LEADERBOARDS])
+    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])
@@ -241,7 +241,7 @@ describe('Leaderboard API service - post', () => {
   })
 
   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])
+    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()
 

tests/services/_api/player-api/identify.test.ts

@@ -2,7 +2,7 @@ import { Collection, EntityManager } from '@mikro-orm/mysql'
 import request from 'supertest'
 import { APIKeyScope } from '../../../../src/entities/api-key'
 import PlayerFactory from '../../../fixtures/PlayerFactory'
-import { isToday, subHours } from 'date-fns'
+import { isToday } from 'date-fns'
 import PlayerGroupFactory from '../../../fixtures/PlayerGroupFactory'
 import PlayerGroupRule, { PlayerGroupRuleName, PlayerGroupRuleCastType } from '../../../../src/entities/player-group-rule'
 import PlayerProp from '../../../../src/entities/player-prop'
@@ -124,20 +124,4 @@ describe('Player API service - identify', () => {
 
     expect(res.body).toStrictEqual({ message: 'Player not found: Talo aliases must be created using the /v1/players/auth API' })
   })
-
-  it('should set the createdAt for the player and aliases to the continuity date', async () => {
-    const [, token] = await createAPIKeyAndToken([APIKeyScope.READ_PLAYERS, APIKeyScope.WRITE_PLAYERS])
-
-    const continuityDate = subHours(new Date(), 1)
-
-    const res = await request(global.app)
-      .get('/v1/players/identify')
-      .query({ service: 'steam', identifier: 'bizboz' })
-      .auth(token, { type: 'bearer' })
-      .set('x-talo-continuity-timestamp', String(continuityDate.getTime()))
-      .expect(200)
-
-    expect(res.body.alias.createdAt).toBe(continuityDate.toISOString())
-    expect(res.body.alias.player.createdAt).toBe(continuityDate.toISOString())
-  })
 })