@bymax-one/nest-logger 1.4.1 → 1.4.3

package/dist/server/index.mjs

@@ -2,6 +2,7 @@ import { join } from 'path';
 import { fileURLToPath } from 'url';
 import { Injectable, Inject, HttpStatus, Catch, ConfigurableModuleBuilder, Module, HttpException, SetMetadata } from '@nestjs/common';
 import { APP_INTERCEPTOR, APP_FILTER } from '@nestjs/core';
+import { types } from 'util';
 import { tap, catchError, throwError } from 'rxjs';
 import pino from 'pino';
 import { createRequire } from 'module';
@@ -26,7 +27,7 @@ var DEFAULT_HTTP = {
   isEnabled: false,
   shouldCaptureExceptions: true,
   shouldGenerateRequestId: true,
-  excludePaths: [/^\/health$/, /^\/metrics$/],
+  excludePaths: [/^\/health$/, /^\/health\/live$/, /^\/health\/ready$/, /^\/metrics$/],
   tenantIdHeader: "x-tenant-id"
 };
 var DEFAULT_OTEL = {
@@ -111,7 +112,36 @@ var LOG_LEVEL_PRIORITY = Object.freeze([
 ]);
 
 // src/server/config/validate-options.ts
-function validateOptions(options) {
+function reject(path2, rule, got) {
+  const received = got === void 0 ? "" : `. Got: ${describeValue(got)}`;
+  throw new Error(`[BymaxLoggerModule] options.${path2} ${rule}${received}`);
+}
+function describeValue(value) {
+  if (value === null) return "null";
+  if (Array.isArray(value)) return "an array";
+  if (typeof value === "object") return "an object";
+  if (typeof value === "function") return "a function";
+  if (typeof value === "string") return JSON.stringify(value);
+  return String(value);
+}
+var isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+var isNonEmptyString = (value) => typeof value === "string" && value.length > 0;
+function checkBoolean(path2, value) {
+  if (value !== void 0 && typeof value !== "boolean") {
+    reject(path2, "must be a boolean", value);
+  }
+}
+function checkNonEmptyString(path2, value) {
+  if (value !== void 0 && !isNonEmptyString(value)) {
+    reject(path2, "must be a non-empty string", value);
+  }
+}
+function checkGroup(path2, value) {
+  if (value === void 0) return void 0;
+  if (!isRecord(value)) reject(path2, "must be an object", value);
+  return value;
+}
+function validateCore(options) {
   if (!options.service) {
     throw new Error("[BymaxLoggerModule] options.service is required");
   }
@@ -128,9 +158,15 @@ function validateOptions(options) {
       )}. Got: ${String(options.level)}`
     );
   }
+  const size = options.maxEntrySizeBytes;
+  if (size !== void 0 && !Number.isFinite(size)) {
+    reject("maxEntrySizeBytes", "must be a finite number", size);
+  }
   if (options.maxEntrySizeBytes !== void 0 && options.maxEntrySizeBytes <= 0) {
     throw new Error("[BymaxLoggerModule] options.maxEntrySizeBytes must be > 0");
   }
+}
+function validateClosedSets(options) {
   if (options.redactStrategy !== void 0 && options.redactStrategy !== "names" && options.redactStrategy !== "paths") {
     throw new Error(
       `[BymaxLoggerModule] options.redactStrategy must be 'names' or 'paths'. Got: ${String(
@@ -160,6 +196,109 @@ function validateOptions(options) {
     );
   }
 }
+function validateCustomization(options) {
+  checkBoolean("isGlobal", options.isGlobal);
+  checkBoolean("shouldDisableDefaultRedact", options.shouldDisableDefaultRedact);
+  if (options.redactCensor !== void 0 && typeof options.redactCensor !== "string") {
+    reject("redactCensor", "must be a string", options.redactCensor);
+  }
+  if (options.timestamp !== void 0 && typeof options.timestamp !== "function") {
+    reject("timestamp", "must be a function", options.timestamp);
+  }
+  const paths = options.redactPaths;
+  if (paths !== void 0) {
+    if (!Array.isArray(paths)) reject("redactPaths", "must be an array of strings", paths);
+    paths.forEach((entry, index) => {
+      if (!isNonEmptyString(entry)) {
+        reject(`redactPaths[${String(index)}]`, "must be a non-empty string", entry);
+      }
+    });
+  }
+  const serializers = options.serializers;
+  if (serializers !== void 0) {
+    if (!isRecord(serializers)) reject("serializers", "must be an object", serializers);
+    for (const [key, serializer] of Object.entries(serializers)) {
+      if (typeof serializer !== "function") {
+        reject(`serializers.${key}`, "must be a function", serializer);
+      }
+    }
+  }
+}
+var UNREADABLE = /* @__PURE__ */ Symbol("unreadable");
+function readMember(destination, key) {
+  try {
+    return Reflect.get(destination, key);
+  } catch {
+    return UNREADABLE;
+  }
+}
+function validateDestination(entry, index) {
+  const path2 = `destinations[${String(index)}]`;
+  if (!isRecord(entry)) {
+    reject(path2, "must be an object implementing ILogDestination", entry);
+  }
+  const write = readMember(entry, "write");
+  if (write !== UNREADABLE && typeof write !== "function") {
+    reject(path2, "must have a write(payload) method");
+  }
+  const name = readMember(entry, "name");
+  if (name !== UNREADABLE && !isNonEmptyString(name)) {
+    reject(path2, "must have a non-empty string name", name);
+  }
+  for (const hook of ["onInit", "onShutdown", "onRegistryReady"]) {
+    const value = readMember(entry, hook);
+    if (value !== UNREADABLE && value !== void 0 && typeof value !== "function") {
+      reject(`${path2}.${hook}`, "must be a function", value);
+    }
+  }
+}
+function validateDestinations(options) {
+  const destinations = options.destinations;
+  if (destinations === void 0) return;
+  if (!Array.isArray(destinations)) {
+    reject("destinations", "must be an array of ILogDestination", destinations);
+  }
+  destinations.forEach((entry, index) => validateDestination(entry, index));
+}
+function validateHttp(options) {
+  const http = checkGroup("http", options.http);
+  if (http === void 0) return;
+  checkBoolean("http.isEnabled", http["isEnabled"]);
+  checkBoolean("http.shouldCaptureExceptions", http["shouldCaptureExceptions"]);
+  checkBoolean("http.shouldGenerateRequestId", http["shouldGenerateRequestId"]);
+  const excludePaths = http["excludePaths"];
+  if (excludePaths !== void 0) {
+    if (!Array.isArray(excludePaths)) {
+      reject("http.excludePaths", "must be an array of RegExp", excludePaths);
+    }
+    excludePaths.forEach((pattern, index) => {
+      if (!types.isRegExp(pattern)) {
+        reject(`http.excludePaths[${String(index)}]`, "must be a RegExp", pattern);
+      }
+    });
+  }
+  checkNonEmptyString("http.tenantIdHeader", http["tenantIdHeader"]);
+}
+function validateOtel(options) {
+  const otel = checkGroup("otel", options.otel);
+  if (otel === void 0) return;
+  checkBoolean("otel.shouldAutoInjectTraceContext", otel["shouldAutoInjectTraceContext"]);
+  const format = otel["fieldFormat"];
+  if (format !== void 0 && format !== "camelCase" && format !== "snake_case") {
+    reject("otel.fieldFormat", "must be 'camelCase' or 'snake_case'", format);
+  }
+  checkNonEmptyString("otel.traceIdField", otel["traceIdField"]);
+  checkNonEmptyString("otel.spanIdField", otel["spanIdField"]);
+  checkNonEmptyString("otel.traceFlagsField", otel["traceFlagsField"]);
+}
+function validateOptions(options) {
+  validateCore(options);
+  validateClosedSets(options);
+  validateCustomization(options);
+  validateDestinations(options);
+  validateHttp(options);
+  validateOtel(options);
+}
 
 // src/server/constants/injection-tokens.constants.ts
 var LOGGER_OPTIONS_TOKEN = /* @__PURE__ */ Symbol("BYMAX_LOGGER_OPTIONS");
@@ -1606,8 +1745,11 @@ function buildPinoInstance(options, logContext, destinations, health) {
       options.resourceFormat,
       extraServiceFields(options.service)
     ),
-    // Pino requires the timestamp fn to emit the `,"time":"..."` fragment.
-    timestamp: () => `,"time":"${options.timestamp()}"`,
+    // Pino requires the timestamp fn to emit the `,"time":<json>` fragment, and
+    // inserts it into the line verbatim. The value comes from consumer code, so it
+    // is encoded as a JSON string here: a quote, a backslash or a newline in it must
+    // neither break the line nor add fields to it.
+    timestamp: () => `,"time":${JSON.stringify(String(options.timestamp()))}`,
     formatters: {
       // Emit the level as a string label instead of the numeric code — easier
       // for log aggregators. Trace context is injected via `mixin`, never via
@@ -2465,10 +2607,18 @@ var PrettyDevDestination = class {
    * Lazily resolve `pino-pretty` and build the colorized transform that renders
    * each entry to `process.stdout`.
    *
+   * @throws Error When `NODE_ENV` is `production`: this sink is development
+   *   output, so it refuses rather than put ANSI colour into the log stream.
    * @throws Error When `pino-pretty` is not installed — with an actionable
    *   message telling the consumer to install it or drop this destination.
    */
   async onInit() {
+    if (process.env["NODE_ENV"] === "production") {
+      this.initFailed = true;
+      throw new Error(
+        "[PrettyDevDestination] refused in production (NODE_ENV=production): it renders ANSI colour through a main-thread transform. Use DefaultStdoutDestination, or register PrettyDevDestination only outside production."
+      );
+    }
     try {
       const { build } = await import('pino-pretty');
       this.stream = build({
@@ -2595,8 +2745,8 @@ var PrettyDevDestination = class {
       this.flushBuffer(writeRawToStdout);
       return;
     }
-    await new Promise((resolve, reject) => {
-      stream.once("error", reject);
+    await new Promise((resolve, reject2) => {
+      stream.once("error", reject2);
       stream.end(resolve);
     });
   }
@@ -3025,4 +3175,4 @@ function LogPerformance(thresholdMs = DEFAULT_THRESHOLD_MS) {
 // src/shared/constants/log-keys-convention.constants.ts
 var LOG_KEYS_CONVENTION_REGEX = /^[A-Z][A-Z0-9_]+_[A-Z][A-Z0-9_]+(_[A-Z][A-Z0-9_]+)?$/;
 
-export { BymaxLoggerModule, DEFAULT_REDACT_PATHS, DefaultStdoutDestination, HttpAccessLogMiddleware, HttpExceptionFilter, HttpLoggingInterceptor, InjectLogger, LOGGER_DESTINATIONS_TOKEN, LOGGER_OPTIONS_TOKEN, LOGGER_PINO_INSTANCE_TOKEN, LOG_CONTEXT_METADATA_KEY, LOG_CONTEXT_TOKEN, LOG_KEYS_CONVENTION_REGEX, LogContext, LogContextService, LogPerformance, PINO_LEVEL_NAMES, PINO_LEVEL_NUMBERS, PinoLoggerService, PinoUnexpectedErrorSink, PrettyDevDestination, RESERVED_LOG_KEYS, RESERVED_LOG_KEYS_NOT_EMITTED, RequestIdMiddleware, applyAccessLog, applyRequestIdMiddleware };
+export { BymaxLoggerModule, DEFAULT_REDACT_PATHS, DefaultStdoutDestination, HttpAccessLogMiddleware, HttpExceptionFilter, HttpLoggingInterceptor, InjectLogger, LOGGER_DESTINATIONS_TOKEN, LOGGER_OPTIONS_TOKEN, LOGGER_PINO_INSTANCE_TOKEN, LOGGER_REDACTOR_TOKEN, LOG_CONTEXT_METADATA_KEY, LOG_CONTEXT_TOKEN, LOG_KEYS_CONVENTION_REGEX, LogContext, LogContextService, LogPerformance, PINO_LEVEL_NAMES, PINO_LEVEL_NUMBERS, PinoLoggerService, PinoUnexpectedErrorSink, PrettyDevDestination, REDACT_COMMON_FIELDS, RESERVED_LOG_KEYS, RESERVED_LOG_KEYS_NOT_EMITTED, RequestIdMiddleware, applyAccessLog, applyRequestIdMiddleware, isValidTraceId };

package/dist/shared/index.d.cts

@@ -270,4 +270,5 @@ declare const RESERVED_LOG_KEYS_NOT_EMITTED: Readonly<{
  */
 type ReservedLogKey = (typeof RESERVED_LOG_KEYS)[keyof typeof RESERVED_LOG_KEYS];
 
-export { type EmittedDeploymentResource, type EmittedServiceResource, LOG_KEYS_CONVENTION_REGEX, type LogEntry, type LogLevel, RESERVED_LOG_KEYS, RESERVED_LOG_KEYS_NOT_EMITTED, type ReservedLogKey, type ResolvedServiceMetadata, type ServiceMetadata };
+export { LOG_KEYS_CONVENTION_REGEX, RESERVED_LOG_KEYS, RESERVED_LOG_KEYS_NOT_EMITTED };
+export type { EmittedDeploymentResource, EmittedServiceResource, LogEntry, LogLevel, ReservedLogKey, ResolvedServiceMetadata, ServiceMetadata };

package/dist/shared/index.d.ts

@@ -270,4 +270,5 @@ declare const RESERVED_LOG_KEYS_NOT_EMITTED: Readonly<{
  */
 type ReservedLogKey = (typeof RESERVED_LOG_KEYS)[keyof typeof RESERVED_LOG_KEYS];
 
-export { type EmittedDeploymentResource, type EmittedServiceResource, LOG_KEYS_CONVENTION_REGEX, type LogEntry, type LogLevel, RESERVED_LOG_KEYS, RESERVED_LOG_KEYS_NOT_EMITTED, type ReservedLogKey, type ResolvedServiceMetadata, type ServiceMetadata };
+export { LOG_KEYS_CONVENTION_REGEX, RESERVED_LOG_KEYS, RESERVED_LOG_KEYS_NOT_EMITTED };
+export type { EmittedDeploymentResource, EmittedServiceResource, LogEntry, LogLevel, ReservedLogKey, ResolvedServiceMetadata, ServiceMetadata };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bymax-one/nest-logger",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "description": "Structured JSON logging for NestJS based on Pino 10, with optional OpenTelemetry correlation.",
   "author": "Bymax One <support@bymax.one>",
   "license": "MIT",
@@ -142,7 +142,7 @@
     "tinybench": "^6.0.2",
     "ts-jest": "^29.4.9",
     "ts-node": "^10.9.2",
-    "tsup": "^8.5.1",
+    "tsup": "^9.0.0",
     "tsx": "^4.19.2",
     "typescript": "^5.9.3"
   },