Rename playerCredentials to credentials for /leave endpoint, update src/lobby/connection.js accordingly (#416)

Author: jasonharrison

docs/api/Lobby.md

@@ -98,7 +98,7 @@ Accepts two parameters, all required:
 
 `playerID`: the ID used by the player in the game (0, 1...).
 
-`playerCredentials`: the authentication token of the player.
+`credentials`: the authentication token of the player.
 
 #### Listing all room instances of a given game
 

src/lobby/connection.js

@@ -101,7 +101,7 @@ class _LobbyConnectionImpl {
               method: 'POST',
               body: JSON.stringify({
                 playerID: player.id,
-                playerCredentials: this.playerCredentials,
+                credentials: this.playerCredentials,
               }),
               headers: { 'Content-Type': 'application/json' },
             }

src/server/api.js

@@ -183,7 +183,7 @@ export const addApiToServer = ({ app, db, games, lobbyConfig }) => {
     const gameName = ctx.params.name;
     const roomID = ctx.params.id;
     const playerID = ctx.request.body.playerID;
-    const playerCredentials = ctx.request.body.playerCredentials;
+    const credentials = ctx.request.body.credentials;
     const namespacedGameID = getNamespacedGameID(roomID, gameName);
     const gameMetadata = await db.get(GameMetadataKey(namespacedGameID));
     if (!playerID) {
@@ -196,8 +196,8 @@ export const addApiToServer = ({ app, db, games, lobbyConfig }) => {
     if (!gameMetadata.players[playerID]) {
       ctx.throw(404, 'Player ' + playerID + ' not found');
     }
-    if (playerCredentials !== gameMetadata.players[playerID].credentials) {
-      ctx.throw(403, 'Invalid credentials ' + playerCredentials);
+    if (credentials !== gameMetadata.players[playerID].credentials) {
+      ctx.throw(403, 'Invalid credentials ' + credentials);
     }
 
     delete gameMetadata.players[playerID].name;

src/server/api.test.js

@@ -476,7 +476,7 @@ describe('.createApiServer', () => {
             const app = createApiServer({ db, games });
             response = await request(app.callback())
               .post('/games/foo/1/leave')
-              .send('playerID=0&playerCredentials=SECRET1');
+              .send('playerID=0&credentials=SECRET1');
           });
 
           test('is successful', async () => {
@@ -522,7 +522,7 @@ describe('.createApiServer', () => {
               const app = createApiServer({ db, games });
               response = await request(app.callback())
                 .post('/games/foo/1/leave')
-                .send('playerID=0&playerCredentials=SECRET1');
+                .send('playerID=0&credentials=SECRET1');
               expect(setSpy).toHaveBeenCalledWith('1');
               expect(setSpy).toHaveBeenCalledWith(
                 expect.stringMatching(':metadata')
@@ -536,7 +536,7 @@ describe('.createApiServer', () => {
             const app = createApiServer({ db, games });
             response = await request(app.callback())
               .post('/games/foo/1/leave')
-              .send('playerID=2&playerCredentials=SECRET1');
+              .send('playerID=2&credentials=SECRET1');
             expect(response.status).toEqual(404);
           });
         });
@@ -546,7 +546,7 @@ describe('.createApiServer', () => {
             const app = createApiServer({ db, games });
             response = await request(app.callback())
               .post('/games/foo/1/leave')
-              .send('playerID=0&playerCredentials=SECRET2');
+              .send('playerID=0&credentials=SECRET2');
             expect(response.status).toEqual(403);
           });
         });
@@ -555,7 +555,7 @@ describe('.createApiServer', () => {
             const app = createApiServer({ db, games });
             response = await request(app.callback())
               .post('/games/foo/1/leave')
-              .send('playerCredentials=foo');
+              .send('credentials=foo');
           });
 
           test('throws error 403', async () => {