@holz/console-backend 0.8.0-rc.3 → 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/console-backend",
-  "version": "0.8.0-rc.3",
+  "version": "0.8.2-rc.0",
   "description": "A console backend for Holz",
   "type": "module",
   "repository": {
@@ -22,8 +22,7 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "keywords": [
     "holz-backend",
@@ -37,10 +36,10 @@
     "test:types": "tsc"
   },
   "peerDependencies": {
-    "@holz/core": "^0.8.0-rc.3"
+    "@holz/core": "^0.8.0"
   },
   "devDependencies": {
-    "@holz/core": "^0.8.0-rc.3",
+    "@holz/core": "^0.8.2-rc.0",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.0.8",
     "typescript": "^5.8.2",
@@ -49,5 +48,5 @@
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.8"
   },
-  "stableVersion": "0.7.0"
-}
+  "gitHead": "59a13334498d9c3f0952235ed6cb59e493558824"
+}

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

@@ -1,85 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Console backend > avoids changing debug messages 1`] = `
-[
-  "%s %o %c%s %c%s",
-  "just spam",
-  {
-    "id": 1234,
-  },
-  "color: gray",
-  "+0ms",
-  "color: rgba(128, 128, 128, 0.6); font-style: italic",
-  "ns-1:ns-2",
-]
-`;
-
-exports[`Console backend > avoids changing error messages 1`] = `
-[
-  "%s %o %c%s %c%s",
-  "some error message",
-  {
-    "id": 1234,
-  },
-  "color: gray",
-  "+0ms",
-  "color: rgba(128, 128, 128, 0.6); font-style: italic",
-  "ns-1:ns-2",
-]
-`;
-
-exports[`Console backend > avoids changing fatal messages 1`] = `
-[
-  "%s %o %c%s %c%s",
-  "a fatal error",
-  {
-    "id": 1234,
-  },
-  "color: gray",
-  "+0ms",
-  "color: rgba(128, 128, 128, 0.6); font-style: italic",
-  "ns-1:ns-2",
-]
-`;
-
-exports[`Console backend > avoids changing info messages 1`] = `
-[
-  "%s %o %c%s %c%s",
-  "a little info",
-  {
-    "id": 1234,
-  },
-  "color: gray",
-  "+0ms",
-  "color: rgba(128, 128, 128, 0.6); font-style: italic",
-  "ns-1:ns-2",
-]
-`;
-
-exports[`Console backend > avoids changing trace messages 1`] = `
-[
-  "%s %o %c%s %c%s",
-  "noise",
-  {
-    "id": 1234,
-  },
-  "color: gray",
-  "+0ms",
-  "color: rgba(128, 128, 128, 0.6); font-style: italic",
-  "ns-1:ns-2",
-]
-`;
-
-exports[`Console backend > avoids changing warn messages 1`] = `
-[
-  "%s %o %c%s %c%s",
-  "a warning",
-  {
-    "id": 1234,
-  },
-  "color: gray",
-  "+0ms",
-  "color: rgba(128, 128, 128, 0.6); font-style: italic",
-  "ns-1:ns-2",
-]
-`;

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

@@ -1,137 +0,0 @@
-import { format } from 'util';
-import { createLogger } from '@holz/core';
-import type { MinimalConsole } from '../console-backend';
-import { createConsoleBackend } from '../console-backend';
-
-class MockConsole implements MinimalConsole {
-  private fmt = (level: string, ...strings: Array<unknown>) => {
-    this.print(format(level, ...strings));
-  };
-
-  trace = vi.fn(this.fmt);
-  debug = vi.fn(this.fmt);
-  info = vi.fn(this.fmt);
-  warn = vi.fn(this.fmt);
-  error = vi.fn(this.fmt);
-
-  // Approximation of what gets printed.
-  print = vi.fn();
-}
-
-describe('Console backend', () => {
-  beforeEach(() => {
-    vi.useFakeTimers({
-      now: new Date('2020-01-01T00:00:00.000Z'),
-    });
-  });
-
-  afterEach(() => {
-    vi.useRealTimers();
-  });
-
-  it('prints messages to the console', () => {
-    const output = new MockConsole();
-    const backend = createConsoleBackend({ console: output });
-
-    const logger = createLogger(backend);
-    logger.info('hello world');
-
-    expect(output.print).toHaveBeenCalledWith(
-      expect.stringContaining('hello world'),
-    );
-  });
-
-  it('includes the log namespace', () => {
-    const output = new MockConsole();
-    const backend = createConsoleBackend({ console: output });
-    const logger = createLogger(backend)
-      .namespace('my-lib')
-      .namespace('MyClass');
-
-    logger.debug('initialized');
-
-    expect(output.print).toHaveBeenCalledWith(
-      expect.stringContaining('my-lib:MyClass'),
-    );
-  });
-
-  it('includes the log context', () => {
-    const output = new MockConsole();
-    const backend = createConsoleBackend({ console: output });
-    const logger = createLogger(backend);
-
-    logger.info('creating session', { sessionId: 3109 });
-
-    // Hard to test without replicating the implementation.
-    expect(output.print).toHaveBeenCalledWith(
-      expect.stringContaining('sessionId'),
-    );
-
-    expect(output.print).toHaveBeenCalledWith(expect.stringContaining('3109'));
-  });
-
-  it('does not include the log context if it is empty', () => {
-    const output = new MockConsole();
-    const backend = createConsoleBackend({ console: output });
-    const logger = createLogger(backend);
-
-    logger.warn('activating death ray', {});
-
-    // Hard to test without replicating the implementation.
-    expect(output.print).not.toHaveBeenCalledWith(expect.stringContaining('{'));
-
-    expect(output.print).not.toHaveBeenCalledWith(expect.stringContaining('}'));
-  });
-
-  it('prints the time since the last log', () => {
-    const output = new MockConsole();
-    const backend = createConsoleBackend({ console: output });
-    const logger = createLogger(backend);
-
-    logger.info('first message');
-    vi.advanceTimersByTime(1000);
-    logger.info('second message');
-
-    expect(output.print).toHaveBeenCalledWith(expect.stringContaining('+1s'));
-  });
-
-  // Snapshot the exact output of each log level. This mostly prevents
-  // regressions while doing innocent refactors.
-  it.each([
-    ['trace' as const, 'noise', ['ns-1', 'ns-2'], 'trace' as const],
-    ['debug' as const, 'just spam', ['ns-1', 'ns-2'], 'debug' as const],
-    ['info' as const, 'a little info', ['ns-1', 'ns-2'], 'info' as const],
-    ['warn' as const, 'a warning', ['ns-1', 'ns-2'], 'warn' as const],
-    [
-      'error' as const,
-      'some error message',
-      ['ns-1', 'ns-2'],
-      'error' as const,
-    ],
-    ['fatal' as const, 'a fatal error', ['ns-1', 'ns-2'], 'error' as const],
-  ])('avoids changing %s messages', (method, message, namespace, pipe) => {
-    const output = new MockConsole();
-    const backend = createConsoleBackend({ console: output });
-    const logger = namespace.reduce(
-      (logger, ns) => logger.namespace(ns),
-      createLogger(backend),
-    );
-
-    logger[method](message, { id: 1234 });
-
-    expect(output[pipe].mock.calls[0]).toMatchSnapshot();
-  });
-
-  it('includes the error object', () => {
-    const output = new MockConsole();
-    const backend = createConsoleBackend({ console: output });
-    const logger = createLogger(backend).namespace('hi');
-
-    const error = new Error('boom');
-    logger.error('an error occurred', { error });
-
-    expect(output.print).toHaveBeenCalledWith(
-      expect.stringContaining('Error: boom'),
-    );
-  });
-});

package/src/__tests__/time-delta.test.ts

@@ -1,29 +0,0 @@
-import { timeDelta } from '../time-delta';
-
-describe('timeDelta', () => {
-  it('formats the difference in human-readable time', () => {
-    expect(timeDelta(new Date(0), new Date(0))).toBe('+0ms');
-    expect(timeDelta(new Date(1), new Date(0))).toBe('+1ms');
-    expect(timeDelta(new Date(999), new Date(0))).toBe('+999ms');
-    expect(timeDelta(new Date(1_000), new Date(0))).toBe('+1s');
-
-    expect(timeDelta(new Date(1_499), new Date(0))).toBe('+1s');
-    expect(timeDelta(new Date(1_500), new Date(0))).toBe('+2s');
-
-    // Not quite a full minute. Kinda weird, but only if you think about it.
-    expect(timeDelta(new Date(59_999), new Date(0))).toBe('+60s');
-
-    expect(timeDelta(new Date(60_000), new Date(0))).toBe('+1m');
-    expect(timeDelta(new Date(3_600_000), new Date(0))).toBe('+1h');
-    expect(timeDelta(new Date(86_400_000), new Date(0))).toBe('+1d');
-  });
-
-  it('uses the current time if the last point is unknown', () => {
-    expect(timeDelta(new Date(0))).toBe('+0ms');
-  });
-
-  it('handles negative time differences', () => {
-    expect(timeDelta(new Date(0), new Date(1))).toBe('-1ms');
-    expect(timeDelta(new Date(0), new Date(60_000))).toBe('-1m');
-  });
-});

package/src/console-backend.ts

@@ -1,81 +0,0 @@
-import { level, type LogLevel, type Log, type LogProcessor } from '@holz/core';
-import { timeDelta } from './time-delta';
-
-/**
- * A backend that pretty-prints logs to a browser console, or any
- * remote-attached console.
- */
-export const createConsoleBackend = (options: Options = {}): LogProcessor => {
-  const output = options.console ?? console;
-  let lastTimestamp: Date;
-
-  return (log: Log) => {
-    const time = new Date(log.timestamp);
-    const { error, ...plainContext } = log.context;
-
-    const segments = [
-      {
-        include: true,
-        format: '%s',
-        values: [log.message],
-      },
-      {
-        include: Object.keys(plainContext).length > 0,
-        format: '%o', // Chrome hides object content with `%O`.
-        values: [plainContext],
-      },
-      {
-        include: true,
-        format: '%c%s',
-        values: ['color: gray', timeDelta(time, lastTimestamp)],
-      },
-      {
-        include: log.origin.length > 0,
-        format: '%c%s',
-        values: [
-          'color: rgba(128, 128, 128, 0.6); font-style: italic',
-          log.origin.join(':'),
-        ],
-      },
-      {
-        include: error,
-        format: '%o',
-        values: [error],
-      },
-    ].filter((segment) => segment.include);
-
-    const format = segments.map((segment) => segment.format).join(' ');
-    const values = segments.flatMap<unknown>((segment) => segment.values);
-
-    // Browsers have UIs for filtering by log level. Leverage that.
-    output[sink[log.level]](format, ...values);
-
-    // Track the time spent between logs.
-    lastTimestamp = time;
-  };
-};
-
-const sink: Record<LogLevel, keyof MinimalConsole> = {
-  [level.trace]: 'trace',
-  [level.debug]: 'debug',
-  [level.info]: 'info',
-  [level.warn]: 'warn',
-  [level.error]: 'error',
-  [level.fatal]: 'error',
-};
-
-interface Options {
-  console?: MinimalConsole;
-}
-
-/**
- * A subset of the Console interface. Must support printf-style interpolation.
- * @see https://console.spec.whatwg.org/#formatting-specifiers
- *
- * Note that `fatal` has no corresponding equivalent. It will be downgraded to
- * `error` when printed.
- */
-export type MinimalConsole = Pick<
-  Console,
-  'trace' | 'debug' | 'info' | 'warn' | 'error'
->;

package/src/index.ts

@@ -1 +0,0 @@
-export { createConsoleBackend } from './console-backend';

package/src/time-delta.ts

@@ -1,33 +0,0 @@
-const second = 1_000;
-const minute = 60 * second;
-const hour = 60 * minute;
-const day = 24 * hour;
-
-/**
- * Formats the difference between two dates in human-readable time.
- *
- * Inspired by the `ms` package. Thanks TJ.
- */
-export const timeDelta = (now: Date, then: Date = now) => {
-  const offset = now.getTime() - then.getTime();
-  const distance = Math.abs(offset);
-  const sign = offset < 0 ? '' : '+';
-
-  if (distance >= day) {
-    return `${sign}${Math.round(offset / day)}d`;
-  }
-
-  if (distance >= hour) {
-    return `${sign}${Math.round(offset / hour)}h`;
-  }
-
-  if (distance >= minute) {
-    return `${sign}${Math.round(offset / minute)}m`;
-  }
-
-  if (distance >= second) {
-    return `${sign}${Math.round(offset / second)}s`;
-  }
-
-  return `${sign}${offset}ms`;
-};