@holz/stream-backend 0.8.0 → 0.8.2

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/stream-backend",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Print logs to stdout or a file.",
   "type": "module",
   "repository": {
@@ -22,8 +22,7 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "keywords": [
     "holz-backend",
@@ -40,7 +39,7 @@
     "@holz/core": "^0.8.0"
   },
   "devDependencies": {
-    "@holz/core": "^0.8.0",
+    "@holz/core": "^0.8.2",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.0.8",
     "typescript": "^5.8.2",
@@ -48,5 +47,6 @@
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.8"
-  }
-}
+  },
+  "gitHead": "f099a09cd01834de9bc1714908183cbb7b828c85"
+}

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

@@ -1,149 +0,0 @@
-import { Writable } from 'node:stream';
-import { createLogger } from '@holz/core';
-import { createStreamBackend } from '../stream-backend';
-
-const CURRENT_TIME = new Date('2020-06-15T12:00:00.000Z');
-
-describe('Stream 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 = 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 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
-      "
-    `);
-  });
-
-  it('includes the log namespace', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createStreamBackend({ stream });
-    const logger = createLogger(backend)
-      .namespace('my-lib')
-      .namespace('MyClass');
-
-    logger.debug('initialized');
-
-    expect(getOutput()).toContain('[my-lib:MyClass]');
-  });
-
-  it('does not print the log namespace if it is empty', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createStreamBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.debug('orphan log');
-
-    expect(getOutput()).not.toContain('[]');
-  });
-
-  it('includes the log context', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createStreamBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.info('creating session', { sessionId: 3109, enabled: true });
-
-    expect(getOutput()).toContain('sessionId=3109');
-    expect(getOutput()).toContain('enabled=true');
-  });
-
-  it('includes the timestamp for each log', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createStreamBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.info('traveling through time');
-
-    expect(getOutput()).toContain(CURRENT_TIME.toISOString());
-  });
-
-  it('wraps strings in log context with quotes', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createStreamBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.info('creating session', { code: 'ENOBACON' });
-
-    expect(getOutput()).toContain('code="ENOBACON"');
-  });
-
-  it('joins arrays in log context', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createStreamBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.info('adding tags', { tags: ['important', 'urgent'] });
-
-    expect(getOutput()).toContain('tags=["important","urgent"]');
-  });
-
-  it('indents multi-line log statements', () => {
-    const { stream, getOutput } = createStream();
-    const backend = createStreamBackend({ stream });
-    const logger = createLogger(backend);
-
-    logger.info('multi-line log\r\nwith a second line\nand a third line');
-
-    expect(getOutput()).toMatchInlineSnapshot(`
-      "2020-06-15T12:00:00.000Z INFO  multi-line log
-                                     with a second line
-                                     and a third line
-      "
-    `);
-  });
-
-  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/index.ts

@@ -1 +0,0 @@
-export { createStreamBackend } from './stream-backend';

package/src/stream-backend.ts

@@ -1,70 +0,0 @@
-import type { Writable } from 'node:stream';
-import { EOL } from 'node:os';
-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.
- *
- * @example
- * createStreamBackend({
- *   stream: fs.createWriteStream('my-app.log', { flags: 'a' }),
- * })
- */
-export const createStreamBackend = ({ stream }: Config): LogProcessor => {
-  return (log: Log) => {
-    const { error, ...plainContext } = log.context;
-    const time = new Date(log.timestamp).toISOString();
-    const level = LOG_LEVELS[log.level];
-    const context = stringifyContext(plainContext);
-    const namespace = log.origin.length ? `[${log.origin.join(':')}] ` : '';
-
-    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
-    // 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}${errorMessage}`);
-  };
-};
-
-/**
- * Some messages will ruin your output without proper indentation. Stack
- * traces are a good example of this.
- *
- * Supports Unix + DOS line endings.
- */
-const multilineIndent = (offset: number, message: string) =>
-  message.replace(/(\r?\n)/g, (newline) => newline + ' '.repeat(offset));
-
-// { id: 123, type: 'article' } -> 'id=123 type="article"'
-const stringifyContext = (context: LogContext) =>
-  Object.entries(context)
-    .map(([key, value]) => `${key}=${JSON.stringify(value)}`)
-    .join(' ');
-
-const LOG_LEVELS: Record<LogLevel, string> = {
-  [level.trace]: 'TRACE',
-  [level.debug]: 'DEBUG',
-  [level.info]: 'INFO ',
-  [level.warn]: 'WARN ',
-  [level.error]: 'ERROR',
-  [level.fatal]: 'FATAL',
-};
-
-interface Config {
-  /** Where to print logs. Normally `process.stderr`. */
-  stream: Writable;
-}