Allow log levels to be configurable

Install winston
2024-02-28 18:10:27 +00:00 · 2024-02-28 17:58:41 +00:00
7 changed files with 295 additions and 3 deletions
--- a/.dev.env
+++ b/.dev.env
@ -12,6 +12,7 @@ BOT_AUTHOR=Vylpes
 BOT_OWNERID=147392775707426816
 BOT_CLIENTID=682942374040961060
 BOT_ENV=4
+BOT_VERBOSE=false
 BOT_ADMINS=147392775707426816,887272961504071690

 ABOUT_FUNDING=
--- a/.prod.env
+++ b/.prod.env
@ -12,6 +12,7 @@ BOT_AUTHOR=Vylpes
 BOT_OWNERID=147392775707426816
 BOT_CLIENTID=1093810443589529631
 BOT_ENV=1
+BOT_VERBOSE=false
 BOT_ADMINS=147392775707426816,887272961504071690

 ABOUT_FUNDING=
--- a/.stage.env
+++ b/.stage.env
@ -12,6 +12,7 @@ BOT_AUTHOR=Vylpes
 BOT_OWNERID=147392775707426816
 BOT_CLIENTID=1147976642942214235
 BOT_ENV=2
+BOT_VERBOSE=false
 BOT_ADMINS=147392775707426816,887272961504071690

 ABOUT_FUNDING=
--- a/package-lock.json
+++ b/package-lock.json
@ -25,7 +25,8 @@
        "minimatch": "9.0.3",
        "mysql": "^2.18.1",
        "ts-jest": "^29.0.0",
-        "typeorm": "0.3.20"
+        "typeorm": "0.3.20",
+        "winston": "^3.11.0"
      },
      "devDependencies": {
        "@types/node": "^20.0.0",
@ -711,6 +712,24 @@
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
+    "node_modules/@colors/colors": {
+      "version": "1.6.0",
+      "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz",
+      "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==",
+      "engines": {
+        "node": ">=0.1.90"
+      }
+    },
+    "node_modules/@dabh/diagnostics": {
+      "version": "2.0.3",
+      "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz",
+      "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==",
+      "dependencies": {
+        "colorspace": "1.1.x",
+        "enabled": "2.0.x",
+        "kuler": "^2.0.0"
+      }
+    },
    "node_modules/@discordjs/builders": {
      "version": "1.7.0",
      "license": "Apache-2.0",
@ -1940,6 +1959,11 @@
      "version": "2.0.3",
      "license": "MIT"
    },
+    "node_modules/@types/triple-beam": {
+      "version": "1.3.5",
+      "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz",
+      "integrity": "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw=="
+    },
    "node_modules/@types/uuid": {
      "version": "9.0.8",
      "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-9.0.8.tgz",
@ -2576,6 +2600,11 @@
        "node": ">=8"
      }
    },
+    "node_modules/async": {
+      "version": "3.2.5",
+      "resolved": "https://registry.npmjs.org/async/-/async-3.2.5.tgz",
+      "integrity": "sha512-baNZyqaaLhyLVKm/DlvdW051MSgO6b8eVfIezl9E5PqWxFgzLm/wQntEW4zOytVburDEr0JlALEpdOFwvErLsg=="
+    },
    "node_modules/babel-jest": {
      "version": "29.7.0",
      "license": "MIT",
@ -3604,6 +3633,15 @@
      "version": "1.0.2",
      "license": "MIT"
    },
+    "node_modules/color": {
+      "version": "3.2.1",
+      "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz",
+      "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==",
+      "dependencies": {
+        "color-convert": "^1.9.3",
+        "color-string": "^1.6.0"
+      }
+    },
    "node_modules/color-convert": {
      "version": "2.0.1",
      "license": "MIT",
@ -3618,6 +3656,15 @@
      "version": "1.1.4",
      "license": "MIT"
    },
+    "node_modules/color-string": {
+      "version": "1.9.1",
+      "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz",
+      "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==",
+      "dependencies": {
+        "color-name": "^1.0.0",
+        "simple-swizzle": "^0.2.2"
+      }
+    },
    "node_modules/color-support": {
      "version": "1.1.3",
      "resolved": "https://registry.npmjs.org/color-support/-/color-support-1.1.3.tgz",
@ -3628,6 +3675,28 @@
        "color-support": "bin.js"
      }
    },
