Add optional "participants" parameter to create draft API endpoint

Author: ZetaTwo

src/DraftServer.ts

@@ -152,6 +152,13 @@ export class DraftServer {
                 socket.emit('message', 'This draft does not exist.');
                 return;
             }
+
+            const draft = draftsStore.getDraftOrThrow(draftId)
+            if (draft.fixedNames) {
+                logger.info("Draft is using fixed names. Setting roles but not changing names", {draftId});
+            }
+
+            let assignedName = message.name;
             const role: Player = Util.sanitizeRole(message.role);
             let assignedRole = Util.getAssignedRole(socket, roomHost, roomGuest);
             let hasAssignedRole = false;
@@ -160,14 +167,16 @@ export class DraftServer {
                     logger.info("Setting player role to 'HOST': %s", message.name, {draftId});
                     socket.join(roomHost); // async
                     socket.leave(roomSpec); // async
-                    draftsStore.connectPlayer(draftId, Player.HOST, message.name);
+                    assignedName = draft.fixedNames ? draft.nameHost : message.name;
+                    draftsStore.connectPlayer(draftId, Player.HOST, assignedName);
                     assignedRole = Player.HOST;
                     hasAssignedRole = true;
                 } else if (role === Player.GUEST && !draftsStore.isPlayerConnected(draftId, role)) {
                     logger.info("Setting player role to 'GUEST': %s", message.name, {draftId});
                     socket.join(roomGuest); // async
                     socket.leave(roomSpec); // async
-                    draftsStore.connectPlayer(draftId, Player.GUEST, message.name);
+                    assignedName = draft.fixedNames ? draft.nameGuest : message.name;
+                    draftsStore.connectPlayer(draftId, Player.GUEST, assignedName);
                     assignedRole = Player.GUEST;
                     hasAssignedRole = true;
                 } else {
@@ -187,7 +196,7 @@ export class DraftServer {
                 .in(roomHost)
                 .in(roomGuest)
                 .in(roomSpec)
-                .emit("player_set_role", {name: message.name, playerType: assignedRole});
+                .emit("player_set_role", {name: assignedName, playerType: assignedRole});
             fn({
                 ...draftsStore.getDraftViewsOrThrow(draftId).getDraftForPlayer(assignedRole),
                 yourPlayerType: assignedRole,
@@ -201,6 +210,13 @@ export class DraftServer {
                 socket.emit('message', 'This draft does not exist.');
                 return;
             }
+
+            const draft = draftsStore.getDraftOrThrow(draftId)
+            if(draft.fixedNames) {
+                logger.info("Draft is using fixed names. Not changing names", {draftId});
+                return;
+            }
+
             let assignedRole = Util.getAssignedRole(socket, roomHost, roomGuest);
             if (assignedRole === Player.HOST) {
                 logger.info("Setting HOST player name to: %s", message.name, {draftId});
@@ -400,6 +416,16 @@ export class DraftServer {
             const validationErrors = Validator.validatePreset(preset);
             if (validationErrors.length === 0) {
                 draftsStore.initDraft(draftId, preset as Preset);
+
+                const nameHost: string | null | undefined = req.body.participants?.host;
+                const nameGuest: string | null | undefined = req.body.participants?.guest;
+                if(nameHost && nameGuest) {
+                    logger.info('Setting names to "%s" and "%s"', nameHost, nameGuest, {draftId});
+                    draftsStore.setPlayerName(draftId, Player.HOST, nameHost);
+                    draftsStore.setPlayerName(draftId, Player.GUEST, nameGuest);
+                    draftsStore.setFixedPlayerNames(draftId, true);
+                }
+
                 res.json({status: 'ok', draftId});
                 logger.info('Created new draft with id: %s', draftId, {draftId});
             } else {

src/components/menu/API.tsx

@@ -30,8 +30,13 @@ class API extends React.Component<object, object> {
                             <dt>Endpoint</dt>
                             <dd><pre>POST https://aoe2cm.net/api/preset/new</pre></dd>
                             <dt>Payload</dt>
-                            <dd><pre>A JSON encoded valid <a
-                                href={'https://github.com/SiegeEngineers/aoe2cm2/blob/master/src/models/Preset.ts'}>Preset</a> object.</pre>
+                            <dd>
+                            <pre>{
+                                `{
+    "preset": `}(A JSON encoded valid <a
+                                href={'https://github.com/SiegeEngineers/aoe2cm2/blob/master/src/models/Preset.ts'}>Preset</a> object.){`
+}`}
+                            </pre>
                             </dd>
                             <dt>Sample Response</dt>
                             <dd><pre>{
@@ -83,9 +88,21 @@ class API extends React.Component<object, object> {
                         <dt>Endpoint</dt>
                         <dd><pre>POST https://aoe2cm.net/api/draft/new</pre></dd>
                         <dt>Payload</dt>
-                        <dd><pre>A JSON encoded valid <a
-                            href={'https://github.com/SiegeEngineers/aoe2cm2/blob/master/src/models/Preset.ts'}>Preset</a> object.
-                        </pre>
+                        <dd>
+                            <pre>{
+`{
+    "preset": `}(A JSON encoded valid <a
+                            href={'https://github.com/SiegeEngineers/aoe2cm2/blob/master/src/models/Preset.ts'}>Preset</a> object.){`
+}`}
+                            </pre>
+                            You can also set fixed names for Host and Guest by supplying then in the <code>participants</code> key:
+                            <pre>{
+`{
+    "preset": `}(A JSON encoded valid <a
+                            href={'https://github.com/SiegeEngineers/aoe2cm2/blob/master/src/models/Preset.ts'}>Preset</a> object.),{`
+    "participants": {"host": "Bohemond of Taranto", "guest": "Govind Tai"}
+}`
+                        }</pre>
                         </dd>
                         <dt>Sample Response</dt>
                         <dd><pre>{

src/models/Draft.ts

@@ -17,6 +17,7 @@ class Draft implements IDraftState {
     public nextAction: number = 0;
     public events: DraftEvent[] = [];
     public startTimestamp: number;
+    public fixedNames: boolean = false;
 
     constructor(nameHost: string, nameGuest: string, preset: Preset) {
         this.nameHost = nameHost;

src/models/DraftsStore.ts

@@ -179,6 +179,11 @@ export class DraftsStore {
         }
     }
 
+    public setFixedPlayerNames(draftId: string, fixedNames: boolean) {
+        const draft: Draft = this.getDraftOrThrow(draftId);
+        draft.fixedNames = fixedNames;
+    }
+
     public setPlayerName(draftId: string, player: Player, name: string) {
         const draft: Draft = this.getDraftOrThrow(draftId);
         switch (player) {
@@ -198,13 +203,17 @@ export class DraftsStore {
         }
         switch (player) {
             case Player.HOST:
-                draft.nameHost = '…';
+                if (!draft.fixedNames) {
+                    draft.nameHost = '…';
+                }
                 draft.hostConnected = false;
                 draft.hostReady = false;
                 this.pauseCountdown(draftId);
                 break;
             case Player.GUEST:
-                draft.nameGuest = '…';
+                if (!draft.fixedNames) {
+                    draft.nameGuest = '…';
+                }
                 draft.guestConnected = false;
                 draft.guestReady = false;
                 this.pauseCountdown(draftId);