rename module property of logger to name

rustymotors · Sep 19, 2024 · 2762630 · 2762630
1 parent 468891e
commit 2762630
Show file tree

Hide file tree

Showing 30 changed files with 281 additions and 299 deletions.
diff --git a/packages/gateway/src/GatewayServer.ts b/packages/gateway/src/GatewayServer.ts
@@ -5,7 +5,11 @@ import { ConsoleThread } from "rusty-motors-cli";
 import { receiveLobbyData } from "rusty-motors-lobby";
 import { receiveLoginData } from "rusty-motors-login";
 import { receivePersonaData } from "rusty-motors-personas";
-import { Configuration, getServerConfiguration, type ServerLogger } from "rusty-motors-shared";
+import {
+    Configuration,
+    getServerConfiguration,
+    type ServerLogger,
+} from "rusty-motors-shared";
 import {
     addOnDataHandler,
     createInitialState,
@@ -15,7 +19,12 @@ import { getServerLogger } from "rusty-motors-shared";
 import { receiveTransactionsData } from "rusty-motors-transactions";
 import { onSocketConnection } from "./index.js";
 import { addWebRoutes } from "./web.js";
-import { populateGameMessageProcessors, populatePortToMessageTypes, portToMessageTypes, gameMessageProcessors } from "rusty-motors-nps";
+import {
+    populateGameMessageProcessors,
+    populatePortToMessageTypes,
+    portToMessageTypes,
+    gameMessageProcessors,
+} from "rusty-motors-nps";
 import { receiveChatData } from "rusty-motors-chat";
 
 /**
@@ -66,7 +75,7 @@ export class Gateway {
     constructor({
         config = getServerConfiguration({}),
         log = getServerLogger({
-            module: "GatewayServer",
+            name: "GatewayServer",
         }),
         backlogAllowedCount = 0,
         listeningPortList = [],
@@ -241,9 +250,7 @@ export class Gateway {
             });
         });
 
-        this.webServer = fastify({
-            logger: true,
-        });
+        this.webServer = fastify({});
         this.webServer.register(FastifySensible);
 
         let state = fetchStateFromDatabase();
@@ -282,7 +289,7 @@ export class Gateway {
     static getInstance({
         config = undefined,
         log = getServerLogger({
-            module: "GatewayServer",
+            name: "GatewayServer",
         }),
         backlogAllowedCount = 0,
         listeningPortList = [],
@@ -321,7 +328,7 @@ Gateway._instance = undefined;
 export function getGatewayServer({
     config,
     log = getServerLogger({
-        module: "GatewayServer",
+        name: "GatewayServer",
     }),
     backlogAllowedCount = 0,
     listeningPortList: listeningPortList = [],

diff --git a/packages/gateway/src/index.ts b/packages/gateway/src/index.ts
@@ -39,7 +39,7 @@ import * as Sentry from "@sentry/node";
  * @property {string} args.connectionId The connection id of the socket that
  *                                  received the data.
  * @property {module:packages/shared/RawMessage} args.message The data that was received.
- * @property {module:shared/log.ServerLogger} [args.log=getServerLogger({ module: "gateway" })] The logger to use.
+ * @property {module:shared/log.ServerLogger} [args.log=getServerLogger({ name: "gateway" })] The logger to use.
  *                                                                    response
  *                                                                to the
  *                                                           data.
@@ -61,7 +61,7 @@ export function socketErrorHandler({
     connectionId,
     error,
     log = getServerLogger({
-        module: "socketErrorHandler",
+        name: "socketErrorHandler",
     }),
 }: {
     connectionId: string;
@@ -81,12 +81,12 @@ export function socketErrorHandler({
  *
  * @param {object} options
  * @param {string} options.connectionId The connection ID
- * @param {import("pino").Logger} [options.log=getServerLogger({ module: "socketEndHandler" })] The logger to use
+ * @param {import("pino").Logger} [options.log=getServerLogger({ name: "socketEndHandler" })] The logger to use
  */
 export function socketEndHandler({
     connectionId,
     log = getServerLogger({
-        module: "socketEndHandler",
+        name: "socketEndHandler",
     }),
 }: {
     connectionId: string;
@@ -103,13 +103,13 @@ export function socketEndHandler({
  *
  * @param {object} options
  * @param {Socket} options.incomingSocket The incoming socket
- * @param {Logger} [options.log=getServerLogger({ module: "onDataHandler" })] The logger to use
+ * @param {Logger} [options.log=getServerLogger({ name: "onDataHandler" })] The logger to use
  *
  */
 export function onSocketConnection({
     incomingSocket,
     log = getServerLogger({
-        module: "onDataHandler",
+        name: "onDataHandler",
     }),
 }: {
     incomingSocket: Socket;

diff --git a/packages/lobby/src/handlers/_setMyUserData.ts b/packages/lobby/src/handlers/_setMyUserData.ts
@@ -8,7 +8,7 @@ export async function _setMyUserData({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
         level: getServerConfiguration({}).logLevel ?? "info",
     }),
 }: {
@@ -25,7 +25,6 @@ export async function _setMyUserData({
 
         log.debug(`User ID: ${incomingMessage._userId}`);
 
-
         // Update the user's data
         updateUser({
             userId: incomingMessage._userId,

diff --git a/packages/lobby/src/handlers/encryptedCommand.ts b/packages/lobby/src/handlers/encryptedCommand.ts
@@ -47,7 +47,7 @@ export const messageHandlers: {
  * @param {object} args
  * @param {string} args.connectionId
  * @param {LegacyMessage | MessageBuffer} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "Lobby" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "Lobby" })]
  * @returns {Promise<{
  * connectionId: string,
  * message: LegacyMessage | MessageBuffer,
@@ -57,7 +57,7 @@ async function encryptCmd({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
     }),
 }: {
     connectionId: string;
@@ -97,7 +97,7 @@ async function encryptCmd({
  * @param {object} args
  * @param {string} args.connectionId
  * @param {LegacyMessage} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "Lobby" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "Lobby" })]
  * @returns {Promise<{
  *  connectionId: string,
  * message: LegacyMessage,
@@ -107,7 +107,7 @@ async function decryptCmd({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
     }),
 }: {
     connectionId: string;
@@ -178,7 +178,7 @@ const npsCommandHandlers: NpsCommandHandler[] = [
  * @param {object} args
  * @param {string} args.connectionId
  * @param {LegacyMessage} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "Lobby" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "Lobby" })]
  * @return {Promise<{
  * connectionId: string,
  * message: MessageBuffer | LegacyMessage,
@@ -188,7 +188,7 @@ async function handleCommand({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
     }),
 }: {
     connectionId: string;
@@ -228,7 +228,7 @@ async function handleCommand({
  * @param {object} args
  * @param {string} args.connectionId
  * @param {SerializedBufferOld} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "Lobby" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "Lobby" })]
   * @returns {Promise<{
 *  connectionId: string,
 * messages: SerializedBufferOld[],
@@ -239,7 +239,7 @@ export async function handleEncryptedNPSCommand({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
     }),
 }: {
     connectionId: string;
@@ -249,7 +249,6 @@ export async function handleEncryptedNPSCommand({
     connectionId: string;
     messages: SerializedBufferOld[];
 }> {
-
     const inboundMessage = new LegacyMessage();
     inboundMessage._doDeserialize(message.data);
 

diff --git a/packages/lobby/src/handlers/handleGetMiniUserList.ts b/packages/lobby/src/handlers/handleGetMiniUserList.ts
@@ -13,14 +13,14 @@ user1._userName = "User 1";
  * @param {object} args
  * @param {string} args.connectionId
  * @param {LegacyMessage} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "Lobby" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "Lobby" })]
  */
 
 export async function handleGetMiniUserList({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
         level: getServerConfiguration({}).logLevel ?? "info",
     }),
 }: {

diff --git a/packages/lobby/src/handlers/handleSendMiniRiffList.ts b/packages/lobby/src/handlers/handleSendMiniRiffList.ts
@@ -10,21 +10,20 @@ import { channelRecordSize, channels } from "./channels.js";
  * @param {object} args
  * @param {string} args.connectionId
  * @param {LegacyMessage} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "Lobby" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "Lobby" })]
  */
 export async function handleSendMiniRiffList({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
         level: getServerConfiguration({}).logLevel ?? "info",
     }),
 }: {
     connectionId: string;
     message: LegacyMessage;
     log?: ServerLogger;
 }) {
-
     log.debug("Handling NPS_SEND_MINI_RIFF_LIST");
     log.debug(`Received command: ${message._doSerialize().toString("hex")}`);
 

diff --git a/packages/lobby/src/handlers/handleTrackingPing.ts b/packages/lobby/src/handlers/handleTrackingPing.ts
@@ -6,7 +6,7 @@ export async function handleTrackingPing({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
     }),
 }: {
     connectionId: string;

diff --git a/packages/lobby/src/handlers/heartbeat.js b/packages/lobby/src/handlers/heartbeat.js
@@ -1,14 +1,11 @@
 import { getServerLogger } from "rusty-motors-shared";
-import {
-    NPSMessage,
-    SerializedBuffer,
-} from "rusty-motors-shared";
+import { NPSMessage, SerializedBuffer } from "rusty-motors-shared";
 
 /**
  * @param {object} args
  * @param {string} args.connectionId
  * @param {SerializedBuffer} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "Lobby" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "Lobby" })]
  * @returns {Promise<{
  *  connectionId: string
  * messages: SerializedBuffer[],
@@ -19,7 +16,7 @@ export async function _npsHeartbeat({
     // @ts-ignore
     message, // eslint-disable-line no-unused-vars
     log = getServerLogger({
-        module: "_npsHeartbeat",
+        name: "_npsHeartbeat",
     }),
 }) {
     const packetContent = Buffer.alloc(8);

diff --git a/packages/lobby/src/handlers/requestConnectGameServer.ts b/packages/lobby/src/handlers/requestConnectGameServer.ts
@@ -46,7 +46,7 @@ export async function _npsRequestGameConnectServer({
     connectionId,
     message,
     log = getServerLogger({
-        module: "LoginServer",
+        name: "LoginServer",
     }),
 }: ServiceArgs): Promise<{
     connectionId: string;

diff --git a/packages/lobby/src/internal.ts b/packages/lobby/src/internal.ts
@@ -72,7 +72,7 @@ export const messageHandlers: {
  * @param {object} args
  * @param {string} args.connectionId
  * @param {SerializedBufferOld} args.message
- * @param {import("pino").Logger} [args.log=getServerLogger({ module: "PersonaServer" })]
+ * @param {import("pino").Logger} [args.log=getServerLogger({ name: "PersonaServer" })]
  * @returns {Promise<{
  *  connectionId: string,
  * messages: SerializedBufferOld[],
@@ -83,7 +83,7 @@ export async function receiveLobbyData({
     connectionId,
     message,
     log = getServerLogger({
-        module: "Lobby",
+        name: "Lobby",
     }),
 }: {
     connectionId: string;
@@ -93,17 +93,14 @@ export async function receiveLobbyData({
     connectionId: string;
     messages: SerializedBufferOld[];
 }> {
-
     /** @type {LegacyMessage | NPSMessage} */
     let inboundMessage: LegacyMessage | NPSMessage;
 
     // Check data length
     const dataLength = message.getByteSize();
 
     if (dataLength < 4) {
-        throw Error(
-            `Data length ${dataLength} is too short to deserialize`,
-        );
+        throw Error(`Data length ${dataLength} is too short to deserialize`);
     }
 
     if (dataLength > 12) {
@@ -128,9 +125,7 @@ export async function receiveLobbyData({
 
     if (typeof supportedHandler === "undefined") {
         // We do not yet support this message code
-        throw Error(
-            `UNSUPPORTED_MESSAGECODE: ${inboundMessage._header.id}`,
-        );
+        throw Error(`UNSUPPORTED_MESSAGECODE: ${inboundMessage._header.id}`);
     }
 
     const buff = new SerializedBufferOld();
@@ -146,9 +141,7 @@ export async function receiveLobbyData({
         log.debug("Leaving receiveLobbyData");
         return result;
     } catch (error) {
-        const err = Error(
-            `Error handling lobby data: ${String(error)}`,
-        );
+        const err = Error(`Error handling lobby data: ${String(error)}`);
         err.cause = error;
         throw err;
     }