chore: cleanup generic wsdata schemas

fix: do not allow attack on already attacked square

Author: evanshortiss

.dockerignore

@@ -1 +1,2 @@
 node_modules
+build

src/models/player.ts

@@ -1,5 +1,8 @@
 import { AttackDataPayload } from '@app/payloads/incoming';
-import { getCellCoverageForOriginOrientationAndArea } from '@app/utils';
+import {
+  getCellCoverageForOriginOrientationAndArea,
+  isSameOrigin
+} from '@app/utils';
 import {
   CellPosition,
   Orientation,
@@ -136,6 +139,10 @@ export default class Player extends Model<PlayerData> {
     return this.attacks.length > 0;
   }
 
+  hasAttackedLocation(origin: CellPosition): boolean {
+    return !!this.attacks.find((a) => isSameOrigin(a.attack.origin, origin));
+  }
+
   getShipPositionData() {
     return this.board?.positions;
   }

src/payloads/incoming.ts

@@ -6,6 +6,11 @@ export enum IncomingMsgType {
   Attack = 'attack'
 }
 
+export type WsPayload = {
+  type: IncomingMsgType;
+  data: unknown;
+};
+
 export type ConnectionRequestPayload = {
   username?: string;
   gameId?: string;

src/payloads/outgoing.ts

@@ -1,5 +1,6 @@
 export enum OutgoingMsgType {
   AttackResult = 'attack-result',
+  BadAttack = 'bad-attack',
   ServerError = 'server-error',
   BadMessageType = 'bad-message-type',
   BadPayload = 'invalid-payload',

src/payloads/schemas.ts

@@ -2,6 +2,11 @@ import Joi from 'joi';
 import { GAME_GRID_SIZE } from '@app/config';
 import { ShipType, Orientation, CellArea } from '@app/game/types';
 
+export const WsPayloadSchema = Joi.object({
+  type: Joi.string().required(),
+  data: Joi.object()
+});
+
 export const ShipSchema = Joi.object({
   origin: Joi.array()
     .min(2)
@@ -17,6 +22,13 @@ export const ShipSchema = Joi.object({
     .required()
 });
 
+export const ConnectionRequestPayloadSchema = Joi.object({
+  username: Joi.string(),
+  gameId: Joi.string(),
+  playerId: Joi.string(),
+  useAiOpponent: Joi.boolean()
+});
+
 export const ShipsLockedSchema = Joi.object({
   [ShipType.Battleship]: ShipSchema.required(),
   [ShipType.Destroyer]: ShipSchema.required(),

src/sockets/handler.attack.ts

@@ -18,6 +18,7 @@ import PlayerConfiguration, {
 import { getPlayerSpecificData, send } from './common';
 import * as ml from '@app/ml';
 import { AttackPayloadSchema } from '@app/payloads/schemas';
+import Player from '@app/models/player';
 
 export type AttackResult = {
   origin: CellPosition;
@@ -48,6 +49,7 @@ const attackHandler: MessageHandler<
       }
     };
   } else {
+    const attack = validatedData.value as AttackDataPayload;
     const wsPlayer = players.getPlayerAssociatedWithSocket(ws);
 
     if (!wsPlayer) {
@@ -93,14 +95,22 @@ const attackHandler: MessageHandler<
       );
     }
 
+    if (player.hasAttackedLocation(attack.origin)) {
+      return {
+        type: OutgoingMsgType.BadAttack,
+        data: {
+          info: `location ${attack.origin.join(',')} has already been attacked`
+        }
+      };
+    }
+
     const opponentShipData = opponent.getShipPositionData();
     if (!opponentShipData) {
       throw new Error(
         `player ${player.getUUID()} opponent (${opponent.getUUID()}) was missing ship position data`
       );
     }
 
-    const attack = validatedData.value as AttackDataPayload;
     let attackResult: AttackResult = {
       origin: attack.origin,
       hit: false,

src/sockets/handler.connection.ts

@@ -1,4 +1,3 @@
-import Joi from 'joi';
 import WebSocket from 'ws';
 import log from '@app/log';
 import PlayerConfiguration, {
@@ -10,16 +9,10 @@ import {
   ValidationErrorPayload
 } from '@app/payloads/outgoing';
 import { ConnectionRequestPayload } from '@app/payloads/incoming';
+import { ConnectionRequestPayloadSchema } from '@app/payloads/schemas';
 import { MessageHandler } from './common';
 import { getPlayerSpecificData, send } from './common';
 
-const ConnectionRequestPayloadSchema = Joi.object({
-  username: Joi.string(),
-  gameId: Joi.string(),
-  playerId: Joi.string(),
-  useAiOpponent: Joi.boolean()
-});
-
 const connectionHandler: MessageHandler<
   PlayerConfigurationData | ValidationErrorPayload
 > = async (ws: WebSocket, data: unknown) => {

src/sockets/index.ts

@@ -1,25 +1,15 @@
 import { FastifyInstance } from 'fastify';
-import Joi from 'joi';
 import WebSocket from 'ws';
 import log from '@app/log';
 import attackHandler from './handler.attack';
 import connectionHandler from './handler.connection';
 import shipPositionHandler from './handler.ship-positions';
 import { OutgoingMsgType } from '@app/payloads/outgoing';
-import { IncomingMsgType } from '@app/payloads/incoming';
+import { WsPayload, IncomingMsgType } from '@app/payloads/incoming';
+import { WsPayloadSchema } from '@app/payloads/schemas';
 import { MessageHandler, MessageHandlerResponse } from './common';
 import { heartbeat, send } from './common';
 
-type ParsedWsData = {
-  type: IncomingMsgType;
-  data: unknown;
-};
-
-const WsDataSchema = Joi.object({
-  type: Joi.string().required(),
-  data: Joi.object()
-});
-
 /**
  * Configures a heartbeat for the WSS attached to the given fastify instance.
  * @param app {FastifyInstance}
@@ -38,9 +28,9 @@ const MessageHandlers: { [key in IncomingMsgType]: MessageHandler<unknown> } = {
  * Find an appropriate handler for the incoming message, and execute it.
  * Send a response generated by the handler to the client.
  * @param ws {WebSocket}
- * @param data {ParsedWsData}
+ * @param data {WsPayload}
  */
-async function _processSocketMessage(ws: WebSocket, data: ParsedWsData) {
+async function _processSocketMessage(ws: WebSocket, data: WsPayload) {
   const handler = MessageHandlers[data.type];
   if (handler) {
     log.trace('processing incoming message: %j', data);
@@ -78,7 +68,7 @@ export default async function processSocketMessage(
   ws: WebSocket,
   data: WebSocket.Data
 ) {
-  let parsed: ParsedWsData;
+  let parsed: WsPayload;
 
   try {
     parsed = JSON.parse(data.toString());
@@ -87,7 +77,7 @@ export default async function processSocketMessage(
     return;
   }
 
-  const valid = WsDataSchema.validate(parsed);
+  const valid = WsPayloadSchema.validate(parsed);
 
   if (valid.error) {
     log.warn('client sent an invalid message payload: %j', parsed);
@@ -99,6 +89,6 @@ export default async function processSocketMessage(
       }
     });
   } else {
-    _processSocketMessage(ws, valid.value as ParsedWsData);
+    _processSocketMessage(ws, valid.value as WsPayload);
   }
 }

src/utils.ts

@@ -56,6 +56,15 @@ export function getCellAreaWidthAndHeight(area: CellArea) {
   };
 }
 
+/**
+ * Determine if two vectors/positions are equal
+ * @param a
+ * @param b
+ */
+export function isSameOrigin(a: CellPosition, b: CellPosition) {
+  return a[0] === b[0] && a[1] === b[1];
+}
+
 /**
  * This function will return an array containing occupied cell coordinates for
  * an input (typically and attack) given area, origin, and orientation.