@holz/stream-backend 0.7.0 → 0.8.0-rc.2

package/README.md

@@ -14,7 +14,7 @@ import * as fs from 'fs';
 createLogger(
   createStreamBackend({
     stream: fs.createWriteStream('server.log', { flags: 'a' }),
-  })
+  }),
 );
 ```
 

package/dist/holz-stream-backend.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("node:os"),r=require("@holz/core");function l({stream:t}){return e=>{const n=new Date().toISOString(),i=m[e.level],o=$(e.context),s=e.origin.length?`[${e.origin.join(":")}] `:"",c=`${n} ${i} ${s}`,a=L(c.length,e.message),u=`${c}${a}${o?" "+o:""}`;t.write(`${u}${g.EOL}`)}}function L(t,e){return e.replace(/(\r?\n)/g,n=>n+" ".repeat(t))}function $(t){return Object.entries(t).map(([e,n])=>`${e}=${JSON.stringify(n)}`).join(" ")}const m={[r.LogLevel.Debug]:"DEBUG",[r.LogLevel.Info]:"INFO ",[r.LogLevel.Warn]:"WARN ",[r.LogLevel.Error]:"ERROR"};exports.createStreamBackend=l;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("node:os"),g=require("node:util"),n=require("@holz/core"),p=({stream:r})=>e=>{const{error:t,...i}=e.context,a=new Date(e.timestamp).toISOString(),l=S[e.level],o=O(i),u=e.origin.length?`[${e.origin.join(":")}] `:"",s=`${a} ${l} ${u}`,$=v(s.length,e.message),m=`${s}${$}${o?" "+o:""}`,d=t?g.inspect(t,{colors:!1})+c.EOL:"";r.write(`${m}${c.EOL}${d}`)},v=(r,e)=>e.replace(/(\r?\n)/g,t=>t+" ".repeat(r)),O=r=>Object.entries(r).map(([e,t])=>`${e}=${JSON.stringify(t)}`).join(" "),S={[n.level.trace]:"TRACE",[n.level.debug]:"DEBUG",[n.level.info]:"INFO ",[n.level.warn]:"WARN ",[n.level.error]:"ERROR",[n.level.fatal]:"FATAL"};exports.createStreamBackend=p;

package/dist/holz-stream-backend.d.ts

@@ -14,6 +14,6 @@ declare interface Config {
  *   stream: fs.createWriteStream('my-app.log', { flags: 'a' }),
  * })
  */
-export declare function createStreamBackend({ stream }: Config): LogProcessor;
+export declare const createStreamBackend: ({ stream }: Config) => LogProcessor;
 
 export { }

package/dist/holz-stream-backend.js

@@ -1,23 +1,17 @@
-import { EOL as u } from "node:os";
-import { LogLevel as r } from "@holz/core";
-function l({ stream: t }) {
-  return (e) => {
-    const n = (/* @__PURE__ */ new Date()).toISOString(), c = g[e.level], o = f(e.context), s = e.origin.length ? `[${e.origin.join(":")}] ` : "", i = `${n} ${c} ${s}`, a = $(i.length, e.message), m = `${i}${a}${o ? " " + o : ""}`;
-    t.write(`${m}${u}`);
-  };
-}
-function $(t, e) {
-  return e.replace(/(\r?\n)/g, (n) => n + " ".repeat(t));
-}
-function f(t) {
-  return Object.entries(t).map(([e, n]) => `${e}=${JSON.stringify(n)}`).join(" ");
-}
-const g = {
-  [r.Debug]: "DEBUG",
-  [r.Info]: "INFO ",
-  [r.Warn]: "WARN ",
-  [r.Error]: "ERROR"
+import { EOL as c } from "node:os";
+import { inspect as g } from "node:util";
+import { level as n } from "@holz/core";
+const S = ({ stream: r }) => (e) => {
+  const { error: t, ...i } = e.context, a = new Date(e.timestamp).toISOString(), m = u[e.level], o = E(i), p = e.origin.length ? `[${e.origin.join(":")}] ` : "", s = `${a} ${m} ${p}`, $ = O(s.length, e.message), l = `${s}${$}${o ? " " + o : ""}`, f = t ? g(t, { colors: !1 }) + c : "";
+  r.write(`${l}${c}${f}`);
+}, O = (r, e) => e.replace(/(\r?\n)/g, (t) => t + " ".repeat(r)), E = (r) => Object.entries(r).map(([e, t]) => `${e}=${JSON.stringify(t)}`).join(" "), u = {
+  [n.trace]: "TRACE",
+  [n.debug]: "DEBUG",
+  [n.info]: "INFO ",
+  [n.warn]: "WARN ",
+  [n.error]: "ERROR",
+  [n.fatal]: "FATAL"
 };
 export {
-  l as createStreamBackend
+  S as createStreamBackend
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/stream-backend",
-  "version": "0.7.0",
+  "version": "0.8.0-rc.2",
   "description": "Print logs to stdout or a file.",
   "type": "module",
   "repository": {
@@ -37,16 +37,17 @@
     "test:types": "tsc"
   },
   "peerDependencies": {
-    "@holz/core": "^0.7.0"
+    "@holz/core": "^0.8.0-rc.2"
   },
   "devDependencies": {
-    "@holz/core": "^0.7.0",
+    "@holz/core": "^0.8.0-rc.2",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.0.8",
-    "typescript": "^5.0.0",
+    "typescript": "^5.8.2",
     "vite": "^6.0.0",
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.8"
-  }
+  },
+  "stableVersion": "0.7.0"
 }

package/src/__tests__/stream-backend.test.ts

@@ -5,7 +5,7 @@ import { createStreamBackend } from '../stream-backend';
 const CURRENT_TIME = new Date('2020-06-15T12:00:00.000Z');
 
 describe('Stream backend', () => {
-  function createStream() {
+  const createStream = () => {
     let output = '';
     const stream = new Writable({
       write(chunk, _encoding, callback) {
@@ -18,7 +18,7 @@ describe('Stream backend', () => {
       getOutput: () => output,
       stream,
     };
-  }
+  };
 
   beforeEach(() => {
     vi.useFakeTimers({
@@ -35,16 +35,20 @@ describe('Stream backend', () => {
     const backend = createStreamBackend({ stream });
 
     const logger = createLogger(backend);
+    logger.trace('scream');
     logger.debug('shout');
     logger.info('normal');
     logger.warn('hmmmm');
     logger.error('oh no');
+    logger.fatal('goodbye');
 
     expect(getOutput()).toMatchInlineSnapshot(`
