@richardmcquiston01/error-log-adapter 0.10.0 → 0.11.0

package/dist/index.d.cts

@@ -466,13 +466,6 @@ declare class FlatFileErrorAdapter<TCode extends string = string> implements Err
     /** Uses the injected file system, or loads `node:fs/promises` on first use. */
     private getFileSystem;
     private prepareDirectory;
-    /**
-     * Moves `app.log` to `app.log.1` (shifting older files up, dropping the
-     * oldest) when the next line would push it past `maxBytes`. A failed rotation
-     * is reported, but the entry is still written so it is not lost.
-     */
-    private rotateIfNeeded;
-    private renameIfPresent;
 }
 
 /** A stored record: the serialized entry plus its generated UUID. */
@@ -488,6 +481,13 @@ interface JsonFileErrorOptions {
     mode?: 'ndjson' | 'array';
     /** Array mode only: most entries to keep. The oldest are dropped first. */
     maxEntries?: number;
+    /**
+     * NDJSON mode only: rotate the file before it would grow past this many
+     * bytes, moving it to `<path>.1` (older files shift up). Off by default.
+     */
+    maxBytes?: number;
+    /** NDJSON mode only: rotated files to keep (`errors.ndjson.1` is newest). Defaults to `3`. Needs `maxBytes`. */
+    maxFiles?: number;
     /** Array mode only: spaces of indentation. Defaults to `2`; `0` is compact. */
     indent?: number;
     /** File system to write to. Defaults to `node:fs/promises`, loaded on first use. */
@@ -506,13 +506,15 @@ declare class JsonFileErrorAdapter<TCode extends string = string> implements Err
     private readonly filePath;
     private readonly mode;
     private readonly maxEntries;
+    private readonly maxBytes;
+    private readonly maxFiles;
     private readonly indent;
     private readonly createDirectory;
     private readonly prefix;
     private fs;
     private directoryReady;
     private readonly queue;
-    /** @throws {RangeError} if `maxEntries` or `indent` is invalid, or `maxEntries` is used outside array mode. */
+    /** @throws {RangeError} if `maxEntries`, `maxBytes`, `maxFiles` or `indent` is invalid, or an option is used in the wrong mode. */
     constructor(filePath: string, options?: JsonFileErrorOptions);
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
     private write;

package/dist/index.d.ts

@@ -466,13 +466,6 @@ declare class FlatFileErrorAdapter<TCode extends string = string> implements Err
     /** Uses the injected file system, or loads `node:fs/promises` on first use. */
     private getFileSystem;
     private prepareDirectory;
-    /**
-     * Moves `app.log` to `app.log.1` (shifting older files up, dropping the
-     * oldest) when the next line would push it past `maxBytes`. A failed rotation
-     * is reported, but the entry is still written so it is not lost.
-     */
-    private rotateIfNeeded;
-    private renameIfPresent;
 }
 
 /** A stored record: the serialized entry plus its generated UUID. */
