Merge pull request #111 from TaloDev/develop

Release 0.15.0

Author: tudddorrr

package.json

@@ -1,6 +1,6 @@
 {
   "name": "game-services",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "",
   "main": "src/index.ts",
   "scripts": {

src/entities/event.ts

@@ -1,8 +1,11 @@
 import { Entity, Embedded, ManyToOne, PrimaryKey, Property, Cascade } from '@mikro-orm/core'
+import sanitiseProps from '../lib/props/sanitiseProps'
 import Game from './game'
 import PlayerAlias from './player-alias'
 import Prop from './prop'
 
+const eventMetaProps = ['META_OS', 'META_GAME_VERSION', 'META_WINDOW_MODE', 'META_SCREEN_WIDTH', 'META_SCREEN_HEIGHT']
+
 @Entity()
 export default class Event {
   @PrimaryKey()
@@ -31,6 +34,18 @@ export default class Event {
     this.game = game
   }
 
+  setProps(props: Prop[]) {
+    this.props = sanitiseProps(props, true, (prop) => {
+      return !prop.key.startsWith('META_') || eventMetaProps.includes(prop.key)
+    })
+
+    this.props.forEach((prop) => {
+      if (eventMetaProps.includes(prop.key)) {
+        this.playerAlias.player.props.push(prop)
+      }
+    })
+  }
+
   toJSON() {
     return {
       id: this.id,

src/lib/props/sanitiseProps.ts

@@ -1,9 +1,12 @@
 import Prop from '../../entities/prop'
 
-const sanitiseProps = (props: Prop[], deleteNull = false): Prop[] => {
+const sanitiseProps = (props: Prop[], deleteNull = false, extraFilter?: (prop: Prop) => boolean): Prop[] => {
   if (deleteNull) props = props.filter((prop) => prop.value !== null)
 
-  return props.filter((prop) => Boolean(prop.key)).map((prop) => new Prop(String(prop.key), prop.value ? String(prop.value) : null))
+  return props
+    .filter((prop) => Boolean(prop.key))
+    .filter((prop) => extraFilter?.(prop) ?? true)
+    .map((prop) => new Prop(String(prop.key), prop.value ? String(prop.value) : null))
 }
 
 export default sanitiseProps

src/policies/api-key.policy.ts

@@ -3,15 +3,14 @@ import { PolicyDenial, Request, PolicyResponse } from 'koa-clay'
 import APIKey from '../entities/api-key'
 import { UserType } from '../entities/user'
 import UserTypeGate from './user-type-gate'
+import EmailConfirmedGate from './email-confirmed-gate'
 
 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 user = await this.getUser()
-    if (!user.emailConfirmed) return new PolicyDenial({ message: 'You need to confirm your email address to do this' })
-
     const canAccessGame = await this.canAccessGame(gameId)
     return canAccessGame
   }

src/policies/data-export.policy.ts

@@ -1,7 +1,8 @@
 import Policy from './policy'
-import { PolicyDenial, Request, PolicyResponse } from 'koa-clay'
+import { Request, PolicyResponse } from 'koa-clay'
 import { UserType } from '../entities/user'
 import UserTypeGate from './user-type-gate'
+import EmailConfirmedGate from './email-confirmed-gate'
 
 export default class DataExportPolicy extends Policy {
   @UserTypeGate([UserType.ADMIN], 'view data exports')
@@ -11,12 +12,9 @@ export default class DataExportPolicy extends Policy {
   }
 
   @UserTypeGate([UserType.ADMIN], 'create data exports')
+  @EmailConfirmedGate('create data exports')
   async post(req: Request): Promise<PolicyResponse> {
     const { gameId } = req.body
-
-    const user = await this.getUser()
-    if (!user.emailConfirmed) return new PolicyDenial({ message: 'You need to confirm your email address to create data exports' })
-
     return await this.canAccessGame(gameId)
   }
 }

src/policies/email-confirmed-gate.ts

@@ -0,0 +1,22 @@
+import { Request } from 'koa-clay'
+import Policy from './policy'
+
+const EmailConfirmedGate = (action: string) => (tar: Policy, _: string, descriptor: PropertyDescriptor) => {
+  const base = descriptor.value
+
+  descriptor.value = async function (...args) {
+    const req: Request = args[0]
+
+    if (!req.ctx.state.user.api) {
+      const user = await tar.getUser(req)
+      if (!user.emailConfirmed) req.ctx.throw(403, `You need to confirm your email address to ${action}`)
+    }
+
+    const result = await base.apply(this, args)
+    return result
+  }
+
+  return descriptor
+}
+
+export default EmailConfirmedGate

src/policies/invite.policy.ts

@@ -2,6 +2,7 @@ import Policy from './policy'
 import { PolicyResponse } from 'koa-clay'
 import { UserType } from '../entities/user'
 import UserTypeGate from './user-type-gate'
+import EmailConfirmedGate from './email-confirmed-gate'
 
 export default class InvitePolicy extends Policy {
   @UserTypeGate([UserType.ADMIN], 'view invites')
@@ -10,6 +11,7 @@ export default class InvitePolicy extends Policy {
   }
 
   @UserTypeGate([UserType.ADMIN], 'create invites')
+  @EmailConfirmedGate('create invites')
   async post(): Promise<PolicyResponse> {
     return true
   }

src/services/api/event-api.service.ts

@@ -7,7 +7,6 @@ import APIService from './api-service'
 import APIKey from '../../entities/api-key'
 import PlayerAlias from '../../entities/player-alias'
 import groupBy from 'lodash.groupby'
-import sanitiseProps from '../../lib/props/sanitiseProps'
 
 export default class EventAPIService extends APIService<EventService> {
   constructor() {
@@ -66,11 +65,8 @@ export default class EventAPIService extends APIService<EventService> {
 
         if (item.props) {
           try {
-            if (!Array.isArray(item.props)) {
-              throw new Error('Props must be an array')
-            }
-
-            event.props = sanitiseProps(item.props, true)
+            if (!Array.isArray(item.props)) throw new Error('Props must be an array')
+            event.setProps(item.props)
           } catch (err) {
             errors[i].push(err.message)
           }

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

@@ -228,4 +228,42 @@ describe('Event API service - post', () => {
 
     expect(res.body.errors[0]).toStrictEqual(['Props must be an array'])
   })
+
+  it('should add valid meta props to the player\'s props', async () => {
+    apiKey.scopes = [APIKeyScope.WRITE_EVENTS]
+    await (<EntityManager>app.context.em).flush()
+    token = await createToken(apiKey)
+
+    await request(app.callback())
+      .post(`${baseUrl}`)
+      .send({
+        events: [
+          { name: 'Equip bow', aliasId: validPlayer.aliases[0].id, timestamp: Date.now(), props: [{ key: 'META_OS', value: 'macOS' }] }
+        ]
+      })
+      .auth(token, { type: 'bearer' })
+      .expect(200)
+
+    const player = await (<EntityManager>app.context.em).getRepository(Player).findOne(validPlayer.id, { refresh: true })
+    expect(player.props).toContainEqual({ key: 'META_OS', value: 'macOS' })
+  })
+
+  it('should strip out event props that start with META_ but aren\'t in the meta props list', async () => {
+    apiKey.scopes = [APIKeyScope.WRITE_EVENTS]
+    await (<EntityManager>app.context.em).flush()
+    token = await createToken(apiKey)
+
+    const res = await request(app.callback())
+      .post(`${baseUrl}`)
+      .send({
+        events: [
+          { name: 'Equip bow', aliasId: validPlayer.aliases[0].id, timestamp: Date.now(), props: [{ key: 'META_NO_WAY', value: 'true' }, { key: 'META_OS', value: 'macOS' }] }
+        ]
+      })
+      .auth(token, { type: 'bearer' })
+      .expect(200)
+
+    expect(res.body.events[0].props).toContainEqual({ key: 'META_OS', value: 'macOS' })
+    expect(res.body.events[0].props).not.toContainEqual({ key: 'META_NO_WAY', value: 'true' })
+  })
 })

tests/services/api-key/post.test.ts

@@ -69,7 +69,7 @@ describe('API key service - post', () => {
       .auth(token, { type: 'bearer' })
       .expect(403)
 
-    expect(res.body).toStrictEqual({ message: 'You need to confirm your email address to do this' })
+    expect(res.body).toStrictEqual({ message: 'You need to confirm your email address to create API keys' })
   })
 
   it('should not create an api key for a non-existent game', async () => {