logxpert 2.0.0 → 2.1.0

package/lib/rotate.js

@@ -0,0 +1,144 @@
+const fs = require('fs');
+const path = require('path');
+const zlib = require('zlib');
+const dayjs = require('dayjs');
+
+function parseSize(value, fallback) {
+  if (value == null) return fallback;
+  const m = String(value).trim().match(/^(\d+(?:\.\d+)?)\s*([kmg])?$/i);
+  if (!m) return fallback;
+  const mult = { k: 1024, m: 1024 ** 2, g: 1024 ** 3 }[(m[2] || '').toLowerCase()] ?? 1;
+  return Math.floor(parseFloat(m[1]) * mult);
+}
+
+function parseDays(value) {
+  if (value == null) return null;
+  const m = String(value).trim().match(/^(\d+)\s*d$/i);
+  return m ? parseInt(m[1], 10) : null;
+}
+
+class FileTransport {
+  constructor({ folder, filename, datePattern, maxSize = '20m', maxFiles = '14d', zippedArchive = false, level, render }) {
+    this.dirname = folder;
+    this.filename = filename;
+    this.options = { datePattern, maxSize, maxFiles, zippedArchive };
+    this.level = level;
+    this.render = render;
+    this.datePattern = datePattern;
+    this.maxBytes = parseSize(maxSize, Infinity);
+    this.maxFiles = maxFiles;
+    this.maxDays = parseDays(maxFiles);
+    this.zippedArchive = zippedArchive;
+    this.currentKey = null;
+    this.currentFile = null;
+    this.stream = null;
+    this.streamSize = 0;
+    this.streamErr = null;
+  }
+
+  fileNameFor(dateStr, n = 0) {
+    let name = this.filename.split('%DATE%').join(dateStr);
+    if (n > 0) {
+      const ext = path.extname(name) || '.log';
+      name = name.slice(0, -ext.length) + '-' + n + ext;
+    }
+    return name;
+  }
+
+  open(dateStr, startN = 0) {
+    if (!fs.existsSync(this.dirname)) fs.mkdirSync(this.dirname, { recursive: true });
+    let n = startN;
+    let full = path.join(this.dirname, this.fileNameFor(dateStr, n));
+    try {
+      let size = fs.existsSync(full) ? fs.statSync(full).size : 0;
+      while (size >= this.maxBytes && n < 1000) {
+        n += 1;
+        full = path.join(this.dirname, this.fileNameFor(dateStr, n));
+        size = fs.existsSync(full) ? fs.statSync(full).size : 0;
+      }
+    } catch {}
+    const stream = fs.createWriteStream(full, { flags: 'a' });
+    stream.on('error', (err) => { this.streamErr = err; });
+    this.stream = stream;
+    this.streamSize = 0;
+    try {
+      this.streamSize = fs.existsSync(full) ? fs.statSync(full).size : 0;
+    } catch {}
+    this.currentKey = dateStr + '#' + n;
+    this.currentFile = full;
+  }
+
+  rotateIfNeeded(dateStr, incoming) {
+    if (this.currentKey !== null && !this.currentKey.startsWith(dateStr + '#')) {
+      const previous = this.currentFile;
+      this.closeStream();
+      this.onDateChanged(previous);
+      this.currentKey = null;
+    }
+    if (this.stream === null) {
+      this.open(dateStr);
+    } else if (this.streamSize + incoming > this.maxBytes) {
+      const cur = parseInt(String(this.currentKey || '#0').split('#')[1] || '0', 10);
+      this.closeStream();
+      this.open(dateStr, cur + 1);
+    }
+  }
+
+  onDateChanged(previousFile) {
+    if (!previousFile) return;
+    try {
+      if (this.zippedArchive && fs.existsSync(previousFile)) {
+        const gz = previousFile + '.gz';
+        const data = fs.readFileSync(previousFile);
+        fs.writeFileSync(gz, zlib.gzipSync(data));
+        fs.rmSync(previousFile, { force: true });
+      }
+    } catch {}
+    this.cleanupOld();
+  }
+
+  cleanupOld() {
+    if (this.maxDays == null) return;
+    let entries;
+    try {
+      entries = fs.readdirSync(this.dirname);
+    } catch {
+      return;
+    }
+    const cutoff = Date.now() - this.maxDays * 86400000;
+    for (const entry of entries) {
+      if (!entry.endsWith('.log') && !entry.endsWith('.log.gz') && !entry.endsWith('.gz')) continue;
+      const full = path.join(this.dirname, entry);
+      try {
+        if (fs.statSync(full).mtimeMs < cutoff) fs.rmSync(full, { force: true });
+      } catch {}
+    }
+  }
+
+  write(entry) {
+    const line = this.render(entry);
+    const buf = Buffer.byteLength(line + '\n');
+    const dateStr = dayjs().format(this.datePattern);
+    this.rotateIfNeeded(dateStr, buf);
+    if (this.stream) {
+      this.stream.write(line + '\n');
+      this.streamSize += buf;
+    }
+  }
+
+  closeStream() {
+    if (this.stream) {
+      try {
+        this.stream.end();
+      } catch {}
+      this.stream = null;
+    }
+  }
+
+  close() {
+    this.closeStream();
+    this.currentKey = null;
+  }
+}
+
+module.exports = { FileTransport, parseSize, parseDays };

