Merge pull request #4 from macropygia/feature/fix-console-logger

Fix wrong operator in `consoleLogger`

Author: macropygia

.github/workflows/checks-pr.yml

@@ -24,7 +24,7 @@ defaults:
     shell: bash
 
 jobs:
-  build:
+  checks:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/docs.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  docs:
+  deploy_docs:
     permissions:
       contents: read
       pages: write

.github/workflows/publish-dry-run.yml

@@ -11,7 +11,7 @@ permissions:
   contents: write
 
 jobs:
-  build:
+  publish_dry_run:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/publish.yml

@@ -12,7 +12,7 @@ permissions:
   contents: write
 
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -55,8 +55,8 @@ jobs:
         with:
           path: ./docs
 
-  deploy:
-    needs: build
+  deploy_docs:
+    needs: publish
     permissions:
       pages: write
       id-token: write

.github/workflows/release-drafter-sync-manual.yml

@@ -11,7 +11,7 @@ permissions:
   contents: read
 
 jobs:
-  version_sync:
+  update_release_draft_and_version_sync:
     env:
       BLANCH: main
       CURRENT_VERSION: null

.github/workflows/release-drafter-sync-push.yml

@@ -13,7 +13,7 @@ permissions:
   contents: read
 
 jobs:
-  version_sync:
+  update_release_draft_and_version_sync:
     env:
       BLANCH: main
       CURRENT_VERSION: null

loggers/consoleLogger.test.ts

@@ -0,0 +1,107 @@
+import {
+  type Mock,
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  spyOn,
+  test,
+} from "bun:test";
+import { consoleLogger } from "./consoleLogger";
+
+describe("consoleLogger", () => {
+  let logDebug: Mock<() => void>;
+  let logInfo: Mock<() => void>;
+  let logWarn: Mock<() => void>;
+  let logError: Mock<() => void>;
+
+  beforeEach(() => {
+    logDebug = spyOn(console, "debug").mockImplementation(() => undefined);
+    logInfo = spyOn(console, "info").mockImplementation(() => undefined);
+    logWarn = spyOn(console, "warn").mockImplementation(() => undefined);
+    logError = spyOn(console, "error").mockImplementation(() => undefined);
+  });
+
+  afterEach(() => {
+    logDebug.mockRestore();
+    logInfo.mockRestore();
+    logWarn.mockRestore();
+    logError.mockRestore();
+  });
+
+  test("default", () => {
+    const logger = consoleLogger();
+
+    logger.silent("test"); // Not called
+    logger.trace("test"); // Called
+    logger.debug("test"); // Called
+    expect(logDebug).toHaveBeenCalledTimes(2);
+
+    logger.info("test"); // Called
+    expect(logInfo).toHaveBeenCalledTimes(1);
+
+    logger.warn("test"); // Called
+    expect(logWarn).toHaveBeenCalledTimes(1);
+
+    logger.error("test"); // Called
+    logger.fatal("test"); // Called
+    expect(logError).toHaveBeenCalledTimes(2);
+  });
+
+  test("info", () => {
+    const logger = consoleLogger("info");
+
+    logger.silent("test"); // Not called
+    logger.trace("test"); // Not called
+    logger.debug("test"); // Not called
+    expect(logDebug).toHaveBeenCalledTimes(0);
+
+    logger.info("test"); // Called
+    expect(logInfo).toHaveBeenCalledTimes(1);
+
+    logger.warn("test"); // Called
+    expect(logWarn).toHaveBeenCalledTimes(1);
+
+    logger.error("test"); // Called
+    logger.fatal("test"); // Called
+    expect(logError).toHaveBeenCalledTimes(2);
+  });
+
+  test("silent", () => {
+    const logger = consoleLogger("silent");
+
+    logger.silent("test"); // Called
+    logger.trace("test"); // Called
+    logger.debug("test"); // Called
+    expect(logDebug).toHaveBeenCalledTimes(3);
+
+    logger.info("test"); // Called
+    expect(logInfo).toHaveBeenCalledTimes(1);
+
+    logger.warn("test"); // Called
+    expect(logWarn).toHaveBeenCalledTimes(1);
+
+    logger.error("test"); // Called
+    logger.fatal("test"); // Called
+    expect(logError).toHaveBeenCalledTimes(2);
+  });
+
+  test("error", () => {
+    const logger = consoleLogger("error");
+
+    logger.silent("test"); // Not called
+    logger.trace("test"); // Not called
+    logger.debug("test"); // Not called
+    expect(logDebug).toHaveBeenCalledTimes(0);
+
+    logger.info("test"); // Not called
+    expect(logInfo).toHaveBeenCalledTimes(0);
+
+    logger.warn("test"); // Not called
+    expect(logWarn).toHaveBeenCalledTimes(0);
+
+    logger.error("test"); // Called
+    logger.fatal("test"); // Called
+    expect(logError).toHaveBeenCalledTimes(2);
+  });
+});

loggers/consoleLogger.ts

@@ -3,26 +3,27 @@ import type { LevelWithSilent } from "pino";
 
 /**
  * Console logger
+ * - `silent` is displayed only when the `level` is set to `silent`
  * @param level - Minimum level to be displayed
  * @returns Logger (console)
  */
 export const consoleLogger = (
   level?: keyof typeof levels,
 ): OIDCClientLogger => ({
-  silent: levels[level || "trace"] >= 99 ? console.debug : () => undefined,
-  trace: levels[level || "trace"] >= 10 ? console.debug : () => undefined,
-  debug: levels[level || "trace"] >= 20 ? console.debug : () => undefined,
-  info: levels[level || "trace"] >= 30 ? console.info : () => undefined,
-  warn: levels[level || "trace"] >= 40 ? console.warn : () => undefined,
-  error: levels[level || "trace"] >= 50 ? console.error : () => undefined,
-  fatal: levels[level || "trace"] >= 60 ? console.error : () => undefined,
+  silent: levels[level || "trace"] === 0 ? console.debug : () => undefined,
+  trace: levels[level || "trace"] <= 10 ? console.debug : () => undefined,
+  debug: levels[level || "trace"] <= 20 ? console.debug : () => undefined,
+  info: levels[level || "trace"] <= 30 ? console.info : () => undefined,
+  warn: levels[level || "trace"] <= 40 ? console.warn : () => undefined,
+  error: levels[level || "trace"] <= 50 ? console.error : () => undefined,
+  fatal: levels[level || "trace"] <= 60 ? console.error : () => undefined,
 });
 
 const levels: Record<LevelWithSilent, number> = {
-  silent: 99,
+  silent: 0,
   fatal: 60,
   error: 50,
-  warn: 50,
+  warn: 40,
   info: 30,
   debug: 20,
   trace: 10,