@stonyx/logs 1.0.1-beta.18 → 1.0.1-beta.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +182 -7
- package/dist/index.d.ts +108 -0
- package/dist/index.js +47 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -57,7 +57,11 @@ const log = new Log();
|
|
|
57
57
|
|
|
58
58
|
log.info('Info: sample application has started');
|
|
59
59
|
log.warn('Warning: this is just a sample');
|
|
60
|
-
|
|
60
|
+
|
|
61
|
+
// logs to logs/error.log; a failed write rejects, and handling that rejection is required
|
|
62
|
+
// see "Handling write failures" below
|
|
63
|
+
log.error('Error: no application logic detected', true)
|
|
64
|
+
.catch(err => { /* err.code is the underlying fs error code, e.g. 'EACCES' */ });
|
|
61
65
|
```
|
|
62
66
|
|
|
63
67
|
Easily define your own logging mechanism and color-coding preference:
|
|
@@ -91,8 +95,15 @@ const log = new Log({
|
|
|
91
95
|
suffix: '\n=============================================================== \n',
|
|
92
96
|
});
|
|
93
97
|
|
|
94
|
-
log.info('Info: sample application has started')
|
|
98
|
+
log.info('Info: sample application has started')
|
|
99
|
+
.catch(err => { /* see "Handling write failures" */ });
|
|
95
100
|
```
|
|
101
|
+
|
|
102
|
+
> **Caveat:** with `logToFileByDefault: true`, every log call *except* [`debug()`](#the-debug-method)
|
|
103
|
+
> becomes a file write, and therefore returns a promise that can reject. A failing log directory turns
|
|
104
|
+
> an unhandled `log.info()` into a process-terminating rejection. See
|
|
105
|
+
> [handling write failures](#handling-write-failures).
|
|
106
|
+
|
|
96
107
|

|
|
97
108
|
|
|
98
109
|
|
|
@@ -107,6 +118,7 @@ const log = new Log({ additionalLogs: { question: 'green' } });
|
|
|
107
118
|
log.defineType('query', log.chalk().black.bgGreen);
|
|
108
119
|
|
|
109
120
|
log.question('What will a fully custom chalk color function look like?');
|
|
121
|
+
// second argument writes to file, so this can reject -- see "Handling write failures"
|
|
110
122
|
await log.query('This is what a custom chalk color setting looks like', true);
|
|
111
123
|
```
|
|
112
124
|

|
|
@@ -153,13 +165,20 @@ These methods can then be called in your application with [logging parameters](#
|
|
|
153
165
|
|
|
154
166
|
Color settings are handled by determining whether your input is a color name or a hex value (prefixed with **#**). For example, passing `red` as a color setting will utilize `chalk.red`, while passing `#ff0000` would use `chalk.hex('#ff0000')` instead. A [list of available colors](https://github.com/chalk/chalk#colors) can be found in chalks' documentation.
|
|
155
167
|
|
|
156
|
-
Additionally, these methods return a promise when `logToFile` is true, allowing you use them with `await` in an async method, or append `then()
|
|
168
|
+
Additionally, these methods return a promise when `logToFile` is true, allowing you to use them with `await` in an async method, or to append `then()`, `catch()` or `finally()`.
|
|
169
|
+
|
|
170
|
+
When `logToFile` is true that promise **can reject**, and handling the rejection is **required** --
|
|
171
|
+
see [handling write failures](#handling-write-failures) for the full contract.
|
|
157
172
|
|
|
158
173
|
```js
|
|
159
174
|
async method() {
|
|
160
|
-
|
|
175
|
+
try {
|
|
176
|
+
await log.error('error message', true);
|
|
161
177
|
|
|
162
|
-
|
|
178
|
+
// do something after logs/error.log (default) is created
|
|
179
|
+
} catch (err) {
|
|
180
|
+
// err.code is the underlying fs error code, e.g. 'EACCES'
|
|
181
|
+
}
|
|
163
182
|
}
|
|
164
183
|
```
|
|
165
184
|
|
|
@@ -177,6 +196,11 @@ JSON.stringify(content, null, 2);
|
|
|
177
196
|
|
|
178
197
|
We believe that when wanting to output complicated objects or debug **typescript** applications, there are better methods than utilizing this **Log** package. But for anyone who's fully incorporated **Log** into their project, this function offers some convenience.
|
|
179
198
|
|
|
199
|
+
`debug(content, logToFile)` writes to file on the same contract as every other log type -- a failed
|
|
200
|
+
write rejects with the underlying `fs` error and must be handled -- with one difference: `debug()`
|
|
201
|
+
ignores [`logToFileByDefault`](#configuration), so it writes to file only when you pass `true`.
|
|
202
|
+
See [handling write failures](#handling-write-failures).
|
|
203
|
+
|
|
180
204
|
### Logging Parameters
|
|
181
205
|
|
|
182
206
|
```js
|
|
@@ -186,10 +210,161 @@ log.error('error message', true, false); // content, logToFile, overwrite
|
|
|
186
210
|
| Parameter | Type | Default | Description |
|
|
187
211
|
| :---: | :---: | :---: | :--- |
|
|
188
212
|
| `content` | **String** | | Content of log that will output on your console. |
|
|
189
|
-
| `logToFile` | **Boolean** | *false* | Option to log content to file. |
|
|
213
|
+
| `logToFile` | **Boolean** | *false* | Option to log content to file. When true, the call returns a promise that rejects if the write fails -- see [handling write failures](#handling-write-failures). |
|
|
190
214
|
| `overwrite` | **Boolean** | *false <br> (true on debug())* | Option to overwrite log file, rather than append to it. This option is redundant if logToFile is false. |
|
|
191
215
|
|
|
192
216
|
**logToFile** will log to *<project-root>/logs* unless [configured](#configuration) differently during instantiation. <br>
|
|
217
|
+
|
|
218
|
+
### Handling Write Failures
|
|
219
|
+
|
|
220
|
+
Any call that writes to a file returns a promise that **rejects when the write fails**. That covers
|
|
221
|
+
`log.error(content, true)`, `log.debug(content, true)`, and every log call except `debug()` when
|
|
222
|
+
[`logToFileByDefault`](#configuration) is `true` -- `debug()` is a direct method that never consults
|
|
223
|
+
`logToFileByDefault`, so it only writes to file when you pass `true` explicitly.
|
|
224
|
+
|
|
225
|
+
That rejection is the only actionable failure signal, so every file-writing call must be awaited
|
|
226
|
+
inside `try`/`catch`, or have `.catch()` attached. The console line is written *before* the file
|
|
227
|
+
write is attempted, so a rejection means only the file copy was lost -- do not re-log the message in
|
|
228
|
+
your handler, or it prints twice.
|
|
229
|
+
|
|
230
|
+
> **A rejection is terminal. Do not retry it.**
|
|
231
|
+
>
|
|
232
|
+
> For the recoverable directory-level codes -- `ENOENT`, `EACCES`, `EPERM`, `EROFS` -- **Log** has
|
|
233
|
+
> already retried internally by the time the rejection reaches you (see
|
|
234
|
+
> [self-healing retry](#self-healing-retry) below), so that retry ran and failed too. Every other
|
|
235
|
+
> code -- `EISDIR`, `ENOTDIR` and `ENOSPC` among them -- is not itself retried, because a retry
|
|
236
|
+
> cannot help it. Either way a consumer-side retry layer races the internal self-heal or repeats a call that
|
|
237
|
+
> already cannot succeed, and only delays the disable or back-off that your error path exists to
|
|
238
|
+
> trigger.
|
|
239
|
+
>
|
|
240
|
+
> Treat the **first** rejection as the signal to disable file logging or back off, and do not attempt
|
|
241
|
+
> the write again straight away. If you do want file logging to come back without a restart, re-arm
|
|
242
|
+
> on a timer -- see [recovering after a latch](#recovering-after-a-latch).
|
|
243
|
+
|
|
244
|
+
#### What the Promise Rejects With
|
|
245
|
+
|
|
246
|
+
The rejection value is the underlying Node `fs` error - a `NodeJS.ErrnoException` passed through
|
|
247
|
+
unmodified, with `err.code`, `err.syscall`, `err.errno` and `err.path` all preserved.
|
|
248
|
+
|
|
249
|
+
```js
|
|
250
|
+
try {
|
|
251
|
+
await log.error('error message', true);
|
|
252
|
+
} catch (err) {
|
|
253
|
+
// err.code is the underlying fs error code, e.g. 'EACCES'
|
|
254
|
+
// err.syscall is the failing call, e.g. 'mkdir' or 'open'
|
|
255
|
+
}
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
Codes you are most likely to see are `EACCES` and `EPERM` (no permission to create the log directory
|
|
259
|
+
or write the log file), `ENOENT` (the directory disappeared and could not be recreated) and `EROFS`
|
|
260
|
+
(read-only filesystem) - but any error the filesystem raises reaches the caller as-is.
|
|
261
|
+
|
|
262
|
+
**An unhandled rejection terminates your process** under Node's default `--unhandled-rejections=throw`.
|
|
263
|
+
A fire-and-forget `log.error('...', true)` pointed at an unwritable log directory exits the process
|
|
264
|
+
with `Error: EACCES: permission denied, mkdir '...'`.
|
|
265
|
+
|
|
266
|
+
The recommended consumer shape is a latch that trips on the first rejection:
|
|
267
|
+
|
|
268
|
+
```js
|
|
269
|
+
let fileLoggingDisabled = false;
|
|
270
|
+
|
|
271
|
+
async function logError(message) {
|
|
272
|
+
// once file logging has failed, stay on the console
|
|
273
|
+
if (fileLoggingDisabled) return log.error(message);
|
|
274
|
+
|
|
275
|
+
try {
|
|
276
|
+
await log.error(message, true);
|
|
277
|
+
} catch (err) {
|
|
278
|
+
// the first rejection is terminal - disable, do not retry
|
|
279
|
+
fileLoggingDisabled = true;
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
That latch is deliberately terminal for the lifetime of the process: nothing in it ever re-enables
|
|
285
|
+
file logging. Records are degraded rather than lost, because the console line is still written on
|
|
286
|
+
every call -- but a consumer using the file sink for audit or compliance should treat the first
|
|
287
|
+
rejection as an **alertable** event, or fail closed, rather than degrade silently.
|
|
288
|
+
|
|
289
|
+
#### Recovering After a Latch
|
|
290
|
+
|
|
291
|
+
If file logging must come back without a restart, re-arm the latch on a **timer**, never on the next
|
|
292
|
+
log call. Hold it closed for a fixed back-off window -- a minute or more, long enough that a
|
|
293
|
+
permissions fix or a freed disk has a chance to land -- then let exactly one write through. If that
|
|
294
|
+
write rejects, latch again and lengthen the window; if it succeeds, clear the latch. Anything faster
|
|
295
|
+
is a consumer-side retry under another name.
|
|
296
|
+
|
|
297
|
+
This also decides what your operators can see. `log-write-recovered` (see
|
|
298
|
+
[structured stderr notices](#structured-stderr-notices)) is emitted **only** on a subsequent
|
|
299
|
+
successful write, and a consumer that latches off permanently never issues one. Its entire stderr
|
|
300
|
+
output for the episode is a single `log-write-failed` followed by silence, which is indistinguishable
|
|
301
|
+
from a failure that self-healed -- so an alert-clear rule keyed on `log-write-recovered` will never
|
|
302
|
+
fire for it. Either treat `log-write-failed` as latching on the operator side too, or use the timed
|
|
303
|
+
re-arm above, which is what makes a recovery notice reachable at all.
|
|
304
|
+
|
|
305
|
+
#### Self-Healing Retry
|
|
306
|
+
|
|
307
|
+
A cached log directory can outlive the directory it describes - for example, something deletes
|
|
308
|
+
`logs/` while your process is running. To cover that, a failure whose `err.code` is `ENOENT`,
|
|
309
|
+
`EACCES`, `EPERM` or `EROFS` drops the cached directory entry and retries the write **exactly once**.
|
|
310
|
+
Any other code -- `EISDIR`, `ENOTDIR`, `ENOSPC`, `EMFILE` and the rest -- does not itself trigger
|
|
311
|
+
a retry. The decision is keyed on the *first* attempt's code, so a rejection carrying one of these
|
|
312
|
+
can still arrive after a retry if conditions changed mid-call.
|
|
313
|
+
|
|
314
|
+
A retry that succeeds emits no *failure* notice: the promise resolves normally and the write counts
|
|
315
|
+
as a success, closing any failure episode already open for that directory with the usual
|
|
316
|
+
`log-write-recovered`. A rejection carrying one of those four codes has therefore already spent its
|
|
317
|
+
single retry; every other code was never retryable in the first place. The retry is per call and per
|
|
318
|
+
`Log` instance -- independent instances retry independently.
|
|
319
|
+
|
|
320
|
+
#### Structured stderr Notices
|
|
321
|
+
|
|
322
|
+
Alongside the rejection, **Log** emits a machine-parseable notice to `stderr` so that operators have
|
|
323
|
+
something to key on. The write-failure path must never re-enter the logger itself, so these notices
|
|
324
|
+
bypass all formatting and configuration: they are emitted via `console.error` as one JSON object per
|
|
325
|
+
line (JSONL), regardless of your color, prefix, suffix or path settings. Anything that wraps or
|
|
326
|
+
patches `console.error` sees them too. Notices are informational; the promise rejection is the
|
|
327
|
+
failure signal.
|
|
328
|
+
|
|
329
|
+
| Field | Value |
|
|
330
|
+
| :---: | :--- |
|
|
331
|
+
| `ts` | ISO-8601 timestamp of the notice |
|
|
332
|
+
| `surface` | Always `"stonyx-logs"` |
|
|
333
|
+
| `sessionKey` | Always `null` |
|
|
334
|
+
| `project` | Always `null` |
|
|
335
|
+
| `severity` | `"error"` for a failure, `"warn"` for a recovery |
|
|
336
|
+
| `event` | `"log-write-failed"` or `"log-write-recovered"` |
|
|
337
|
+
| `payload` | Event-specific, see below |
|
|
338
|
+
| `schemaVersion` | Always `1` |
|
|
339
|
+
|
|
340
|
+
`log-write-failed` payload:
|
|
341
|
+
|
|
342
|
+
| Field | Description |
|
|
343
|
+
| :---: | :--- |
|
|
344
|
+
| `targetLog` | Resolved path of the log file that could not be written |
|
|
345
|
+
| `path` | Resolved log *directory*, with trailing separator - this is the dedupe key |
|
|
346
|
+
| `syscall` | The failing syscall, e.g. `"mkdir"` or `"open"` |
|
|
347
|
+
| `code` | The same `err.code` carried by the rejection |
|
|
348
|
+
| `cached` | Whether the directory was already cached when the write started |
|
|
349
|
+
| `suppressedCount` | Always `0` on a failure notice |
|
|
350
|
+
|
|
351
|
+
`log-write-recovered` carries `targetLog`, `path` and `suppressedCount` only.
|
|
352
|
+
|
|
353
|
+
**Dedupe:** notices are one per failure episode, keyed on the resolved directory and scoped to the
|
|
354
|
+
`Log` instance -- the failure counters are instance state, so two instances writing to the same
|
|
355
|
+
directory emit one notice each. The first failure for a directory emits `log-write-failed`; every
|
|
356
|
+
subsequent failure for that same directory is silent. The next successful write to it emits a single
|
|
357
|
+
`log-write-recovered` carrying `suppressedCount` - the number of notices that were suppressed, i.e.
|
|
358
|
+
`N - 1` for an episode of `N` consecutive failures.
|
|
359
|
+
Every failure still rejects its own promise; only the notices are deduped.
|
|
360
|
+
|
|
361
|
+
Five consecutive failures followed by one success emit exactly these two records:
|
|
362
|
+
|
|
363
|
+
```jsonl
|
|
364
|
+
{"ts":"2026-08-29T23:08:50.343Z","surface":"stonyx-logs","sessionKey":null,"project":null,"severity":"error","event":"log-write-failed","payload":{"targetLog":"/private/tmp/my-app/logs/error.log","path":"/private/tmp/my-app/logs/","syscall":"mkdir","code":"EACCES","cached":false,"suppressedCount":0},"schemaVersion":1}
|
|
365
|
+
{"ts":"2026-08-29T23:08:50.344Z","surface":"stonyx-logs","sessionKey":null,"project":null,"severity":"warn","event":"log-write-recovered","payload":{"targetLog":"/private/tmp/my-app/logs/error.log","path":"/private/tmp/my-app/logs/","suppressedCount":4},"schemaVersion":1}
|
|
366
|
+
```
|
|
367
|
+
|
|
193
368
|
### Configuration
|
|
194
369
|
|
|
195
370
|
When instantiating **Log**, you can pass an object to customize your settings. Below is the default configuration:
|
|
@@ -213,7 +388,7 @@ const log = new Log({
|
|
|
213
388
|
|
|
214
389
|
| Option | Type | Default | Description |
|
|
215
390
|
| :---: | :---: | :---: | :--- |
|
|
216
|
-
| `logToFileByDefault` | **Boolean** | *false* | Option to change default setting for `logToFile` parameter of logging functions. |
|
|
391
|
+
| `logToFileByDefault` | **Boolean** | *false* | Option to change default setting for `logToFile` parameter of logging functions. When true, every log call except `debug()` becomes a rejectable file write -- see [handling write failures](#handling-write-failures). |
|
|
217
392
|
| `logTimestamp` | **Boolean** | *false* | Option to include timestamp in console logging. Timestamps are automatically included in file logs. |
|
|
218
393
|
| `path` | **String** | *'logs/'* | Path in which to store log files. This setting is relative to your project's root directory. |
|
|
219
394
|
| `prefix` | **String** | *''* | Prefix string to prepend all log messages for all log types with the exception of *debug*. |
|
package/dist/index.d.ts
CHANGED
|
@@ -17,21 +17,129 @@ export default class Log {
|
|
|
17
17
|
directoryCache: Map<string, Promise<void>>;
|
|
18
18
|
writeFailures: Map<string, number>;
|
|
19
19
|
[key: string]: unknown;
|
|
20
|
+
/**
|
|
21
|
+
* Logs `content` to the console in the `info` color, and to file when `logToFile` is true.
|
|
22
|
+
*
|
|
23
|
+
* **A failed file write rejects the returned promise, and that rejection is terminal - do not retry
|
|
24
|
+
* it.** `ENOENT`, `EACCES`, `EPERM` and `EROFS` have already been retried once internally by the
|
|
25
|
+
* time one reaches you; every other code (`EISDIR`, `ENOTDIR`, `ENOSPC`, `EMFILE`, ...) is never
|
|
26
|
+
* retried, because a retry cannot help it. Handle the first rejection by disabling file logging or
|
|
27
|
+
* backing off - never by writing again. The rejection value is the underlying
|
|
28
|
+
* `NodeJS.ErrnoException` with `err.code` preserved, and leaving it unhandled terminates the
|
|
29
|
+
* process.
|
|
30
|
+
*
|
|
31
|
+
* @see https://github.com/abofs/stonyx-logs#handling-write-failures
|
|
32
|
+
*/
|
|
20
33
|
info: (content: string, logToFile?: boolean, overwrite?: boolean) => Promise<void>;
|
|
34
|
+
/**
|
|
35
|
+
* Logs `content` to the console in the `warn` color, and to file when `logToFile` is true.
|
|
36
|
+
*
|
|
37
|
+
* **A failed file write rejects the returned promise, and that rejection is terminal - do not retry
|
|
38
|
+
* it.** `ENOENT`, `EACCES`, `EPERM` and `EROFS` have already been retried once internally by the
|
|
39
|
+
* time one reaches you; every other code (`EISDIR`, `ENOTDIR`, `ENOSPC`, `EMFILE`, ...) is never
|
|
40
|
+
* retried, because a retry cannot help it. Handle the first rejection by disabling file logging or
|
|
41
|
+
* backing off - never by writing again. The rejection value is the underlying
|
|
42
|
+
* `NodeJS.ErrnoException` with `err.code` preserved, and leaving it unhandled terminates the
|
|
43
|
+
* process.
|
|
44
|
+
*
|
|
45
|
+
* @see https://github.com/abofs/stonyx-logs#handling-write-failures
|
|
46
|
+
*/
|
|
21
47
|
warn: (content: string, logToFile?: boolean, overwrite?: boolean) => Promise<void>;
|
|
48
|
+
/**
|
|
49
|
+
* Logs `content` to the console in the `error` color, and to file when `logToFile` is true.
|
|
50
|
+
*
|
|
51
|
+
* **A failed file write rejects the returned promise, and that rejection is terminal - do not retry
|
|
52
|
+
* it.** `ENOENT`, `EACCES`, `EPERM` and `EROFS` have already been retried once internally by the
|
|
53
|
+
* time one reaches you; every other code (`EISDIR`, `ENOTDIR`, `ENOSPC`, `EMFILE`, ...) is never
|
|
54
|
+
* retried, because a retry cannot help it. Handle the first rejection by disabling file logging or
|
|
55
|
+
* backing off - never by writing again. The rejection value is the underlying
|
|
56
|
+
* `NodeJS.ErrnoException` with `err.code` preserved, and leaving it unhandled terminates the
|
|
57
|
+
* process.
|
|
58
|
+
*
|
|
59
|
+
* @see https://github.com/abofs/stonyx-logs#handling-write-failures
|
|
60
|
+
*/
|
|
22
61
|
error: (content: string, logToFile?: boolean, overwrite?: boolean) => Promise<void>;
|
|
23
62
|
constructor(options?: Partial<LogOptions>);
|
|
24
63
|
defineType(type: string, setting: ColorSetting, options?: Partial<LogOptions> | null): void;
|
|
25
64
|
createConvenienceMethod(type: string): void;
|
|
65
|
+
/**
|
|
66
|
+
* Validates params and applies configuration-based defaults for logging. Every convenience method
|
|
67
|
+
* created by `defineType` - including `info`, `warn` and `error` - routes through here. Note that
|
|
68
|
+
* `debug` does not: it is a direct method that never consults `logToFileByDefault`.
|
|
69
|
+
*
|
|
70
|
+
* **A failed file write rejects the returned promise, and that rejection is terminal - do not retry
|
|
71
|
+
* it.** `ENOENT`, `EACCES`, `EPERM` and `EROFS` have already been retried once internally by the
|
|
72
|
+
* time one reaches you; every other code (`EISDIR`, `ENOTDIR`, `ENOSPC`, `EMFILE`, ...) is never
|
|
73
|
+
* retried, because a retry cannot help it. Handle the first rejection by disabling file logging or
|
|
74
|
+
* backing off - never by writing again. The rejection value is the underlying
|
|
75
|
+
* `NodeJS.ErrnoException` with `err.code` preserved, and leaving it unhandled terminates the
|
|
76
|
+
* process.
|
|
77
|
+
*
|
|
78
|
+
* @see https://github.com/abofs/stonyx-logs#handling-write-failures
|
|
79
|
+
*/
|
|
26
80
|
logAction(type: string, content: string, logToFile?: boolean, overwrite?: boolean): Promise<void>;
|
|
27
81
|
getOptionForType(type: string, option: keyof LogOptions): LogOptions[keyof LogOptions];
|
|
28
82
|
chalk(): ReturnType<Color['getChalkInstance']>;
|
|
83
|
+
/**
|
|
84
|
+
* Logs to console, and conditionally to file.
|
|
85
|
+
*
|
|
86
|
+
* When `logToFile` is true this awaits `writeToFile` and propagates its rejection unchanged, so
|
|
87
|
+
* the caller receives the underlying `NodeJS.ErrnoException`. Callers must handle it: see the
|
|
88
|
+
* `writeToFile` contract below.
|
|
89
|
+
*/
|
|
29
90
|
log(content: string, type: string, logToFile: boolean, overwrite: boolean): Promise<void>;
|
|
91
|
+
/**
|
|
92
|
+
* Direct hardcoded debug method (limited file logging). Unlike the `defineType` convenience
|
|
93
|
+
* methods this does not route through `logAction`, so it never consults `logToFileByDefault` and
|
|
94
|
+
* only writes to file when `logToFile` is passed explicitly.
|
|
95
|
+
*
|
|
96
|
+
* When `logToFile` is true this awaits `writeToFile` and propagates its rejection unchanged, on
|
|
97
|
+
* exactly the same contract as `log` - see `writeToFile` below.
|
|
98
|
+
*/
|
|
30
99
|
debug(content: unknown, logToFile?: boolean, overwrite?: boolean): Promise<void>;
|
|
100
|
+
/**
|
|
101
|
+
* Writes `content` to the resolved target for `type`, creating the target's directory on first
|
|
102
|
+
* use for that directory.
|
|
103
|
+
*
|
|
104
|
+
* The returned promise rejecting with the underlying `NodeJS.ErrnoException` (with `err.code`
|
|
105
|
+
* preserved) is the sole failure signal - callers that care must handle it. The structured
|
|
106
|
+
* stderr notice emitted alongside a failure is informational only and is deduped per episode.
|
|
107
|
+
*
|
|
108
|
+
* On `ENOENT`, `EACCES`, `EPERM` or `EROFS` the cached directory entry is dropped and the write
|
|
109
|
+
* is retried exactly once. Other codes do not themselves trigger a retry; the decision is keyed
|
|
110
|
+
* on the first attempt's code.
|
|
111
|
+
*
|
|
112
|
+
* A rejection is terminal either way. For those four codes the self-heal has already run and
|
|
113
|
+
* failed by the time one escapes; the rest were never retryable, so repeating the call cannot
|
|
114
|
+
* change the outcome. Consumers must not layer their own retry on top - doing so either races the
|
|
115
|
+
* internal one or repeats a call that already cannot succeed, and delays the disable/back-off the
|
|
116
|
+
* rejection exists to trigger. The correct response to the first rejection is to stop writing.
|
|
117
|
+
* See README "Handling write failures".
|
|
118
|
+
*/
|
|
31
119
|
writeToFile(type: string, content: string, overwrite: boolean): Promise<void>;
|
|
120
|
+
/**
|
|
121
|
+
* One structured stderr notice per failure episode: an emit on the first failure, silence while
|
|
122
|
+
* it keeps failing, one recovery emit on the next success. A null payload records a success.
|
|
123
|
+
*
|
|
124
|
+
* Keyed on the directory rather than the resolved target, matching `directoryCache`: every code
|
|
125
|
+
* in the retry allowlist is a directory-level condition, so keying on the target would strand an
|
|
126
|
+
* un-reaped entry - and silently drop its suppressed count - whenever a `{date}` template rotates
|
|
127
|
+
* away from a still-failing filename.
|
|
128
|
+
*/
|
|
32
129
|
noticeWriteResult(path: string, targetLog: string, payload: Record<string, unknown> | null): void;
|
|
130
|
+
/**
|
|
131
|
+
* The write-failure path must never re-enter this logger, so notices go straight out through
|
|
132
|
+
* `console.error` as a single JSONL record, bypassing all of this package's formatting. Field
|
|
133
|
+
* order is the canonical one mandated by the framework logging schema, with the optional
|
|
134
|
+
* `schemaVersion` last.
|
|
135
|
+
*/
|
|
33
136
|
emitNotice(severity: Severity, event: string, payload: Record<string, unknown>): void;
|
|
34
137
|
resolveFilename(template: string, type: string): string;
|
|
138
|
+
/**
|
|
139
|
+
* Ensures the target's directory exists. Both write paths auto-create the file itself, so no
|
|
140
|
+
* bootstrap write is needed. `targetLog` is unused but retained for signature compatibility:
|
|
141
|
+
* resolveFilename strips separators, so the only cached invariant is the directory.
|
|
142
|
+
*/
|
|
35
143
|
validateFileAndDirectory(path: string, targetLog: string): Promise<void>;
|
|
36
144
|
sanitizePath(path: string): string;
|
|
37
145
|
}
|
package/dist/index.js
CHANGED
|
@@ -72,7 +72,21 @@ export default class Log {
|
|
|
72
72
|
createConvenienceMethod(type) {
|
|
73
73
|
this[type] = (content, logToFile, overwrite = false) => this.logAction(type, content, logToFile, overwrite);
|
|
74
74
|
}
|
|
75
|
-
|
|
75
|
+
/**
|
|
76
|
+
* Validates params and applies configuration-based defaults for logging. Every convenience method
|
|
77
|
+
* created by `defineType` - including `info`, `warn` and `error` - routes through here. Note that
|
|
78
|
+
* `debug` does not: it is a direct method that never consults `logToFileByDefault`.
|
|
79
|
+
*
|
|
80
|
+
* **A failed file write rejects the returned promise, and that rejection is terminal - do not retry
|
|
81
|
+
* it.** `ENOENT`, `EACCES`, `EPERM` and `EROFS` have already been retried once internally by the
|
|
82
|
+
* time one reaches you; every other code (`EISDIR`, `ENOTDIR`, `ENOSPC`, `EMFILE`, ...) is never
|
|
83
|
+
* retried, because a retry cannot help it. Handle the first rejection by disabling file logging or
|
|
84
|
+
* backing off - never by writing again. The rejection value is the underlying
|
|
85
|
+
* `NodeJS.ErrnoException` with `err.code` preserved, and leaving it unhandled terminates the
|
|
86
|
+
* process.
|
|
87
|
+
*
|
|
88
|
+
* @see https://github.com/abofs/stonyx-logs#handling-write-failures
|
|
89
|
+
*/
|
|
76
90
|
logAction(type, content, logToFile, overwrite) {
|
|
77
91
|
// set logToFile default based on class options when not set
|
|
78
92
|
if (logToFile === undefined)
|
|
@@ -93,7 +107,13 @@ export default class Log {
|
|
|
93
107
|
chalk() {
|
|
94
108
|
return this.color.getChalkInstance();
|
|
95
109
|
}
|
|
96
|
-
|
|
110
|
+
/**
|
|
111
|
+
* Logs to console, and conditionally to file.
|
|
112
|
+
*
|
|
113
|
+
* When `logToFile` is true this awaits `writeToFile` and propagates its rejection unchanged, so
|
|
114
|
+
* the caller receives the underlying `NodeJS.ErrnoException`. Callers must handle it: see the
|
|
115
|
+
* `writeToFile` contract below.
|
|
116
|
+
*/
|
|
97
117
|
async log(content, type, logToFile, overwrite) {
|
|
98
118
|
const logTimestamp = this.getOptionForType(type, 'logTimestamp');
|
|
99
119
|
const timestamp = `[${new Date().toLocaleString('en-US')}]`;
|
|
@@ -112,14 +132,21 @@ export default class Log {
|
|
|
112
132
|
return;
|
|
113
133
|
await this.writeToFile(type, `${timestamp} ${content}\n`, overwrite);
|
|
114
134
|
}
|
|
115
|
-
|
|
135
|
+
/**
|
|
136
|
+
* Direct hardcoded debug method (limited file logging). Unlike the `defineType` convenience
|
|
137
|
+
* methods this does not route through `logAction`, so it never consults `logToFileByDefault` and
|
|
138
|
+
* only writes to file when `logToFile` is passed explicitly.
|
|
139
|
+
*
|
|
140
|
+
* When `logToFile` is true this awaits `writeToFile` and propagates its rejection unchanged, on
|
|
141
|
+
* exactly the same contract as `log` - see `writeToFile` below.
|
|
142
|
+
*/
|
|
116
143
|
async debug(content, logToFile = false, overwrite = true) {
|
|
117
144
|
console.dir(content, { depth: 6 }); // eslint-disable-line no-console
|
|
118
145
|
if (!logToFile)
|
|
119
146
|
return;
|
|
120
147
|
await this.writeToFile('debug', JSON.stringify(content, null, 2), overwrite);
|
|
121
148
|
}
|
|
122
|
-
|
|
149
|
+
/**
|
|
123
150
|
* Writes `content` to the resolved target for `type`, creating the target's directory on first
|
|
124
151
|
* use for that directory.
|
|
125
152
|
*
|
|
@@ -128,7 +155,15 @@ export default class Log {
|
|
|
128
155
|
* stderr notice emitted alongside a failure is informational only and is deduped per episode.
|
|
129
156
|
*
|
|
130
157
|
* On `ENOENT`, `EACCES`, `EPERM` or `EROFS` the cached directory entry is dropped and the write
|
|
131
|
-
* is retried exactly once
|
|
158
|
+
* is retried exactly once. Other codes do not themselves trigger a retry; the decision is keyed
|
|
159
|
+
* on the first attempt's code.
|
|
160
|
+
*
|
|
161
|
+
* A rejection is terminal either way. For those four codes the self-heal has already run and
|
|
162
|
+
* failed by the time one escapes; the rest were never retryable, so repeating the call cannot
|
|
163
|
+
* change the outcome. Consumers must not layer their own retry on top - doing so either races the
|
|
164
|
+
* internal one or repeats a call that already cannot succeed, and delays the disable/back-off the
|
|
165
|
+
* rejection exists to trigger. The correct response to the first rejection is to stop writing.
|
|
166
|
+
* See README "Handling write failures".
|
|
132
167
|
*/
|
|
133
168
|
async writeToFile(type, content, overwrite) {
|
|
134
169
|
const path = this.getOptionForType(type, 'path');
|
|
@@ -161,7 +196,7 @@ export default class Log {
|
|
|
161
196
|
}
|
|
162
197
|
this.noticeWriteResult(path, targetLog, null);
|
|
163
198
|
}
|
|
164
|
-
|
|
199
|
+
/**
|
|
165
200
|
* One structured stderr notice per failure episode: an emit on the first failure, silence while
|
|
166
201
|
* it keeps failing, one recovery emit on the next success. A null payload records a success.
|
|
167
202
|
*
|
|
@@ -190,10 +225,11 @@ export default class Log {
|
|
|
190
225
|
});
|
|
191
226
|
}
|
|
192
227
|
}
|
|
193
|
-
|
|
194
|
-
* The write-failure path must never re-enter this logger, so notices go straight
|
|
195
|
-
* single JSONL record
|
|
196
|
-
* schema, with the optional
|
|
228
|
+
/**
|
|
229
|
+
* The write-failure path must never re-enter this logger, so notices go straight out through
|
|
230
|
+
* `console.error` as a single JSONL record, bypassing all of this package's formatting. Field
|
|
231
|
+
* order is the canonical one mandated by the framework logging schema, with the optional
|
|
232
|
+
* `schemaVersion` last.
|
|
197
233
|
*/
|
|
198
234
|
emitNotice(severity, event, payload) {
|
|
199
235
|
const ts = new Date().toISOString();
|
|
@@ -229,7 +265,7 @@ export default class Log {
|
|
|
229
265
|
// sanitize: prevent path traversal and disallow directory separators
|
|
230
266
|
return resolved.replace(/\.\./g, '').replace(/[/\\]/g, '');
|
|
231
267
|
}
|
|
232
|
-
|
|
268
|
+
/**
|
|
233
269
|
* Ensures the target's directory exists. Both write paths auto-create the file itself, so no
|
|
234
270
|
* bootstrap write is needed. `targetLog` is unused but retained for signature compatibility:
|
|
235
271
|
* resolveFilename strips separators, so the only cached invariant is the directory.
|