-      "2020-06-15T12:00:00.000Z DEBUG shout
+      "2020-06-15T12:00:00.000Z TRACE scream
+      2020-06-15T12:00:00.000Z DEBUG shout
       2020-06-15T12:00:00.000Z INFO  normal
       2020-06-15T12:00:00.000Z WARN  hmmmm
       2020-06-15T12:00:00.000Z ERROR oh no
+      2020-06-15T12:00:00.000Z FATAL goodbye
       "
     `);
   });
@@ -126,4 +130,20 @@ describe('Stream backend', () => {
       "
     `);
   });
+
+  it('serializes errors included in log context', () => {
+    const { stream, getOutput } = createStream();
+    const backend = createStreamBackend({ stream });
+    const logger = createLogger(backend);
+
+    const error = new Error('Testing error serialization');
+    logger.error('something went wrong', { error });
+
+    // Make sure it shows up, but don't test the stack trace. Too volatile.
+    expect(getOutput().split('\n').slice(0, 2).join('\n'))
+      .toMatchInlineSnapshot(`
+        "2020-06-15T12:00:00.000Z ERROR something went wrong
+        Error: Testing error serialization"
+      `);
+  });
 });

package/src/stream-backend.ts

@@ -1,7 +1,13 @@
 import type { Writable } from 'node:stream';
 import { EOL } from 'node:os';
-import { LogLevel } from '@holz/core';
-import type { Log, LogContext, LogProcessor } from '@holz/core';
+import { inspect } from 'node:util';
+import {
+  level,
+  type LogLevel,
+  type Log,
+  type LogContext,
+  type LogProcessor,
+} from '@holz/core';
 
 /**
  * Prints logs to a writable stream in plaintext. Optimized for log files.
@@ -11,16 +17,18 @@ import type { Log, LogContext, LogProcessor } from '@holz/core';
  *   stream: fs.createWriteStream('my-app.log', { flags: 'a' }),
  * })
  */
-export function createStreamBackend({ stream }: Config): LogProcessor {
+export const createStreamBackend = ({ stream }: Config): LogProcessor => {
   return (log: Log) => {
-    const currentTime = new Date().toISOString();
+    const { error, ...plainContext } = log.context;
+    const time = new Date(log.timestamp).toISOString();
     const level = LOG_LEVELS[log.level];
-    const context = stringifyContext(log.context);
+    const context = stringifyContext(plainContext);
     const namespace = log.origin.length ? `[${log.origin.join(':')}] ` : '';
 
-    const header = `${currentTime} ${level} ${namespace}`;
+    const header = `${time} ${level} ${namespace}`;
     const message = multilineIndent(header.length, log.message);
     const output = `${header}${message}${context ? ' ' + context : ''}`;
+    const errorMessage = error ? inspect(error, { colors: false }) + EOL : '';
 
     // NOTE: If the stream applies backpressure, we will lose logs. I believe
     // this is the right tradeoff. We can't prevent the app from generating
@@ -28,9 +36,9 @@ export function createStreamBackend({ stream }: Config): LogProcessor {
     // crashing the process.
     //
     // It is unlikely that a file or tty will apply backpressure in practice.
-    stream.write(`${output}${EOL}`);
+    stream.write(`${output}${EOL}${errorMessage}`);
   };
-}
+};
 
 /**
  * Some messages will ruin your output without proper indentation. Stack
@@ -38,22 +46,22 @@ export function createStreamBackend({ stream }: Config): LogProcessor {
  *
  * Supports Unix + DOS line endings.
  */
-function multilineIndent(offset: number, message: string) {
-  return message.replace(/(\r?\n)/g, (newline) => newline + ' '.repeat(offset));
-}
+const multilineIndent = (offset: number, message: string) =>
+  message.replace(/(\r?\n)/g, (newline) => newline + ' '.repeat(offset));
 
 // { id: 123, type: 'article' } -> 'id=123 type="article"'
-function stringifyContext(context: LogContext) {
-  return Object.entries(context)
+const stringifyContext = (context: LogContext) =>
+  Object.entries(context)
     .map(([key, value]) => `${key}=${JSON.stringify(value)}`)
     .join(' ');
-}
 
 const LOG_LEVELS: Record<LogLevel, string> = {
-  [LogLevel.Debug]: 'DEBUG',
-  [LogLevel.Info]: 'INFO ',
-  [LogLevel.Warn]: 'WARN ',
-  [LogLevel.Error]: 'ERROR',
+  [level.trace]: 'TRACE',
+  [level.debug]: 'DEBUG',
+  [level.info]: 'INFO ',
+  [level.warn]: 'WARN ',
+  [level.error]: 'ERROR',
+  [level.fatal]: 'FATAL',
 };
 
 interface Config {