@eggjs/logrotator 4.1.0 → 5.0.0-beta.17

package/README.md

@@ -1,8 +1,6 @@
 # @eggjs/logrotator
 
 [![NPM version][npm-image]][npm-url]
-[![CI](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml)
-[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/logrotator.svg?style=flat-square)](https://codecov.io/gh/eggjs/logrotator)
 [![npm download][download-image]][download-url]
 [![Node.js Version](https://img.shields.io/node/v/@eggjs/logrotator.svg?style=flat)](https://nodejs.org/en/download/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
@@ -118,6 +116,6 @@ Please open an issue [here](https://github.com/eggjs/egg/issues).
 
 ## Contributors
 
-[![Contributors](https://contrib.rocks/image?repo=eggjs/logrotator)](https://github.com/eggjs/logrotator/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)
 
 Made with [contributors-img](https://contrib.rocks).

package/README.zh-CN.md

@@ -1,8 +1,6 @@
 # @eggjs/logrotator
 
 [![NPM version][npm-image]][npm-url]
-[![CI](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml)
-[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/logrotator.svg?style=flat-square)](https://codecov.io/gh/eggjs/logrotator)
 [![npm download][download-image]][download-url]
 [![Node.js Version](https://img.shields.io/node/v/@eggjs/logrotator.svg?style=flat)](https://nodejs.org/en/download/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
@@ -110,6 +108,6 @@ Please open an issue [here](https://github.com/eggjs/egg/issues).
 
 ## Contributors
 
-[![Contributors](https://contrib.rocks/image?repo=eggjs/logrotator)](https://github.com/eggjs/logrotator/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)
 
 Made with [contributors-img](https://contrib.rocks).

package/dist/agent.d.ts

@@ -0,0 +1,2 @@
+import { Boot } from "./boot.js";
+export { Boot as default };

package/dist/agent.js

@@ -0,0 +1,7 @@
+import { Boot } from "./boot.js";
+
+//#region src/agent.ts
+var agent_default = Boot;
+
+//#endregion
+export { agent_default as default };

package/dist/app/extend/agent.d.ts

@@ -0,0 +1,8 @@
+import { LogRotator } from "../../lib/rotator.js";
+
+//#region src/app/extend/agent.d.ts
+declare const _default: {
+  LogRotator: typeof LogRotator;
+};
+//#endregion
+export { _default as default };

package/dist/app/extend/agent.js

@@ -0,0 +1,7 @@
+import { LogRotator } from "../../lib/rotator.js";
+
+//#region src/app/extend/agent.ts
+var agent_default = { LogRotator };
+
+//#endregion
+export { agent_default as default };

package/dist/app/extend/application.d.ts

@@ -0,0 +1,8 @@
+import { LogRotator } from "../../lib/rotator.js";
+
+//#region src/app/extend/application.d.ts
+declare const _default: {
+  LogRotator: typeof LogRotator;
+};
+//#endregion
+export { _default as default };

package/dist/app/extend/application.js

@@ -0,0 +1,7 @@
+import { LogRotator } from "../../lib/rotator.js";
+
+//#region src/app/extend/application.ts
+var application_default = { LogRotator };
+
+//#endregion
+export { application_default as default };

package/dist/app/schedule/clean_log.d.ts

@@ -0,0 +1,12 @@
+import { Application } from "egg";
+
+//#region src/app/schedule/clean_log.d.ts
+declare const _default: (app: Application) => {
+  schedule: {
+    type: string;
+    cron: string;
+  };
+  task(): Promise<void>;
+};
+//#endregion
+export { _default as default };

package/dist/app/schedule/clean_log.js

@@ -0,0 +1,60 @@
+import { walkLoggerFile } from "../../lib/utils.js";
+import fs from "node:fs/promises";
+import { exists } from "utility";
+import path from "node:path";
+import moment from "moment";
+
+//#region src/app/schedule/clean_log.ts
+var clean_log_default = (app) => ({
+	schedule: {
+		type: "worker",
+		cron: "0 0 * * *"
+	},
+	async task() {
+		const logger = app.coreLogger;
+		const logDirs = /* @__PURE__ */ new Set();
+		const loggerFiles = walkLoggerFile(app.loggers);
+		for (const file of loggerFiles) {
+			const logDir = path.dirname(file);
+			logDirs.add(logDir);
+		}
+		const maxDays = app.config.logrotator.maxDays;
+		if (maxDays && maxDays > 0) try {
+			const tasks = Array.from(logDirs, (logDir) => removeExpiredLogFiles(logDir, maxDays, logger));
+			await Promise.all(tasks);
+		} catch (err) {
+			logger.error(err);
+		}
+		logger.info("[@eggjs/logrotator] clean all log before %s days", maxDays);
+	}
+});
+async function removeExpiredLogFiles(logDir, maxDays, logger) {
+	if (!await exists(logDir)) {
+		logger.warn(`[@eggjs/logrotator] logDir ${logDir} not exists`);
+		return;
+	}
+	const files = await fs.readdir(logDir);
+	const expiredDate = moment().subtract(maxDays, "days").startOf("date");
+	const names = files.filter((file) => {
+		const name = path.extname(file).slice(1);
+		if (!/^\d{4}-\d{2}-\d{2}/.test(name)) return false;
+		const date = moment(name, "YYYY-MM-DD").startOf("date");
+		if (!date.isValid()) return false;
+		return date.isBefore(expiredDate);
+	});
+	if (names.length === 0) return;
+	logger.info(`[@eggjs/logrotator] start remove ${logDir} files: ${names.join(", ")}`);
+	await Promise.all(names.map(async (name) => {
+		const logFile = path.join(logDir, name);
+		try {
+			await fs.unlink(logFile);
+		} catch (e) {
+			const err = e;
+			err.message = `[@eggjs/logrotator] remove logFile ${logFile} error, ${err.message}`;
+			logger.error(err);
+		}
+	}));
+}
+
+//#endregion
+export { clean_log_default as default };

package/dist/app/schedule/rotate_by_file.d.ts

@@ -0,0 +1,13 @@
+import { Application } from "egg";
+
+//#region src/app/schedule/rotate_by_file.d.ts
+declare const _default: (app: Application) => {
+  schedule: {
+    type: string;
+    cron: string;
+    disable: boolean;
+  };
+  task(): Promise<void>;
+};
+//#endregion
+export { _default as default };

package/dist/app/schedule/rotate_by_file.js

@@ -0,0 +1,19 @@
+import { DayRotator } from "../../lib/day_rotator.js";
+
+//#region src/app/schedule/rotate_by_file.ts
+var rotate_by_file_default = (app) => {
+	const rotator = new DayRotator({ app });
+	return {
+		schedule: {
+			type: "worker",
+			cron: "1 0 0 * * *",
+			disable: app.config.logrotator.disableRotateByDay
+		},
+		async task() {
+			await rotator.rotate();
+		}
+	};
+};
+
+//#endregion
+export { rotate_by_file_default as default };

package/dist/app/schedule/rotate_by_hour.d.ts

@@ -0,0 +1,13 @@
+import { Application } from "egg";
+
+//#region src/app/schedule/rotate_by_hour.d.ts
+declare const _default: (app: Application) => {
+  schedule: {
+    type: string;
+    cron: string;
+    disable: boolean;
+  };
+  task(): Promise<void>;
+};
+//#endregion
+export { _default as default };

package/dist/app/schedule/rotate_by_hour.js

@@ -0,0 +1,19 @@
+import { HourRotator } from "../../lib/hour_rotator.js";
+
+//#region src/app/schedule/rotate_by_hour.ts
+var rotate_by_hour_default = (app) => {
+	const rotator = new HourRotator({ app });
+	return {
+		schedule: {
+			type: "worker",
+			cron: "1 * * * *",
+			disable: (app.config.logrotator.filesRotateByHour || []).length === 0
+		},
+		async task() {
+			await rotator.rotate();
+		}
+	};
+};
+
+//#endregion
+export { rotate_by_hour_default as default };

package/dist/app/schedule/rotate_by_size.d.ts

@@ -0,0 +1,13 @@
+import { Application } from "egg";
+
+//#region src/app/schedule/rotate_by_size.d.ts
+declare const _default: (app: Application) => {
+  schedule: {
+    type: string;
+    interval: number;
+    disable: boolean;
+  };
+  task(): Promise<void>;
+};
+//#endregion
+export { _default as default };

package/dist/app/schedule/rotate_by_size.js

@@ -0,0 +1,19 @@
+import { SizeRotator } from "../../lib/size_rotator.js";
+
+//#region src/app/schedule/rotate_by_size.ts
+var rotate_by_size_default = (app) => {
+	const rotator = new SizeRotator({ app });
+	return {
+		schedule: {
+			type: "worker",
+			interval: app.config.logrotator.rotateDuration,
+			disable: (app.config.logrotator.filesRotateBySize || []).length === 0
+		},
+		async task() {
+			await rotator.rotate();
+		}
+	};
+};
+
+//#endregion
+export { rotate_by_size_default as default };

package/dist/app.d.ts

@@ -0,0 +1,2 @@
+import { Boot } from "./boot.js";
+export { Boot as default };

package/dist/app.js

@@ -0,0 +1,7 @@
+import { Boot } from "./boot.js";
+
+//#region src/app.ts
+var app_default = Boot;
+
+//#endregion
+export { app_default as default };

package/dist/boot.d.ts

@@ -0,0 +1,10 @@
+import { Application, ILifecycleBoot } from "egg";
+
+//#region src/boot.d.ts
+declare class Boot implements ILifecycleBoot {
+  private readonly app;
+  constructor(app: Application);
+  didLoad(): Promise<void>;
+}
+//#endregion
+export { Boot };

package/dist/boot.js

@@ -0,0 +1,16 @@
+//#region src/boot.ts
+var Boot = class {
+	app;
+	constructor(app) {
+		this.app = app;
+	}
+	async didLoad() {
+		this.app.messenger.on("log-reload", () => {
+			this.app.loggers.reload();
+			this.app.coreLogger.info("[@eggjs/logrotator] %s logger reload: got log-reload message", this.app.type);
+		});
+	}
+};
+
+//#endregion
+export { Boot };

package/{src/config/config.default.ts → dist/config/config.default.d.ts}

@@ -1,8 +1,5 @@
-/**
- * logrotator options
- * @member Config#logrotator
- */
-export interface LogrotatorConfig {
+//#region src/config/config.default.d.ts
+interface LogrotatorConfig {
   /**
    * Disable rotate by day
    *
@@ -58,17 +55,8 @@ export interface LogrotatorConfig {
    */
   gzip: boolean;
 }
-
-export default {
-  logrotator: {
-    disableRotateByDay: false,
-    filesRotateByHour: null,
-    hourDelimiter: '-',
-    filesRotateBySize: null,
-    maxFileSize: 50 * 1024 * 1024,
-    maxFiles: 10,
-    rotateDuration: 60_000,
-    maxDays: 31,
-    gzip: false,
-  } as LogrotatorConfig,
+declare const _default: {
+  logrotator: LogrotatorConfig;
 };
+//#endregion
+export { LogrotatorConfig, _default as default };

package/dist/config/config.default.js

@@ -0,0 +1,15 @@
+//#region src/config/config.default.ts
+var config_default_default = { logrotator: {
+	disableRotateByDay: false,
+	filesRotateByHour: null,
+	hourDelimiter: "-",
+	filesRotateBySize: null,
+	maxFileSize: 50 * 1024 * 1024,
+	maxFiles: 10,
+	rotateDuration: 6e4,
+	maxDays: 31,
+	gzip: false
+} };
+
+//#endregion
+export { config_default_default as default };

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { LogRotator, RotateFile, RotatorOptions } from "./lib/rotator.js";
+export { LogRotator, RotateFile, RotatorOptions };

package/dist/index.js

@@ -0,0 +1,5 @@
+import "./config/config.default.js";
+import { LogRotator } from "./lib/rotator.js";
+import "./app/extend/application.js";
+
+export { LogRotator };

package/dist/lib/day_rotator.d.ts

@@ -0,0 +1,12 @@
+import { LogRotator, RotateFile, RotatorOptions } from "./rotator.js";
+
+//#region src/lib/day_rotator.d.ts
+declare class DayRotator extends LogRotator {
+  private filesRotateBySize;
+  private filesRotateByHour;
+  constructor(options: RotatorOptions);
+  getRotateFiles(): Promise<Map<string, RotateFile>>;
+  _setFile(srcPath: string, files: Map<string, RotateFile>): void;
+}
+//#endregion
+export { DayRotator };

package/dist/lib/day_rotator.js

@@ -0,0 +1,64 @@
+import { LogRotator } from "./rotator.js";
+import { walkLoggerFile } from "./utils.js";
+import fs from "node:fs/promises";
+import { debuglog } from "node:util";
+import { exists } from "utility";
+import path from "node:path";
+import moment from "moment";
+
+//#region src/lib/day_rotator.ts
+const debug = debuglog("egg/logrotator/lib/day_rotator");
+var DayRotator = class extends LogRotator {
+	filesRotateBySize;
+	filesRotateByHour;
+	constructor(options) {
+		super(options);
+		this.filesRotateBySize = this.app.config.logrotator.filesRotateBySize ?? [];
+		this.filesRotateByHour = this.app.config.logrotator.filesRotateByHour ?? [];
+	}
+	async getRotateFiles() {
+		const files = /* @__PURE__ */ new Map();
+		const logDir = this.app.config.logger.dir;
+		const loggers = this.app.loggers;
+		const loggerFiles = walkLoggerFile(loggers);
+		for (let file of loggerFiles) {
+			if (!path.isAbsolute(file)) file = path.join(logDir, file);
+			this._setFile(file, files);
+		}
+		const agentLogName = this.app.config.logger.agentLogName;
+		this._setFile(path.join(logDir, agentLogName), files);
+		const rotateLogDirs = this.app.config.logger.rotateLogDirs;
+		if (rotateLogDirs && rotateLogDirs.length > 0) {
+			this.app.deprecate("[@eggjs/logrotator] Do not use app.config.logger.rotateLogDirs, only rotate core loggers and custom loggers");
+			for (const dir of rotateLogDirs) {
+				if (!await exists(dir)) continue;
+				try {
+					const names = await fs.readdir(dir);
+					for (const name of names) {
+						if (!name.endsWith(".log")) continue;
+						this._setFile(path.join(dir, name), files);
+					}
+				} catch (err) {
+					this.logger.error(err);
+				}
+			}
+		}
+		return files;
+	}
+	_setFile(srcPath, files) {
+		if (this.filesRotateBySize.includes(srcPath)) return;
+		if (this.filesRotateByHour.includes(srcPath)) return;
+		if (!files.has(srcPath)) {
+			const ext = this.app.config.logrotator.gzip === true ? ".gz" : "";
+			const targetPath = srcPath + moment().subtract(23, "hours").subtract(58, "minutes").format(".YYYY-MM-DD") + ext;
+			debug("set file %s => %s", srcPath, targetPath);
+			files.set(srcPath, {
+				srcPath,
+				targetPath
+			});
+		}
+	}
+};
+
+//#endregion
+export { DayRotator };

package/dist/lib/hour_rotator.d.ts

@@ -0,0 +1,10 @@
+import { LogRotator, RotateFile } from "./rotator.js";
+
+//#region src/lib/hour_rotator.d.ts
+declare class HourRotator extends LogRotator {
+  getRotateFiles(): Promise<Map<string, RotateFile>>;
+  get hourDelimiter(): string;
+  _setFile(srcPath: string, files: Map<string, RotateFile>): void;
+}
+//#endregion
+export { HourRotator };

package/dist/lib/hour_rotator.js

@@ -0,0 +1,38 @@
+import { LogRotator } from "./rotator.js";
+import { debuglog } from "node:util";
+import { exists } from "utility";
+import path from "node:path";
+import moment from "moment";
+
+//#region src/lib/hour_rotator.ts
+const debug = debuglog("egg/logrotator/lib/hour_rotator");
+var HourRotator = class extends LogRotator {
+	async getRotateFiles() {
+		const files = /* @__PURE__ */ new Map();
+		const logDir = this.app.config.logger.dir;
+		const filesRotateByHour = this.app.config.logrotator.filesRotateByHour ?? [];
+		for (let logPath of filesRotateByHour) {
+			if (!path.isAbsolute(logPath)) logPath = path.join(logDir, logPath);
+			if (!await exists(logPath)) continue;
+			this._setFile(logPath, files);
+		}
+		return files;
+	}
+	get hourDelimiter() {
+		return this.app.config.logrotator.hourDelimiter;
+	}
+	_setFile(srcPath, files) {
+		if (!files.has(srcPath)) {
+			const ext = this.app.config.logrotator.gzip === true ? ".gz" : "";
+			const targetPath = srcPath + moment().subtract(1, "hours").format(`.YYYY-MM-DD${this.hourDelimiter}HH`) + ext;
+			debug("set file %s => %s", srcPath, targetPath);
+			files.set(srcPath, {
+				srcPath,
+				targetPath
+			});
+		}
+	}
+};
+
+//#endregion
+export { HourRotator };

package/dist/lib/rotator.d.ts

@@ -0,0 +1,20 @@
+import { Application } from "egg";
+
+//#region src/lib/rotator.d.ts
+interface RotatorOptions {
+  app: Application;
+}
+interface RotateFile {
+  srcPath: string;
+  targetPath: string;
+}
+declare abstract class LogRotator {
+  protected readonly options: RotatorOptions;
+  protected readonly app: Application;
+  protected readonly logger: Application['coreLogger'];
+  constructor(options: RotatorOptions);
+  abstract getRotateFiles(): Promise<Map<string, RotateFile>>;
+  rotate(): Promise<void>;
+}
+//#endregion
+export { LogRotator, RotateFile, RotatorOptions };

package/dist/lib/rotator.js

@@ -0,0 +1,56 @@
+import assert from "node:assert";
+import { createReadStream, createWriteStream } from "node:fs";
+import fs from "node:fs/promises";
+import { pipeline } from "node:stream/promises";
+import { createGzip } from "node:zlib";
+import { debuglog } from "node:util";
+import { exists } from "utility";
+
+//#region src/lib/rotator.ts
+const debug = debuglog("egg/logrotator/lib/rotator");
+var LogRotator = class {
+	options;
+	app;
+	logger;
+	constructor(options) {
+		this.options = options;
+		assert(this.options.app, "options.app is required");
+		this.app = this.options.app;
+		this.logger = this.app.coreLogger;
+	}
+	async rotate() {
+		const files = await this.getRotateFiles();
+		assert(files instanceof Map, "getRotateFiles should return a Map");
+		const rotatedFiles = [];
+		for (const file of files.values()) try {
+			debug("rename from %s to %s", file.srcPath, file.targetPath);
+			await renameOrDelete(file.srcPath, file.targetPath, this.app.config.logrotator.gzip);
+			rotatedFiles.push(`${file.srcPath} -> ${file.targetPath}`);
+		} catch (e) {
+			const err = e;
+			err.message = `[@eggjs/logrotator] rename ${file.srcPath}, found exception: ${err.message}`;
+			this.logger.error(err);
+		}
+		if (rotatedFiles.length > 0) {
+			debug("broadcast log-reload, rotated files: %j", rotatedFiles);
+			this.logger.info("[@eggjs/logrotator] broadcast log-reload");
+			this.app.messenger.sendToApp("log-reload");
+			this.app.messenger.sendToAgent("log-reload");
+		}
+		this.logger.info("[@eggjs/logrotator] rotate files success by %s, files %j", this.constructor.name, rotatedFiles);
+	}
+};
+async function renameOrDelete(srcPath, targetPath, gzip) {
+	if (srcPath === targetPath) return;
+	if (!await exists(srcPath)) return;
+	if (await exists(targetPath)) throw /* @__PURE__ */ new Error(`targetFile ${targetPath} exists!!!`);
+	if (gzip === true) {
+		const tmpPath = `${targetPath}.tmp`;
+		await fs.rename(srcPath, tmpPath);
+		await pipeline(createReadStream(tmpPath), createGzip(), createWriteStream(targetPath));
+		await fs.unlink(tmpPath);
+	} else await fs.rename(srcPath, targetPath);
+}
+
+//#endregion
+export { LogRotator };

package/dist/lib/size_rotator.d.ts

@@ -0,0 +1,9 @@
+import { LogRotator, RotateFile } from "./rotator.js";
+
+//#region src/lib/size_rotator.d.ts
+declare class SizeRotator extends LogRotator {
+  getRotateFiles(): Promise<Map<string, RotateFile>>;
+  _setFile(logPath: string, files: Map<string, RotateFile>): void;
+}
+//#endregion
+export { SizeRotator };

package/dist/lib/size_rotator.js

@@ -0,0 +1,61 @@
+import { LogRotator } from "./rotator.js";
+import fs from "node:fs/promises";
+import { debuglog } from "node:util";
+import { exists } from "utility";
+import path from "node:path";
+
+//#region src/lib/size_rotator.ts
+const debug = debuglog("egg/logrotator/lib/size_rotator");
+var SizeRotator = class extends LogRotator {
+	async getRotateFiles() {
+		const files = /* @__PURE__ */ new Map();
+		const logDir = this.app.config.logger.dir;
+		const filesRotateBySize = this.app.config.logrotator.filesRotateBySize ?? [];
+		const maxFileSize = this.app.config.logrotator.maxFileSize;
+		const maxFiles = this.app.config.logrotator.maxFiles;
+		for (let logPath of filesRotateBySize) {
+			if (!path.isAbsolute(logPath)) logPath = path.join(logDir, logPath);
+			const stat = await exists(logPath);
+			if (!stat) continue;
+			const size = stat.size;
+			try {
+				if (size >= maxFileSize) {
+					this.logger.info(`[@eggjs/logrotator] file ${logPath} reach the maximum file size, current size: ${size}, max size: ${maxFileSize}`);
+					const maxFileName = `${logPath}.${maxFiles}`;
+					if (await exists(maxFileName)) {
+						await fs.unlink(maxFileName);
+						this.logger.info(`[@eggjs/logrotator] delete max log file ${maxFileName}`);
+					}
+					this._setFile(logPath, files);
+				}
+			} catch (e) {
+				const err = e;
+				err.message = `[@eggjs/logrotator] ${err.message}`;
+				this.logger.error(err);
+			}
+		}
+		return files;
+	}
+	_setFile(logPath, files) {
+		const maxFiles = this.app.config.logrotator.maxFiles;
+		if (files.has(logPath)) return;
+		const ext = this.app.config.logrotator.gzip === true ? ".gz" : "";
+		for (let i = maxFiles - 1; i >= 1; i--) {
+			const srcPath = `${logPath}.${i}`;
+			const targetPath = `${logPath}.${i + 1}${ext}`;
+			debug("set file %s => %s", srcPath, targetPath);
+			files.set(srcPath, {
+				srcPath,
+				targetPath
+			});
+		}
+		debug("set file %s => %s", logPath, `${logPath}.1`);
+		files.set(logPath, {
+			srcPath: logPath,
+			targetPath: `${logPath}.1${ext}`
+		});
+	}
+};
+
+//#endregion
+export { SizeRotator };

package/dist/lib/utils.d.ts

@@ -0,0 +1,12 @@
+//#region src/lib/utils.d.ts
+interface LoggerTransport {
+  options: {
+    file: string;
+  };
+}
+/**
+ * Walk all logger files from loggers
+ */
+declare function walkLoggerFile(loggers: Record<string, Map<string, LoggerTransport>>): string[];
+//#endregion
+export { walkLoggerFile };