ntlogger 2.6.1 → 2.7.0

package/index.js

@@ -5,14 +5,33 @@
  */
 
 /**
- * TODO: [Feature] Generic Webhook Plugin for sending logs to any webhook
- * TODO: [Feature] Email Plugin for sending logs to an email address
- * TODO: [Feature] SMS Mail ID Plugin for sending logs to a phone number
- * TODO: [Feature] Allow for custom log levels and colors
+ * TODO: [FEATURE] Generic Webhook Plugin for sending logs to any webhook
+ * TODO: [FEATURE] Email Plugin for sending logs to an email address
+ * TODO: [FEATURE] SMS Mail ID Plugin for sending logs to a phone number
+ * TODO: [FEATURE] Allow for custom log levels and colors
+ * TODO: [FEATURE] Add a toggle to enable/disable individual plugins
+ * TODO: [FEATURE] Attempt automatically parse the environment variables for the config using special flags.
+ *                 This would allow for a more seamless integration with Docker and adjustments to the config without code changes.
+ * TODO: [FEATURE] Make `LOG_REPORT_PATH` a build in variable. This variable attempts to find the current file name and directory name for cleaner logs.
+ *                 LOG_REPORT_PATH=(path.basename(path.dirname(__filename)) === process.env.APP_NAME ? '/' : path.basename(path.dirname(__filename)) + '/') + path.basename(__filename, ".js")
+ *                 2024-08-27 23:45:28 [trace   ] [ID: 578060] [APP_NAME routes/instructions]: Logger initiated by routes/instructions with log level trace
+ *                 2024-08-27 23:45:28 [trace   ] [ID: 578060] [APP_NAME routes/create-and-sign]: Logger initiated by routes/create-and-sign with log level trace
+ * TODO: [FEATURE] Add a option to pass a banner. For example logger.banner('Project Name') would print a banner with the project name.
+ * TODO: [TESTING] Create a comprehensive test suite for all plugins.
+ * TODO: [BUG] Syslog plugin has incorrect log levels. (For example, info reports level 3, and reports as 11 in the Syslog server)
  */
 
 /**
  * Change Log:
+ * v2.7.0 - 09/02/2024:
+ * [FEATURE] Added a toggle to enable/disable individual plugins. See documentation for more information.
+ * [NOTE] Changed how the plugins are loaded. Broken plugins will no longer crash the logger, rather they will be disabled.
+ *
+ * v2.6.2 - 08/15/2024:
+ * [DEPENDENCY] Added pg package for Postgres Plugin
+ * [FEATURE] Postgres Plugin
+ *           a simple mysql rewrite so not even going to make a minor version bump
+ *
  * v2.6.1 - 08/15/2024:
  * [UPDATED] @sentry/node            ^8.25.0 --> ^8.26.0
  * [UPDATED] @sentry/profiling-node  ^8.25.0 --> ^8.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ntlogger",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NightSquawk/NightTimeLogger.git"
@@ -32,6 +32,7 @@
   "dependencies": {
     "@sentry/node": "^8.26.0",
     "mysql2": "^3.11.0",
+    "pg": "^8.12.0",
     "winston": "^3.14.2",
     "winston-transport": "^4.7.1"
   },

package/plugins/index.js

@@ -7,10 +7,12 @@
 const plugins = {
     Sentry  : require('./sentry'),
     MySQL   : require('./mysql'),
+    Postgres: require('./postgres'),
     Jest    : require('./jest'),
     Syslog  : require('./syslog'),
     Discord : require('./discord'),
     Teams   : require('./teams'),
+
     // WIP SMSMail : require('./smsMail'),
 };
 
@@ -37,8 +39,25 @@ function initPlugins(config = {}) {
     let pluginTransports = [];
     try {
         for (let plugin of config) {
-            if (!plugin.name) {
-                throw new Error('Plugin name is required');
+            try {
+                if (!plugin.name) {
+                    throw new Error('Plugin name is required');
+                }
+            } catch (nameError) {
+                console.error('Error initializing plugins:', nameError.message);
+                console.error(nameError.stack);
+                continue
+            }
+
+            try {
+                if (!plugin.enabled) {
+                    console.log(`Plugin ${plugin.name} is disabled`);
+                    continue;
+                }
+            } catch (enabledError) {
+                console.error('Error initializing plugins:', enabledError.message);
+                console.error(enabledError.stack);
+                continue
             }
 
             try {

package/plugins/postgres.js

@@ -0,0 +1,140 @@
+/**
+ * @file /plugins/postgres.js
+ * @description Stores logs in PostgresSQL database.
+ */
+
+const Transport = require('winston-transport');
+const { Pool } = require('pg');
+const levels = require('../lib/levels');
+
+let connectionPool = null;
+let tableInitialized = false;
+
+class PostgreSQLTransport extends Transport {
+    constructor(opts = {}) {
+        super(opts);
+
+        this.name = 'PostgreSQL Transport for NTLogger';
+        this.database = opts.database || 'test';
+        this.table = opts.table || 'logs';
+
+        this.logLevel = opts.level ? levels[opts.level] : levels.info;
+
+        this.poolConfig = {
+            host: opts.host || 'localhost',
+            port: opts.port || 5432,
+            user: opts.user || 'postgres',
+            password: opts.password || '',
+            database: this.database,
+            max: opts.connectionLimit || 10,
+            idleTimeoutMillis: opts.idleTimeout || 60000,
+            connectionTimeoutMillis: opts.connectionTimeout || 2000,
+        };
+
+        this.init();
+    }
+
+    async init() {
+        try {
+            if (!connectionPool) {
+                connectionPool = new Pool(this.poolConfig);
+            }
+            this.pool = connectionPool;
+            await this.checkLogTable();
+        } catch (err) {
+            console.error(`Failed to initialize ${this.name}:`, err);
+        }
+    }
+
+    async log(info, callback) {
+        setImmediate(() => {
+            this.emit('logged', info);
+        });
+
+        if (!tableInitialized) {
+            await this.checkLogTable();
+        }
+
+        const { level, message, ...meta } = info;
+
+        if (levels[level] > this.logLevel) {
+            callback();
+            return;
+        }
+
+        const metaString = JSON.stringify(meta);
+        const timestamp = this.formatTimestamp(meta.timeCreated);
+
+        try {
+            await this.pool.query(
+                `INSERT INTO ${this.table} (level, message, meta, timestamp) VALUES ($1, $2, $3, $4)`,
+                [level, message, metaString, timestamp]
+            );
+        } catch (err) {
+            console.error(`Failed to log message to ${this.name}:`, err);
+        }
+
+        callback();
+    }
+
+    formatTimestamp(timeCreated) {
+        if (!timeCreated) {
+            return new Date().toISOString().slice(0, 19).replace('T', ' ');
+        }
+
+        const date = new Date();
+        const [time, modifier] = timeCreated.split(' ');
+        let [hours, minutes, seconds] = time.split(':');
+
+        if (modifier === 'PM' && hours !== '12') {
+            hours = parseInt(hours, 10) + 12;
+        }
+        if (modifier === 'AM' && hours === '12') {
+            hours = '00';
+        }
+
+        return `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')} ${hours}:${minutes}:${seconds}`;
+    }
+
+    async checkLogTable() {
+        if (tableInitialized) return;
+
+        try {
+            const result = await this.pool.query(
+                `SELECT to_regclass('${this.table}') as tablename`
+            );
+
+            if (!result.rows[0].tablename) {
+                await this.pool.query(
+                    `CREATE TABLE IF NOT EXISTS ${this.table} (
+                        id SERIAL PRIMARY KEY,
+                        level VARCHAR(255) NOT NULL,
+                        message TEXT NOT NULL,
+                        meta JSONB,
+                        timestamp TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
+                    )`
+                );
+            }
+
+            tableInitialized = true;
+        } catch (err) {
+            console.error(`Failed to check or create table ${this.table}:`, err);
+        }
+    }
+
+    isActive() {
+        return this.pool && !this.pool.ended;
+    }
+
+    async close() {
+        if (connectionPool) {
+            await connectionPool.end();
+            connectionPool = null;
+            console.log('Closed PostgreSQL connection pool.');
+        }
+    }
+}
+
+module.exports = {
+    transport: PostgreSQLTransport,
+};