fix(api): Expose gameover metadata in rooms endpoints. (#666)

* fix(api): Expose gameover metadata in rooms endpoints.

This adds the `gameover` metadata, if it exists, to both the all rooms and single room query endpoints.

Fixes #665.

* Refactor game metadata redacting into a function.

Co-authored-by: Chris Swithinbank <[email protected]>

Author: adngdb

src/server/api.test.ts

@@ -1146,6 +1146,7 @@ describe('.createRouter', () => {
                 },
               },
               unlisted: gameID === 'bar-4',
+              gameover: gameID === 'bar-3' ? { winner: 0 } : undefined,
             },
           };
         },
@@ -1165,6 +1166,7 @@ describe('.createRouter', () => {
         },
       });
     });
+
     describe('when given 2 rooms', () => {
       let response;
       let rooms;
@@ -1188,6 +1190,11 @@ describe('.createRouter', () => {
         expect(rooms[0].players).toEqual([{ id: 0 }, { id: 1 }]);
         expect(rooms[1].players).toEqual([{ id: 0 }, { id: 1 }]);
       });
+
+      test('returns gameover data for ended game', async () => {
+        expect(rooms[0].gameover).toBeUndefined();
+        expect(rooms[1].gameover).toEqual({ winner: 0 });
+      });
     });
   });
 
@@ -1209,6 +1216,7 @@ describe('.createRouter', () => {
                   credentials: 'SECRET2',
                 },
               },
+              gameover: { winner: 1 },
             },
           };
         },
@@ -1235,6 +1243,10 @@ describe('.createRouter', () => {
       test('returns player names', async () => {
         expect(room.players).toEqual([{ id: 0 }, { id: 1 }]);
       });
+
+      test('returns gameover data for ended game', async () => {
+        expect(room.gameover).toEqual({ winner: 1 });
+      });
     });
 
     describe('when given a non-existent room ID', () => {

src/server/api.ts

@@ -62,6 +62,30 @@ export const CreateGame = async ({
   return gameID;
 };
 
+/**
+ * Create a metadata object without secret credentials to return to the client.
+ *
+ * @param {string} gameID - The identifier of the game the metadata belongs to.
+ * @param {object} metadata - The game metadata object to strip credentials from.
+ * @return - A metadata object without player credentials.
+ */
+const createClientGameMetadata = (
+  gameID: string,
+  metadata: Server.GameMetadata
+) => {
+  return {
+    ...metadata,
+    gameID,
+    roomID: gameID,
+    matchID: gameID,
+    players: Object.values(metadata.players).map(player => {
+      // strip away credentials
+      const { credentials, ...strippedInfo } = player;
+      return strippedInfo;
+    }),
+  };
+};
+
 export const createRouter = ({
   db,
   games,
@@ -117,15 +141,7 @@ export const createRouter = ({
         metadata: true,
       });
       if (!metadata.unlisted) {
-        rooms.push({
-          gameID,
-          players: Object.values(metadata.players).map(player => {
-            // strip away credentials
-            const { credentials, ...strippedInfo } = player;
-            return strippedInfo;
-          }),
-          setupData: metadata.setupData,
-        });
+        rooms.push(createClientGameMetadata(gameID, metadata));
       }
     }
     ctx.body = {
@@ -141,15 +157,7 @@ export const createRouter = ({
     if (!metadata) {
       ctx.throw(404, 'Room ' + gameID + ' not found');
     }
-    const strippedRoom = {
-      roomID: gameID,
-      players: Object.values(metadata.players).map(player => {
-        const { credentials, ...strippedInfo } = player;
-        return strippedInfo;
-      }),
-      setupData: metadata.setupData,
-    };
-    ctx.body = strippedRoom;
+    ctx.body = createClientGameMetadata(gameID, metadata);
   });
 
   router.post('/games/:name/:id/join', koaBody(), async ctx => {