Add option to exclude games from public listing (#653)

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

Author: c-w

docs/documentation/api/Lobby.md

@@ -52,12 +52,14 @@ Options are:
 
 Creates a new authenticated room for a game named `name`.
 
-Accepts two parameters:
+Accepts three parameters:
 
 `numPlayers` (required): the number of players.
 
 `setupData` (optional): custom object that is passed to the game `setup` function.
 
+`unlisted` (optional): if set to `true`, the room will be excluded from the public list of room instances.
+
 Returns `roomID`, which is the ID of the newly created game instance.
 
 #### Joining a game

src/server/api.test.ts

@@ -96,6 +96,7 @@ describe('.createApiServer', () => {
                 '1': 'red',
               },
             },
+            unlisted: true,
           });
       });
 
@@ -142,6 +143,7 @@ describe('.createApiServer', () => {
                 '1': 'red',
               }),
             }),
+            unlisted: true,
           })
         );
       });
@@ -1041,7 +1043,7 @@ describe('.createApiServer', () => {
     beforeEach(() => {
       delete process.env.API_SECRET;
       db = new AsyncStorage({
-        fetch: async () => {
+        fetch: async gameID => {
           return {
             metadata: {
               players: {
@@ -1054,6 +1056,7 @@ describe('.createApiServer', () => {
                   credentials: 'SECRET2',
                 },
               },
+              unlisted: gameID === 'bar-4',
             },
           };
         },
@@ -1063,6 +1066,7 @@ describe('.createApiServer', () => {
             'foo-1': { gameName: 'foo' },
             'bar-2': { gameName: 'bar' },
             'bar-3': { gameName: 'bar' },
+            'bar-4': { gameName: 'bar' },
           };
           const keys = Object.keys(metadata);
           if (opts && opts.gameName) {

src/server/api.ts

@@ -16,8 +16,9 @@ import { InitializeGame } from '../core/initialize';
 import * as StorageAPI from './db/base';
 import { Server, Game } from '../types';
 
-const createGameMetadata = ({ gameName }): Server.GameMetadata => ({
+const createGameMetadata = ({ gameName, unlisted }): Server.GameMetadata => ({
   gameName,
+  unlisted,
   players: {},
   setupData: {},
 });
@@ -31,15 +32,17 @@ const createGameMetadata = ({ gameName }): Server.GameMetadata => ({
  * @param {object} setupData - User-defined object that's available
  *                             during game setup.
  * @param {object } lobbyConfig - Configuration options for the lobby.
+ * @param {boolean} unlisted - Whether the game should be excluded from public listing.
  */
 export const CreateGame = async (
   db: StorageAPI.Sync | StorageAPI.Async,
   game: Game,
   numPlayers: number,
   setupData: object,
-  lobbyConfig: Server.LobbyConfig
+  lobbyConfig: Server.LobbyConfig,
+  unlisted: boolean
 ) => {
-  const gameMetadata = createGameMetadata({ gameName: game.name });
+  const gameMetadata = createGameMetadata({ gameName: game.name, unlisted });
 
   const state = InitializeGame({
     game,
@@ -106,6 +109,8 @@ export const addApiToServer = ({
     const gameName = ctx.params.name;
     // User-data to pass to the game setup function.
     const setupData = ctx.request.body.setupData;
+    // Whether the game should be excluded from public listing.
+    const unlisted = ctx.request.body.unlisted;
     // The number of players for this game instance.
     let numPlayers = parseInt(ctx.request.body.numPlayers);
     if (!numPlayers) {
@@ -118,7 +123,8 @@ export const addApiToServer = ({
       game,
       numPlayers,
       setupData,
-      lobbyConfig
+      lobbyConfig,
+      unlisted
     );
 
     ctx.body = {
@@ -134,15 +140,17 @@ export const addApiToServer = ({
       const { metadata } = await (db as StorageAPI.Async).fetch(gameID, {
         metadata: true,
       });
-      rooms.push({
-        gameID,
-        players: Object.values(metadata.players).map((player: any) => {
-          // strip away credentials
-          const { credentials, ...strippedInfo } = player;
-          return strippedInfo;
-        }),
-        setupData: metadata.setupData,
-      });
+      if (!metadata.unlisted) {
+        rooms.push({
+          gameID,
+          players: Object.values(metadata.players).map((player: any) => {
+            // strip away credentials
+            const { credentials, ...strippedInfo } = player;
+            return strippedInfo;
+          }),
+          setupData: metadata.setupData,
+        });
+      }
     }
     ctx.body = {
       rooms: rooms,
@@ -243,6 +251,7 @@ export const addApiToServer = ({
     const gameID = ctx.params.id;
     const playerID = ctx.request.body.playerID;
     const credentials = ctx.request.body.credentials;
+    const unlisted = ctx.request.body.unlisted;
     const { metadata } = await (db as StorageAPI.Async).fetch(gameID, {
       metadata: true,
     });
@@ -280,7 +289,8 @@ export const addApiToServer = ({
       game,
       numPlayers,
       setupData,
-      lobbyConfig
+      lobbyConfig,
+      unlisted
     );
     metadata.nextRoomID = nextRoomID;
 

src/types.ts

@@ -278,6 +278,7 @@ export namespace Server {
     setupData: any;
     gameover?: any;
     nextRoomID?: string;
+    unlisted?: boolean;
   }
 
   export interface LobbyConfig {