@govuk-one-login/frontend-logger 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.0.1 (2026-05-07)
+
+### 🚀 Features
+
+- **DFC-806:** Logger package ([6b0b5d3](https://github.com/govuk-one-login/govuk-one-login-frontend/commit/6b0b5d3))
+
+### 🩹 Fixes
+
+- **DFC-806:** Logger package version and name ([eddde3b](https://github.com/govuk-one-login/govuk-one-login-frontend/commit/eddde3b))
+
+### ❤️ Thank You
+
+- Sam Bunce

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@govuk-one-login/frontend-logger",
+  "version": "0.0.1",
+  "description": "Shared logger for one-login-frontend packages",
+  "main": "index.js",
+  "module": "",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "vitest --run --coverage",
+    "build": "rollup -c",
+    "dev": "rollup -c --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/govuk-one-login/govuk-one-login-frontend.git"
+  },
+  "keywords": [
+    "govuk-one-login",
+    "gds",
+    "govuk-onelogin",
+    "govuk one login"
+  ],
+  "author": "DI Frontend Capability Team",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/govuk-one-login/govuk-one-login-frontend/issues"
+  },
+  "homepage": "https://github.com/govuk-one-login/govuk-one-login-frontend#readme",
+  "devDependencies": {},
+  "exports": {
+    ".": {
+      "import": "./build/esm/index.js",
+      "require": "./build/cjs/index.cjs"
+    }
+  },
+  "types": "./build/esm/index.d.ts"
+}

package/project.json

@@ -0,0 +1,17 @@
+{
+  "name": "@govuk-one-login/frontend-logger",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "packages/frontend-logger/src",
+  "// targets": "to see all targets run: nx show project frontend-logger --web",
+  "targets": {
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "options": {
+        "lintFilePatterns": [
+          "packages/frontend-logger/src/**/*.{js,ts,json}"
+        ]
+      }
+    }
+  }
+}

package/rollup.config.js

@@ -0,0 +1,32 @@
+import json from "@rollup/plugin-json";
+import typescript from "rollup-plugin-typescript2";
+import copy from "rollup-plugin-copy";
+
+export default {
+  external: ["pino"],
+  input: "src/index.ts",
+  output: [
+    {
+      file: "build/cjs/index.cjs",
+      format: "cjs",
+    },
+    {
+      file: "build/esm/index.js",
+      format: "es",
+    },
+  ],
+  plugins: [
+    typescript(),
+    json(),
+    copy({
+      targets: [
+        {
+          src: "./build/cjs/index.d.ts",
+          dest: "./build/cjs/",
+          rename: "index.d.cts",
+        },
+      ],
+      hook: "closeBundle",
+    }),
+  ],
+};

package/sonar-project.properties

@@ -0,0 +1,16 @@
+sonar.projectKey=govuk-one-login_frontend-logger
+sonar.organization=govuk-one-login
+
+# This is the name and version displayed in the SonarCloud UI.
+sonar.projectName=frontend-logger
+sonar.projectVersion=1.0
+
+# Language-specific settings
+sonar.language=typescript
+
+sonar.sources=src/
+
+sonar.tests=src/
+sonar.test.inclusions=**/*.test.ts,**/*.spec.ts
+
+sonar.sourceEncoding=UTF-8

package/src/__tests__/index.test.ts