package/lib/sanitize.js

@@ -0,0 +1,89 @@
+const path = require('path');
+
+const VALID_LEVELS = ['error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly'];
+
+function assertLevel(level) {
+  if (!VALID_LEVELS.includes(level)) throw new Error(`Invalid log level "${level}". Use one of: ${VALID_LEVELS.join(', ')}`);
+}
+
+function stripAnsi(str) {
+  let out = '';
+  let i = 0;
+  while (i < str.length) {
+    if (str[i] !== '\x1b') {
+      out += str[i];
+      i++;
+      continue;
+    }
+    const next = str[i + 1];
+    if (next === ']') {
+      let j = i + 2;
+      while (j < str.length) {
+        if (str[j] === '\x07') { j++; break; }
+        if (str[j] === '\x1b' && str[j + 1] === '\\') { j += 2; break; }
+        j++;
+      }
+      i = j;
+    } else if (next === '[') {
+      let j = i + 2;
+      while (j < str.length && str[j] >= ' ' && str[j] <= '?') j++;
+      if (j < str.length) j++;
+      i = j;
+    } else if (next === '(' || next === ')') {
+      i += 3;
+    } else {
+      i += next === undefined ? 1 : 2;
+    }
+  }
+  return out;
+}
+const CONTROL_RE = /[\x00-\x08\x0b\x0c\x0d\x0e-\x1f\x7f]/g;
+
+function sanitizeMessage(msg) {
+  if (typeof msg !== 'string') return msg;
+  return stripAnsi(msg).replace(CONTROL_RE, '');
+}
+
+function assertFilenameSafe(filename) {
+  if (typeof filename !== 'string' || !filename.trim() || filename.includes('\0')) {
+    throw new Error('files.filename must be a non-empty string');
+  }
+  if (path.isAbsolute(filename) || filename.split(/[\\/]/).includes('..')) {
+    throw new Error('files.filename must not escape the log folder (.. and absolute paths are rejected)');
+  }
+}
+
+function isSafeChar(c) {
+  return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c === '.' || c === '_' || c === '-';
+}
+
+function isPadChar(c) {
+  return c === '-' || c === '_' || c === '.';
+}
+
+function sanitizeAppName(name) {
+  if (typeof name !== 'string' || !name.trim()) return null;
+  const base = name.trim().slice(0, 200).split('/').pop();
+  let out = '';
+  for (let i = 0; i < base.length; i++) {
+    out += isSafeChar(base[i]) ? base[i] : '-';
+  }
+  let start = 0;
+  while (start < out.length && isPadChar(out[start])) start++;
+  let end = out.length;
+  while (end > start && isPadChar(out[end - 1])) end--;
+  const safe = out.slice(start, end);
+  return safe || null;
+}
+
+module.exports = {
+  VALID_LEVELS,
+  assertLevel,
+  stripAnsi,
+  CONTROL_RE,
+  sanitizeMessage,
+  assertFilenameSafe,
+  isSafeChar,
+  isPadChar,
+  sanitizeAppName,
+};

package/lib/time.js

