@fabbahiense/pulsar-pino-transport 0.2.0 → 0.3.0

package/dist/index.cjs

@@ -42,6 +42,23 @@ var GENERIC_HTTP_MSGS = /* @__PURE__ */ new Set([
   "incoming request",
   "http request"
 ]);
+var PINO_INTERNAL_FIELDS = /* @__PURE__ */ new Set([
+  "level",
+  "msg",
+  "time",
+  "v",
+  "pid",
+  "hostname",
+  "name",
+  "traceId",
+  "trace_id",
+  "requestId",
+  "req",
+  "res",
+  "responseTime",
+  "err",
+  "metadata"
+]);
 function pickFirst(obj, keys) {
   for (const k of keys) {
     if (obj[k] !== void 0 && obj[k] !== null) return obj[k];
@@ -164,7 +181,13 @@ async function index_default(options) {
       }
       const extracted = extractPayloads(obj);
       const baseMeta = isObj(obj.metadata) ? obj.metadata : {};
-      const merged = { ...baseMeta, ...extracted };
+      const customFields = {};
+      for (const [key, value] of Object.entries(obj)) {
+        if (!PINO_INTERNAL_FIELDS.has(key) && value !== void 0 && value !== null) {
+          customFields[key] = value;
+        }
+      }
+      const merged = { ...baseMeta, ...customFields, ...extracted };
       const metadata = Object.keys(merged).length > 0 ? merged : null;
       buffer.push({
         level: LEVEL_MAP[obj.level] || "info",

package/dist/index.js

@@ -7,6 +7,23 @@ var GENERIC_HTTP_MSGS = /* @__PURE__ */ new Set([
   "incoming request",
   "http request"
 ]);
+var PINO_INTERNAL_FIELDS = /* @__PURE__ */ new Set([
+  "level",
+  "msg",
+  "time",
+  "v",
+  "pid",
+  "hostname",
+  "name",
+  "traceId",
+  "trace_id",
+  "requestId",
+  "req",
+  "res",
+  "responseTime",
+  "err",
+  "metadata"
+]);
 function pickFirst(obj, keys) {
   for (const k of keys) {
     if (obj[k] !== void 0 && obj[k] !== null) return obj[k];
@@ -129,7 +146,13 @@ async function index_default(options) {
       }
       const extracted = extractPayloads(obj);
       const baseMeta = isObj(obj.metadata) ? obj.metadata : {};
-      const merged = { ...baseMeta, ...extracted };
+      const customFields = {};
+      for (const [key, value] of Object.entries(obj)) {
+        if (!PINO_INTERNAL_FIELDS.has(key) && value !== void 0 && value !== null) {
+          customFields[key] = value;
+        }
+      }
+      const merged = { ...baseMeta, ...customFields, ...extracted };
       const metadata = Object.keys(merged).length > 0 ? merged : null;
       buffer.push({
         level: LEVEL_MAP[obj.level] || "info",

package/dist/middleware.cjs

@@ -0,0 +1,161 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/middleware.ts
+var middleware_exports = {};
+__export(middleware_exports, {
+  pulsarRequestLogger: () => pulsarRequestLogger
+});
+module.exports = __toCommonJS(middleware_exports);
+var DEFAULT_SKIP_URLS = ["/health", "/metrics", "/favicon.ico"];
+var DEFAULT_REDACT = ["authorization", "cookie", "set-cookie", "x-api-key", "x-auth-token"];
+var DEFAULT_MAX_BODY = 5e4;
+function pulsarRequestLogger(options) {
+  const logger = options.logger;
+  if (!logger) throw new Error("pulsarRequestLogger: options.logger is required");
+  const skipUrls = options.skipUrls ?? DEFAULT_SKIP_URLS;
+  const redactKeys = [...DEFAULT_REDACT, ...options.redactKeys ?? []].map((k) => k.toLowerCase());
+  const maxBodySize = options.maxBodySize ?? DEFAULT_MAX_BODY;
+  const getUserId = options.getUserId ?? ((req) => req.user?.id);
+  const getLevel = options.getLevel ?? defaultLevel;
+  return function pulsarMw(req, res, next) {
+    const url = req.originalUrl || req.url;
+    if (skipUrls.some((s) => url.includes(s))) return next();
+    const startedAt = Date.now();
+    const chunks = [];
+    const originalWrite = res.write.bind(res);
+    const originalEnd = res.end.bind(res);
+    res.write = function(chunk, ...rest) {
+      try {
+        if (chunk) chunks.push(toBuffer(chunk));
+      } catch {
+      }
+      return originalWrite(chunk, ...rest);
+    };
+    res.end = function(chunk, ...rest) {
+      try {
+        if (chunk) chunks.push(toBuffer(chunk));
+      } catch {
+      }
+      return originalEnd(chunk, ...rest);
+    };
+    res.on("finish", () => {
+      try {
+        const responseTime = Date.now() - startedAt;
+        const status = res.statusCode;
+        const level = getLevel(req, res);
+        const responseBody = readBuffer(chunks, maxBodySize, getResponseContentType(res));
+        const payload = {
+          // Top-level → colunas/filtros
+          req: { method: req.method, url, id: req.id },
+          res: { statusCode: status },
+          responseTime,
+          traceId: req.id || (typeof req.headers["x-trace-id"] === "string" ? req.headers["x-trace-id"] : void 0),
+          // metadata → seções coloridas no painel lateral
+          metadata: trimUndefined({
+            requestBody: redactDeep(req.body, redactKeys),
+            responseBody,
+            requestHeaders: redactHeaders(req.headers, redactKeys),
+            responseHeaders: redactHeaders(res.getHeaders ? res.getHeaders() : {}, redactKeys),
+            query: isPopulatedObject(req.query) ? req.query : void 0,
+            params: isPopulatedObject(req.params) ? req.params : void 0,
+            userId: getUserId(req)
+          })
+        };
+        const msg = `${req.method} ${url} ${status}`;
+        logger[level](payload, msg);
+      } catch (err) {
+        if (typeof console !== "undefined") console.error("[pulsarRequestLogger] failed:", err);
+      }
+    });
+    next();
+  };
+}
+function defaultLevel(_req, res) {
+  if (res.statusCode >= 500) return "error";
+  if (res.statusCode >= 400) return "warn";
+  return "info";
+}
+function toBuffer(chunk) {
+  if (Buffer.isBuffer(chunk)) return chunk;
+  if (typeof chunk === "string") return Buffer.from(chunk);
+  try {
+    return Buffer.from(JSON.stringify(chunk));
+  } catch {
+    return Buffer.alloc(0);
+  }
+}
+function readBuffer(chunks, max, contentType) {
+  if (chunks.length === 0) return void 0;
+  const buf = Buffer.concat(chunks);
+  if (buf.length === 0) return void 0;
+  if (buf.length > max) {
+    return `[TRUNCATED ${buf.length}B > ${max}B] ${buf.subarray(0, max).toString("utf8")}\u2026`;
+  }
+  const raw = buf.toString("utf8");
+  const ct = contentType.toLowerCase();
+  if (ct.includes("application/json")) {
+    try {
+      return JSON.parse(raw);
+    } catch {
+      return raw;
+    }
+  }
+  return raw;
+}
+function getResponseContentType(res) {
+  if (!res.getHeaders) return "";
+  const headers = res.getHeaders();
+  const v = headers["content-type"] ?? headers["Content-Type"];
+  if (typeof v === "string") return v;
+  if (Array.isArray(v)) return v.join(", ");
+  return "";
+}
+function redactHeaders(headers, redactKeys) {
+  const out = {};
+  for (const [k, v] of Object.entries(headers)) {
+    if (v === void 0 || v === null) continue;
+    out[k] = redactKeys.includes(k.toLowerCase()) ? "[REDACTED]" : Array.isArray(v) ? v.join(", ") : String(v);
+  }
+  return out;
+}
+function redactDeep(value, redactKeys) {
+  if (value === null || value === void 0) return value;
+  if (typeof value !== "object") return value;
+  if (Array.isArray(value)) return value.map((v) => redactDeep(v, redactKeys));
+  const out = {};
+  for (const [k, v] of Object.entries(value)) {
+    out[k] = redactKeys.includes(k.toLowerCase()) ? "[REDACTED]" : redactDeep(v, redactKeys);
+  }
+  return out;
+}
+function trimUndefined(obj) {
+  const out = {};
+  for (const [k, v] of Object.entries(obj)) {
+    if (v !== void 0) out[k] = v;
+  }
+  return out;
+}
+function isPopulatedObject(v) {
+  return typeof v === "object" && v !== null && !Array.isArray(v) && Object.keys(v).length > 0;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pulsarRequestLogger
+});

package/dist/middleware.d.cts

@@ -0,0 +1,63 @@
+/**
+ * Express middleware que loga cada request com payload completo no Pulsar.
+ *
+ * @example
+ * ```ts
+ * import pino from 'pino'
+ * import { pulsarRequestLogger } from '@fabbahiense/pulsar-pino-transport/middleware'
+ *
+ * const logger = pino({
+ *   transport: {
+ *     target: '@fabbahiense/pulsar-pino-transport',
+ *     options: { url: process.env.PULSAR_URL, apiKey: process.env.PULSAR_API_KEY },
+ *   },
+ * })
+ *
+ * const app = express()
+ * app.use(express.json())
+ * app.use(pulsarRequestLogger({ logger }))
+ * ```
+ */
+interface PinoLikeLogger {
+    info: (obj: unknown, msg?: string) => void;
+    warn: (obj: unknown, msg?: string) => void;
+    error: (obj: unknown, msg?: string) => void;
+}
+interface PulsarRequestLoggerOptions {
+    /** Your pino logger (com o transport do Pulsar configurado). */
+    logger: PinoLikeLogger;
+    /** URLs (substring match) que NÃO devem gerar log. Default: /health, /metrics, /favicon */
+    skipUrls?: string[];
+    /** Chaves a redactar em headers e bodies (case-insensitive). */
+    redactKeys?: string[];
+    /** Tamanho máximo em bytes pra request/response body. Bigger = truncado. Default: 50000 (50KB) */
+    maxBodySize?: number;
+    /** Extrai o id do user do req pra mandar como `metadata.userId`. */
+    getUserId?: (req: ExpressLikeRequest) => string | undefined;
+    /** Sobrescreve o cálculo de level (default: 5xx=error, 4xx=warn, resto=info). */
+    getLevel?: (req: ExpressLikeRequest, res: ExpressLikeResponse) => 'info' | 'warn' | 'error';
+}
+interface ExpressLikeRequest {
+    method: string;
+    url: string;
+    originalUrl?: string;
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    query?: Record<string, unknown>;
+    params?: Record<string, unknown>;
+    id?: string;
+    user?: {
+        id?: string;
+    };
+    [key: string]: unknown;
+}
+interface ExpressLikeResponse {
+    statusCode: number;
+    write: (...args: unknown[]) => boolean;
+    end: (...args: unknown[]) => unknown;
+    getHeaders?: () => Record<string, string | string[] | number | undefined>;
+    on: (event: string, handler: () => void) => void;
+}
+declare function pulsarRequestLogger(options: PulsarRequestLoggerOptions): (req: ExpressLikeRequest, res: ExpressLikeResponse, next: () => void) => void;
+
+export { type ExpressLikeRequest, type ExpressLikeResponse, type PinoLikeLogger, type PulsarRequestLoggerOptions, pulsarRequestLogger };

package/dist/middleware.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Express middleware que loga cada request com payload completo no Pulsar.
+ *
+ * @example
+ * ```ts
+ * import pino from 'pino'
+ * import { pulsarRequestLogger } from '@fabbahiense/pulsar-pino-transport/middleware'
+ *
+ * const logger = pino({
+ *   transport: {
+ *     target: '@fabbahiense/pulsar-pino-transport',
+ *     options: { url: process.env.PULSAR_URL, apiKey: process.env.PULSAR_API_KEY },
+ *   },
+ * })
+ *
+ * const app = express()
+ * app.use(express.json())
+ * app.use(pulsarRequestLogger({ logger }))
+ * ```
+ */
+interface PinoLikeLogger {
+    info: (obj: unknown, msg?: string) => void;
+    warn: (obj: unknown, msg?: string) => void;
+    error: (obj: unknown, msg?: string) => void;
+}
+interface PulsarRequestLoggerOptions {
+    /** Your pino logger (com o transport do Pulsar configurado). */
+    logger: PinoLikeLogger;
+    /** URLs (substring match) que NÃO devem gerar log. Default: /health, /metrics, /favicon */
+    skipUrls?: string[];
+    /** Chaves a redactar em headers e bodies (case-insensitive). */
+    redactKeys?: string[];
+    /** Tamanho máximo em bytes pra request/response body. Bigger = truncado. Default: 50000 (50KB) */
+    maxBodySize?: number;
+    /** Extrai o id do user do req pra mandar como `metadata.userId`. */
+    getUserId?: (req: ExpressLikeRequest) => string | undefined;
+    /** Sobrescreve o cálculo de level (default: 5xx=error, 4xx=warn, resto=info). */
+    getLevel?: (req: ExpressLikeRequest, res: ExpressLikeResponse) => 'info' | 'warn' | 'error';
+}
+interface ExpressLikeRequest {
+    method: string;
+    url: string;
+    originalUrl?: string;
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    query?: Record<string, unknown>;
+    params?: Record<string, unknown>;
+    id?: string;
+    user?: {
+        id?: string;
+    };
+    [key: string]: unknown;
+}
+interface ExpressLikeResponse {
+    statusCode: number;
+    write: (...args: unknown[]) => boolean;
+    end: (...args: unknown[]) => unknown;
+    getHeaders?: () => Record<string, string | string[] | number | undefined>;
+    on: (event: string, handler: () => void) => void;
+}
+declare function pulsarRequestLogger(options: PulsarRequestLoggerOptions): (req: ExpressLikeRequest, res: ExpressLikeResponse, next: () => void) => void;
+
+export { type ExpressLikeRequest, type ExpressLikeResponse, type PinoLikeLogger, type PulsarRequestLoggerOptions, pulsarRequestLogger };

package/dist/middleware.js

@@ -0,0 +1,136 @@
+// src/middleware.ts
+var DEFAULT_SKIP_URLS = ["/health", "/metrics", "/favicon.ico"];
+var DEFAULT_REDACT = ["authorization", "cookie", "set-cookie", "x-api-key", "x-auth-token"];
+var DEFAULT_MAX_BODY = 5e4;
+function pulsarRequestLogger(options) {
+  const logger = options.logger;
+  if (!logger) throw new Error("pulsarRequestLogger: options.logger is required");
+  const skipUrls = options.skipUrls ?? DEFAULT_SKIP_URLS;
+  const redactKeys = [...DEFAULT_REDACT, ...options.redactKeys ?? []].map((k) => k.toLowerCase());
+  const maxBodySize = options.maxBodySize ?? DEFAULT_MAX_BODY;
+  const getUserId = options.getUserId ?? ((req) => req.user?.id);
+  const getLevel = options.getLevel ?? defaultLevel;
+  return function pulsarMw(req, res, next) {
+    const url = req.originalUrl || req.url;
+    if (skipUrls.some((s) => url.includes(s))) return next();
+    const startedAt = Date.now();
+    const chunks = [];
+    const originalWrite = res.write.bind(res);
+    const originalEnd = res.end.bind(res);
+    res.write = function(chunk, ...rest) {
+      try {
+        if (chunk) chunks.push(toBuffer(chunk));
+      } catch {
+      }
+      return originalWrite(chunk, ...rest);
+    };
+    res.end = function(chunk, ...rest) {
+      try {
+        if (chunk) chunks.push(toBuffer(chunk));
+      } catch {
+      }
+      return originalEnd(chunk, ...rest);
+    };
+    res.on("finish", () => {
+      try {
+        const responseTime = Date.now() - startedAt;
+        const status = res.statusCode;
+        const level = getLevel(req, res);
+        const responseBody = readBuffer(chunks, maxBodySize, getResponseContentType(res));
+        const payload = {
+          // Top-level → colunas/filtros
+          req: { method: req.method, url, id: req.id },
+          res: { statusCode: status },
+          responseTime,
+          traceId: req.id || (typeof req.headers["x-trace-id"] === "string" ? req.headers["x-trace-id"] : void 0),
+          // metadata → seções coloridas no painel lateral
+          metadata: trimUndefined({
+            requestBody: redactDeep(req.body, redactKeys),
+            responseBody,
+            requestHeaders: redactHeaders(req.headers, redactKeys),
+            responseHeaders: redactHeaders(res.getHeaders ? res.getHeaders() : {}, redactKeys),
+            query: isPopulatedObject(req.query) ? req.query : void 0,
+            params: isPopulatedObject(req.params) ? req.params : void 0,
+            userId: getUserId(req)
+          })
+        };
+        const msg = `${req.method} ${url} ${status}`;
+        logger[level](payload, msg);
+      } catch (err) {
+        if (typeof console !== "undefined") console.error("[pulsarRequestLogger] failed:", err);
+      }
+    });
+    next();
+  };
+}
+function defaultLevel(_req, res) {
+  if (res.statusCode >= 500) return "error";
+  if (res.statusCode >= 400) return "warn";
+  return "info";
+}
+function toBuffer(chunk) {
+  if (Buffer.isBuffer(chunk)) return chunk;
+  if (typeof chunk === "string") return Buffer.from(chunk);
+  try {
+    return Buffer.from(JSON.stringify(chunk));
+  } catch {
+    return Buffer.alloc(0);
+  }
+}
+function readBuffer(chunks, max, contentType) {
+  if (chunks.length === 0) return void 0;
+  const buf = Buffer.concat(chunks);
+  if (buf.length === 0) return void 0;
+  if (buf.length > max) {
+    return `[TRUNCATED ${buf.length}B > ${max}B] ${buf.subarray(0, max).toString("utf8")}\u2026`;
+  }
+  const raw = buf.toString("utf8");
+  const ct = contentType.toLowerCase();
+  if (ct.includes("application/json")) {
+    try {
+      return JSON.parse(raw);
+    } catch {
+      return raw;
+    }
+  }
+  return raw;
+}
+function getResponseContentType(res) {
+  if (!res.getHeaders) return "";
+  const headers = res.getHeaders();
+  const v = headers["content-type"] ?? headers["Content-Type"];
+  if (typeof v === "string") return v;
+  if (Array.isArray(v)) return v.join(", ");
+  return "";
+}
+function redactHeaders(headers, redactKeys) {
+  const out = {};
+  for (const [k, v] of Object.entries(headers)) {
+    if (v === void 0 || v === null) continue;
+    out[k] = redactKeys.includes(k.toLowerCase()) ? "[REDACTED]" : Array.isArray(v) ? v.join(", ") : String(v);
+  }
+  return out;
+}
+function redactDeep(value, redactKeys) {
+  if (value === null || value === void 0) return value;
+  if (typeof value !== "object") return value;
+  if (Array.isArray(value)) return value.map((v) => redactDeep(v, redactKeys));
+  const out = {};
+  for (const [k, v] of Object.entries(value)) {
+    out[k] = redactKeys.includes(k.toLowerCase()) ? "[REDACTED]" : redactDeep(v, redactKeys);
+  }
+  return out;
+}
+function trimUndefined(obj) {
+  const out = {};
+  for (const [k, v] of Object.entries(obj)) {
+    if (v !== void 0) out[k] = v;
+  }
+  return out;
+}
+function isPopulatedObject(v) {
+  return typeof v === "object" && v !== null && !Array.isArray(v) && Object.keys(v).length > 0;
+}
+export {
+  pulsarRequestLogger
+};

package/package.json

@@ -1,22 +1,28 @@
 {
   "name": "@fabbahiense/pulsar-pino-transport",
-  "version": "0.2.0",
-  "description": "Pino transport for Pulsar observability platform",
+  "version": "0.3.0",
+  "description": "Pino transport for Pulsar observability platform + Express request logger middleware",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.cjs"
+    },
+    "./middleware": {
+      "types": "./dist/middleware.d.ts",
+      "import": "./dist/middleware.js",
+      "require": "./dist/middleware.cjs"
     }
   },
   "files": ["dist"],
   "scripts": {
     "build": "tsup",
-    "dev": "tsup --watch"
+    "dev": "tsup --watch",
+    "test": "node --test test/"
   },
   "peerDependencies": {
     "pino-abstract-transport": ">=2.0.0"
@@ -26,7 +32,7 @@
     "tsup": "^8.0.0",
     "typescript": "^5.9.0"
   },
-  "keywords": ["pino", "transport", "pulsar", "observability", "logging"],
+  "keywords": ["pino", "transport", "pulsar", "observability", "logging", "express", "middleware"],
   "license": "MIT",
   "engines": {
     "node": ">=18.0.0"