@@ -488,6 +481,13 @@ interface JsonFileErrorOptions {
     mode?: 'ndjson' | 'array';
     /** Array mode only: most entries to keep. The oldest are dropped first. */
     maxEntries?: number;
+    /**
+     * NDJSON mode only: rotate the file before it would grow past this many
+     * bytes, moving it to `<path>.1` (older files shift up). Off by default.
+     */
+    maxBytes?: number;
+    /** NDJSON mode only: rotated files to keep (`errors.ndjson.1` is newest). Defaults to `3`. Needs `maxBytes`. */
+    maxFiles?: number;
     /** Array mode only: spaces of indentation. Defaults to `2`; `0` is compact. */
     indent?: number;
     /** File system to write to. Defaults to `node:fs/promises`, loaded on first use. */
@@ -506,13 +506,15 @@ declare class JsonFileErrorAdapter<TCode extends string = string> implements Err
     private readonly filePath;
     private readonly mode;
     private readonly maxEntries;
+    private readonly maxBytes;
+    private readonly maxFiles;
     private readonly indent;
     private readonly createDirectory;
     private readonly prefix;
     private fs;
     private directoryReady;
     private readonly queue;
-    /** @throws {RangeError} if `maxEntries` or `indent` is invalid, or `maxEntries` is used outside array mode. */
+    /** @throws {RangeError} if `maxEntries`, `maxBytes`, `maxFiles` or `indent` is invalid, or an option is used in the wrong mode. */
     constructor(filePath: string, options?: JsonFileErrorOptions);
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
     private write;

package/dist/index.mjs

@@ -920,8 +920,55 @@ function isMissingFileError(error) {
   return typeof error === "object" && error !== null && error.code === "ENOENT";
 }
 
-// src/adapters/flat-file-error-adapter.ts
+// src/file-rotation.ts
 var DEFAULT_MAX_FILES = 3;
+function assertPositiveInteger(adapterName, value, name) {
+  if (!Number.isInteger(value) || value < 1) {
+    throw new RangeError(
+      `${adapterName}: ${name} must be a positive integer, received ${String(value)}.`
+    );
+  }
+}
+async function renameIfPresent(fs, from, to) {
+  try {
+    await fs.rename(from, to);
+  } catch (error) {
+    if (!isMissingFileError(error)) {
+      throw error;
+    }
+  }
+}
+async function rotateIfNeeded(fs, filePath, writeBytes, settings, report) {
+  try {
+    let currentSize;
+    try {
+      currentSize = (await fs.stat(filePath)).size;
+    } catch (error) {
+      if (isMissingFileError(error)) {
+        return;
+      }
+      throw error;
+    }
+    if (currentSize === 0 || currentSize + writeBytes <= settings.maxBytes) {
+      return;
+    }
+    await fs.rm(`${filePath}.${settings.maxFiles}`, { force: true });
+    for (let index = settings.maxFiles - 1; index >= 1; index -= 1) {
+      await renameIfPresent(
+        fs,
+        `${filePath}.${index}`,
+        `${filePath}.${index + 1}`
+      );
+    }
+    await fs.rename(filePath, `${filePath}.1`);
+  } catch (error) {
+    console.error(
+      `${report.prefix} ${report.adapterName}: could not rotate "${filePath}", so it will keep growing: ${describeError(error)}`
+    );
+  }
+}
+
+// src/adapters/flat-file-error-adapter.ts
 function escapeLineBreaks(text) {
   return text.replace(/\r?\n/g, "\\n");
 }
@@ -948,13 +995,6 @@ function formatErrorLogLine(entry) {
     `${entry.timestamp} [${entry.code}] ${source}${entry.message}${cause}`
   );
 }