@@ -0,0 +1,64 @@
+const dayjs = require('dayjs');
+
+const DEFAULT_CONSOLE_FORMAT = 'YYYY-MM-DD HH:mm:ss';
+
+function pad2(n) {
+  return String(n).padStart(2, '0');
+}
+
+function formatDefaultTimestamp(d = new Date()) {
+  return `${d.getFullYear()}-${pad2(d.getMonth() + 1)}-${pad2(d.getDate())} ${pad2(d.getHours())}:${pad2(d.getMinutes())}:${pad2(d.getSeconds())}`;
+}
+
+function splitBrackets(fmt) {
+  const parts = [];
+  let current = '';
+  let i = 0;
+  while (i < fmt.length) {
+    if (fmt[i] === '[') {
+      const close = fmt.indexOf(']', i + 1);
+      if (close === -1) {
+        current += fmt.slice(i);
+        break;
+      }
+      if (current) {
+        parts.push(current);
+        current = '';
+      }
+      parts.push(fmt.slice(i, close + 1));
+      i = close + 1;
+    } else {
+      current += fmt[i];
+      i++;
+    }
+  }
+  if (current) parts.push(current);
+  return parts;
+}
+
+function compileTimestampFormatter(fmt) {
+  if (typeof fmt !== 'string' || !fmt) return formatDefaultTimestamp;
+  if (fmt === DEFAULT_CONSOLE_FORMAT) return formatDefaultTimestamp;
+  if (!fmt.includes('[') || !fmt.includes(']')) return () => dayjs().format(fmt);
+  const parts = splitBrackets(fmt).map((part) => {
+    if (part.startsWith('[') && part.endsWith(']')) {
+      const inner = part.slice(1, -1);
+      return inner ? () => '[' + dayjs().format(inner) + ']' : () => '[]';
+    }
+    return () => part;
+  });
+  return () => parts.map((f) => f()).join('');
+}
+
+function formatCustomTimestamp(fmt) {
+  return compileTimestampFormatter(fmt)();
+}
+
+module.exports = {
+  DEFAULT_CONSOLE_FORMAT,
+  pad2,
+  formatDefaultTimestamp,
+  splitBrackets,
+  compileTimestampFormatter,
+  formatCustomTimestamp,
+};

package/main.js

@@ -1,100 +1,40 @@
 const fs = require('fs');
 const path = require('path');
