Merge pull request #62 from TaloDev/develop

tudddorrr · web-flow · commit 65b578009164 · 2022-02-04T20:20:16.000Z
Release 0.5.1
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,17 @@
+hangelog:
+  exclude:
+    labels:
+      - release
+  categories:
+    - title: Breaking changes
+      labels:
+        - breaking
+    - title: Features
+      labels:
+        - enhancement
+    - title: Fixes
+      labels:
+        - fix
+    - title: Other
+      labels:
+        - "*"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -27,14 +27,11 @@ jobs:
       - name: Install deps
         run: yarn --prefer-offline
 
-      - name: Setup Docker
-        run: |
-          cp envs/.env.dev .env
-          yarn dc up -d db
-          echo Waiting for DB to be ready...
-          sleep '10s'
-
-      - run: yarn test
+      - name: Setup environment
+        run: cp envs/.env.dev .env
+
+      - name: Run tests
+        run: yarn test
 
       - uses: codecov/codecov-action@v1
         with:
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -0,0 +1,19 @@
+
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Create release
+        uses: softprops/action-gh-release@v1
+        if: "!contains(github.event.head_commit.message, '--no-release')"
+        with:
+          generate_release_notes: true
diff --git a/_templates/service/new/policy.ejs.t b/_templates/service/new/policy.ejs.t
@@ -6,7 +6,7 @@ import { ServicePolicyResponse, ServicePolicyDenial } from 'koa-rest-services'
 import { UserType } from '../entities/user'
 
 export default class <%= h.changeCase.pascal(name) %>sPolicy extends Policy {
-  async get(): Promise<boolean> {
+  async get(): Promise<ServicePolicyResponse> {
     return true
   }
 
diff --git a/envs/.env.test b/envs/.env.test
@@ -1,4 +1,7 @@
 DB_HOST=127.0.0.1
+DB_PORT=3307
+DB_NAME=gs_test
+DB_PASS=password
 
 SENDGRID_KEY=
 SENTRY_DSN=
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "game-services",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "",
   "main": "src/index.ts",
   "scripts": {
diff --git a/src/entities/user-two-factor-auth.ts b/src/entities/user-two-factor-auth.ts
@@ -12,7 +12,7 @@ export default class UserTwoFactorAuth {
   @Property({ hidden: true })
   secret: string
 
-  @Property()
+  @Property({ default: false })
   enabled: boolean
 
   constructor(secret: string) {
diff --git a/src/migrations/20220203130919SetUserTwoFactorAuthEnabledDefaultFalse.ts b/src/migrations/20220203130919SetUserTwoFactorAuthEnabledDefaultFalse.ts
@@ -0,0 +1,9 @@
+import { Migration } from '@mikro-orm/migrations'
+
+export class SetUserTwoFactorAuthEnabledDefaultFalse extends Migration {
+
+  async up(): Promise<void> {
+    this.addSql('alter table `user_two_factor_auth` modify `enabled` tinyint(1) default false;')
+  }
+
+}
diff --git a/src/migrations/index.ts b/src/migrations/index.ts
@@ -7,6 +7,7 @@ import { CascadeDeletePlayerAliasEvents } from './20211221195514CascadeDeletePla
 import { AddLeaderboardEntryHiddenColumn } from './20211224154919AddLeaderboardEntryHiddenColumn'
 import { CreateGameSavesTable } from './20220109144435CreateGameSavesTable'
 import { CreateGameActivitiesTable } from './20220125220401CreateGameActivitiesTable'
+import { SetUserTwoFactorAuthEnabledDefaultFalse } from './20220203130919SetUserTwoFactorAuthEnabledDefaultFalse'
 
 export default [
   {
@@ -44,5 +45,9 @@ export default [
   {
     name: 'CreateGameActivitiesTable',
     class: CreateGameActivitiesTable
+  },
+  {
+    name: 'SetUserTwoFactorAuthEnabledDefaultFalse',
+    class: SetUserTwoFactorAuthEnabledDefaultFalse
   }
 ]
diff --git a/src/policies/game-activities.policy.ts b/src/policies/game-activities.policy.ts
@@ -1,9 +1,16 @@
 import Policy from './policy'
-import { ServiceRequest } from 'koa-rest-services'
+import { ServicePolicyDenial, ServicePolicyResponse, ServiceRequest } from 'koa-rest-services'
+import { UserType } from '../entities/user'
 
 export default class GameActivitysPolicy extends Policy {
-  async index(req: ServiceRequest): Promise<boolean> {
+  async index(req: ServiceRequest): Promise<ServicePolicyResponse> {
     const { gameId } = req.query
+
+    const user = await this.getUser()
+    if (user.type === UserType.DEV) {
+      return new ServicePolicyDenial({ message: 'You do not have permissions to view game activities' })
+    }
+
     return await this.canAccessGame(Number(gameId))
   }
 }
diff --git a/src/policies/policy.ts b/src/policies/policy.ts
@@ -41,7 +41,7 @@ export default class Policy extends ServicePolicy {
 
   async canAccessGame(gameId: number): Promise<boolean> {
     const game = await this.em.getRepository(Game).findOne(gameId, ['organisation'])
-    if (!game) this.ctx.throw(404, 'The specified game doesn\'t exist')
+    if (!game) this.ctx.throw(404, 'Game not found')
     this.ctx.state.game = game
 
     const user = await this.getUser()
diff --git a/src/services/leaderboards.service.ts b/src/services/leaderboards.service.ts
@@ -229,7 +229,7 @@ export default class LeaderboardsService implements Service {
       extra: {
         leaderboardInternalName: leaderboard.internalName,
         display: {
-          'Updated properties': Object.keys(req.body).map((key) => `${key}: ${req.body[key]}`).join(', ')
+          'Updated properties': Object.keys(req.body).filter((key) => key !== 'gameId').map((key) => `${key}: ${req.body[key]}`).join(', ')
         }
       }
     })
diff --git a/src/services/public/demo.service.ts b/src/services/public/demo.service.ts
@@ -10,6 +10,7 @@ import createQueue from '../../lib/queues/createQueue'
 import UserSession from '../../entities/user-session'
 import Event from '../../entities/event'
 import randomDate from '../../lib/dates/randomDate'
+import bcrypt from 'bcrypt'
 
 interface DemoUserJob {
   userId: number
@@ -44,6 +45,7 @@ export default class DemoService implements Service {
     user.type = UserType.DEMO
     user.organisation = await em.getRepository(Organisation).findOne({ name: process.env.DEMO_ORGANISATION_NAME })
     user.emailConfirmed = true
+    user.password = await bcrypt.hash(user.email, 10)
 
     await em.getRepository(User).persistAndFlush(user)
 
diff --git a/tests/fixtures/LeaderboardEntryFactory.ts b/tests/fixtures/LeaderboardEntryFactory.ts
@@ -24,7 +24,8 @@ export default class LeaderboardEntryFactory extends Factory<LeaderboardEntry> {
     return {
       leaderboard: this.leaderboard,
       playerAlias: casual.random_element(player.aliases.getItems()),
-      score: Number(casual.double(10, 100000).toFixed(2))
+      score: Number(casual.double(10, 100000).toFixed(2)),
+      hidden: false
     }
   }
 
diff --git a/tests/refresh-db.ts b/tests/refresh-db.ts
diff --git a/tests/services/_api/leaderboards-api/get.test.ts b/tests/services/_api/leaderboards-api/get.test.ts
@@ -43,26 +43,7 @@ describe('Leaderboards API service - get', () => {
 
     apiKey.scopes = [APIKeyScope.READ_LEADERBOARDS]
     const players = await new PlayerFactory([game]).many(3)
-    const entries = await new LeaderboardEntryFactory(leaderboard, players).many(5)
-
-    await (<EntityManager>app.context.em).persistAndFlush([...players, ...entries])
-    token = await createToken(apiKey)
-
-    const res = await request(app.callback())
-      .get(`${baseUrl}/${leaderboard.internalName}/entries`)
-      .query({ page: 0 })
-      .auth(token, { type: 'bearer' })
-      .expect(200)
-
-    expect(res.body.entries).toHaveLength(entries.length)
-  })
-
-  it('should get leaderboard entries if the scope is valid', async () => {
-    const leaderboard = await new LeaderboardFactory([game]).one()
-
-    apiKey.scopes = [APIKeyScope.READ_LEADERBOARDS]
-    const players = await new PlayerFactory([game]).many(3)
-    const entries = await new LeaderboardEntryFactory(leaderboard, players).many(5)
+    const entries = await new LeaderboardEntryFactory(leaderboard, players).many(3)
     const hiddenEntries = await new LeaderboardEntryFactory(leaderboard, players).state('hidden').many(3)
 
     await (<EntityManager>app.context.em).persistAndFlush([...players, ...entries, ...hiddenEntries])
diff --git a/tests/services/_public/demo/post.test.ts b/tests/services/_public/demo/post.test.ts
@@ -51,14 +51,14 @@ describe('Demo service - post', () => {
 
     let oldEvents = events.filter((event) => event.createdAt < sub(new Date(), { months: 3 }))
     expect(oldEvents.length).toBeGreaterThan(0)
- 
+
     await request(app.callback())
       .post(`${baseUrl}`)
       .expect(200)
 
     await (<EntityManager>app.context.em).clear()
 
-    const updatedEvents = await (<EntityManager>app.context.em).getRepository(Event).findAll() 
+    const updatedEvents = await (<EntityManager>app.context.em).getRepository(Event).findAll()
     oldEvents = updatedEvents.filter((event) => event.createdAt < sub(new Date(), { months: 3 }))
 
     expect(oldEvents).toHaveLength(0)
diff --git a/tests/services/api-keys/get.test.ts b/tests/services/api-keys/get.test.ts
@@ -51,7 +51,7 @@ describe('API keys service - get', () => {
       .auth(token, { type: 'bearer' })
       .expect(404)
 
-    expect(res.body).toStrictEqual({ message: 'The specified game doesn\'t exist' })
+    expect(res.body).toStrictEqual({ message: 'Game not found' })
   })
 
   it('should not return a list of api keys for a game the user has no access to', async () => {
diff --git a/tests/services/api-keys/post.test.ts b/tests/services/api-keys/post.test.ts
@@ -73,7 +73,7 @@ describe('API keys service - post', () => {
       .auth(token, { type: 'bearer' })
       .expect(404)
 
-    expect(res.body).toStrictEqual({ message: 'The specified game doesn\'t exist' })
+    expect(res.body).toStrictEqual({ message: 'Game not found' })
   })
 
   it('should not create an api key for a game the user has no access to', async () => {
diff --git a/tests/services/events/get.test.ts b/tests/services/events/get.test.ts
@@ -204,7 +204,7 @@ describe('Events service - get', () => {
       .auth(token, { type: 'bearer' })
       .expect(404)
 
-    expect(res.body).toStrictEqual({ message: 'The specified game doesn\'t exist' })
+    expect(res.body).toStrictEqual({ message: 'Game not found' })
   })
 
   it('should not return a list of events for a game the user has no access to', async () => {
diff --git a/tests/services/game-activities/index.test.ts b/tests/services/game-activities/index.test.ts
@@ -8,21 +8,24 @@ import UserFactory from '../../fixtures/UserFactory'
 import Game from '../../../src/entities/game'
 import GameFactory from '../../fixtures/GameFactory'
 import GameActivityFactory from '../../fixtures/GameActivityFactory'
+import GameActivity from '../../../src/entities/game-activity'
 
 const baseUrl = '/game-activities'
 
 describe('Game activities service - index', () => {
   let app: Koa
   let user: User
   let game: Game
+  let activities: GameActivity[]
   let token: string
 
   beforeAll(async () => {
     app = await init()
 
-    user = await new UserFactory().one()
+    user = await new UserFactory().state('admin').one()
     game = await new GameFactory(user.organisation).one()
-    await (<EntityManager>app.context.em).persistAndFlush([user, game])
+    activities = await new GameActivityFactory([game], [user]).many(5)
+    await (<EntityManager>app.context.em).persistAndFlush([user, game, ...activities])
 
     token = await genAccessToken(user)
   })
@@ -31,10 +34,7 @@ describe('Game activities service - index', () => {
     await (<EntityManager>app.context.em).getConnection().close()
   })
 
-  it('should return a list of game activities', async () => {
-    const activities = await new GameActivityFactory([game], [user]).many(10)
-    await (<EntityManager>app.context.em).persistAndFlush(activities)
-
+  it('should return a list of game activities for an admin user', async () => {
     const res = await request(app.callback())
       .get(`${baseUrl}`)
       .query({ gameId: game.id })
@@ -44,6 +44,34 @@ describe('Game activities service - index', () => {
     expect(res.body.activities).toHaveLength(activities.length)
   })
 
+  it('should not return a list of game activities for a dev user', async () => {
+    const devUser = await new UserFactory().with(() => ({ organisation: game.organisation })).one()
+    await (<EntityManager>app.context.em).persistAndFlush(devUser)
+    const devToken = await genAccessToken(devUser)
+
+    const res = await request(app.callback())
+      .get(`${baseUrl}`)
+      .query({ gameId: game.id })
+      .auth(devToken, { type: 'bearer' })
+      .expect(403)
+
+    expect(res.body).toStrictEqual({ message: 'You do not have permissions to view game activities' })
+  })
+
+  it('should return a list of game activities for a demo user', async () => {
+    const demoUser = await new UserFactory().state('demo').with(() => ({ organisation: game.organisation })).one()
+    await (<EntityManager>app.context.em).persistAndFlush(demoUser)
+    const demoToken = await genAccessToken(demoUser)
+
+    const res = await request(app.callback())
+      .get(`${baseUrl}`)
+      .query({ gameId: game.id })
+      .auth(demoToken, { type: 'bearer' })
+      .expect(200)
+
+    expect(res.body.activities).toHaveLength(activities.length)
+  })
+
   it('should not return a list of game activities for a game the user has no access to', async () => {
     const otherUser = await new UserFactory().one()
     const otherGame = await new GameFactory(otherUser.organisation).one()
diff --git a/tests/services/leaderboards/index.test.ts b/tests/services/leaderboards/index.test.ts
@@ -54,7 +54,7 @@ describe('Leaderboards service - index', () => {
       .auth(token, { type: 'bearer' })
       .expect(404)
 
-    expect(res.body).toStrictEqual({ message: 'The specified game doesn\'t exist' })
+    expect(res.body).toStrictEqual({ message: 'Game not found' })
   })
 
   it('should not return leaderboards for a game the user has no access to', async () => {
diff --git a/tests/services/leaderboards/post.test.ts b/tests/services/leaderboards/post.test.ts
@@ -95,7 +95,7 @@ describe('Leaderboards service - post', () => {
       .auth(token, { type: 'bearer' })
       .expect(404)
 
-    expect(res.body).toStrictEqual({ message: 'The specified game doesn\'t exist' })
+    expect(res.body).toStrictEqual({ message: 'Game not found' })
   })
 
   it('should not create a leaderboard with an invalid sort mode', async () => {
diff --git a/tests/services/players/get.test.ts b/tests/services/players/get.test.ts
@@ -50,7 +50,7 @@ describe('Players service - get', () => {
       .auth(token, { type: 'bearer' })
       .expect(404)
 
-    expect(res.body).toStrictEqual({ message: 'The specified game doesn\'t exist' })
+    expect(res.body).toStrictEqual({ message: 'Game not found' })
   })
 
   it('should not return a list of players for a game the user has no access to', async () => {
diff --git a/tests/services/players/post.test.ts b/tests/services/players/post.test.ts
@@ -85,7 +85,7 @@ describe('Players service - post', () => {
       .auth(token, { type: 'bearer' })
       .expect(404)
 
-    expect(res.body).toStrictEqual({ message: 'The specified game doesn\'t exist' })
+    expect(res.body).toStrictEqual({ message: 'Game not found' })
   })
 
   it('should not create a player for a game the user has no access to', async () => {
diff --git a/tests/setup-tests.sh b/tests/setup-tests.sh

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import { ServicePolicyResponse, ServicePolicyDenial } from 'koa-rest-services'`
`6`	`6`	`import { UserType } from '../entities/user'`
`7`	`7`
`8`	`8`	`export default class <%= h.changeCase.pascal(name) %>sPolicy extends Policy {`
`9`		`- async get(): Promise<boolean> {`
	`9`	`+ async get(): Promise<ServicePolicyResponse> {`
`10`	`10`	`return true`
`11`	`11`	`}`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "game-services",`
`3`		`- "version": "0.5.0",`
	`3`	`+ "version": "0.5.1",`
`4`	`4`	`"description": "",`
`5`	`5`	`"main": "src/index.ts",`
`6`	`6`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ import { CascadeDeletePlayerAliasEvents } from './20211221195514CascadeDeletePla`
`7`	`7`	`import { AddLeaderboardEntryHiddenColumn } from './20211224154919AddLeaderboardEntryHiddenColumn'`
`8`	`8`	`import { CreateGameSavesTable } from './20220109144435CreateGameSavesTable'`
`9`	`9`	`import { CreateGameActivitiesTable } from './20220125220401CreateGameActivitiesTable'`
	`10`	`+import { SetUserTwoFactorAuthEnabledDefaultFalse } from './20220203130919SetUserTwoFactorAuthEnabledDefaultFalse'`
`10`	`11`
`11`	`12`	`export default [`
`12`	`13`	`{`
`@@ -44,5 +45,9 @@ export default [`
`44`	`45`	`{`
`45`	`46`	`name: 'CreateGameActivitiesTable',`
`46`	`47`	`class: CreateGameActivitiesTable`
	`48`	`+ },`
	`49`	`+ {`
	`50`	`+ name: 'SetUserTwoFactorAuthEnabledDefaultFalse',`
	`51`	`+ class: SetUserTwoFactorAuthEnabledDefaultFalse`
`47`	`52`	`}`
`48`	`53`	`]`