170a185928
Add a new /singleplayer/log route for logging data to the server console from the client Supports: - All server log levels - `Custom` log level with text/background color - Specifying the source of the log line (ex. Plugin name) Example output: ![Example](https://i.imgur.com/c0XBYLm.png) Co-authored-by: DrakiaXYZ <565558+TheDgtl@users.noreply.github.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/160 Co-authored-by: DrakiaXYZ <drakiaxyz@noreply.dev.sp-tarkov.com> Co-committed-by: DrakiaXYZ <drakiaxyz@noreply.dev.sp-tarkov.com>
57 lines
1.9 KiB
TypeScript
57 lines
1.9 KiB
TypeScript
import { IClientLogRequest } from "@spt-aki/models/spt/logging/IClientLogRequest";
|
|
import { LogBackgroundColor } from "@spt-aki/models/spt/logging/LogBackgroundColor";
|
|
import { LogLevel } from "@spt-aki/models/spt/logging/LogLevel";
|
|
import { LogTextColor } from "@spt-aki/models/spt/logging/LogTextColor";
|
|
import { ILogger } from "@spt-aki/models/spt/utils/ILogger";
|
|
import { inject, injectable } from "tsyringe";
|
|
|
|
@injectable()
|
|
export class ClientLogController
|
|
{
|
|
constructor(
|
|
@inject("WinstonLogger") protected logger: ILogger
|
|
)
|
|
{ }
|
|
|
|
/**
|
|
* Handle /singleplayer/log
|
|
*/
|
|
public clientLog(logRequest: IClientLogRequest): void
|
|
{
|
|
const message = `[${logRequest.Source}] ${logRequest.Message}`;
|
|
const color = logRequest.Color ?? LogTextColor.WHITE;
|
|
const backgroundColor = logRequest.BackgroundColor ?? LogBackgroundColor.DEFAULT;
|
|
|
|
// Allow supporting either string or enum levels
|
|
// Required due to the C# modules serializing enums as their name
|
|
let level = logRequest.Level;
|
|
if (typeof level === "string")
|
|
{
|
|
level = LogLevel[level.toUpperCase() as keyof typeof LogLevel];
|
|
}
|
|
|
|
switch (level)
|
|
{
|
|
case LogLevel.ERROR:
|
|
this.logger.error(message);
|
|
break;
|
|
case LogLevel.WARN:
|
|
this.logger.warning(message);
|
|
break;
|
|
case LogLevel.SUCCESS:
|
|
this.logger.success(message);
|
|
break;
|
|
case LogLevel.INFO:
|
|
this.logger.info(message);
|
|
break;
|
|
case LogLevel.CUSTOM:
|
|
this.logger.log(message, color, backgroundColor);
|
|
break;
|
|
case LogLevel.DEBUG:
|
|
this.logger.debug(message);
|
|
break;
|
|
default:
|
|
this.logger.info(message);
|
|
}
|
|
}
|
|
} |