-const dayjs = require('dayjs');
-const { createLogger, format, transports } = require('winston');
-require('winston-daily-rotate-file');
-
-const VALID_LEVELS = ['error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly'];
-const DEFAULT_CONSOLE_FORMAT = 'YYYY-MM-DD HH:mm:ss';
-
-function formatCustomTimestamp(fmt) {
-  if (typeof fmt !== 'string' || !fmt) return dayjs().format(DEFAULT_CONSOLE_FORMAT);
-  if (fmt.includes('[') && fmt.includes(']')) {
-    return fmt.split(/(\[[^\]]*\])/).map((part) => {
-      if (part.startsWith('[') && part.endsWith(']')) {
-        const inner = part.slice(1, -1);
-        return '[' + (inner ? dayjs().format(inner) : '') + ']';
-      }
-      return part;
-    }).join('');
-  }
-  return dayjs().format(fmt);
-}
-
-function formatExtra(meta) {
-  const keys = Object.keys(meta).filter((k) => k !== 'splat' && k !== 'ms');
-  if (!keys.length) return '';
-  try {
-    const picked = {};
-    for (const k of keys) picked[k] = meta[k];
-    return JSON.stringify(picked);
-  } catch {
-    return '';
-  }
-}
-
-const prettyFormat = format.printf(({ timestamp, level, message, ...meta }) => {
-  const msg = typeof message === 'string' ? message : message == null ? '' : JSON.stringify(message);
-  const extra = formatExtra(meta);
-  const body = [msg, extra].filter(Boolean).join(' ');
-  return timestamp ? `${timestamp} [${level}]: ${body}` : `[${level}]: ${body}`;
-});
-
-function assertLevel(level) {
-  if (!VALID_LEVELS.includes(level)) throw new Error(`Invalid log level "${level}". Use one of: ${VALID_LEVELS.join(', ')}`);
+const { MiniLogger, ConsoleTransport, NullTransport, colorizeLevel, resolveLevelColors } = require('./lib/mini');
+const { FileTransport } = require('./lib/rotate');
+const { DEFAULT_CONSOLE_FORMAT, compileTimestampFormatter } = require('./lib/time');
+const { buildLine } = require('./lib/format');
+const { assertLevel, sanitizeMessage } = require('./lib/sanitize');
+const { normalizeFilesOptions } = require('./lib/files');
+
+function normalizeConsoleOpts(input) {
+  if (input === false) return { enabled: false };
+  return input || {};
 }
 
-function normalizeFilesOptions(files = {}) {
-  const folder = files.folder ?? 'logs';
-  if (typeof folder !== 'string' || !folder.trim() || folder.includes('\0')) {
-    throw new Error('files.folder must be a non-empty string');
-  }
-  const datePattern = files.filesName ?? files.datePattern ?? 'YYYY-MM-DD';
-  if (typeof datePattern !== 'string' || !datePattern.trim()) {
-    throw new Error('files.filesName/datePattern must be a non-empty string');
-  }
-  let filename = files.filename ?? `application-%DATE%.log`;
-  if (typeof filename !== 'string' || !filename.trim()) {
-    throw new Error('files.filename must be a non-empty string');
-  }
-  if (!filename.includes('%DATE%')) {
-    const ext = path.extname(filename) || '.log';
-    const base = path.basename(filename, ext);
-    filename = `${base}-%DATE%${ext}`;
-  }
-  return {
-    folder: path.normalize(folder),
-    datePattern,
-    filename,
-    maxFiles: files.maxFile ?? files.maxFiles ?? '14d',
-    maxSize: files.maxSize ?? '20m',
-    zippedArchive: files.zippedArchive ?? false,
-    level: files.level,
+function buildConsoleTransport({ enabled = true, enableTimestamp = true, timestampFormat = DEFAULT_CONSOLE_FORMAT, timestampPrefix = '', timestampSuffix = '', colorize = true, colors, level } = {}) {
+  if (!enabled) return new NullTransport();
+  const stamp = enableTimestamp ? compileTimestampFormatter(timestampFormat) : null;
+  const palette = resolveLevelColors(colors);
+  const render = ({ level, message, meta }) => {
+    const timestamp = stamp ? `${timestampPrefix}${stamp()}${timestampSuffix}` : '';
+    const tag = colorize ? colorizeLevel(level, `[${level}]`, palette) : `[${level}]`;
+    return buildLine(timestamp, level, message, meta, tag);
   };
-}
-
-function buildConsoleTransport({ enableTimestamp = true, timestampFormat = DEFAULT_CONSOLE_FORMAT, timestampPrefix = '', timestampSuffix = '', colorize = true, level } = {}) {
-  const parts = [];
-  if (colorize) parts.push(format.colorize());
-  if (enableTimestamp) {
-    parts.push(format.timestamp({ format: () => `${timestampPrefix}${formatCustomTimestamp(timestampFormat)}${timestampSuffix}` }));
-  } else {
-    parts.push(format((info) => { delete info.timestamp; return info; })());
-  }
-  parts.push(format.errors({ stack: true }), format.splat(), prettyFormat);
-  return new transports.Console({ format: format.combine(...parts), level });
+  return new ConsoleTransport({ level, render });
 }
 
 function buildFileTransport({ folder, datePattern, filename, maxFiles, maxSize, zippedArchive, level }) {
   if (!fs.existsSync(folder)) fs.mkdirSync(folder, { recursive: true });
-  return new transports.DailyRotateFile({
-    filename: path.join(folder, filename),
+  return new FileTransport({
+    folder: path.normalize(folder),
+    filename,
     datePattern,
     zippedArchive,
     maxSize,
     maxFiles,
     level,
-    format: format.combine(format.errors({ stack: true }), format.splat(), format.timestamp(), prettyFormat),
+    render: ({ level, message, meta }) => buildLine(new Date().toISOString(), level, message, meta),
   });
 }
 
@@ -102,17 +42,14 @@ function createLoggerInstance(initial = {}) {
   const globalLevel = process.env.LOG_LEVEL || initial.level || 'debug';
   assertLevel(globalLevel);
 
-  const logger = createLogger({
-    level: globalLevel,
-    format: format.combine(format.errors({ stack: true }), format.splat()),
-  });
+  const logger = new MiniLogger({ level: globalLevel });
 
-  let consoleTransport = buildConsoleTransport(initial.console);
-  consoleTransport.level = initial.console?.level;
+  let consoleTransport = buildConsoleTransport(normalizeConsoleOpts(initial.console));
+  consoleTransport.level = normalizeConsoleOpts(initial.console).level;
   logger.add(consoleTransport);
 
   let fileTransport = null;
-  let consoleOpts = { ...(initial.console || {}) };
+  let consoleOpts = { ...normalizeConsoleOpts(initial.console) };
   let filesOpts = null;
 
   function applySettings(options = {}) {
@@ -120,9 +57,10 @@ function createLoggerInstance(initial = {}) {
       assertLevel(options.level);
       logger.level = options.level;
     }
-    if (options.console) {
-      if (options.console.level !== undefined && options.console.level !== null) assertLevel(options.console.level);
-      consoleOpts = { ...consoleOpts, ...options.console };
+    if (options.console !== undefined) {
+      const next = normalizeConsoleOpts(options.console);
+      if (next.level !== undefined && next.level !== null) assertLevel(next.level);
+      consoleOpts = { ...consoleOpts, ...next };
       logger.remove(consoleTransport);
       consoleTransport = buildConsoleTransport(consoleOpts);
       consoleTransport.level = consoleOpts.level;
@@ -138,12 +76,22 @@ function createLoggerInstance(initial = {}) {
     }
   }
 
+  function isEnabled(level) {
+    const want = logger.levels[level];
+    const current = logger.levels[logger.level];
+    return want !== undefined && current !== undefined && want <= current;
+  }
+
   function write(level, message, ...meta) {
+    if (typeof message === 'function') {
+      if (!isEnabled(level)) return;
+      message = message();
+    }
     if (message instanceof Error) {
-      logger.log(level, message.message, { stack: message.stack, ...meta[0] });
+      logger.log(level, sanitizeMessage(message.message), { stack: message.stack, ...meta[0] });
       return;
     }
-    logger.log(level, message, ...meta);
+    logger.log(level, sanitizeMessage(message), ...meta);
   }
 
   function callable(message, ...meta) {

package/package.json

@@ -1,51 +1,63 @@
-{
-  "name": "logxpert",
-  "version": "2.0.0",
-  "description": "A powerful logging library for Node.js with colorful output and daily file rotation",
-  "main": "main.js",
-  "types": "index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./main.mjs",
-      "require": "./main.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "main.js",
-    "main.mjs",
-    "index.d.ts",
-    "README.md",
-    "LICENSE",
-    "CHANGELOG.md"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/lighscent/LogXpert.git"
-  },
-  "bugs": {
-    "url": "https://github.com/lighscent/LogXpert/issues"
-  },
-  "homepage": "https://github.com/lighscent/LogXpert#readme",
-  "author": "https://github.com/lighscent",
-  "license": "GPL-3.0-only",
-  "keywords": [
-    "logging",
-    "logger",
-    "winston",
-    "daily-rotate",
-    "nodejs"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "scripts": {
-    "test": "node --test test/logger.test.js"
-  },
-  "dependencies": {
-    "dayjs": "^1.11.23",
-    "winston": "^3.19.0",
-    "winston-daily-rotate-file": "^5.0.0"
-  }
-}
+{
+  "name": "logxpert",
+  "version": "2.1.0",
+  "description": "A powerful logging library for Node.js with colorful output and daily file rotation",
+  "main": "main.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.mts",
+        "default": "./main.mjs"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./main.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "main.js",
+    "main.mjs",
+    "index.d.ts",
+    "index.d.mts",
+    "lib/",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lighscent/LogXpert.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lighscent/LogXpert/issues"
+  },
+  "homepage": "https://github.com/lighscent/LogXpert#readme",
+  "author": "https://github.com/lighscent",
+  "license": "Apache-2.0",
+  "keywords": [
+    "logging",
+    "logger",
+    "winston",
+    "daily-rotate",
+    "nodejs"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "test": "node --test --test-reporter=./test/reporter.js test/logger.test.js test/console.test.js test/files.test.js test/lib.test.js",
+    "test:demo": "node --test --test-reporter=./test/reporter.js demo/reporter.demo.test.js",
+    "check:types": "tsc -p test-d --noEmit && echo TYPES-OK",
+    "attw": "attw --pack"
+  },
+  "dependencies": {
+    "dayjs": "^1.11.23"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "typescript": "^7.0.2"
+  }
+}