chore: Adapt logs to object format - 2 (RocketChat#38001)

Author: KevLehman

apps/meteor/app/integrations/server/lib/ScriptEngine.ts

@@ -276,7 +276,11 @@ export abstract class IntegrationScriptEngine<IsIncoming extends boolean> {
 		}
 
 		if (!script[method]) {
-			this.logger.error(`Method "${method}" not found in the Integration "${integration.name}"`);
+			this.logger.error({
+				msg: 'Script method not found in the Integration',
+				method,
+				integration: integration.name,
+			});
 			await updateHistory({ historyId, step: `execute-script-no-method-${method}` });
 			return;
 		}
@@ -327,12 +331,20 @@ export abstract class IntegrationScriptEngine<IsIncoming extends boolean> {
 		}
 
 		const script = await wrapExceptions(() => this.getIntegrationScript(integration)).catch((e) => {
-			this.logger.error(e);
+			this.logger.error({
+				msg: 'Error getting Integration script',
+				integration: integration.name,
+				err: e,
+			});
 			throw e;
 		});
 
 		if (!script[method]) {
-			this.logger.error(`Method "${method}" not found in the Integration "${integration.name}"`);
+			this.logger.error({
+				msg: 'Script method not found in the Integration',
+				method,
+				integration: integration.name,
+			});
 			return;
 		}
 

apps/meteor/app/lib/server/functions/getFullUserData.ts

@@ -60,7 +60,10 @@ settings.watch<string>('Accounts_CustomFields', (settingValue) => {
 			customFields[`customFields.${key}`] = 1;
 		});
 	} catch (e) {
-		logger.warn(`The JSON specified for "Accounts_CustomFields" is invalid. The following error was thrown: ${e}`);
+		logger.warn({
+			msg: 'The JSON specified for "Accounts_CustomFields" is invalid. The following error was thrown',
+			err: e,
+		});
 	}
 });
 

apps/meteor/app/lib/server/lib/deprecationWarningLogger.ts

@@ -41,7 +41,7 @@ export const apiDeprecationLogger = ((logger) => {
 
 			metrics.deprecations.inc({ type: 'deprecation', kind: 'endpoint', name: endpoint });
 
-			logger.warn(message);
+			logger.warn({ msg: message, endpoint, version, info });
 		},
 		parameter: (
 			endpoint: string,
@@ -66,7 +66,7 @@ export const apiDeprecationLogger = ((logger) => {
 
 			writeDeprecationHeader(res, 'parameter-deprecation', message, version);
 
-			logger.warn(message);
+			logger.warn({ msg: message, endpoint, parameter, version });
 		},
 
 		deprecatedParameterUsage: (
@@ -95,7 +95,7 @@ export const apiDeprecationLogger = ((logger) => {
 
 			writeDeprecationHeader(res, 'invalid-usage', message, version);
 
-			logger.warn(message);
+			logger.warn({ msg: message, endpoint, parameter, version });
 		},
 	};
 })(deprecationLogger.section('API'));
@@ -114,7 +114,7 @@ export const methodDeprecationLogger = ((logger) => {
 			}
 			compareVersions(version, message);
 			metrics.deprecations.inc({ type: 'deprecation', name: method, kind: 'method' });
-			logger.warn(message);
+			logger.warn({ msg: message, method, version, replacement });
 		},
 		parameter: (method: string, parameter: string, version: DeprecationLoggerNextPlannedVersion) => {
 			const message = `The parameter "${parameter}" in the method "${method}" is deprecated and will be removed on version ${version}`;
@@ -125,7 +125,7 @@ export const methodDeprecationLogger = ((logger) => {
 			metrics.deprecations.inc({ type: 'parameter-deprecation', name: method, params: parameter });
 
 			compareVersions(version, message);
-			logger.warn(message);
+			logger.warn({ msg: message, method, parameter, version });
 		},
 		deprecatedParameterUsage: (
 			method: string,
@@ -150,7 +150,7 @@ export const methodDeprecationLogger = ((logger) => {
 
 			metrics.deprecations.inc({ type: 'invalid-usage', name: method, params: parameter, kind: 'method' });
 
-			logger.warn(message);
+			logger.warn({ msg: message, method, parameter, version });
 		},
 		/** @deprecated */
 		warn: (message: string) => {
@@ -159,7 +159,7 @@ export const methodDeprecationLogger = ((logger) => {
 			}
 
 			compareVersions('0.0.0', message);
-			logger.warn(message);
+			logger.warn({ msg: message });
 		},
 	};
 })(deprecationLogger.section('METHOD'));

apps/meteor/app/livechat/server/api/v1/room.ts

@@ -516,7 +516,7 @@ const livechatRoomsEndpoints = API.v1
 			body: isPOSTLivechatRoomsCloseAll,
 		},
 		async function action() {
-			livechatLogger.info(`User ${this.userId} is removing all closed rooms`);
+			livechatLogger.info({ msg: 'User is removing all closed rooms', userId: this.userId });
 
 			const params = this.bodyParams;
 
@@ -527,7 +527,7 @@ const livechatRoomsEndpoints = API.v1
 			});
 			await Promise.all(promises);
 
-			livechatLogger.info(`User ${this.userId} removed ${promises.length} closed rooms`);
+			livechatLogger.info({ msg: 'User removed closed rooms', userId: this.userId, removedRooms: promises.length });
 			return API.v1.success({ removedRooms: promises.length });
 		},
 	);

