utilitas 1989.9.32 → 1989.9.36

package/index.mjs

@@ -1,6 +1,7 @@
 // dependencies
 export { default as colors } from 'colors/safe.js';
 export { default as fetch } from 'node-fetch';
+export { Tail as tail } from 'tail';
 export * as base64url from 'base64url';
 export * as fileType from 'file-type';
 export * as geoIp from 'fast-geoip';
@@ -18,8 +19,6 @@ export * as telegraf from 'telegraf';
 export * as telesign from 'telesignsdk';
 export * as twilio from 'twilio';
 export * as uuid from 'uuid';
-export * as winston from 'winston';
-export * as winstonPapertrail from 'winston-papertrail-mproved';
 
 // features
 export * as bot from './lib/bot.mjs';

package/lib/tape.mjs

@@ -2,78 +2,43 @@ import * as bot from './bot.mjs';
 import * as event from './event.mjs';
 import * as utilitas from './utilitas.mjs';
 
-// https://github.com/winstonjs/winston#logging-levels
-// const levels = ['error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly'];
-// Handle, report, or silently ignore connection errors and failures
-const handleError = (err) => { process.stdout.write(`${err.message}\n`); };
-const consoleMap = { log: 'verbose', info: 0, debug: 0, warn: 0, error: 0 };
-const [TAPE, maxLength, defBufCycle, maxBufCycle] = ['TAPE', 4096, 10, 100];
-const modLog = (content) => { return utilitas.modLog(content, TAPE); };
-const getLogger = async () => { return (await init()).logger; };
-const [BOT, RSYSLOG, PAPERTRAIL] = ['BOT', 'RSYSLOG', 'PAPERTRAIL'];
+const consoleMap = ['log', 'info', 'debug', 'warn', 'error'];
+const [TAPE, BOT, maxLength, defBufCycle, maxBufCycle] = ['TAPE', 'BOT', 4096, 10, 100];
+const stdout = (message) => { return process.stdout.write(`${message}\n`); };
+const modLog = (c, o) => { utilitas.modLog(c, TAPE, { time: true, ...o || {} }); };
 const getSendTxt = (arr) => { return arr.map(x => x[1]).join('\n'); };
 const getSndSize = (arr) => { return getSendTxt(arr).length; };
 const getBufSize = () => { return maxLength * bufferCycle; };
 const nextLen = () => { return botBuffer?.[0]?.[1].length || (maxLength + 1); };
 