-function assertPositiveInteger(value, name) {
-  if (!Number.isInteger(value) || value < 1) {
-    throw new RangeError(
-      `FlatFileErrorAdapter: ${name} must be a positive integer, received ${String(value)}.`
-    );
-  }
-}
 var FlatFileErrorAdapter = class {
   /** @throws {RangeError} if `maxBytes` or `maxFiles` is not a positive integer. */
   constructor(filePath, options = {}) {
@@ -968,9 +1008,9 @@ var FlatFileErrorAdapter = class {
     this.createDirectory = options.createDirectory ?? true;
     this.prefix = options.prefix ?? DEFAULT_PREFIX;
     if (this.maxBytes !== void 0) {
-      assertPositiveInteger(this.maxBytes, "maxBytes");
+      assertPositiveInteger("FlatFileErrorAdapter", this.maxBytes, "maxBytes");
     }
-    assertPositiveInteger(this.maxFiles, "maxFiles");
+    assertPositiveInteger("FlatFileErrorAdapter", this.maxFiles, "maxFiles");
   }
   log(entry) {
     return this.queue.run(() => this.write(entry));
@@ -982,7 +1022,15 @@ var FlatFileErrorAdapter = class {
       const line = formatted.endsWith("\n") ? formatted : `${formatted}
 `;
       await this.prepareDirectory(fs);
-      await this.rotateIfNeeded(fs, new TextEncoder().encode(line).length);
+      if (this.maxBytes !== void 0) {
+        await rotateIfNeeded(
+          fs,
+          this.filePath,
+          new TextEncoder().encode(line).length,
+          { maxBytes: this.maxBytes, maxFiles: this.maxFiles },
+          { adapterName: "FlatFileErrorAdapter", prefix: this.prefix }
+        );
+      }
       await fs.appendFile(this.filePath, line);
       return { ok: true };
     } catch (error) {
@@ -1011,64 +1059,20 @@ var FlatFileErrorAdapter = class {
     }
     this.directoryReady = true;
   }
-  /**
-   * Moves `app.log` to `app.log.1` (shifting older files up, dropping the
-   * oldest) when the next line would push it past `maxBytes`. A failed rotation
-   * is reported, but the entry is still written so it is not lost.
-   */
-  async rotateIfNeeded(fs, lineBytes) {
-    if (this.maxBytes === void 0) {
-      return;
-    }
-    try {
-      let currentSize;
-      try {
-        currentSize = (await fs.stat(this.filePath)).size;
-      } catch (error) {
-        if (isMissingFileError(error)) {
-          return;
-        }
-        throw error;
-      }
-      if (currentSize === 0 || currentSize + lineBytes <= this.maxBytes) {
-        return;
-      }
-      await fs.rm(`${this.filePath}.${this.maxFiles}`, { force: true });
-      for (let index = this.maxFiles - 1; index >= 1; index -= 1) {
-        await this.renameIfPresent(
-          fs,
-          `${this.filePath}.${index}`,
-          `${this.filePath}.${index + 1}`
-        );
-      }
-      await fs.rename(this.filePath, `${this.filePath}.1`);
-    } catch (error) {
-      console.error(
-        `${this.prefix} FlatFileErrorAdapter: could not rotate "${this.filePath}", so it will keep growing: ${describeError(error)}`
-      );
-    }
-  }
-  async renameIfPresent(fs, from, to) {
-    try {
-      await fs.rename(from, to);
-    } catch (error) {
-      if (!isMissingFileError(error)) {
-        throw error;
-      }
-    }
-  }
 };
 
 // src/adapters/json-file-error-adapter.ts
 var DEFAULT_INDENT = 2;
 var JsonFileErrorAdapter = class {
-  /** @throws {RangeError} if `maxEntries` or `indent` is invalid, or `maxEntries` is used outside array mode. */
+  /** @throws {RangeError} if `maxEntries`, `maxBytes`, `maxFiles` or `indent` is invalid, or an option is used in the wrong mode. */
   constructor(filePath, options = {}) {
     this.filePath = filePath;
     this.directoryReady = false;
     this.queue = new SerialQueue();
     this.mode = options.mode ?? "ndjson";
     this.maxEntries = options.maxEntries;
+    this.maxBytes = options.maxBytes;
+    this.maxFiles = options.maxFiles ?? DEFAULT_MAX_FILES;
     this.indent = options.indent ?? DEFAULT_INDENT;
     this.fs = options.fs;
     this.createDirectory = options.createDirectory ?? true;
@@ -1085,6 +1089,20 @@ var JsonFileErrorAdapter = class {
         );
       }
     }
+    if (this.maxBytes !== void 0 || options.maxFiles !== void 0) {
+      if (this.mode !== "ndjson") {
+        throw new RangeError(
+          `JsonFileErrorAdapter: maxBytes and maxFiles only apply to mode "ndjson", but mode is "${this.mode}". Use mode "ndjson", or use maxEntries to limit array mode.`
+        );
+      }
+      if (this.maxBytes === void 0) {
+        throw new RangeError(
+          "JsonFileErrorAdapter: maxFiles needs maxBytes; set maxBytes to turn rotation on."
+        );
+      }
+      assertPositiveInteger("JsonFileErrorAdapter", this.maxBytes, "maxBytes");
+      assertPositiveInteger("JsonFileErrorAdapter", this.maxFiles, "maxFiles");
+    }
     if (!Number.isInteger(this.indent) || this.indent < 0) {
       throw new RangeError(
         `JsonFileErrorAdapter: indent must be a non-negative integer, received ${String(this.indent)}.`
@@ -1103,8 +1121,18 @@ var JsonFileErrorAdapter = class {
       const fs = await this.getFileSystem();
       await this.prepareDirectory(fs);
       if (this.mode === "ndjson") {
-        await fs.appendFile(this.filePath, `${JSON.stringify(record)}
-`);
+        const line = `${JSON.stringify(record)}
+`;
+        if (this.maxBytes !== void 0) {
+          await rotateIfNeeded(
+            fs,
+            this.filePath,
+            new TextEncoder().encode(line).length,
+            { maxBytes: this.maxBytes, maxFiles: this.maxFiles },
+            { adapterName: "JsonFileErrorAdapter", prefix: this.prefix }
+          );
+        }
+        await fs.appendFile(this.filePath, line);
       } else {
         await this.rewriteArray(fs, record);
       }