@holz/json-backend 0.4.0

package/dist/holz-json-backend.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const o=require("node:os");class t{constructor(e){this.stream=e.stream}processLog(e){const s=JSON.stringify({level:e.level,time:new Date().toISOString(),msg:e.message,ctx:Object.keys(e.context).length>0?e.context:void 0});this.stream.write(`${s}${o.EOL}`)}}exports.JsonBackend=t;exports.default=t;

package/dist/holz-json-backend.js

@@ -0,0 +1,19 @@
+import { EOL as s } from "node:os";
+class c {
+  constructor(t) {
+    this.stream = t.stream;
+  }
+  processLog(t) {
+    const e = JSON.stringify({
+      level: t.level,
+      time: new Date().toISOString(),
+      msg: t.message,
+      ctx: Object.keys(t.context).length > 0 ? t.context : void 0
+    });
+    this.stream.write(`${e}${s}`);
+  }
+}
+export {
+  c as JsonBackend,
+  c as default
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@holz/json-backend",
+  "version": "0.4.0",
+  "description": "Print logs as newline-delimited JSON.",
+  "type": "module",
+  "main": "./dist/holz-json-backend.cjs",
+  "module": "./dist/holz-json-backend.js",
+  "types": "./src/index.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PsychoLlama/holz",
+    "directory": "packages/holz-json-backend"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/holz-json-backend.cjs",
+      "import": "./dist/holz-json-backend.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Jesse Gibson",
+  "license": "MIT",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "keywords": [
+    "holz-backend",
+    "ndjson",
+    "structured",
+    "logging"
+  ],
+  "scripts": {
+    "prepack": "vite build",
+    "test:unit": "vitest --color --passWithNoTests",
+    "test:types": "tsc"
+  },
+  "devDependencies": {
+    "@holz/core": "0.2.0",
+    "@types/node": "^18.14.0",
+    "@vitest/coverage-c8": "0.28.5",
+    "typescript": "4.9.5",
+    "vite": "^4.0.0",
+    "vitest": "^0.28.5"
+  }
+}

package/src/__tests__/__snapshots__/json-backend.test.ts.snap

@@ -0,0 +1,9 @@
+// Vitest Snapshot v1
+
+exports[`JSON backend > prints the logs to the writable stream 1`] = `
+"{\\"level\\":\\"debug\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"shout\\"}
+{\\"level\\":\\"info\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"normal\\"}
+{\\"level\\":\\"warn\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"hmmmm\\"}
+{\\"level\\":\\"error\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"oh no\\"}
+"
+`;

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

@@ -0,0 +1,67 @@
+import { Writable } from 'node:stream';
+import { createLogger } from '@holz/core';
+import JsonBackend from '../json-backend';
+
+const CURRENT_TIME = new Date('2020-06-15T12:00:00.000Z');
+
+describe('JSON backend', () => {
+  function createStream() {
+    let output = '';
+    const stream = new Writable({
+      write(chunk, _encoding, callback) {
+        output += String(chunk);
+        callback();
+      },
+    });
+
+    return {
+      getOutput: () => output,
+      stream,
+    };
+  }
+
+  beforeEach(() => {
+    vi.useFakeTimers({
+      now: CURRENT_TIME,
+    });
+  });
+
+  afterEach(() => {
+    vi.useRealTimers();
+  });
+
+  it('prints the logs to the writable stream', () => {
+    const { stream, getOutput } = createStream();
+    const backend = new JsonBackend({ stream });
+
+    const logger = createLogger(backend);
+    logger.debug('shout');
+    logger.info('normal');
+    logger.warn('hmmmm');
+    logger.error('oh no');
+
+    expect(getOutput()).toMatchSnapshot();
+  });
+
+  it('escapes newlines and carriage returns', () => {
+    const { stream, getOutput } = createStream();
+    const backend = new JsonBackend({ stream });
+    const logger = createLogger(backend);
+
+    logger.debug('sneaky log\nwith newlines\rand carriage returns\r\n');
+
+    expect(getOutput()).toContain(
+      'sneaky log\\nwith newlines\\rand carriage returns\\r\\n'
+    );
+  });
+
+  it('includes log context', () => {
+    const { stream, getOutput } = createStream();
+    const backend = new JsonBackend({ stream });
+    const logger = createLogger(backend);
+
+    logger.debug('hello', { reqId: 'abc' });
+
+    expect(getOutput()).toContain('"reqId":"abc"');
+  });
+});

package/src/index.ts

@@ -0,0 +1 @@
+export { default, default as JsonBackend } from './json-backend';

package/src/json-backend.ts

@@ -0,0 +1,46 @@
+import type { Writable } from 'node:stream';
+import { EOL } from 'node:os';
+import type { Log, LogProcessor } from '@holz/core';
+
+/**
+ * Prints structured logs to a writable stream in NDJSON form. Optimized for
+ * log files.
+ *
+ * @example
+ * new JsonBackend({
+ *   stream: fs.createWriteStream('my-app.log', { flags: 'a' }),
+ * })
+ *
+ * @see http://ndjson.org
+ */
+export default class JsonBackend implements LogProcessor {
+  private stream: Writable;
+
+  constructor(options: Config) {
+    this.stream = options.stream;
+  }
+
+  processLog(log: Log) {
+    // Follow the order of typical log statements. Be kind to the human
+    // reader.
+    const output = JSON.stringify({
+      level: log.level,
+      time: new Date().toISOString(),
+      msg: log.message,
+      ctx: Object.keys(log.context).length > 0 ? log.context : undefined,
+    });
+
+    // 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
+    // more logs, and if we buffered it would risk running out of memory and
+    // crashing the process.
+    //
+    // It is unlikely that a file or tty will apply backpressure in practice.
+    this.stream.write(`${output}${EOL}`);
+  }
+}
+
+interface Config {
+  /** Where to print logs. */
+  stream: Writable;
+}