Add an API for submitting game results (does not yet trigger reconcil…

…iation).

server/lib/api/gameResults.js

@@ -0,0 +1,63 @@
+import httpErrors from 'http-errors'
+import { getUserGameRecord, setReportedResults } from '../models/games-users'
+import createThrottle from '../throttle/create-throttle'
+import throttleMiddleware from '../throttle/middleware'
+
+const throttle = createThrottle('gamesResults', {
+  rate: 10,
+  burst: 30,
+  window: 60000,
+})
+
+export default function (router) {
+  router.post(
+    '/:gameId',
+    throttleMiddleware(throttle, ctx => ctx.ip),
+    submitGameResults,
+  )
+}
+
+// TODO(tec27): clients also need to report the assigned races for each player
+async function submitGameResults(ctx, next) {
+  const { gameId } = ctx.params
+  const { userId, resultCode, results } = ctx.request.body
+
+  if (userId == null) {
+    throw new httpErrors.BadRequest('userId must be specified')
+  } else if (!resultCode) {
+    throw new httpErrors.BadRequest('resultCode must be specified')
+  } else if (!results) {
+    throw new httpErrors.BadRequest('results must be specified')
+  } else if (!Array.isArray(results) || !results.length) {
+    throw new httpErrors.BadRequest('results must be a non-empty array')
+  }
+
+  // TODO(tec27): Check that the results only contain players that are actually in the game
+  for (const result of results) {
+    if (
+      !Array.isArray(result) ||
+      result.length !== 2 ||
+      isNaN(result[1]) ||
+      result[1] < 0 ||
+      result[1] > 3
+    ) {
+      throw new httpErrors.BadRequest('results are incorrectly formatted')
+    }
+  }
+
+  const gameRecord = await getUserGameRecord(userId, gameId)
+  if (!gameRecord || gameRecord.resultCode !== resultCode) {
+    // TODO(tec27): Should we be giving this info to clients? Should we be giving *more* info?
+    throw new httpErrors.NotFound('no matching game found')
+  }
+
+  if (gameRecord.reportedResults) {
+    throw new httpErrors.Conflict('results already reported')
+  }
+
+  await setReportedResults({ userId, gameId, reportedResults: results, reportedAt: new Date() })
+
+  ctx.status = 204
+
+  // TODO(tec27): check if this game now has complete results
+}

server/lib/models/games-users.js

@@ -33,3 +33,67 @@ export async function deleteUserRecordsForGame(gameId) {
     done()
   }
 }
+
+/**
+ * Retrieves a particular user-specific game record.
+ *
+ * @param userId
+ * @param gameId
+ *
+ * @returns an object containing the information about the game, or null if there is no such game
+ */
+export async function getUserGameRecord(userId, gameId) {
+  const { client, done } = await db()
+
+  try {
+    const result = await client.query(
+      sql`SELECT * FROM games_users WHERE user_id = ${userId} AND game_id = ${gameId}`,
+    )
+    if (!result.rows.length) {
+      return null
+    }
+
+    const row = result.rows[0]
+
+    return {
+      userId: row.user_id,
+      gameId: row.game_id,
+      startTime: row.start_time,
+      selectedRace: row.selected_race,
+      resultCode: row.result_code,
+      reportedResults: row.reported_results,
+      reportedAt: row.reported_at,
+      assignedRace: row.assignedRace,
+      result: row.result,
+    }
+  } finally {
+    done()
+  }
+}
+
+/**
+ * Updates a particular user's results for a game.
+ *
+ * Results should be an array of entries containing [playerName, resultCode], where resultCode can
+ * be:
+ *
+ * - 0: playing
+ * - 1: disconnected
+ * - 2: victory
+ * - 3: defeat
+ */
+export async function setReportedResults({ userId, gameId, reportedResults, reportedAt }) {
+  const { client, done } = await db()
+
+  try {
+    await client.query(sql`
+      UPDATE games_users
+      SET
+        reported_results = ${JSON.stringify(reportedResults)},
+        reported_at = ${reportedAt}
+      WHERE user_id = ${userId} AND game_id = ${gameId}
+    `)
+  } finally {
+    done()
+  }
+}

server/lib/throttle/create-throttle.js

@@ -42,14 +42,17 @@ class IoredisTable extends RedisTable {
   }
 }
 
-// Creates a new throttle object using the specified options and our usual redis client.
-// The `name` is used in the redis key.
-// Options are:
-//  - window: the number of milliseconds in which `rate` and `burst` act
-//  - rate: how many tokens are refreshed every `window` amount of time
-//  - burst: maximum number of requests allowed in a `window` amount of time
-//  - expiry: how long the token bucket keys in redis should be set to expire for, in seconds
-//    (default: 10 * (`burst` / `rate`) `window`s)
+/**
+ * Creates a new throttle object using the specified options and our usual redis client. The `name`
+ * is used in the redis key.
+ *
+ * Options are:
+ *  - window: the number of milliseconds in which `rate` and `burst` act
+ *  - rate: how many tokens are refreshed every `window` amount of time
+ *  - burst: maximum number of requests allowed in a `window` amount of time
+ *  - expiry: how long the token bucket keys in redis should be set to expire for, in seconds
+ *    (default: 10 * (`burst` / `rate`) `window`s)
+ */
 export default function createThrottle(name, opts) {
   const table = new IoredisTable(redisClient, {
     prefix: 'sbthrottle:' + name,