opencode-logger 0.4.5 → 0.5.1

package/README.md

@@ -20,7 +20,7 @@ and add:
 ```jsonc
 {
   "$schema": "https://opencode.ai/config.json",
-  "plugin": ["opencode-logger"]
+  "plugin": ["opencode-logger"],
 }
 ```
 
@@ -28,13 +28,13 @@ and add:
 
 You can customize the log directory, filename, and logging scope using environment variables.
 
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `OPENCODE_LOGGER_DIR` | The directory where logs are stored. Can be absolute or relative to project root. | `logs/opencode` |
-| `OPENCODE_LOGGER_FILENAME` | The filename for the log file. | `log.jsonl` |
-| `OPENCODE_LOGGER_SCOPE` | Comma-separated list of event types to log. Supports wildcards (e.g., `session.*`). | `*` (Log all events) |
-
-
+| Variable                        | Description                                                                               | Default              |
+| ------------------------------- | ----------------------------------------------------------------------------------------- | -------------------- |
+| `OPENCODE_LOGGER_DIR`           | The directory where logs are stored. Can be absolute or relative to project root.         | `logs/opencode`      |
+| `OPENCODE_LOGGER_FILENAME`      | The filename for the log file.                                                            | `log.jsonl`          |
+| `OPENCODE_LOGGER_SCOPE`         | Comma-separated list of event types to log. Supports wildcards (e.g., `session.*`).       | `*` (Log all events) |
+| `OPENCODE_LOGGER_MAX_FILE_SIZE` | Maximum log file size in bytes before automatic rotation. Set to `0` to disable rotation. | `104857600` (100 MB) |
+| `OPENCODE_LOGGER_MAX_FILES`     | Maximum number of rotated log files to keep. Set to `0` to keep all.                      | `0` (unlimited)      |
 
 ### Setting via CLI
 