-let chatIds, tarLevel, botBuffer, bufferCycle, logger, silent, provider;
-
-// Do something after the connection to the Papertrail server is established
-const handleConnect = (data) => {
-    return silent || modLog(data.replace('Papertrail', provider.toLowerCase()));
-};
+let botBuffer, bufferCycle, chatIds, log, tarLevel;
 
 const hookConsole = () => {
-    for (let act in consoleMap) {
-        const tar = consoleMap[act] || act;
-        const bakAct = `_${act}`;
-        console[bakAct] = console[act];
-        console[act] = function() {
-            console[bakAct].apply(console, arguments);
-            const str = [...arguments].map(
-                utilitas.ensureString
-            ).join(' ').replace(/\u001b\[\d+m/g, '').split('');
+    for (let tar of consoleMap) {
+        const bakTar = `_${tar}`;
+        console[bakTar] = console[tar];
+        console[tar] = function() {
+            console[bakTar].apply(console, arguments);
+            const str = [...arguments].map(utilitas.ensureString).join(' ')
+                .replace(/\u001b\[\d+m/g, '')
+                .split('\n').filter(x => x.length).join('\n').split('');
             while (str.length) {
-                const t = str.splice(0, maxLength).join('').trim();
-                t.length && logger && logger.log(tar, str);
+                const message = str.splice(0, maxLength).join('').trim();
+                message.length && log?.(tar, message);
             }
         };
     }
 };
 
 const releaseConsole = () => {
-    for (let act in consoleMap) {
-        const bakAct = `_${act}`;
-        if (!console[bakAct]) { continue; }
-        console[act] = console[bakAct];
-        delete console[bakAct];
+    for (let tar of consoleMap) {
+        const bakTar = `_${tar}`;
+        if (!console[bakTar]) { continue; }
+        console[tar] = console[bakTar];
+        delete console[bakTar];
     }
 };
 
-const getDefaultOptions = async (provider, options) => {
-    const result = { program: (await utilitas.which()).name };
-    switch (provider) { case RSYSLOG: result.disableTls = true; }
-    // result.logFormat = (level, message) => { return message; }
-    return Object.assign(result, options || {});
-};
-
-const sysLogInit = async (options) => {
-    options = await getDefaultOptions(provider, options);
-    const winston = await import('winston');
-    const papertrail = await import('winston-papertrail-mproved');
-    const papertrailConnection = new papertrail.PapertrailConnection(options);
-    papertrailConnection.on('error', handleError);
-    papertrailConnection.on('connect', handleConnect);
-    const papertrailTransport = new papertrail.PapertrailTransport(
-        papertrailConnection, options
-    );
-    logger = new winston.createLogger({ transports: [papertrailTransport] });
-    return {
-        logger,
-        dependencies: { winston, papertrail, papertrailConnection, papertrailTransport },
-    };
-};
-
 const addChatId = (id) => {
     return chatIds && id && !chatIds.includes(id) ? chatIds.push(id) : null;
 };
@@ -82,77 +47,67 @@ const removeChatId = (id) => {
     return chatIds && id && chatIds.includes(id) ? delete chatIds[id] : false;
 };
 
-const botLoggerInit = async (options) => {
-    chatIds = utilitas.ensureArray(options?.chatId);
-    utilitas.assert(chatIds.length, 'ChatId is required.', 501);
-    handleConnect(`Sending logs via bot, chatId: ${chatIds.join(', ')}.`);
-    bufferCycle = utilitas.ensureInt(
-        options?.bufferCycle || defBufCycle, { min: 1, max: maxBufCycle }
-    );
-    logger = botLogger;
-    await event.loop(
-        botLoggerSync, ~~options?.interval || 5, ~~options?.tout || 10,
-        ~~options?.delay, TAPE, { silent: true }
-    );
-    return { logger, dependencies: { bot, event } };
-};
-
-const botLoggerSync = async () => {
+const sync = async () => {
     let f = [];
     while (getSndSize(f) + nextLen() <= maxLength) { f.push(botBuffer.shift()) }
     if (!(f = getSendTxt(f)).length) { return; };
     for (let id of chatIds) {
-        try { await bot.send(id, f); } catch (err) { handleError(err); }
+        try { await bot.send(id, f); } catch (err) { stdout(err.message); }
     }
 };
 
-const botLogger = {
-    log: (level, message) => {
-        if (tarLevel !== 'verbose' && level === 'verbose') { return; }
-        (botBuffer = botBuffer || []).push([level, message]);
-        while (getSndSize(botBuffer) > getBufSize()) { botBuffer.shift(); }
-    },
-    end: () => {
-        chatIds = undefined; botBuffer = undefined; event.end(TAPE);
-    },
+const rawLog = (level, message) => {
+    if (tarLevel !== 'verbose' && level === 'log') { return; }
+    (botBuffer = botBuffer || []).push([level, message]);
+    while (getSndSize(botBuffer) > getBufSize()) { botBuffer.shift(); }
 };
 
 // use options.level = 'verbose' to send console.log logs
 const init = async (options) => {
-    let result;
     if (options) {
-        silent = !!options?.silent;
+        utilitas.assert(
+            utilitas.insensitiveCompare(options?.provider, BOT),
+            `Invalid tape provider: '${options?.provider}'.`, 501
+        );
+        utilitas.assert(
+            (chatIds = utilitas.ensureArray(options?.chatId)).length,
+            'ChatId is required.', 501
+        );
         tarLevel = options?.level;
-        provider = utilitas.ensureString(options?.provider, { case: 'UP' });
-        switch (provider) {
-            case BOT:
-                result = await botLoggerInit(options);
-                break;
-            case RSYSLOG: // prefer this one
-            case PAPERTRAIL:
-                result = await sysLogInit(options);
-                break;
-            default:
-                utilitas.throwError(
-                    `Invalid tape provider: '${options?.provider}'.`, 501
-                );
+        bufferCycle = utilitas.ensureInt(
+            options?.bufferCycle || defBufCycle, { min: 1, max: maxBufCycle }
+        );
+        if (!options?.silent) {
+            modLog(`Sending logs via bot, chatId: ${chatIds.join(', ')}.`);
         }
+        log = rawLog;
+        await event.loop(
+            sync, ~~options?.interval || 5, ~~options?.tout || 10,
+            ~~options?.delay, TAPE, { silent: true }
+        );
         options.noHook || hookConsole();
     }
-    utilitas.assert(logger, 'Logger client has not been initialized.', 501);
-    return result;
+    utilitas.assert(log, 'Tape has not been initialized.', 501);
+    return log;
 };
 
 const end = async () => {
     releaseConsole();
-    setTimeout(() => { logger?.end?.(); modLog('Terminated.'); }, 1000);
+    setTimeout(async () => {
+        await event.end(TAPE);
+        botBuffer = undefined;
+        bufferCycle = undefined;
+        chatIds = undefined;
+        log = undefined;
+        tarLevel = undefined;
+        modLog('Terminated.');
+    }, 1000);
 };
 
 export default init;
 export {
     addChatId,
     end,
-    getLogger,
     init,
     removeChatId,
 };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "utilitas",
     "description": "Just another common utility for Node.js.",
-    "version": "1989.9.32",
+    "version": "1989.9.36",
     "private": false,
     "homepage": "https://github.com/Leask/utilitas",
     "main": "index.mjs",
@@ -25,7 +25,7 @@
         "url": "https://github.com/Leask/utilitas.git"
     },
     "dependencies": {
-        "@sentry/node": "^6.17.6",
+        "@sentry/node": "^6.17.7",
         "base64url": "^3.0.1",
         "colors": "1.4.0",
         "fast-geoip": "^1.1.58",
@@ -40,11 +40,10 @@
         "node-mailjet": "^3.3.5",
         "ping": "^0.4.1",
         "qs": "^6.10.3",
+        "tail": "^2.2.4",
         "telegraf": "^4.7.0",
         "telesignsdk": "^2.2.1",
         "twilio": "^3.74.0",
-        "uuid": "^8.3.2",
-        "winston": "^3.5.1",
-        "winston-papertrail-mproved": "^1.0.7"
+        "uuid": "^8.3.2"
     }
 }