@@ -0,0 +1,93 @@
+import {
+  createLogger,
+  getLogger,
+  resetLogger,
+  setCustomLogger,
+  type Logger,
+} from "..";
+import pino from "pino";
+
+// Custom matcher for pseudo-deep equality: JSON string (does not include all properties), log level, name
+expect.extend({
+  toMatchLogger(received, expected) {
+    const { isNot } = this;
+
+    return {
+      pass:
+        JSON.stringify(expected) === JSON.stringify(received) &&
+        expected?.level &&
+        expected.level === received.level &&
+        JSON.stringify(expected.bindings && expected.bindings()) ===
+          JSON.stringify(received.bindings && received.bindings()),
+      message: () =>
+        `${received} ${isNot ? "matches" : "does not match"} ${expected}.
+        Expected: ${JSON.stringify({ logLevel: expected.level, bindings: expected.bindings && expected.bindings() })} 
+        Received: ${JSON.stringify({ logLevel: received.level, bindings: received.bindings && received.bindings() })} 
+      `,
+    };
+  },
+});
+
+const defaultLogger = pino({
+  name: "@govuk-one-login/default-logger",
+  level: "warn",
+});
+
+const customLogger = {
+  trace: vi.fn(),
+  warn: vi.fn(),
+  info: vi.fn(),
+  error: vi.fn(),
+};
+
+describe("logger", () => {
+  beforeEach(() => {
+    resetLogger();
+    vi.resetAllMocks();
+  });
+
+  it("should create a default logger on first get if none exists", () => {
+    expect(getLogger() as Logger).toMatchLogger(defaultLogger);
+  });
+
+  it("should use a custom logger when one is provided", () => {
+    setCustomLogger(customLogger);
+    expect(customLogger).not.toMatchLogger(defaultLogger);
+  });
+
+  it("should warn if a logger is being overwritten by a custom logger", () => {
+    const warnSpy = vi.spyOn(getLogger(), "warn");
+    setCustomLogger(customLogger);
+    expect(warnSpy).toHaveBeenCalledWith(
+      "Setting custom logger when one already exists",
+    );
+  });
+
+  it("should return a customised pino logger if one has been created", () => {
+    const customisedLogger = createLogger({
+      level: "error",
+      name: "test",
+    });
+    expect(customisedLogger).not.toMatchLogger(defaultLogger);
+  });
+
+  it("should warn if a logger is being overwritten by a customised pino logger", () => {
+    const warnSpy = vi.spyOn(getLogger(), "warn");
+    createLogger({ level: "info" });
+    expect(warnSpy).toHaveBeenCalledWith(
+      "Creating new logger with config when one already exists",
+    );
+  });
+
+  it("should return to using the default logger after being reset", () => {
+    createLogger({ name: "@govuk-one-login/default-logger", level: "error" });
+    expect(getLogger()).toMatchLogger(
+      pino({
+        name: "@govuk-one-login/default-logger",
+        level: "error",
+      }),
+    );
+    resetLogger();
+    expect(getLogger()).toMatchLogger(defaultLogger);
+  });
+});

package/src/index.ts

@@ -0,0 +1,62 @@
+import type { Logger as PinoLogger, LoggerOptions } from "pino";
+import { pino } from "pino";
+
+export type TLogLevel =
+  | "fatal"
+  | "error"
+  | "warn"
+  | "info"
+  | "debug"
+  | "trace"
+  | "silent";
+
+export type CustomLogger = {
+  trace: (message: unknown) => void;
+  warn: (message: unknown) => void;
+  info: (message: unknown) => void;
+  error: (message: unknown) => void;
+};
+
+export type Logger = PinoLogger | CustomLogger;
+
+let logger: Logger | undefined;
+
+const initialiseDefaultLogger = () => {
+  logger = pino({
+    name: "@govuk-one-login/default-logger",
+    level: process.env.LOG_LEVEL ?? process.env.LOGS_LEVEL ?? "warn",
+  });
+};
+
+export const setCustomLogger = (customLogger: CustomLogger) => {
+  if (logger) {
+    logger.warn("Setting custom logger when one already exists");
+  }
+
+  logger = customLogger;
+};
+
+export const getLogger = (): Logger => {
+  if (!logger) {
+    initialiseDefaultLogger();
+    if (!logger) {
+      throw new Error("Error initialising default logger");
+    }
+  }
+
+  return logger;
+};
+
+export const createLogger = (loggerOptions: LoggerOptions) => {
+  if (logger) {
+    logger.warn("Creating new logger with config when one already exists");
+  }
+
+  logger = pino(loggerOptions);
+
+  return logger;
+};
+
+export const resetLogger = () => {
+  logger = undefined;
+};

package/tsconfig.json

@@ -0,0 +1,66 @@
+{
+  "include": ["./src"],
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "ES2018" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "ESNext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    "lib": [
+      "es2019"
+    ] /* Specify library files to be included in the compilation. */,
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "react",                           /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    "declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */,
+    "sourceMap": true /* Generates corresponding '.map' file. */,
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist" /* Redirect output structure to the directory. */,
+    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    "isolatedModules": true /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */,
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    /* Module Resolution Options */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    "types": [
+      "vitest/globals"
+    ] /* Type declaration files to be included in compilation. */,
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,
+    "resolveJsonModule": true
+  }
+}