Merge pull request #59 from TaloDev/develop

Release 0.5.0

Author: tudddorrr

README.md

@@ -5,7 +5,10 @@ Talo's backend is a set of self-hostable services that helps you build games fas
 ## Features
 - Event tracking
 - Player management (including identity and cross-session data)
+- [Unity SDK](https://github.com/TaloDev/unity)
+- Data exports
 - Leaderboards
+- Game saves
 
 ### In progress
 - Global stats (track unique or aggregated stats e.g. total quests completed)

package.json

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

src/config/protected-routes.ts

@@ -1,5 +1,6 @@
 import Koa, { Context, Next } from 'koa'
 import { service } from 'koa-rest-services'
+import GameActivitiesService from '../services/game-activities.service'
 import LeaderboardsService from '../services/leaderboards.service'
 import DataExportsService from '../services/data-exports.service'
 import APIKeysService from '../services/api-keys.service'
@@ -17,6 +18,7 @@ export default (app: Koa) => {
     await next()
   })
 
+  app.use(service('/game-activities', new GameActivitiesService()))
   app.use(service('/leaderboards', new LeaderboardsService()))
   app.use(service('/data-exports', new DataExportsService()))
   app.use(service('/api-keys', new APIKeysService()))

src/entities/game-activity.ts

@@ -0,0 +1,79 @@
+import { Entity, Enum, ManyToOne, PrimaryKey, Property } from '@mikro-orm/core'
+import Game from './game'
+import User from './user'
+
+export enum GameActivityType {
+  PLAYER_PROPS_UPDATED,
+  LEADERBOARD_CREATED,
+  LEADERBOARD_UPDATED,
+  LEADERBOARD_DELETED,
+  LEADERBOARD_ENTRY_HIDDEN,
+  LEADERBOARD_ENTRY_RESTORED,
+  API_KEY_CREATED,
+  API_KEY_REVOKED
+}
+
+@Entity()
+export default class GameActivity {
+  @PrimaryKey()
+  id: number
+
+  @ManyToOne(() => Game)
+  game: Game
+
+  @ManyToOne(() => User)
+  user: User
+
+  @Enum(() => GameActivityType)
+  type: GameActivityType
+
+  @Property({ type: 'json' })
+  extra: {
+    [key: string]: unknown,
+    displayable?: {
+      [key: string]: string
+    }
+  } = {}
+
+  @Property()
+  createdAt: Date = new Date()
+
+  constructor(game: Game, user: User) {
+    this.game = game
+    this.user = user
+  }
+
+  /* istanbul ignore next */
+  private getActivity(): string {
+    switch (this.type) {
+      case GameActivityType.PLAYER_PROPS_UPDATED:
+        return `${this.user.email} updated a player's props`
+      case GameActivityType.LEADERBOARD_CREATED:
+        return `${this.user.email} created the leaderboard ${this.extra.leaderboardInternalName}`
+      case GameActivityType.LEADERBOARD_UPDATED:
+        return `${this.user.email} updated the leaderboard ${this.extra.leaderboardInternalName}`
+      case GameActivityType.LEADERBOARD_DELETED:
+        return `${this.user.email} deleted the leaderboard ${this.extra.leaderboardInternalName}`
+      case GameActivityType.LEADERBOARD_ENTRY_HIDDEN:
+        return `${this.user.email} hid a leaderboard entry in ${this.extra.leaderboardInternalName}`
+      case GameActivityType.LEADERBOARD_ENTRY_RESTORED:
+        return `${this.user.email} restored a leaderboard entry in ${this.extra.leaderboardInternalName}`
+      case GameActivityType.API_KEY_CREATED:
+        return `${this.user.email} created an access key`
+      case GameActivityType.API_KEY_REVOKED:
+        return `${this.user.email} remove an access key`
+      default:
+        return ''
+    }
+  }
+
+  toJSON() {
+    return {
+      id: this.id,
+      type: this.type,
+      description: this.getActivity(),
+      extra: this.extra.display,
+      createdAt: this.createdAt
+    }
+  }
+}

