@rawnodes/logger 2.4.0 → 2.6.0

package/dist/index.js

@@ -8,9 +8,9 @@ var promises = require('fs/promises');
 var rotatingFileStream = require('rotating-file-stream');
 var events = require('events');
 var clientCloudwatchLogs = require('@aws-sdk/client-cloudwatch-logs');
+var crypto = require('crypto');
 var zod = require('zod');
 var path = require('path');
-var crypto = require('crypto');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -422,13 +422,50 @@ var TelegramTransport = class extends BaseHttpTransport {
     return text.replace(/[&<>"']/g, (c) => entities[c] || c);
   }
 };
+var instanceUuid = crypto.randomUUID().slice(0, 8);
+function formatDate() {
+  return (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
+}
+function formatDateTime() {
+  return (/* @__PURE__ */ new Date()).toISOString().slice(0, 19).replace(/[T:]/g, "-");
+}
+function resolveLogStreamName(config, configHostname) {
+  const hostname = configHostname || process.env.HOSTNAME || os.hostname();
+  if (!config) {
+    return hostname;
+  }
+  if (typeof config === "string") {
+    return config;
+  }
+  if ("pattern" in config) {
+    switch (config.pattern) {
+      case "hostname":
+        return hostname;
+      case "hostname-date":
+        return `${hostname}/${formatDate()}`;
+      case "hostname-uuid":
+        return `${hostname}-${instanceUuid}`;
+      case "date":
+        return formatDate();
+      case "uuid":
+        return crypto.randomUUID();
+      default:
+        return hostname;
+    }
+  }
+  if ("template" in config) {
+    return config.template.replace(/\{hostname\}/g, hostname).replace(/\{date\}/g, formatDate()).replace(/\{datetime\}/g, formatDateTime()).replace(/\{uuid\}/g, instanceUuid).replace(/\{pid\}/g, String(process.pid)).replace(/\{env\}/g, process.env.NODE_ENV || "development");
+  }
+  return hostname;
+}
 var CloudWatchTransport = class extends BaseHttpTransport {
   config;
   client;
   sequenceToken;
   initialized = false;
   initPromise = null;
-  constructor(config) {
+  resolvedLogStreamName;
+  constructor(config, configHostname) {
     super({
       batchSize: config.batchSize ?? 100,
       flushInterval: config.flushInterval ?? 1e3,
@@ -436,6 +473,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
       retryDelay: config.retryDelay
     });
     this.config = config;
+    this.resolvedLogStreamName = resolveLogStreamName(config.logStreamName, configHostname);
     this.client = new clientCloudwatchLogs.CloudWatchLogsClient({
       region: config.region,
       credentials: {
@@ -458,7 +496,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
     logEvents.sort((a, b) => (a.timestamp ?? 0) - (b.timestamp ?? 0));
     const command = new clientCloudwatchLogs.PutLogEventsCommand({
       logGroupName: this.config.logGroupName,
-      logStreamName: this.config.logStreamName,
+      logStreamName: this.resolvedLogStreamName,
       logEvents,
       sequenceToken: this.sequenceToken
     });
@@ -470,7 +508,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
         await this.fetchSequenceToken();
         const retryCommand = new clientCloudwatchLogs.PutLogEventsCommand({
           logGroupName: this.config.logGroupName,
-          logStreamName: this.config.logStreamName,
+          logStreamName: this.resolvedLogStreamName,
           logEvents,
           sequenceToken: this.sequenceToken
         });
@@ -516,7 +554,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
       await this.client.send(
         new clientCloudwatchLogs.CreateLogStreamCommand({
           logGroupName: this.config.logGroupName,
-          logStreamName: this.config.logStreamName
+          logStreamName: this.resolvedLogStreamName
         })
       );
     } catch (error) {
@@ -529,11 +567,11 @@ var CloudWatchTransport = class extends BaseHttpTransport {
     const response = await this.client.send(
       new clientCloudwatchLogs.DescribeLogStreamsCommand({
         logGroupName: this.config.logGroupName,
-        logStreamNamePrefix: this.config.logStreamName,
+        logStreamNamePrefix: this.resolvedLogStreamName,
         limit: 1
       })
     );
-    const stream = response.logStreams?.find((s) => s.logStreamName === this.config.logStreamName);
+    const stream = response.logStreams?.find((s) => s.logStreamName === this.resolvedLogStreamName);
     this.sequenceToken = stream?.uploadSequenceToken;
   }
   isResourceAlreadyExistsError(error) {
@@ -651,6 +689,7 @@ function createFormattedFilterStream(format, level, rules, store, destination) {
 }
 function createStreams(config, store) {
   const streams = [];
+  const transports = [];
   const consoleStream = createFormattedFilterStream(
     config.console.format,
     config.console.level,
@@ -698,6 +737,7 @@ function createStreams(config, store) {
   }
   for (const discordConfig of toArray(config.discord)) {
     const transport = new DiscordTransport(discordConfig);
+    transports.push(transport);
     const discordStream = createHttpTransportStream(transport, discordConfig.level, discordConfig.rules, store);
     streams.push({
       level: "trace",
@@ -706,6 +746,7 @@ function createStreams(config, store) {
   }
   for (const telegramConfig of toArray(config.telegram)) {
     const transport = new TelegramTransport(telegramConfig);
+    transports.push(transport);
     const telegramStream = createHttpTransportStream(transport, telegramConfig.level, telegramConfig.rules, store);
     streams.push({
       level: "trace",
@@ -713,14 +754,18 @@ function createStreams(config, store) {
     });
   }
   for (const cloudwatchConfig of toArray(config.cloudwatch)) {
-    const transport = new CloudWatchTransport(cloudwatchConfig);
+    const transport = new CloudWatchTransport(cloudwatchConfig, config.hostname);
+    transports.push(transport);
     const cwStream = createHttpTransportStream(transport, cloudwatchConfig.level, cloudwatchConfig.rules, store);
     streams.push({
       level: "trace",
       stream: cwStream
     });
   }
-  return pino__default.default.multistream(streams);
+  return {
+    destination: pino__default.default.multistream(streams),
+    transports
+  };
 }
 function toArray(value) {
   if (!value) return [];
@@ -805,14 +850,14 @@ function createState(config, store) {
     levelOverrides.set(key, rule);
   }
   const { contextIndex, complexRules } = buildIndexes(levelOverrides);
-  const streams = createStreams(config, loggerStore);
+  const { destination, transports } = createStreams(config, loggerStore);
   const options = {
     level: "trace",
     // Accept all, we filter in shouldLog()
     customLevels: CUSTOM_LEVELS,
     base: { hostname: config.hostname ?? os.hostname() }
   };
-  const pinoLogger = pino__default.default(options, streams);
+  const pinoLogger = pino__default.default(options, destination);
   let callerConfig;
   if (config.caller === true) {
     callerConfig = {};
@@ -826,7 +871,8 @@ function createState(config, store) {
     levelOverrides,
     contextIndex,
     complexRules,
-    callerConfig
+    callerConfig,
+    transports
   };
 }
 function rebuildIndexes(state) {
@@ -927,6 +973,24 @@ var TelegramConfigSchema = zod.z.object({
   threadId: zod.z.number().int().optional(),
   replyToMessageId: zod.z.number().int().optional()
 });
+var LogStreamPatternSchema = zod.z.enum([
+  "hostname",
+  "hostname-date",
+  "hostname-uuid",
+  "date",
+  "uuid"
+]);
+var LogStreamPatternConfigSchema = zod.z.object({
+  pattern: LogStreamPatternSchema
+});
+var LogStreamTemplateConfigSchema = zod.z.object({
+  template: zod.z.string().min(1, "template is required")
+});
+var LogStreamNameSchema = zod.z.union([
+  zod.z.string().min(1, "logStreamName string must not be empty"),
+  LogStreamPatternConfigSchema,
+  LogStreamTemplateConfigSchema
+]);
 var CloudWatchConfigSchema = zod.z.object({
   level: LogLevelSchema.optional(),
   rules: zod.z.array(LevelRuleSchema).optional(),
@@ -935,7 +999,7 @@ var CloudWatchConfigSchema = zod.z.object({
   maxRetries: zod.z.number().int().nonnegative().optional(),
   retryDelay: zod.z.number().int().positive().optional(),
   logGroupName: zod.z.string().min(1, "logGroupName is required"),
-  logStreamName: zod.z.string().min(1, "logStreamName is required"),
+  logStreamName: LogStreamNameSchema.optional(),
   region: zod.z.string().min(1, "region is required"),
   accessKeyId: zod.z.string().min(1, "accessKeyId is required"),
   secretAccessKey: zod.z.string().min(1, "secretAccessKey is required"),
@@ -954,6 +1018,10 @@ var CallerConfigSchema = zod.z.object({
   depth: zod.z.number().int().nonnegative().optional(),
   fullPath: zod.z.boolean().optional()
 });
+var AutoShutdownConfigSchema = zod.z.object({
+  timeout: zod.z.number().int().positive().optional(),
+  signals: zod.z.array(zod.z.string()).optional()
+});
 var LoggerConfigSchema = zod.z.object({
   level: LevelConfigSchema,
   console: ConsoleConfigSchema,
@@ -962,7 +1030,8 @@ var LoggerConfigSchema = zod.z.object({
   telegram: zod.z.union([TelegramConfigSchema, zod.z.array(TelegramConfigSchema)]).optional(),
   cloudwatch: zod.z.union([CloudWatchConfigSchema, zod.z.array(CloudWatchConfigSchema)]).optional(),
   caller: zod.z.union([zod.z.boolean(), CallerConfigSchema]).optional(),
-  hostname: zod.z.string().optional()
+  hostname: zod.z.string().optional(),
+  autoShutdown: zod.z.union([zod.z.boolean(), AutoShutdownConfigSchema]).optional()
 });
 function validateConfig(config) {
   return LoggerConfigSchema.parse(config);
@@ -1031,6 +1100,53 @@ function formatCallerInfo(info) {
   return location;
 }
 
+// src/utils/shutdown.ts
+var DEFAULT_OPTIONS2 = {
+  timeout: 5e3,
+  exitCode: 0,
+  signals: ["SIGTERM", "SIGINT"]
+};
+var registered = false;
+function registerShutdown(logger, options = {}) {
+  const opts = { ...DEFAULT_OPTIONS2, ...options };
+  const shutdown = async (signal) => {
+    if (signal) {
+      console.error(`[Logger] Received ${signal}, shutting down gracefully...`);
+    }
+    try {
+      if (opts.onShutdown) {
+        await opts.onShutdown();
+      }
+      const timeoutPromise = new Promise((_, reject) => {
+        setTimeout(() => {
+          reject(new Error(`Shutdown timed out after ${opts.timeout}ms`));
+        }, opts.timeout);
+      });
+      await Promise.race([
+        logger.shutdown(),
+        timeoutPromise
+      ]);
+      if (signal) {
+        console.error("[Logger] Graceful shutdown completed");
+        process.exit(opts.exitCode);
+      }
+    } catch (error) {
+      console.error("[Logger] Shutdown error:", error instanceof Error ? error.message : error);
+      if (signal) {
+        process.exit(1);
+      }
+    }
+  };
+  if (!registered) {
+    for (const signal of opts.signals) {
+      process.on(signal, () => void shutdown(signal));
+    }
+    process.on("beforeExit", () => void shutdown());
+    registered = true;
+  }
+  return shutdown;
+}
+
 // src/logger.ts
 var Logger = class _Logger {
   constructor(state, context) {
@@ -1041,7 +1157,12 @@ var Logger = class _Logger {
   static create(config, store) {
     const validatedConfig = validateConfig(config);
     const state = createState(validatedConfig, store);
-    return new _Logger(state, "APP");
+    const logger = new _Logger(state, "APP");
+    if (validatedConfig.autoShutdown) {
+      const shutdownConfig = typeof validatedConfig.autoShutdown === "object" ? validatedConfig.autoShutdown : {};
+      registerShutdown(logger, shutdownConfig);
+    }
+    return logger;
   }
   for(context) {
     return new _Logger(this.state, context);
@@ -1083,6 +1204,15 @@ var Logger = class _Logger {
   getLevelOverrides() {
     return Array.from(this.state.levelOverrides.values());
   }
+  // Shutdown
+  /**
+   * Gracefully shutdown the logger, flushing all pending messages.
+   * Should be called before process exit to ensure no logs are lost.
+   */
+  async shutdown() {
+    const closePromises = this.state.transports.map((transport) => transport.close());
+    await Promise.all(closePromises);
+  }
   // Profiling
   profile(id, meta) {
     const existing = this.profileTimers.get(id);
@@ -1349,16 +1479,28 @@ function createMasker(options = {}) {
 }
 
 // src/formatters.ts
-function flattenObject(obj, prefix = "") {
+var MAX_FLATTEN_DEPTH = 10;
+var CIRCULAR_REF = "[Circular]";
+function flattenObject(obj, prefix = "", ancestors = /* @__PURE__ */ new WeakSet(), depth = 0) {
   const result = {};
+  if (depth > MAX_FLATTEN_DEPTH) {
+    result[prefix || "value"] = "[Max depth exceeded]";
+    return result;
+  }
+  ancestors.add(obj);
   for (const [key, value] of Object.entries(obj)) {
     const newKey = prefix ? `${prefix}.${key}` : key;
     if (value !== null && typeof value === "object" && !Array.isArray(value) && !(value instanceof Error)) {
-      Object.assign(result, flattenObject(value, newKey));
+      if (ancestors.has(value)) {
+        result[newKey] = CIRCULAR_REF;
+      } else {
+        Object.assign(result, flattenObject(value, newKey, ancestors, depth + 1));
+      }
     } else {
       result[newKey] = value;
     }
   }
+  ancestors.delete(obj);
   return result;
 }
 function formatLogfmtValue(value) {
@@ -1387,6 +1529,7 @@ function formatLogfmt(data) {
   return Object.entries(flattened).filter(([, value]) => value !== void 0 && value !== null).map(([key, value]) => `${key}=${formatLogfmtValue(value)}`).join(" ");
 }
 
+exports.AutoShutdownConfigSchema = AutoShutdownConfigSchema;
 exports.BaseHttpTransport = BaseHttpTransport;
 exports.CallerConfigSchema = CallerConfigSchema;
 exports.CloudWatchConfigSchema = CloudWatchConfigSchema;
@@ -1402,6 +1545,10 @@ exports.LevelConfigSchema = LevelConfigSchema;
 exports.LevelRuleSchema = LevelRuleSchema;
 exports.LogFormatSchema = LogFormatSchema;
 exports.LogLevelSchema = LogLevelSchema;
+exports.LogStreamNameSchema = LogStreamNameSchema;
+exports.LogStreamPatternConfigSchema = LogStreamPatternConfigSchema;
+exports.LogStreamPatternSchema = LogStreamPatternSchema;
+exports.LogStreamTemplateConfigSchema = LogStreamTemplateConfigSchema;
 exports.Logger = Logger;
 exports.LoggerConfigSchema = LoggerConfigSchema;
 exports.LoggerStore = LoggerStore;
@@ -1424,6 +1571,7 @@ exports.maskSecrets = maskSecrets;
 exports.matchesContext = matchesContext;
 exports.measureAsync = measureAsync;
 exports.measureSync = measureSync;
+exports.registerShutdown = registerShutdown;
 exports.safeValidateConfig = safeValidateConfig;
 exports.validateConfig = validateConfig;
 //# sourceMappingURL=index.js.map