@holz/log-collector 0.8.0-rc.1 → 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/log-collector",
-  "version": "0.8.0-rc.1",
+  "version": "0.8.2-rc.0",
   "description": "Send all logs to a central collector",
   "type": "module",
   "repository": {
@@ -22,8 +22,7 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "keywords": [
     "holz",
@@ -37,10 +36,10 @@
     "test:types": "tsc"
   },
   "peerDependencies": {
-    "@holz/core": "^0.8.0-rc.2"
+    "@holz/core": "^0.8.0"
   },
   "devDependencies": {
-    "@holz/core": "^0.8.0-rc.2",
+    "@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__/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__/log-collector.test.ts

@@ -1,76 +0,0 @@
-import { createLogger, level } from '@holz/core';
-import {
-  createLogCollector,
-  unsetGlobalLogCollector,
-  setGlobalLogCollector,
-} from '../index';
-
-const CURRENT_TIME = new Date('2010-10-01T00:00:00Z').getTime();
-
-vi.setSystemTime(CURRENT_TIME);
-
-describe('log collector', () => {
-  afterEach(() => {
-    unsetGlobalLogCollector();
-  });
-
-  describe('createLogInterceptor', () => {
-    it('sends logs to the default backend', () => {
-      const fallback = vi.fn();
-      const logger = createLogger(createLogCollector({ fallback }));
-
-      logger.info('test message');
-      expect(fallback).toHaveBeenCalledOnce();
-      expect(fallback).toHaveBeenCalledWith({
-        timestamp: CURRENT_TIME,
-        message: 'test message',
-        level: level.info,
-        origin: [],
-        context: {},
-      });
-    });
-
-    it('sends logs to the interceptor if defined', () => {
-      const interceptor = vi.fn();
-      const fallback = vi.fn();
-      const logger = createLogger(createLogCollector({ fallback }));
-
-      setGlobalLogCollector({
-        processor: interceptor,
-      });
-
-      logger.info('test message');
-      expect(fallback).not.toHaveBeenCalled();
-      expect(interceptor).toHaveBeenCalledOnce();
-      expect(interceptor).toHaveBeenCalledWith({
-        timestamp: CURRENT_TIME,
-        message: 'test message',
-        level: level.info,
-        origin: [],
-        context: {},
-      });
-    });
-
-    it('uses the default backend if the interceptor does not match', () => {
-      const interceptor = vi.fn();
-      const fallback = vi.fn();
-      const logger = createLogger(createLogCollector({ fallback }));
-
-      setGlobalLogCollector({
-        processor: interceptor,
-        condition: () => false,
-      });
-
-      logger.info('test message');
-      expect(interceptor).not.toHaveBeenCalled();
-      expect(fallback).toHaveBeenCalledOnce();
-      expect(fallback).toHaveBeenCalledWith({
-        timestamp: CURRENT_TIME,
-        message: 'test message',
-        level: level.info,
-        origin: [],
-        context: {},
-      });
-    });
-  });
-});

package/src/global.ts

@@ -1,45 +0,0 @@
-import type { Log, LogProcessor } from '@holz/core';
-
-const MATCH_ALL = () => true;
-
-/**
- * Overrides the default log destination for all loggers in the app. Call this
- * early on startup. If logs are sent before registering the collector, they
- * will be lost.
- */
-export const setGlobalLogCollector = ({
-  processor,
-  condition: match = MATCH_ALL,
-}: InterceptorConfig) => {
-  globalScope[COLLECTOR_SYMBOL] = { processor, condition: match };
-};
-
-/**
- * Remove the global log collector restoring defaults. Safe to call regardless
- * of whether one is set.
- */
-export const unsetGlobalLogCollector = () => {
-  delete globalScope[COLLECTOR_SYMBOL];
-};
-
-interface InterceptorConfig {
-  /** Plugin handling all logs captured by the interceptor. */
-  processor: LogProcessor;
-
-  /**
-   * Only capture logs matching this function. Return `false` to use the
-   * default log destination. Defaults to capture all logs.
-   */
-  condition?: (log: Log) => boolean;
-}
-
-// As of 2025-04-12 there is no way to declare a symbol on `globalThis`.
-export const globalScope = globalThis as unknown as GlobalContext;
-
-// Stored in the global scope. Uses the symbol registry in case multiple
-// versions of Holz are loaded in the same context.
-export const COLLECTOR_SYMBOL = Symbol.for('@holz/log-collector');
-
-interface GlobalContext {
-  [COLLECTOR_SYMBOL]?: Required<InterceptorConfig>;
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export { createLogCollector } from './log-collector';
-export { setGlobalLogCollector, unsetGlobalLogCollector } from './global';

package/src/log-collector.ts

@@ -1,22 +0,0 @@
-import type { LogProcessor } from '@holz/core';
-import { globalScope, COLLECTOR_SYMBOL } from './global';
-
-/**
- * Redirects logs to a global collector if one is configured. This is designed
- * with apps in mind, which may want to aggregate logs from multiple sources.
- */
-export const createLogCollector =
-  (config: Config): LogProcessor =>
-  (log) => {
-    const collector = globalScope[COLLECTOR_SYMBOL];
-
-    if (collector?.condition(log)) {
-      collector.processor(log);
-    } else {
-      config.fallback(log);
-    }
-  };
-
-export interface Config {
-  fallback: LogProcessor;
-}