Zod EVERYWHERE (#2027)

* Zod EVERYWHERE

* Add no-unused-vars rule to eslint in front

* Add no-unused-vars rule to eslint in pusher

* Add no-unused-vars rule to eslint in back

* Remove unused PlayerTexture guards

* Fix data providing on room connection

Co-authored-by: Alexis Faizeau <a.faizeau@workadventu.re>

back/src/Controller/DebugController.ts

@@ -48,7 +48,7 @@ export class DebugController {
                                     return obj;
                                 } else if (value instanceof Set) {
                                     const obj: Array<unknown> = [];
-                                    for (const [setKey, setValue] of value.entries()) {
+                                    for (const setValue of value.values()) {
                                         obj.push(setValue);
                                     }
                                     return obj;

back/src/Controller/PrometheusController.ts

@@ -1,5 +1,5 @@
 import { App } from "../Server/sifrr.server";
-import { HttpRequest, HttpResponse } from "uWebSockets.js";
+import { HttpResponse } from "uWebSockets.js";
 import { register, collectDefaultMetrics } from "prom-client";
 
 export class PrometheusController {
@@ -11,7 +11,7 @@ export class PrometheusController {
         this.App.get("/metrics", this.metrics.bind(this));
     }
 
-    private metrics(res: HttpResponse, req: HttpRequest): void {
+    private metrics(res: HttpResponse): void {
         res.writeHeader("Content-Type", register.contentType);
         res.end(register.metrics());
     }

back/src/Model/GameRoom.ts

@@ -1,7 +1,7 @@
 import { PointInterface } from "./Websocket/PointInterface";
 import { Group } from "./Group";
 import { User, UserSocket } from "./User";
-import { PositionInterface } from "_Model/PositionInterface";
+import { PositionInterface } from "../Model/PositionInterface";
 import {
     EmoteCallback,
     EntersCallback,
@@ -9,23 +9,20 @@ import {
     LockGroupCallback,
     MovesCallback,
     PlayerDetailsUpdatedCallback,
-} from "_Model/Zone";
+} from "../Model/Zone";
 import { PositionNotifier } from "./PositionNotifier";
-import { Movable } from "_Model/Movable";
+import { Movable } from "../Model/Movable";
 import {
-    BatchToPusherMessage,
     BatchToPusherRoomMessage,
     EmoteEventMessage,
-    ErrorMessage,
     JoinRoomMessage,
     SetPlayerDetailsMessage,
     SubToPusherRoomMessage,
-    VariableMessage,
     VariableWithTagMessage,
     ServerToClientMessage,
 } from "../Messages/generated/messages_pb";
 import { ProtobufUtils } from "../Model/Websocket/ProtobufUtils";
-import { RoomSocket, ZoneSocket } from "src/RoomManager";
+import { RoomSocket, ZoneSocket } from "../RoomManager";
 import { Admin } from "../Model/Admin";
 import { adminApi } from "../Services/AdminApi";
 import { isMapDetailsData, MapDetailsData } from "../Messages/JsonMessages/MapDetailsData";
@@ -36,7 +33,6 @@ import { ADMIN_API_URL } from "../Enum/EnvironmentVariable";
 import { LocalUrlError } from "../Services/LocalUrlError";
 import { emitErrorOnRoomSocket } from "../Services/MessageHelpers";
 import { VariableError } from "../Services/VariableError";
-import { isRoomRedirect } from "../Messages/JsonMessages/RoomRedirect";
 
 export type ConnectCallback = (user: User, group: Group) => void;
 export type DisconnectCallback = (user: User, group: Group) => void;
@@ -399,7 +395,7 @@ export class GameRoom {
     private searchClosestAvailableUserOrGroup(user: User): User | Group | null {
         let minimumDistanceFound: number = Math.max(this.minDistance, this.groupRadius);
         let matchingItem: User | Group | null = null;
-        this.users.forEach((currentUser, userId) => {
+        this.users.forEach((currentUser) => {
             // Let's only check users that are not part of a group
             if (typeof currentUser.group !== "undefined") {
                 return;
@@ -585,12 +581,15 @@ export class GameRoom {
             };
         }
 
-        const result = await adminApi.fetchMapDetails(roomUrl);
-        if (isRoomRedirect(result)) {
-            console.error("Unexpected room redirect received while querying map details", result);
-            throw new Error("Unexpected room redirect received while querying map details");
+        const result = isMapDetailsData.safeParse(await adminApi.fetchMapDetails(roomUrl));
+
+        if (result.success) {
+            return result.data;
         }
-        return result;
+
+        console.error(result.error.issues);
+        console.error("Unexpected room redirect received while querying map details", result);
+        throw new Error("Unexpected room redirect received while querying map details");
     }
 
     private mapPromise: Promise<ITiledMap> | undefined;

back/src/Model/Group.ts

@@ -1,8 +1,8 @@
 import { ConnectCallback, DisconnectCallback, GameRoom } from "./GameRoom";
 import { User } from "./User";
-import { PositionInterface } from "_Model/PositionInterface";
-import { Movable } from "_Model/Movable";
-import { PositionNotifier } from "_Model/PositionNotifier";
+import { PositionInterface } from "../Model/PositionInterface";
+import { Movable } from "../Model/Movable";
+import { PositionNotifier } from "../Model/PositionNotifier";
 import { MAX_PER_GROUP } from "../Enum/EnvironmentVariable";
 import type { Zone } from "../Model/Zone";
 

back/src/Model/Movable.ts

@@ -1,4 +1,4 @@
-import { PositionInterface } from "_Model/PositionInterface";
+import { PositionInterface } from "../Model/PositionInterface";
 
 /**
  * A physical object that can be placed into a Zone

back/src/Model/PositionNotifier.ts

@@ -17,8 +17,8 @@ import {
     PlayerDetailsUpdatedCallback,
     Zone,
 } from "./Zone";
-import { Movable } from "_Model/Movable";
-import { PositionInterface } from "_Model/PositionInterface";
+import { Movable } from "../Model/Movable";
+import { PositionInterface } from "../Model/PositionInterface";
 import { ZoneSocket } from "../RoomManager";
 import { User } from "../Model/User";
 import { EmoteEventMessage, SetPlayerDetailsMessage } from "../Messages/generated/messages_pb";

back/src/Model/User.ts

@@ -1,8 +1,8 @@
 import { Group } from "./Group";
 import { PointInterface } from "./Websocket/PointInterface";
-import { Zone } from "_Model/Zone";
-import { Movable } from "_Model/Movable";
-import { PositionNotifier } from "_Model/PositionNotifier";
+import { Zone } from "../Model/Zone";
+import { Movable } from "../Model/Movable";
+import { PositionNotifier } from "../Model/PositionNotifier";
 import { ServerDuplexStream } from "grpc";
 import {
     BatchMessage,
@@ -14,7 +14,7 @@ import {
     SetPlayerDetailsMessage,
     SubMessage,
 } from "../Messages/generated/messages_pb";
-import { CharacterLayer } from "_Model/Websocket/CharacterLayer";
+import { CharacterLayer } from "../Model/Websocket/CharacterLayer";
 import { BoolValue, UInt32Value } from "google-protobuf/google/protobuf/wrappers_pb";
 
 export type UserSocket = ServerDuplexStream<PusherToBackMessage, ServerToClientMessage>;

back/src/Model/Websocket/ItemEventMessage.ts

@@ -1,11 +1,10 @@
-import * as tg from "generic-type-guard";
+import { z } from "zod";
 
-export const isItemEventMessageInterface = new tg.IsInterface()
-    .withProperties({
-        itemId: tg.isNumber,
-        event: tg.isString,
-        state: tg.isUnknown,
-        parameters: tg.isUnknown,
-    })
-    .get();
-export type ItemEventMessageInterface = tg.GuardedType<typeof isItemEventMessageInterface>;
+export const isItemEventMessageInterface = z.object({
+    itemId: z.number(),
+    event: z.string(),
+    state: z.unknown(),
+    parameters: z.unknown(),
+});
+
+export type ItemEventMessageInterface = z.infer<typeof isItemEventMessageInterface>;

back/src/Model/Websocket/PointInterface.ts

@@ -1,18 +1,10 @@
-import * as tg from "generic-type-guard";
+import { z } from "zod";
 
-/*export interface PointInterface {
-    readonly x: number;
-    readonly y: number;
-    readonly direction: string;
-    readonly moving: boolean;
-}*/
+export const isPointInterface = z.object({
+    x: z.number(),
+    y: z.number(),
+    direction: z.string(),
+    moving: z.boolean(),
+});
 
-export const isPointInterface = new tg.IsInterface()
-    .withProperties({
-        x: tg.isNumber,
-        y: tg.isNumber,
-        direction: tg.isString,
-        moving: tg.isBoolean,
-    })
-    .get();
-export type PointInterface = tg.GuardedType<typeof isPointInterface>;
+export type PointInterface = z.infer<typeof isPointInterface>;

back/src/Model/Websocket/ProtobufUtils.ts

@@ -5,10 +5,10 @@ import {
     PointMessage,
     PositionMessage,
 } from "../../Messages/generated/messages_pb";
-import { CharacterLayer } from "_Model/Websocket/CharacterLayer";
+import { CharacterLayer } from "../../Model/Websocket/CharacterLayer";
 import Direction = PositionMessage.Direction;
-import { ItemEventMessageInterface } from "_Model/Websocket/ItemEventMessage";
-import { PositionInterface } from "_Model/PositionInterface";
+import { ItemEventMessageInterface } from "../../Model/Websocket/ItemEventMessage";
+import { PositionInterface } from "../../Model/PositionInterface";
 
 export class ProtobufUtils {
     public static toPositionMessage(point: PointInterface): PositionMessage {

back/src/Model/Zone.ts

@@ -1,5 +1,5 @@
 import { User } from "./User";
-import { PositionInterface } from "_Model/PositionInterface";
+import { PositionInterface } from "../Model/PositionInterface";
 import { Movable } from "./Movable";
 import { Group } from "./Group";
 import { ZoneSocket } from "../RoomManager";
@@ -71,6 +71,7 @@ export class Zone {
     /**
      * Notify listeners of this zone that this user entered
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     private notifyEnter(thing: Movable, oldZone: Zone | null, position: PositionInterface) {
         for (const listener of this.listeners) {
             this.onEnters(thing, oldZone, listener);

back/src/RoomManager.ts

@@ -15,7 +15,6 @@ import {
     EmptyMessage,
     ItemEventMessage,
     JoinRoomMessage,
-    PlayGlobalMessage,
     PusherToBackMessage,
     QueryJitsiJwtMessage,
     RefreshRoomPromptMessage,

back/src/Services/AdminApi.ts

@@ -18,12 +18,21 @@ class AdminApi {
             params,
         });
 
-        if (!isMapDetailsData(res.data) && !isRoomRedirect(res.data)) {
-            console.error("Unexpected answer from the /api/map admin endpoint.", res.data);
-            throw new Error("Unexpected answer from the /api/map admin endpoint.");
+        const mapDetailData = isMapDetailsData.safeParse(res.data);
+        const roomRedirect = isRoomRedirect.safeParse(res.data);
+
+        if (mapDetailData.success) {
+            return mapDetailData.data;
         }
 
-        return res.data;
+        if (roomRedirect.success) {
+            return roomRedirect.data;
+        }
+
+        console.error(mapDetailData.error.issues);
+        console.error(roomRedirect.error.issues);
+        console.error("Unexpected answer from the /api/map admin endpoint.", res.data);
+        throw new Error("Unexpected answer from the /api/map admin endpoint.");
     }
 }
 

back/src/Services/MessageHelpers.ts

@@ -1,5 +1,4 @@
 import {
-    BatchMessage,
     BatchToPusherMessage,
     BatchToPusherRoomMessage,
     ErrorMessage,
@@ -7,7 +6,7 @@ import {
     SubToPusherMessage,
     SubToPusherRoomMessage,
 } from "../Messages/generated/messages_pb";
-import { UserSocket } from "_Model/User";
+import { UserSocket } from "../Model/User";
 import { RoomSocket, ZoneSocket } from "../RoomManager";
 
 function getMessageFromError(error: unknown): string {

back/src/Services/Repository/VoidVariablesRepository.ts

@@ -4,10 +4,12 @@ import { VariablesRepositoryInterface } from "./VariablesRepositoryInterface";
  * Mock class in charge of NOT saving/loading variables from the data store
  */
 export class VoidVariablesRepository implements VariablesRepositoryInterface {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     loadVariables(roomUrl: string): Promise<{ [key: string]: string }> {
         return Promise.resolve({});
     }
 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     saveVariable(roomUrl: string, key: string, value: string): Promise<number> {
         return Promise.resolve(0);
     }

back/src/Services/SocketManager.ts

@@ -2,7 +2,6 @@ import { GameRoom } from "../Model/GameRoom";
 import {
     ItemEventMessage,
     ItemStateMessage,
-    PlayGlobalMessage,
     PointMessage,
     RoomJoinedMessage,
     ServerToClientMessage,
@@ -35,12 +34,10 @@ import {
     FollowAbortMessage,
     VariableMessage,
     BatchToPusherRoomMessage,
-    SubToPusherRoomMessage,
     SetPlayerDetailsMessage,
     PlayerDetailsUpdatedMessage,
     GroupUsersUpdateMessage,
     LockGroupPromptMessage,
-    RoomMessage,
 } from "../Messages/generated/messages_pb";
 import { User, UserSocket } from "../Model/User";
 import { ProtobufUtils } from "../Model/Websocket/ProtobufUtils";
@@ -60,9 +57,9 @@ import { JITSI_URL } from "../Enum/EnvironmentVariable";
 import { clientEventsEmitter } from "./ClientEventsEmitter";
 import { gaugeManager } from "./GaugeManager";
 import { RoomSocket, ZoneSocket } from "../RoomManager";
-import { Zone } from "_Model/Zone";
+import { Zone } from "../Model/Zone";
 import Debug from "debug";
-import { Admin } from "_Model/Admin";
+import { Admin } from "../Model/Admin";
 import crypto from "crypto";
 
 const debug = Debug("sockermanager");

back/src/Services/VariablesManager.ts

@@ -2,7 +2,7 @@
  * Handles variables shared between the scripting API and the server.
  */
 import { ITiledMap, ITiledMapLayer, ITiledMapObject } from "@workadventure/tiled-map-type-guard/dist";
-import { User } from "_Model/User";
+import { User } from "../Model/User";
 import { variablesRepository } from "./Repository/VariablesRepository";
 import { redisClient } from "./RedisClient";
 import { VariableError } from "./VariableError";