apps/meteor/app/livechat/server/api/v1/visitor.ts

@@ -151,7 +151,7 @@ API.v1.addRoute('livechat/visitor/:token', {
 				},
 			});
 		} catch (e) {
-			livechatLogger.error(e);
+			livechatLogger.error({ msg: 'Error removing visitor', err: e });
 			throw new Meteor.Error('error-removing-visitor', 'An error ocurred while deleting visitor');
 		}
 	},

apps/meteor/app/livechat/server/api/v1/webhooks.ts

@@ -72,18 +72,18 @@ API.v1.addRoute(
 			}
 
 			try {
-				logger.debug(`Testing webhook ${webhookUrl}`);
+				logger.debug({ msg: 'Testing webhook', webhookUrl });
 				const request = await fetch(webhookUrl, options);
 				const response = await request.text();
 
-				logger.debug({ response });
+				logger.debug({ msg: 'Webhook response', response });
 				if (request.status === 200) {
 					return API.v1.success();
 				}
 
 				throw new Error('Invalid status code');
 			} catch (error) {
-				logger.error(`Error testing webhook: ${error}`);
+				logger.error({ msg: 'Error testing webhook', err: error });
 				throw new Error('error-invalid-webhook-response');
 			}
 		},

apps/meteor/app/livechat/server/business-hour/BusinessHourManager.ts

@@ -287,7 +287,7 @@ export class BusinessHourManager {
 		const failed = result.filter((r) => r.status === 'rejected');
 		if (failed.length > 0) {
 			failed.forEach((error: any) => {
-				businessHourLogger.error('Failed to update business hours with new timezone', error.reason);
+				businessHourLogger.error({ msg: 'Failed to update business hours with new timezone', err: error });
 			});
 		}
 

apps/meteor/app/livechat/server/business-hour/Single.ts

@@ -30,7 +30,8 @@ export class SingleBusinessHourBehavior extends AbstractBusinessHourBehavior imp
 	async onNewAgentCreated(agentId: string): Promise<void> {
 		const defaultBusinessHour = await LivechatBusinessHours.findOneDefaultBusinessHour();
 		if (!defaultBusinessHour) {
-			businessHourLogger.debug('No default business hour found for agentId', {
+			businessHourLogger.debug({
+				msg: 'No default business hour found for agentId',
 				agentId,
 			});
 			return;