@anhocva214/logzen 1.0.0

package/README.md

@@ -0,0 +1,8 @@
+# LogZen
+
+**LogZen** là một middleware logging nhẹ cho các ứng dụng Node.js/Express, được viết bằng TypeScript. Module này ghi lại chi tiết các request và response theo định dạng JSON, giúp bạn dễ dàng tích hợp và theo dõi hoạt động của hệ thống.
+
+## Cài đặt
+
+```bash
+npm install @anho/logzen

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { Request, Response, NextFunction } from "express";
+export interface LogZenOptions {
+    /**
+     * Đường dẫn đến file log nơi các log sẽ được ghi.
+     * Mặc định là 'logzen.log' tại thư mục hiện hành.
+     */
+    filePath?: string;
+}
+/**
+ * LogZen middleware
+ * @param options Cấu hình cho middleware
+ * @returns Express middleware function
+ */
+export declare function logzen(options?: LogZenOptions): (req: Request, res: Response, next: NextFunction) => void;
+export default logzen;

package/dist/index.js

@@ -0,0 +1,82 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logzen = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/**
+ * LogZen middleware
+ * @param options Cấu hình cho middleware
+ * @returns Express middleware function
+ */
+function logzen(options = {}) {
+    const filePath = options.filePath || path.join(process.cwd(), "logzen.log");
+    // Tạo stream ghi log ở chế độ append
+    const logStream = fs.createWriteStream(filePath, { flags: "a" });
+    return (req, res, next) => {
+        const startTime = Date.now();
+        const { method, originalUrl, headers } = req;
+        // Khai báo mảng chứa các phần của response
+        const chunks = [];
+        // Lưu lại tham chiếu của các hàm gốc
+        const originalWrite = res.write.bind(res);
+        const originalEnd = res.end.bind(res);
+        // Ghi đè res.write để lưu lại các chunk dữ liệu của response
+        res.write = ((chunk, ...args) => {
+            // chunk có thể là string hoặc Buffer
+            chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+            return originalWrite(chunk, ...args);
+        });
+        // Ghi đè res.end để hoàn thiện quá trình logging khi response kết thúc
+        res.end = ((chunk, ...args) => {
+            if (chunk) {
+                chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+            }
+            const responseBody = Buffer.concat(chunks).toString("utf8");
+            const duration = Date.now() - startTime;
+            const logEntry = {
+                time: new Date().toISOString(),
+                duration,
+                request: {
+                    method,
+                    url: originalUrl,
+                    headers,
+                    // Lưu ý: req.body sẽ có giá trị nếu middleware body-parser đã được gọi trước
+                    body: req.body || null,
+                },
+                response: {
+                    statusCode: res.statusCode,
+                    body: responseBody,
+                },
+            };
+            // Ghi log dưới dạng JSON
+            logStream.write(JSON.stringify(logEntry) + "\n");
+            return originalEnd(chunk, ...args);
+        });
+        next();
+    };
+}
+exports.logzen = logzen;
+exports.default = logzen;

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@anhocva214/logzen",
+  "version": "1.0.0",
+  "description": "A lightweight logging middleware for Node.js/Express written in TypeScript that logs request and response details in JSON format.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"No tests yet\""
+  },
+  "keywords": [
+    "logging",
+    "middleware",
+    "express",
+    "nodejs",
+    "typescript",
+    "log"
+  ],
+  "author": "anho",
+  "license": "MIT",
+  "dependencies": {},
+  "devDependencies": {
+    "@types/express": "^4.17.15",
+    "@types/node": "^18.11.0",
+    "typescript": "^4.9.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -0,0 +1,76 @@
+import { Request, Response, NextFunction } from "express";
+import * as fs from "fs";
+import * as path from "path";
+
+export interface LogZenOptions {
+  /**
+   * Đường dẫn đến file log nơi các log sẽ được ghi.
+   * Mặc định là 'logzen.log' tại thư mục hiện hành.
+   */
+  filePath?: string;
+}
+
+/**
+ * LogZen middleware
+ * @param options Cấu hình cho middleware
+ * @returns Express middleware function
+ */
+export function logzen(options: LogZenOptions = {}) {
+  const filePath = options.filePath || path.join(process.cwd(), "logzen.log");
+
+  // Tạo stream ghi log ở chế độ append
+  const logStream = fs.createWriteStream(filePath, { flags: "a" });
+
+  return (req: Request, res: Response, next: NextFunction): void => {
+    const startTime = Date.now();
+    const { method, originalUrl, headers } = req;
+
+    // Khai báo mảng chứa các phần của response
+    const chunks: Buffer[] = [];
+
+    // Lưu lại tham chiếu của các hàm gốc
+    const originalWrite = res.write.bind(res);
+    const originalEnd = res.end.bind(res);
+
+    // Ghi đè res.write để lưu lại các chunk dữ liệu của response
+    res.write = ((chunk: any, ...args: any[]): boolean => {
+      // chunk có thể là string hoặc Buffer
+      chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+      return originalWrite(chunk, ...args);
+    }) as typeof res.write;
+
+    // Ghi đè res.end để hoàn thiện quá trình logging khi response kết thúc
+    res.end = ((chunk?: any, ...args: any[]): Response => {
+      if (chunk) {
+        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+      }
+      const responseBody = Buffer.concat(chunks).toString("utf8");
+      const duration = Date.now() - startTime;
+
+      const logEntry = {
+        time: new Date().toISOString(),
+        duration, // Thời gian xử lý request (ms)
+        request: {
+          method,
+          url: originalUrl,
+          headers,
+          // Lưu ý: req.body sẽ có giá trị nếu middleware body-parser đã được gọi trước
+          body: req.body || null,
+        },
+        response: {
+          statusCode: res.statusCode,
+          body: responseBody,
+        },
+      };
+
+      // Ghi log dưới dạng JSON
+      logStream.write(JSON.stringify(logEntry) + "\n");
+
+      return originalEnd(chunk, ...args);
+    }) as typeof res.end;
+
+    next();
+  };
+}
+
+export default logzen;

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}