src/entities/index.ts

@@ -1,3 +1,4 @@
+import GameActivity from './game-activity'
 import GameSave from './game-save'
 import Leaderboard from './leaderboard'
 import LeaderboardEntry from './leaderboard-entry'
@@ -17,6 +18,7 @@ import UserTwoFactorAuth from './user-two-factor-auth'
 import UserRecoveryCode from './user-recovery-code'
 
 export default [
+  GameActivity,
   GameSave,
   UserRecoveryCode,
   UserTwoFactorAuth,

src/entities/leaderboard-entry.ts

@@ -34,6 +34,7 @@ export default class LeaderboardEntry {
       id: this.id,
       score: this.score,
       leaderboardName: this.leaderboard.name,
+      leaderboardInternalName: this.leaderboard.internalName,
       playerAlias: {
         id: this.playerAlias.id,
         service: this.playerAlias.service,

src/lib/logging/createGameActivity.ts

@@ -0,0 +1,12 @@
+import { EntityManager } from '@mikro-orm/core'
+import GameActivity from '../../entities/game-activity'
+
+export default async function createGameActivity(em: EntityManager, data: Partial<GameActivity>): Promise<GameActivity> {
+  const activity = new GameActivity(data.game, data.user)
+  activity.type = data.type
+  activity.extra = data.extra
+
+  em.persist(activity)
+
+  return activity
+}

src/migrations/20220125220401CreateGameActivitiesTable.ts

@@ -0,0 +1,14 @@
+import { Migration } from '@mikro-orm/migrations'
+
+export class CreateGameActivitiesTable extends Migration {
+
+  async up(): Promise<void> {
+    this.addSql('create table `game_activity` (`id` int unsigned not null auto_increment primary key, `game_id` int(11) unsigned not null, `user_id` int(11) unsigned not null, `type` tinyint not null, `extra` json not null, `created_at` datetime not null) default character set utf8mb4 engine = InnoDB;')
+    this.addSql('alter table `game_activity` add index `game_activity_game_id_index`(`game_id`);')
+    this.addSql('alter table `game_activity` add index `game_activity_user_id_index`(`user_id`);')
+
+    this.addSql('alter table `game_activity` add constraint `game_activity_game_id_foreign` foreign key (`game_id`) references `game` (`id`) on update cascade;')
+    this.addSql('alter table `game_activity` add constraint `game_activity_user_id_foreign` foreign key (`user_id`) references `user` (`id`) on update cascade;')
+  }
+
+}

src/migrations/index.ts

@@ -6,6 +6,7 @@ import { CreateUserRecoveryCodeTable } from './20211209003017CreateUserRecoveryC
 import { CascadeDeletePlayerAliasEvents } from './20211221195514CascadeDeletePlayerAliasEvents'
 import { AddLeaderboardEntryHiddenColumn } from './20211224154919AddLeaderboardEntryHiddenColumn'
 import { CreateGameSavesTable } from './20220109144435CreateGameSavesTable'
+import { CreateGameActivitiesTable } from './20220125220401CreateGameActivitiesTable'
 
 export default [
   {
@@ -39,5 +40,9 @@ export default [
   {
     name: 'CreateGameSavesTable',
     class: CreateGameSavesTable
+  },
+  {
+    name: 'CreateGameActivitiesTable',
+    class: CreateGameActivitiesTable
   }
 ]

src/policies/game-activities.policy.ts

@@ -0,0 +1,9 @@
+import Policy from './policy'
+import { ServiceRequest } from 'koa-rest-services'
+
+export default class GameActivitysPolicy extends Policy {
+  async index(req: ServiceRequest): Promise<boolean> {
+    const { gameId } = req.query
+    return await this.canAccessGame(Number(gameId))
+  }
+}