+    "node_modules/color/node_modules/color-convert": {
+      "version": "1.9.3",
+      "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+      "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+      "dependencies": {
+        "color-name": "1.1.3"
+      }
+    },
+    "node_modules/color/node_modules/color-name": {
+      "version": "1.1.3",
+      "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+      "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="
+    },
+    "node_modules/colorspace": {
+      "version": "1.1.4",
+      "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz",
+      "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==",
+      "dependencies": {
+        "color": "^3.1.3",
+        "text-hex": "1.0.x"
+      }
+    },
    "node_modules/commander": {
      "version": "6.2.1",
      "dev": true,
@ -4233,6 +4302,11 @@
      "version": "8.0.0",
      "license": "MIT"
    },
+    "node_modules/enabled": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz",
+      "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ=="
+    },
    "node_modules/encodeurl": {
      "version": "1.0.2",
      "license": "MIT",
@ -4823,6 +4897,11 @@
        "bser": "2.1.1"
      }
    },
+    "node_modules/fecha": {
+      "version": "4.2.3",
+      "resolved": "https://registry.npmjs.org/fecha/-/fecha-4.2.3.tgz",
+      "integrity": "sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw=="
+    },
    "node_modules/figures": {
      "version": "2.0.0",
      "dev": true,
@ -4915,6 +4994,11 @@
      "integrity": "sha512-36yxDn5H7OFZQla0/jFJmbIKTdZAQHngCedGxiMmpNfEZM0sdEeT+WczLQrjK6D7o2aiyLYDnkw0R3JK0Qv1RQ==",
      "dev": true
    },
+    "node_modules/fn.name": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz",
+      "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw=="
+    },
    "node_modules/foreground-child": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
@ -7111,6 +7195,11 @@
        "node": ">=6"
      }
    },
+    "node_modules/kuler": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz",
+      "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A=="
+    },
    "node_modules/latest-version": {
      "version": "7.0.0",
      "dev": true,
@ -7611,6 +7700,27 @@
        "node": ">=4"
      }
    },
+    "node_modules/logform": {
+      "version": "2.6.0",
+      "resolved": "https://registry.npmjs.org/logform/-/logform-2.6.0.tgz",
+      "integrity": "sha512-1ulHeNPp6k/LD8H91o7VYFBng5i1BDE7HoKxVbZiGFidS1Rj65qcywLxX+pVfAPoQJEjRdvKcusKwOupHCVOVQ==",
+      "dependencies": {
+        "@colors/colors": "1.6.0",
+        "@types/triple-beam": "^1.3.2",
+        "fecha": "^4.2.0",
+        "ms": "^2.1.1",
+        "safe-stable-stringify": "^2.3.1",
+        "triple-beam": "^1.3.0"
+      },
+      "engines": {
+        "node": ">= 12.0.0"
+      }
+    },
+    "node_modules/logform/node_modules/ms": {
+      "version": "2.1.3",
+      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
+      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
+    },
    "node_modules/lowercase-keys": {
      "version": "2.0.0",
      "dev": true,
@ -8726,6 +8836,14 @@
        "wrappy": "1"
      }
    },
+    "node_modules/one-time": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/one-time/-/one-time-1.0.0.tgz",
+      "integrity": "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==",
+      "dependencies": {
+        "fn.name": "1.x.x"
+      }
+    },
    "node_modules/onetime": {
      "version": "5.1.2",
      "license": "MIT",
@ -9943,6 +10061,14 @@
      ],
      "license": "MIT"
    },
+    "node_modules/safe-stable-stringify": {
+      "version": "2.4.3",
+      "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.4.3.tgz",
+      "integrity": "sha512-e2bDA2WJT0wxseVd4lsDP4+3ONX6HpMXQa1ZhFQ7SU+GjvORCmShbCMltrtIDfkYhVHrOcPtj+KhmDBdPdZD1g==",
+      "engines": {
+        "node": ">=10"
+      }
+    },
    "node_modules/safer-buffer": {
      "version": "2.1.2",
      "license": "MIT"
@ -10090,6 +10216,19 @@
      "version": "3.0.7",
      "license": "ISC"
    },