@@ -68,6 +68,17 @@ It accepts a comma-separated string of event types or patterns.
 export OPENCODE_LOGGER_SCOPE="session.*,command.executed"
 ```
 
+### Log Rotation
+
+You can control when log files are rotated and how many archived files are retained.
 
+- `OPENCODE_LOGGER_MAX_FILE_SIZE`: Once the active log file reaches this size (in bytes), it is rotated. Set to `0` to disable rotation entirely.
+- `OPENCODE_LOGGER_MAX_FILES`: After rotation, only this many archived files are kept (oldest deleted first). Set to `0` to keep all rotated files indefinitely.
 
+**Example:**
 
+```bash
+# Rotate at 10 MB, keep last 5 archived files
+export OPENCODE_LOGGER_MAX_FILE_SIZE=10485760
+export OPENCODE_LOGGER_MAX_FILES=5
+```

package/dist/constants.d.ts

@@ -6,6 +6,17 @@ export declare const DEFAULT_LOG_DIRECTORY = "logs/opencode";
  * Filename for the log file.
  */
 export declare const DEFAULT_LOG_FILENAME = "log.jsonl";
+/**
+ * Default maximum log file size in bytes before rotation occurs (100 MB).
+ * Set OPENCODE_LOGGER_MAX_FILE_SIZE to override. Set to 0 to disable rotation.
+ */
+export declare const DEFAULT_MAX_FILE_SIZE = 104857600;
+/**
+ * Default maximum number of rotated log files to retain.
+ * 0 means unlimited — all rotated files are kept.
+ * Set OPENCODE_LOGGER_MAX_FILES to override.
+ */
+export declare const DEFAULT_MAX_FILES = 0;
 /**
  * List of event types supported by the logger plugin.
  * These events correspond to various lifecycle hooks and actions within the Opencode environment.

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,qBAAqB,kBAAkB,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,oBAAoB,cAAc,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,ulBA2CnB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,qBAAqB,kBAAkB,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,oBAAoB,cAAc,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,YAAY,CAAC;AAE/C;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,ulBA2CnB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/constants.js

@@ -6,6 +6,17 @@ export const DEFAULT_LOG_DIRECTORY = "logs/opencode";
  * Filename for the log file.
  */
 export const DEFAULT_LOG_FILENAME = "log.jsonl";
+/**
+ * Default maximum log file size in bytes before rotation occurs (100 MB).
+ * Set OPENCODE_LOGGER_MAX_FILE_SIZE to override. Set to 0 to disable rotation.
+ */
+export const DEFAULT_MAX_FILE_SIZE = 104857600;
+/**
+ * Default maximum number of rotated log files to retain.
+ * 0 means unlimited — all rotated files are kept.
+ * Set OPENCODE_LOGGER_MAX_FILES to override.
+ */
+export const DEFAULT_MAX_FILES = 0;
 /**
  * List of event types supported by the logger plugin.
  * These events correspond to various lifecycle hooks and actions within the Opencode environment.

package/dist/file-logger.d.ts

@@ -12,10 +12,17 @@ export interface LogEntry {
 }
 /**
  * Handles initialization of the log directory and writing log entries to the file system.
+ * Supports automatic log file rotation when the active file exceeds a configurable size.
  */
 export declare class FileLogger {
+    private logDir;
+    private baseFilename;
     private logFilePath;
+    private maxFileSize;
+    private maxFiles;
     private pluginInput;
+    /** Mutex: each log() call chains onto this promise, serialising all writes. */
+    private _lock;
     /**
      * Creates a new instance of FileLogger.
      * @param projectRoot - The absolute path to the root of the project.
@@ -24,6 +31,7 @@ export declare class FileLogger {
     constructor(projectRoot: string, pluginInput: PluginInput);
     private resolveLogDirectory;
     private getLogFilename;
+    private parseEnvInt;
     /**
      * Initializes the logger by ensuring the log directory exists.
      * This method must be called before attempting to log any events.
@@ -31,9 +39,30 @@ export declare class FileLogger {
     init(): Promise<void>;
     /**
      * Logs an event and its payload to the log file in JSONL format.
+     * Automatically rotates the file if the configured maximum size has been reached.
+     *
+     * Concurrent calls are serialised via an async mutex so that the
+     * check-and-rotate step is never interleaved between two callers.
+     *
      * @param eventType - The type of event to log.
      * @param payload - The data associated with the event.
      */
     log(eventType: string, payload: unknown): Promise<void>;
+    /** Performs the actual write; always called serially through the mutex. */
+    private _doLog;
+    /**
+     * Checks whether the active log file has exceeded the maximum size and, if so, rotates it.
+     * If maxFileSize is 0, rotation is disabled.
+     */
+    private checkAndRotate;
+    /**
+     * Renames the active log file to a timestamped archive name and resets the active path.
+     * Prunes oldest rotated files if maxFiles is configured.
+     */
+    private rotate;
+    /**
+     * Deletes the oldest rotated log files when the number of archived files exceeds maxFiles.
+     */
+    private pruneOldFiles;
 }
 //# sourceMappingURL=file-logger.d.ts.map

package/dist/file-logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-logger.d.ts","sourceRoot":"","sources":["../src/file-logger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGvD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,uFAAuF;IACvF,SAAS,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAc;IAEjC;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW;IAQzD,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,cAAc;IAItB;;;OAGG;IACG,IAAI;IASV;;;;OAIG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAwB7C"}
+{"version":3,"file":"file-logger.d.ts","sourceRoot":"","sources":["../src/file-logger.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAQvD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,uFAAuF;IACvF,SAAS,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,WAAW,CAAc;IACjC,+EAA+E;IAC/E,OAAO,CAAC,KAAK,CAAoC;IAEjD;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW;IAezD,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,WAAW;IAOnB;;;OAGG;IACG,IAAI;IAQV;;;;;;;;;OASG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7D,2EAA2E;YAC7D,MAAM;IA0BpB;;;OAGG;YACW,cAAc;IAiB5B;;;OAGG;YACW,MAAM;IA+BpB;;OAEG;YACW,aAAa;CA+B3B"}

package/dist/file-logger.js

@@ -1,22 +1,31 @@
-import { appendFile, mkdir } from "node:fs/promises";
-import { isAbsolute, join, resolve } from "node:path";
-import { DEFAULT_LOG_DIRECTORY, DEFAULT_LOG_FILENAME } from "./constants.js";
+import { appendFile, mkdir, readdir, rename, stat, unlink, } from "node:fs/promises";
+import { basename, extname, isAbsolute, join, resolve } from "node:path";
+import { DEFAULT_LOG_DIRECTORY, DEFAULT_LOG_FILENAME, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_FILES, } from "./constants.js";
 /**
  * Handles initialization of the log directory and writing log entries to the file system.
+ * Supports automatic log file rotation when the active file exceeds a configurable size.
  */
 export class FileLogger {
+    logDir;
+    baseFilename;
     logFilePath;
+    maxFileSize;
+    maxFiles;
     pluginInput;
+    /** Mutex: each log() call chains onto this promise, serialising all writes. */
+    _lock = Promise.resolve();
     /**
      * Creates a new instance of FileLogger.
      * @param projectRoot - The absolute path to the root of the project.
      * @param pluginInput - Opencode plugin input
      */
     constructor(projectRoot, pluginInput) {
-        const logDir = this.resolveLogDirectory(projectRoot);
-        const logFilename = this.getLogFilename();
-        this.logFilePath = join(logDir, logFilename);
+        this.logDir = this.resolveLogDirectory(projectRoot);
+        this.baseFilename = this.getLogFilename();
+        this.logFilePath = join(this.logDir, this.baseFilename);
         this.pluginInput = pluginInput;
+        this.maxFileSize = this.parseEnvInt("OPENCODE_LOGGER_MAX_FILE_SIZE", DEFAULT_MAX_FILE_SIZE);
+        this.maxFiles = this.parseEnvInt("OPENCODE_LOGGER_MAX_FILES", DEFAULT_MAX_FILES);
     }
     resolveLogDirectory(projectRoot) {
         const logDir = process.env["OPENCODE_LOGGER_DIR"] ||
@@ -29,14 +38,20 @@ export class FileLogger {
     getLogFilename() {
         return process.env["OPENCODE_LOGGER_FILENAME"] || DEFAULT_LOG_FILENAME;
     }
+    parseEnvInt(varName, defaultValue) {
+        const raw = process.env[varName];
+        if (raw === undefined || raw === "")
+            return defaultValue;
+        const parsed = Number.parseInt(raw, 10);
+        return Number.isNaN(parsed) ? defaultValue : parsed;
+    }
     /**
      * Initializes the logger by ensuring the log directory exists.
      * This method must be called before attempting to log any events.
      */
     async init() {
         try {
-            const dirPath = join(this.logFilePath, "..");
-            await mkdir(dirPath, { recursive: true });
+            await mkdir(this.logDir, { recursive: true });
         }
         catch (error) {
             console.error(`[Opencode-logger]: Failed to initialize.\n${error}`);
@@ -44,10 +59,22 @@ export class FileLogger {
     }
     /**
      * Logs an event and its payload to the log file in JSONL format.
+     * Automatically rotates the file if the configured maximum size has been reached.
+     *
+     * Concurrent calls are serialised via an async mutex so that the
+     * check-and-rotate step is never interleaved between two callers.
+     *
      * @param eventType - The type of event to log.
      * @param payload - The data associated with the event.
      */
     async log(eventType, payload) {
+        // Chain this write onto the tail of the lock so all log() calls execute
+        // sequentially, regardless of how many are in-flight at once.
+        this._lock = this._lock.then(() => this._doLog(eventType, payload));
+        return this._lock;
+    }
+    /** Performs the actual write; always called serially through the mutex. */
+    async _doLog(eventType, payload) {
         const entry = {
             timestamp: new Date().toISOString(),
             eventType,
@@ -55,6 +82,7 @@ export class FileLogger {
         };
         const line = `${JSON.stringify(entry)}\n`;
         try {
+            await this.checkAndRotate();
             await appendFile(this.logFilePath, line, "utf-8");
         }
         catch (error) {
@@ -70,4 +98,91 @@ export class FileLogger {
             });
         }
     }
+    /**
+     * Checks whether the active log file has exceeded the maximum size and, if so, rotates it.
+     * If maxFileSize is 0, rotation is disabled.
+     */
+    async checkAndRotate() {
+        if (this.maxFileSize === 0)
+            return;
+        let fileSize;
+        try {
+            const fileStat = await stat(this.logFilePath);
+            fileSize = fileStat.size;
+        }
+        catch {
+            // File does not exist yet — no rotation needed
+            return;
+        }
+        if (fileSize >= this.maxFileSize) {
+            await this.rotate();
+        }
+    }
+    /**
+     * Renames the active log file to a timestamped archive name and resets the active path.
+     * Prunes oldest rotated files if maxFiles is configured.
+     */
+    async rotate() {
+        const ext = extname(this.baseFilename);
+        const base = basename(this.baseFilename, ext);
+        const timestamp = new Date()
+            .toISOString()
+            .replace(/:/g, "-")
+            .replace(/\..+$/, "");
+        const shortId = crypto.randomUUID().slice(0, 8);
+        const rotatedFilename = `${base}.${timestamp}-${shortId}${ext}`;
+        const rotatedFilePath = join(this.logDir, rotatedFilename);
+        try {
+            await rename(this.logFilePath, rotatedFilePath);
+        }
+        catch (error) {
+            await this.pluginInput.client.app.log({
+                body: {
+                    service: "opencode-logger",
+                    level: "error",
+                    message: "Failed to rotate log file.",
+                    extra: { error },
+                },
+            });
+            return;
+        }
+        // logFilePath stays pointing to the base filename — next appendFile will create a fresh file
+        if (this.maxFiles > 0) {
+            await this.pruneOldFiles();
+        }
+    }
+    /**
+     * Deletes the oldest rotated log files when the number of archived files exceeds maxFiles.
+     */
+    async pruneOldFiles() {
+        const ext = extname(this.baseFilename);
+        const base = basename(this.baseFilename, ext);
+        // Rotated files match: <base>.<timestamp>-<shortId><ext>
+        const rotationPattern = new RegExp(`^${escapeRegExp(base)}\\..+${escapeRegExp(ext)}$`);
+        let entries;
+        try {
+            entries = await readdir(this.logDir);
+        }
+        catch {
+            return;
+        }
+        const rotatedFiles = entries
+            .filter((name) => rotationPattern.test(name))
+            .sort(); // ISO timestamp prefix sorts lexicographically = chronologically
+        const excess = rotatedFiles.length - this.maxFiles;
+        if (excess <= 0)
+            return;
+        const toDelete = rotatedFiles.slice(0, excess);
+        for (const filename of toDelete) {
+            try {
+                await unlink(join(this.logDir, filename));
+            }
+            catch {
+                // Best-effort: ignore individual deletion failures
+            }
+        }
+    }
+}
+function escapeRegExp(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAS,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAKzD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,MAkB1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAS,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAIzD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,MAe1B,CAAC"}

package/dist/index.js

@@ -1,4 +1,3 @@
-import { SUPPORTED_EVENTS } from "./constants.js";
 import { FileLogger } from "./file-logger.js";
 import { shouldLogEvent } from "./utils.js";
 /**
@@ -14,8 +13,7 @@ export const loggerPlugin = async (ctx) => {
     console.log("[Opencode Logger] Plugin initialized!");
     const hooks = {
         event: async ({ event }) => {
-            if (SUPPORTED_EVENTS.includes(event.type) &&
-                shouldLogEvent(event.type, process.env["OPENCODE_LOGGER_SCOPE"])) {
+            if (shouldLogEvent(event.type, process.env["OPENCODE_LOGGER_SCOPE"])) {
                 await logger.log(event.type, event);
             }
         },

package/package.json

@@ -2,7 +2,7 @@
 	"name": "opencode-logger",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
-	"version": "0.4.5",
+	"version": "0.5.1",
 	"repository": {
 		"url": "git+https://github.com/radekBednarik/opencode-logger.git"
 	},
@@ -33,6 +33,7 @@
 	},
 	"private": false,
 	"scripts": {
+		"test": "bun test",
 		"build-dist": "bunx tsc",
 		"lint": "bunx biome lint --write ./src",
 		"format": "bunx biome format --write",
@@ -42,7 +43,7 @@
 	},
 	"type": "module",
 	"lint-staged": {
-		"*.{js, ts}": [
+		"*.{js,ts}": [
 			"bun forlint"
 		],
 		"*.{ts,json}": [