feat: logger

.changeset/brave-jokes-film.md

@@ -0,0 +1,5 @@
+---
+"@vue-storefront/logger": minor
+---
+
+rc.1

.changeset/chilly-eggs-fetch.md

@@ -0,0 +1,5 @@
+---
+"@vue-storefront/logger": major
+---
+
+rc.2

.changeset/pre.json

@@ -0,0 +1,25 @@
+{
+ "mode": "pre",
+ "tag": "rc",
+ "initialVersions": {
+ "@vue-storefront/api-extractor-config": "1.0.0",
+ "@vue-storefront/eslint-config": "3.1.3",
+ "@vue-storefront/eslint-config-integrations": "1.0.1",
+ "@vue-storefront/integrations-tsconfig": "1.0.0",
+ "@vue-storefront/jest-config": "1.0.2",
+ "@vue-storefront/prettier-config": "2.0.0",
+ "@vue-storefront/rollup-config": "1.0.0",
+ "@vue-storefront/changesets": "2.0.0",
+ "@vue-storefront/cli": "5.0.0",
+ "@vue-storefront/logger": "0.0.0",
+ "@vue-storefront/middleware": "5.0.0",
+ "@vue-storefront/multistore": "4.1.1",
+ "@vue-storefront/sdk": "3.2.3",
+ "@vue-storefront/sdk-axios-request-sender": "2.0.0"
+ },
+ "changesets": [
+ "brave-jokes-film",
+ "chilly-eggs-fetch",
+ "strange-schools-mate"
+ ]
+}

.changeset/strange-schools-mate.md

@@ -0,0 +1,5 @@
+---
+"@vue-storefront/logger": major
+---
+
+Feature logger

.eslintrc.js

@@ -1,3 +1,6 @@
 module.exports = {
  extends: "@vue-storefront/eslint-config-integrations",
+ rules: {
+ "class-methods-use-this": "off",
+ },
 };

packages/logger/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @vue-storefront/logger
+
+## 1.0.0-rc.2
+
+### Major Changes
+
+rc.2
+
+## 1.0.0-rc.1
+
+### Minor Changes
+
+rc.1
+
+## 1.0.0-rc.0
+
+### Major Changes
+
+Feature logger

packages/logger/__tests__/unit/consolaStructuredLogger.spec.ts

@@ -0,0 +1,43 @@
+import { createConsolaStructuredLogger } from "../../src/ConsolaStructuredLogger";
+import type { StructuredLog } from "../../src/interfaces/StructuredLog";
+import type { LogData, Metadata } from "../../src/interfaces/LoggerInterface";
+
+process.env.NODE_ENV = "development";
+
+describe("createConsolaStructuredLogger", () => {
+ const mockStructuredLog: StructuredLog = {
+ createLog: jest.fn(),
+ };
+
+ const logData: LogData = "Test log message";
+ const metadata: Metadata = { userId: "12345" };
+
+ it("should create a logger with the correct set of methods", () => {
+ const logger = createConsolaStructuredLogger(mockStructuredLog);
+
+ expect(logger).toHaveProperty("log");
+ expect(logger).toHaveProperty("emergency");
+ expect(logger).toHaveProperty("alert");
+ expect(logger).toHaveProperty("critical");
+ expect(logger).toHaveProperty("error");
+ expect(logger).toHaveProperty("warning");
+ expect(logger).toHaveProperty("notice");
+ expect(logger).toHaveProperty("info");
+ expect(logger).toHaveProperty("debug");
+ });
+
+ it("should log at the correct level", () => {
+ const logger = createConsolaStructuredLogger(mockStructuredLog);
+
+ const infoSpy = jest.spyOn(logger, "info").mockImplementation(() => {});
+ logger.info(logData, metadata);
+ expect(infoSpy).toHaveBeenCalledTimes(1);
+
+ const errorSpy = jest.spyOn(logger, "error").mockImplementation(() => {});
+ logger.error(logData, metadata);
+ expect(errorSpy).toHaveBeenCalledTimes(1);
+
+ const debugSpy = jest.spyOn(logger, "debug").mockImplementation(() => {});
+ expect(debugSpy).not.toHaveBeenCalled();
+ });
+});

packages/logger/__tests__/unit/loggerFactory.spec.ts

@@ -0,0 +1,21 @@
+import { LoggerFactory } from "../../src/LoggerFactory";
+
+describe("LoggerFactory try to create type '$type'", () => {
+ // We can add more in the future
+ it.each([
+ {
+ type: "consola-gcp",
+ expected: "Object",
+ },
+ ])("should create a $type logger", ({ type, expected }) => {
+ const result = LoggerFactory.create(type as any);
+ expect(result.constructor.name).toBe(expected);
+ });
+
+ it(`should throw an error for unknown logger type`, () => {
+ const unknownLoggerType = "some-unknown-logger";
+ expect(() =>
+ LoggerFactory.create(unknownLoggerType as any, {})
+ ).toThrowError(`Logger type ${unknownLoggerType} is not supported`);
+ });
+});

packages/logger/__tests__/unit/structuredLog/gcpStructuredLog.spec.ts