+    "node_modules/simple-swizzle": {
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz",
+      "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==",
+      "dependencies": {
+        "is-arrayish": "^0.3.1"
+      }
+    },
+    "node_modules/simple-swizzle/node_modules/is-arrayish": {
+      "version": "0.3.2",
+      "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz",
+      "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ=="
+    },
    "node_modules/sisteransi": {
      "version": "1.0.5",
      "license": "MIT"
@ -10279,6 +10418,14 @@
        "node": ">=8"
      }
    },
+    "node_modules/stack-trace": {
+      "version": "0.0.10",
+      "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.10.tgz",
+      "integrity": "sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg==",
+      "engines": {
+        "node": "*"
+      }
+    },
    "node_modules/stack-utils": {
      "version": "2.0.6",
      "license": "MIT",
@ -10627,6 +10774,11 @@
        "node": "*"
      }
    },
+    "node_modules/text-hex": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz",
+      "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg=="
+    },
    "node_modules/text-table": {
      "version": "0.2.0",
      "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz",
@ -10712,6 +10864,14 @@
      "optional": true,
      "peer": true
    },
+    "node_modules/triple-beam": {
+      "version": "1.4.1",
+      "resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.4.1.tgz",
+      "integrity": "sha512-aZbgViZrg1QNcG+LULa7nhZpJTZSLm/mXnHXnbAbjmN5aSa0y7V+wvv6+4WaBtpISJzThKy+PIPxc1Nq1EJ9mg==",
+      "engines": {
+        "node": ">= 14.0.0"
+      }
+    },
    "node_modules/ts-api-utils": {
      "version": "1.0.3",
      "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.0.3.tgz",
@ -11303,6 +11463,66 @@
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
+    "node_modules/winston": {
+      "version": "3.11.0",
+      "resolved": "https://registry.npmjs.org/winston/-/winston-3.11.0.tgz",
+      "integrity": "sha512-L3yR6/MzZAOl0DsysUXHVjOwv8mKZ71TrA/41EIduGpOOV5LQVodqN+QdQ6BS6PJ/RdIshZhq84P/fStEZkk7g==",
+      "dependencies": {
+        "@colors/colors": "^1.6.0",
+        "@dabh/diagnostics": "^2.0.2",
+        "async": "^3.2.3",
+        "is-stream": "^2.0.0",
+        "logform": "^2.4.0",
+        "one-time": "^1.0.0",
+        "readable-stream": "^3.4.0",
+        "safe-stable-stringify": "^2.3.1",
+        "stack-trace": "0.0.x",
+        "triple-beam": "^1.3.0",
+        "winston-transport": "^4.5.0"
+      },
+      "engines": {
+        "node": ">= 12.0.0"
+      }
+    },
+    "node_modules/winston-transport": {
+      "version": "4.7.0",
+      "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.7.0.tgz",
+      "integrity": "sha512-ajBj65K5I7denzer2IYW6+2bNIVqLGDHqDw3Ow8Ohh+vdW+rv4MZ6eiDvHoKhfJFZ2auyN8byXieDDJ96ViONg==",
+      "dependencies": {
+        "logform": "^2.3.2",
+        "readable-stream": "^3.6.0",
+        "triple-beam": "^1.3.0"
+      },
+      "engines": {
+        "node": ">= 12.0.0"
+      }
+    },
+    "node_modules/winston-transport/node_modules/readable-stream": {
+      "version": "3.6.2",
+      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz",
+      "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==",
+      "dependencies": {
+        "inherits": "^2.0.3",
+        "string_decoder": "^1.1.1",
+        "util-deprecate": "^1.0.1"
+      },
+      "engines": {
+        "node": ">= 6"
+      }
+    },
+    "node_modules/winston/node_modules/readable-stream": {
+      "version": "3.6.2",
+      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz",
+      "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==",
+      "dependencies": {
+        "inherits": "^2.0.3",
+        "string_decoder": "^1.1.1",
+        "util-deprecate": "^1.0.1"
+      },
+      "engines": {
+        "node": ">= 6"
+      }
+    },
    "node_modules/wrap-ansi": {
      "version": "8.1.0",
      "license": "MIT",
--- a/package.json
+++ b/package.json
@ -41,7 +41,8 @@
    "minimatch": "9.0.3",
    "mysql": "^2.18.1",
    "ts-jest": "^29.0.0",
-    "typeorm": "0.3.20"
+    "typeorm": "0.3.20",
+    "winston": "^3.11.0"
  },
  "resolutions": {},
  "devDependencies": {
--- a/src/client/appLogger.ts
+++ b/src/client/appLogger.ts
@ -0,0 +1,62 @@
+import { Logger, createLogger, format, transports } from "winston";
+import { CoreClient } from "./client";
+
+export default class AppLogger {
+    public static InitialiseLogger(logLevel: string, outputToConsole: boolean): Logger {
+        const customFormat = format.printf(({ level, message, timestamp, label }) => {
+            return `${timestamp} [${label}] ${level}: ${message}`;
+        });
+
+        const logger = createLogger({
+            level: logLevel,
+            format: format.combine(
+                format.timestamp({
+                    format: 'YYYY-MM-DD HH:mm:ss'
+                }),
+                format.errors({ stack: true }),
+                format.splat(),
+                customFormat,
+            ),
+            defaultMeta: { service: 'bot' },
+            transports: [
+                new transports.File({ filename: 'error.log', level: 'error' }),
+                new transports.File({ filename: 'combined.log' }),
+            ],
+        });
+
+        if (outputToConsole) {
+            logger.add(new transports.Console({
+                format: format.combine(
+                    format.colorize(),
+                    format.timestamp(),
+                    customFormat,
+            )}));
+        }
+
+        return logger;
+    }
+
+    public static LogError(label: string, message: string) {
+        CoreClient.Logger.error({ label, message });
+    }
+
+    public static LogWarn(label: string, message: string) {
+        CoreClient.Logger.warn({ label, message });
+    }
+
+    public static LogInfo(label: string, message: string) {
+        CoreClient.Logger.info({ label, message });
+    }
+
+    public static LogVerbose(label: string, message: string) {
+        CoreClient.Logger.verbose({ label, message });
+    }
+
+    public static LogDebug(label: string, message: string) {
+        CoreClient.Logger.debug({ label, message });
+    }
+
+    public static LogSilly(label: string, message: string) {
+        CoreClient.Logger.silly({ label, message });
+    }
+}
--- a/src/client/client.ts
+++ b/src/client/client.ts
@ -13,6 +13,8 @@ import { Environment } from "../constants/Environment";
 import Webhooks from "../webhooks";
 import CardMetadataFunction from "../Functions/CardMetadataFunction";
 import { SeriesMetadata } from "../contracts/SeriesMetadata";
+import { Logger } from "winston";
+import AppLogger from "./appLogger";

 export class CoreClient extends Client {
    private static _commandItems: ICommandItem[];
@ -27,6 +29,7 @@ export class CoreClient extends Client {
    public static Environment: Environment;
    public static AllowDrops: boolean;
    public static Cards: SeriesMetadata[];
+    public static Logger: Logger;

    public static get commandItems(): ICommandItem[] {
        return this._commandItems;
@ -44,6 +47,10 @@ export class CoreClient extends Client {
        super({ intents: intents });
        dotenv.config();

+        CoreClient.Environment = Number(process.env.BOT_ENV);
+
+        CoreClient.Logger = AppLogger.InitialiseLogger(process.env.BOT_VERBOSE == "true" ? "verbose" : "info", CoreClient.Environment == Environment.Local);
+
        CoreClient._commandItems = [];
        CoreClient._buttonEvents = [];

@ -51,7 +58,6 @@ export class CoreClient extends Client {
        this._util = new Util();
        this._webhooks = new Webhooks();

-        CoreClient.Environment = Number(process.env.BOT_ENV);
        console.log(`Bot Environment: ${CoreClient.Environment}`);

        CoreClient.AllowDrops = true;
Author	SHA1	Message	Date
Ethan Lane	408874859e	Allow log levels to be configurable Some checks failed ci/woodpecker/push/woodpecker Pipeline failed Details	2024-02-28 18:10:27 +00:00
Ethan Lane	0677f8feb8	Install winston	2024-02-28 17:58:41 +00:00