@stonyx/logs 1.0.1-beta.16 → 1.0.1-beta.18

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import Color, { type ColorSetting } from './color.js';
+export type Severity = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
 export interface LogOptions {
     logToFileByDefault: boolean;
     logTimestamp: boolean;
@@ -13,7 +14,12 @@ export default class Log {
     options: LogOptions;
     color: Color;
     typeOptions: Record<string, Partial<LogOptions>>;
+    directoryCache: Map<string, Promise<void>>;
+    writeFailures: Map<string, number>;
     [key: string]: unknown;
+    info: (content: string, logToFile?: boolean, overwrite?: boolean) => Promise<void>;
+    warn: (content: string, logToFile?: boolean, overwrite?: boolean) => Promise<void>;
+    error: (content: string, logToFile?: boolean, overwrite?: boolean) => Promise<void>;
     constructor(options?: Partial<LogOptions>);
     defineType(type: string, setting: ColorSetting, options?: Partial<LogOptions> | null): void;
     createConvenienceMethod(type: string): void;
@@ -23,6 +29,8 @@ export default class Log {
     log(content: string, type: string, logToFile: boolean, overwrite: boolean): Promise<void>;
     debug(content: unknown, logToFile?: boolean, overwrite?: boolean): Promise<void>;
     writeToFile(type: string, content: string, overwrite: boolean): Promise<void>;
+    noticeWriteResult(path: string, targetLog: string, payload: Record<string, unknown> | null): void;
+    emitNotice(severity: Severity, event: string, payload: Record<string, unknown>): void;
     resolveFilename(template: string, type: string): string;
     validateFileAndDirectory(path: string, targetLog: string): Promise<void>;
     sanitizePath(path: string): string;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { mkdirSync, promises as fsp } from 'fs';
+import { promises as fsp } from 'fs';
 import { fileURLToPath } from 'url';
 import { hostname } from 'os';
 import projectPath from 'path';
@@ -23,6 +23,10 @@ export default class Log {
     options;
     color;
     typeOptions = {};
+    // resolved directory -> in-flight or settled mkdir; instance-scoped so it cannot outlive its directory
+    directoryCache = new Map();
+    // resolved directory -> consecutive write failures, used to dedupe the operator notice
+    writeFailures = new Map();
     constructor(options = {}) {
         const merged = {
             ...defaultOptions,
@@ -89,7 +93,7 @@ export default class Log {
     chalk() {
         return this.color.getChalkInstance();
     }
-    // logs to console, and conditionally to file
+    // logs to console, and conditionally to file; propagates any writeToFile rejection to the caller
     async log(content, type, logToFile, overwrite) {
         const logTimestamp = this.getOptionForType(type, 'logTimestamp');
         const timestamp = `[${new Date().toLocaleString('en-US')}]`;
@@ -108,21 +112,101 @@ export default class Log {
             return;
         await this.writeToFile(type, `${timestamp} ${content}\n`, overwrite);
     }
-    // direct hardcoded debug method (log to file functionality is limited)
+    // direct hardcoded debug method (limited file logging); propagates any writeToFile rejection
     async debug(content, logToFile = false, overwrite = true) {
         console.dir(content, { depth: 6 }); // eslint-disable-line no-console
         if (!logToFile)
             return;
         await this.writeToFile('debug', JSON.stringify(content, null, 2), overwrite);
     }
+    /*
+     * Writes `content` to the resolved target for `type`, creating the target's directory on first
+     * use for that directory.
+     *
+     * The returned promise rejecting with the underlying `NodeJS.ErrnoException` (with `err.code`
+     * preserved) is the sole failure signal - callers that care must handle it. The structured
+     * stderr notice emitted alongside a failure is informational only and is deduped per episode.
+     *
+     * On `ENOENT`, `EACCES`, `EPERM` or `EROFS` the cached directory entry is dropped and the write
+     * is retried exactly once; every other code rejects on the first attempt without a retry.
+     */
     async writeToFile(type, content, overwrite) {
         const path = this.getOptionForType(type, 'path');
         const filenameTemplate = this.getOptionForType(type, 'filename');
-        const resolvedName = this.resolveFilename(filenameTemplate, type);
-        const targetLog = `${path}${resolvedName}`;
-        await this.validateFileAndDirectory(path, targetLog);
-        const fileAction = overwrite ? fsp.writeFile : fsp.appendFile;
-        await fileAction(targetLog, content);
+        const targetLog = `${path}${this.resolveFilename(filenameTemplate, type)}`;
+        const cached = this.directoryCache.has(path);
+        const attempt = async () => {
+            await this.validateFileAndDirectory(path, targetLog);
+            await (overwrite ? fsp.writeFile : fsp.appendFile)(targetLog, content);
+        };
+        try {
+            await attempt().catch(async (error) => {
+                // a warm cache can outlive its directory, so drop the entry and retry exactly once
+                if (!['ENOENT', 'EACCES', 'EPERM', 'EROFS'].includes(error?.code))
+                    throw error;
+                this.directoryCache.delete(path);
+                return attempt();
+            });
+        }
+        catch (error) {
+            const { code, syscall } = error;
+            this.noticeWriteResult(path, targetLog, {
+                targetLog,
+                path,
+                syscall,
+                code,
+                cached,
+            });
+            throw error;
+        }
+        this.noticeWriteResult(path, targetLog, null);
+    }
+    /*
+     * One structured stderr notice per failure episode: an emit on the first failure, silence while
+     * it keeps failing, one recovery emit on the next success. A null payload records a success.
+     *
+     * Keyed on the directory rather than the resolved target, matching `directoryCache`: every code
+     * in the retry allowlist is a directory-level condition, so keying on the target would strand an
+     * un-reaped entry - and silently drop its suppressed count - whenever a `{date}` template rotates
+     * away from a still-failing filename.
+     */
+    noticeWriteResult(path, targetLog, payload) {
+        const failures = this.writeFailures.get(path) ?? 0;
+        if (payload) {
+            this.writeFailures.set(path, failures + 1);
+            if (!failures) {
+                this.emitNotice('error', 'log-write-failed', {
+                    ...payload,
+                    suppressedCount: 0,
+                });
+            }
+        }
+        else if (failures) {
+            this.writeFailures.delete(path);
+            this.emitNotice('warn', 'log-write-recovered', {
+                targetLog,
+                path,
+                suppressedCount: failures - 1,
+            });
+        }
+    }
+    /*
+     * The write-failure path must never re-enter this logger, so notices go straight to stderr as a
+     * single JSONL record. Field order is the canonical one mandated by the framework logging
+     * schema, with the optional `schemaVersion` last.
+     */
+    emitNotice(severity, event, payload) {
+        const ts = new Date().toISOString();
+        console.error(JSON.stringify({
+            ts,
+            surface: 'stonyx-logs',
+            sessionKey: null,
+            project: null,
+            severity,
+            event,
+            payload,
+            schemaVersion: 1,
+        }));
     }
     // resolves template variables in a filename string
     resolveFilename(template, type) {
@@ -145,16 +229,21 @@ export default class Log {
         // sanitize: prevent path traversal and disallow directory separators
         return resolved.replace(/\.\./g, '').replace(/[/\\]/g, '');
     }
-    // attempts to create file and/or directory if they don't already exist
+    /*
+     * Ensures the target's directory exists. Both write paths auto-create the file itself, so no
+     * bootstrap write is needed. `targetLog` is unused but retained for signature compatibility:
+     * resolveFilename strips separators, so the only cached invariant is the directory.
+     */
     async validateFileAndDirectory(path, targetLog) {
-        const errorMethod = this.error || console.error;
-        mkdirSync(path, { recursive: true });
-        await fsp.access(targetLog).catch(() => {
-            fsp.writeFile(targetLog, '').catch(() => {
-                errorMethod(`Failed to create log file: ${targetLog}.`
-                    + '\n Verify that the application runner has write permissions');
-            });
-        });
+        let pending = this.directoryCache.get(path);
+        if (!pending) {
+            // cache the promise before awaiting: a flag here would let a concurrent write append first
+            pending = fsp.mkdir(path, { recursive: true }).then(() => undefined);
+            this.directoryCache.set(path, pending);
+            // never keep a poisoned entry - the next write retries from scratch
+            pending.catch(() => this.directoryCache.delete(path));
+        }
+        return pending;
     }
     // method to conditionally sanitize user configuration input
     sanitizePath(path) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonyx/logs",
-  "version": "1.0.1-beta.16",
+  "version": "1.0.1-beta.18",
   "description": "Simplified logging for node applications",
   "type": "module",
   "main": "dist/index.js",