@@ -0,0 +1,165 @@
+import { LogLevel } from "../../../src/interfaces/LogLevel";
+import { GCPStructuredLog } from "../../../src/structuredLog/GCPStructuredLog";
+
+// We do not want to serialize the log payload at this point
+process.env.NODE_ENV = "dev";
+
+describe("GCPStructuredLog", () => {
+ it.each([
+ {
+ id: "1",
+ logData: "test message",
+ options: {},
+ severity: "alert",
+ metadata: {
+ alokai: "test",
+ },
+ expected: {
+ message: "test message",
+ severity: "ALERT",
+ timestamp: expect.any(String),
+ alokai: "test",
+ },
+ },
+ {
+ id: "2",
+ logData: "test message",
+ options: { includeStackTrace: true },
+ severity: undefined,
+ metadata: {
+ alokai: "test",
+ },
+ expected: {
+ message: "test message",
+ severity: "DEFAULT",
+ timestamp: expect.any(String),
+ alokai: "test",
+ },
+ },
+ {
+ id: "3",
+ logData: new Error("test error"),
+ options: { includeStackTrace: true },
+ severity: undefined,
+ expected: {
+ message: "test error",
+ severity: "DEFAULT",
+ timestamp: expect.any(String),
+ stackTrace: expect.any(String),
+ },
+ },
+ {
+ id: "4",
+ logData: "another test message",
+ options: { includeStackTrace: false },
+ severity: "info",
+ metadata: {
+ alokai: "test",
+ },
+ expected: {
+ message: "another test message",
+ severity: "INFO",
+ timestamp: expect.any(String),
+ alokai: "test",
+ },
+ },
+ {
+ id: "5",
+ logData: "test message with options",
+ options: { includeStackTrace: false },
+ severity: "debug",
+ expected: {
+ message: "test message with options",
+ severity: "DEBUG",
+ timestamp: expect.any(String),
+ },
+ },
+ {
+ id: "6",
+ logData: new Error("another test error"),
+ options: { includeStackTrace: true },
+ severity: "error",
+ metadata: {
+ alokai: "test",
+ },
+ expected: {
+ message: "another test error",
+ severity: "ERROR",
+ timestamp: expect.any(String),
+ stackTrace: expect.any(String),
+ alokai: "test",
+ },
+ },
+ {
+ id: "7",
+ logData: new Error("another test error"),
+ options: { includeStackTrace: true },
+ severity: "error",
+ metadata: {
+ alokai: "test",
+ },
+ expected: {
+ message: "another test error",
+ severity: "ERROR",
+ timestamp: expect.any(String),
+ stackTrace: expect.any(String),
+ alokai: "test",
+ },
+ },
+ {
+ id: "8",
+ logData: "test message with options",
+ options: { includeStackTrace: false },
+ severity: "debug",
+ expected: {
+ message: "test message with options",
+ severity: "DEBUG",
+ timestamp: expect.any(String),
+ },
+ },
+ {
+ id: "9: with metadata",
+ logData: "message",
+ options: { includeStackTrace: false },
+ severity: "info",
+ metadata: {
+ labels: "other-label",
+ },
+ expected: {
+ message: "message",
+ severity: "INFO",
+ timestamp: expect.any(String),
+ labels: "other-label",
+ },
+ },
+ {
+ id: "10:with ansi codes",
+ logData:
+ "\x1b[90m(/var/www/apps/storefront-unified-nextjs/\x1b[39m.next/server/chunks/689.js:67:9\x1b[90m)\x1b[39m",
+ options: { includeStackTrace: false },
+ severity: "info",
+ metadata: {
+ labels: "other-label",
+ },
+ expected: {
+ message:
+ "(/var/www/apps/storefront-unified-nextjs/.next/server/chunks/689.js:67:9)",
+ severity: "INFO",
+ timestamp: expect.any(String),
+ labels: "other-label",
+ },
+ },
+ ])(
+ "should create a GCP structured log: #ID $id",
+ ({ logData, expected, options, severity, metadata }) => {
+ const log = new GCPStructuredLog();
+ const gcpStructuredLog = log.createLog(
+ logData,
+ options,
+ severity as LogLevel,
+ metadata
+ );
+ expect(gcpStructuredLog).toEqual(expected);
+ }
+ );
+});

packages/logger/jest.config.ts

@@ -0,0 +1,5 @@
+import { baseConfig } from "@vue-storefront/jest-config";
+
+export default {
+ ...baseConfig,
+};

packages/logger/package.json

@@ -0,0 +1,29 @@
+{
+ "name": "@vue-storefront/logger",
+ "version": "1.0.0-rc.2",
+ "main": "lib/index.cjs.js",
+ "module": "lib/index.es.js",
+ "types": "lib/index.d.ts",
+ "license": "MIT",
+ "files": [
+ "lib"
+ ],
+ "scripts": {
+ "build": "rimraf lib && rollup -c",
+ "test": "yarn test:unit && yarn test:integration",
+ "test:unit": "jest -c jest.config.ts --coverage",
+ "test:integration": "echo 'No integration tests available'",
+ "lint": "eslint . --ext .ts,.js",
+ "prepublishOnly": "yarn build",
+ "changesets:version": "yarn changeset version && YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install",
+ "changesets:publish": "yarn build && yarn changeset publish"
+ },
+ "packageManager": "yarn@1.22.10",
+ "engines": {
+ "node": ">=18"
+ },
+ "dependencies": {
+ "consola": "^3",
+ "dotenv": "^16"
+ }
+}

packages/logger/rollup.config.js

@@ -0,0 +1,4 @@
+import { generateBaseConfig } from "@vue-storefront/rollup-config";
+import package_ from "./package.json";
+
+export default [generateBaseConfig(package_)];