Merge pull request #117 from TaloDev/develop

Release 0.18.0

Author: tudddorrr

_templates/service/new/api-service.ejs.t

@@ -12,7 +12,7 @@ export default class <%= h.changeCase.pascal(name) %>APIService extends APIServi
   async post(req: Request): Promise<Response> {
     const key: APIKey = await this.getAPIKey(req.ctx)
     return await forwardRequest(req, {
-      body: {
+      params: {
         gameId: key.game.id
       }
     })

package.json

@@ -1,6 +1,6 @@
 {
   "name": "game-services",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "",
   "main": "src/index.ts",
   "scripts": {
@@ -22,7 +22,7 @@
   "author": "Sleepy Studios",
   "license": "MIT",
   "devDependencies": {
-    "@mikro-orm/cli": "^5.1.4",
+    "@mikro-orm/cli": "^5.2.2",
     "@types/ioredis": "4.22.3",
     "@types/jest": "^27.4.1",
     "@types/koa": "^2.13.4",
@@ -51,9 +51,9 @@
   "dependencies": {
     "@dinero.js/currencies": "^2.0.0-alpha.8",
     "@koa/cors": "^3.3.0",
-    "@mikro-orm/core": "^5.1.4",
-    "@mikro-orm/migrations": "^5.1.4",
-    "@mikro-orm/mysql": "^5.1.4",
+    "@mikro-orm/core": "^5.2.2",
+    "@mikro-orm/migrations": "^5.2.2",
+    "@mikro-orm/mysql": "^5.2.2",
     "@sendgrid/mail": "^7.6.2",
     "@sentry/node": "^6.19.6",
     "@sentry/tracing": "^6.19.6",
@@ -68,7 +68,7 @@
     "jsonwebtoken": "^8.5.1",
     "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
-    "koa-clay": "^6.2.0",
+    "koa-clay": "^6.4.0",
     "koa-helmet": "^6.1.0",
     "koa-jwt": "^4.0.3",
     "koa-logger": "^3.2.1",

src/config/protected-routes.ts

@@ -32,14 +32,14 @@ export default (app: Koa) => {
   app.use(service('/billing', new BillingService(), serviceOpts))
   app.use(service('/organisations', new OrganisationService(), serviceOpts))
   app.use(service('/invites', new InviteService(), serviceOpts))
-  app.use(service('/game-stats', new GameStatService(), serviceOpts))
-  app.use(service('/game-activities', new GameActivityService(), serviceOpts))
-  app.use(service('/leaderboards', new LeaderboardService(), serviceOpts))
-  app.use(service('/data-exports', new DataExportService(), serviceOpts))
-  app.use(service('/api-keys', new APIKeyService(), serviceOpts))
-  app.use(service('/events', new EventService(), serviceOpts))
-  app.use(service('/players', new PlayerService(), serviceOpts))
+  app.use(service('/games/:gameId/game-stats', new GameStatService(), serviceOpts))
+  app.use(service('/games/:gameId/game-activities', new GameActivityService(), serviceOpts))
+  app.use(service('/games/:gameId/leaderboards', new LeaderboardService(), serviceOpts))
+  app.use(service('/games/:gameId/data-exports', new DataExportService(), serviceOpts))
+  app.use(service('/games/:gameId/api-keys', new APIKeyService(), serviceOpts))
+  app.use(service('/games/:gameId/events', new EventService(), serviceOpts))
+  app.use(service('/games/:gameId/players', new PlayerService(), serviceOpts))
+  app.use(service('/games/:gameId/headlines', new HeadlineService(), serviceOpts))
   app.use(service('/games', new GameService(), serviceOpts))
   app.use(service('/users', new UserService(), serviceOpts))
-  app.use(service('/headlines', new HeadlineService(), serviceOpts))
 }

src/entities/game-stat.ts

@@ -9,10 +9,14 @@ export default class GameStat {
   id: number
 
   @Required({
-    methods: ['POST'],
     validation: async (val: unknown, req: Request): Promise<ValidationCondition[]> => {
+      const { gameId, id } = req.params
       const em: EntityManager = req.ctx.em
-      const duplicateInternalName = await em.getRepository(GameStat).findOne({ internalName: val, game: req.body.gameId })
+      const duplicateInternalName = await em.getRepository(GameStat).findOne({
+        id: { $ne: Number(id ?? null) },
+        internalName: val,
+        game: Number(gameId)
+      })
 
       return [
         {
@@ -25,11 +29,11 @@ export default class GameStat {
   @Property()
   internalName: string
 
-  @Required({ methods: ['POST'] })
+  @Required()
   @Property()
   name: string
 
-  @Required({ methods: ['POST'] })
+  @Required()
   @Property()
   global: boolean
 
@@ -42,7 +46,6 @@ export default class GameStat {
   maxChange: number
 
   @Required({
-    methods: [],
     validation: async (value: number, req: Request): Promise<ValidationCondition[]> => [{
       check: value < (req.body.maxValue ?? Infinity),
       error: 'minValue must be less than maxValue'
@@ -52,7 +55,6 @@ export default class GameStat {
   minValue: number
 
   @Required({
-    methods: [],
     validation: async (value: number, req: Request): Promise<ValidationCondition[]> => [{
       check: value > (req.body.minValue ?? -Infinity),
       error: 'maxValue must be greater than minValue'
@@ -62,7 +64,6 @@ export default class GameStat {
   maxValue: number
 
   @Required({
-    methods: ['POST'],
     validation: async (value: number, req: Request): Promise<ValidationCondition[]> => [{
       check: value >= (req.body.minValue ?? -Infinity) && value <= (req.body.maxValue ?? Infinity),
       error: 'defaultValue must be between minValue and maxValue'
@@ -71,14 +72,10 @@ export default class GameStat {
   @Property({ type: 'double' })
   defaultValue: number
 
-  @Required({ methods: ['POST'] })
+  @Required()
   @Property()
   minTimeBetweenUpdates: number
 
-  @Required({
-    methods: ['POST'],
-    as: 'gameId'
-  })
   @ManyToOne(() => Game)
   game: Game
 

src/entities/leaderboard.ts

@@ -1,4 +1,5 @@
-import { Collection, Entity, Enum, ManyToOne, OneToMany, PrimaryKey, Property } from '@mikro-orm/core'
+import { Collection, Entity, EntityManager, Enum, ManyToOne, OneToMany, PrimaryKey, Property } from '@mikro-orm/core'
+import { Request, Required, ValidationCondition } from 'koa-clay'
 import Game from './game'
 import LeaderboardEntry from './leaderboard-entry'
 
@@ -12,15 +13,47 @@ export default class Leaderboard {
   @PrimaryKey()
   id: number
 
+  @Required({
+    validation: async (val: unknown, req: Request): Promise<ValidationCondition[]> => {
+      const { gameId, id } = req.params
+      const em: EntityManager = req.ctx.em
+      const duplicateInternalName = await em.getRepository(Leaderboard).findOne({
+        id: { $ne: Number(id ?? null) },
+        internalName: val,
+        game: Number(gameId)
+      })
+
+      return [
+        {
+          check: !duplicateInternalName,
+          error: `A leaderboard with the internalName ${val} already exists`
+        }
+      ]
+    }
+  })
   @Property()
   internalName: string
 
+  @Required()
   @Property()
   name: string
 
+  @Required({
+    validation: async (val: unknown): Promise<ValidationCondition[]> => {
+      const keys = Object.keys(LeaderboardSortMode).map((key) => LeaderboardSortMode[key])
+
+      return [
+        {
+          check: keys.includes(val),
+          error: `Sort mode must be one of ${keys.join(', ')}`
+        }
+      ]
+    }
+  })
   @Enum(() => LeaderboardSortMode)
   sortMode: LeaderboardSortMode = LeaderboardSortMode.DESC
 
+  @Required()
   @Property()
   unique: boolean
 

src/policies/api-key.policy.ts

@@ -9,14 +9,12 @@ export default class APIKeyPolicy extends Policy {
   @UserTypeGate([UserType.ADMIN], 'create API keys')
   @EmailConfirmedGate('create API keys')
   async post(req: Request): Promise<PolicyResponse> {
-    const { gameId } = req.body
-
-    const canAccessGame = await this.canAccessGame(gameId)
-    return canAccessGame
+    const { gameId } = req.params
+    return await this.canAccessGame(Number(gameId))
   }
 
   async index(req: Request): Promise<boolean> {
-    const { gameId } = req.query
+    const { gameId } = req.params
     return await this.canAccessGame(Number(gameId))
   }
 

src/policies/data-export.policy.ts

@@ -7,14 +7,14 @@ import EmailConfirmedGate from './email-confirmed-gate'
 export default class DataExportPolicy extends Policy {
   @UserTypeGate([UserType.ADMIN], 'view data exports')
   async index(req: Request): Promise<PolicyResponse> {
-    const { gameId } = req.query
+    const { gameId } = req.params
     return await this.canAccessGame(Number(gameId))
   }
 
   @UserTypeGate([UserType.ADMIN], 'create data exports')
   @EmailConfirmedGate('create data exports')
   async post(req: Request): Promise<PolicyResponse> {
-    const { gameId } = req.body
-    return await this.canAccessGame(gameId)
+    const { gameId } = req.params
+    return await this.canAccessGame(Number(gameId))
   }
 }

src/policies/event.policy.ts

@@ -3,7 +3,7 @@ import { Request } from 'koa-clay'
 
 export default class EventPolicy extends Policy {
   async index(req: Request): Promise<boolean> {
-    const { gameId } = req.query
+    const { gameId } = req.params
     return await this.canAccessGame(Number(gameId))
   }
 }

src/policies/game-activity.policy.ts

@@ -6,7 +6,7 @@ import UserTypeGate from './user-type-gate'
 export default class GameActivityPolicy extends Policy {
   @UserTypeGate([UserType.ADMIN, UserType.DEMO], 'view game activities')
   async index(req: Request): Promise<PolicyResponse> {
-    const { gameId } = req.query
+    const { gameId } = req.params
     return await this.canAccessGame(Number(gameId))
   }
 }

src/policies/game-stat.policy.ts

@@ -6,14 +6,14 @@ import UserTypeGate from './user-type-gate'
 
 export default class GameStatPolicy extends Policy {
   async index(req: Request): Promise<PolicyResponse> {
-    const { gameId } = req.query
+    const { gameId } = req.params
     return await this.canAccessGame(Number(gameId))
   }
 
   @UserTypeGate([UserType.ADMIN, UserType.DEV], 'create stats')
   async post(req: Request): Promise<PolicyResponse> {
-    const { gameId } = req.body
-    return await this.canAccessGame(gameId)
+    const { gameId } = req.params
+    return await this.canAccessGame(Number(gameId))
   }
 
   async getStat(id: number): Promise<GameStat> {
@@ -22,7 +22,7 @@ export default class GameStatPolicy extends Policy {
     return stat
   }
 
-  async patch(req: Request): Promise<PolicyResponse> {
+  async put(req: Request): Promise<PolicyResponse> {
     const { id } = req.params
 
     const stat = await this.getStat(Number(id))