@holz/json-backend 0.8.0 → 0.8.2-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jesse Gibson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/json-backend",
-  "version": "0.8.0",
+  "version": "0.8.2-rc.0",
   "description": "Print logs as newline-delimited JSON.",
   "type": "module",
   "repository": {
@@ -22,8 +22,7 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "keywords": [
     "holz-backend",
@@ -37,7 +36,7 @@
     "test:types": "tsc"
   },
   "devDependencies": {
-    "@holz/core": "^0.8.0",
+    "@holz/core": "^0.8.2-rc.0",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.0.8",
     "typescript": "^5.8.2",
@@ -45,5 +44,6 @@
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.8"
-  }
-}
+  },
+  "gitHead": "59a13334498d9c3f0952235ed6cb59e493558824"
+}

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

@@ -1,9 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-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

@@ -1,117 +0,0 @@
-import { Writable } from 'node:stream';
-import { createLogger } from '@holz/core';
-import { createJsonBackend } from '../json-backend';
-
-const CURRENT_TIME = new Date('2020-06-15T12:00:00.000Z');
-
-describe('JSON backend', () => {
-  const 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 = createJsonBackend({ 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 = createJsonBackend({ 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 = createJsonBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.debug('hello', { reqId: 'abc' });
-
-    expect(getOutput()).toContain('"reqId":"abc"');
-  });
-
-  it('pulls structure from errors', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createJsonBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.error('content', {
-      error: new RangeError('Testing NDJSON errors'),
-    });
-
-    const output = getOutput();
-    expect(output).toContain(
-      '"error":{"name":"RangeError","message":"Testing NDJSON errors"}',
-    );
-  });
-
-  it('detects and includes error causes', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createJsonBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.error('content', {
-      error: new Error('Testing NDJSON errors', {
-        cause: new Error('Cause'),
-      }),
-    });
-
-    const output = getOutput();
-    expect(output).toContain(
-      '"error":{"name":"Error","message":"Testing NDJSON errors","cause":{"name":"Error","message":"Cause"}}',
-    );
-  });
-
-  it('includes any enumerable properties on the object', () => {
-    class CustomError extends Error {
-      name = 'CustomError';
-      status = 418;
-    }
-
-    const { stream, getOutput } = createStream();
-    const backend = createJsonBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.error('content', {
-      error: new CustomError('Testing NDJSON errors'),
-    });
-
-    const output = getOutput();
-    expect(output).toContain('"status":418');
-  });
-});

package/src/index.ts

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

package/src/json-backend.ts

@@ -1,68 +0,0 @@
-import type { Writable } from 'node:stream';
-import { EOL } from 'node:os';
-import { level, type LogLevel, type Log, type LogProcessor } from '@holz/core';
-
-/**
- * Prints structured logs to a writable stream in NDJSON form. Optimized for
- * log files.
- *
- * @example
- * createJsonBackend({
- *   stream: fs.createWriteStream('my-app.log', { flags: 'a' }),
- * })
- *
- * @see http://ndjson.org
- */
-export const createJsonBackend = ({ stream }: Config): LogProcessor => {
-  return (log: Log) => {
-    // Follow the order of typical log statements. Be kind to the human
-    // reader.
-    const output = JSON.stringify(
-      {
-        level: labelForLevel[log.level],
-        time: new Date(log.timestamp).toISOString(),
-        msg: log.message,
-        ctx: Object.keys(log.context).length > 0 ? log.context : undefined,
-      },
-      errorSerializer,
-    );
-
-    // 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.
-    stream.write(`${output}${EOL}`);
-  };
-};
-
-/**
- * Errors are not JSON serializable, but errors are naturally a crucial aspect
- * of any logging system. This unwraps errors into a JSON representation.
- */
-const errorSerializer = (_key: string, value: unknown) => {
-  if (value instanceof Error) {
-    return {
-      ...value, // Some custom errors have important custom properties.
-      name: value.name,
-      message: value.message,
-      cause: value.cause,
-    };
-  }
-
-  return value;
-};
-
-/**
- * Slightly heavier than logging the number, but easier to process
- * programmatically which is somewhat implied by a JSON backend.
- */
-const labelForLevel = Object.fromEntries(
-  Object.entries(level).map(([key, value]) => [value, key]),
-) as Record<LogLevel, string>;
-
-interface Config {
-  /** Where to print logs. */
-  stream: Writable;
-}