/*
* Copyright (C) 2025 TomTom Navigation B.V.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { describe, it, expect, beforeEach } from "vitest";
import { Writable } from "stream";
import { makeLogger, type Logger } from "./logger";
describe("Logger", () => {
let logs: any[];
let logger: Logger;
beforeEach(() => {
// Reset logs array before each test
logs = [];
// Create an in-memory stream that captures logs
const memoryStream = new Writable({
write(chunk, encoding, callback) {
logs.push(JSON.parse(chunk.toString()));
callback();
},
});
// Create logger with memory stream
logger = makeLogger(memoryStream);
});
it("should log errors with timestamp and ERROR level", () => {
logger.error("Test error message");
expect(logs).toHaveLength(1);
expect(logs[0].level).toBe("error");
expect(logs[0].msg).toBe("Test error message");
expect(logs[0].time).toMatch(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/);
});
it("should log warnings with timestamp and WARN level", () => {
logger.warn("Test warning message");
expect(logs).toHaveLength(1);
expect(logs[0].level).toBe("warn");
expect(logs[0].msg).toBe("Test warning message");
expect(logs[0].time).toMatch(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/);
});
it("should log info with timestamp and INFO level", () => {
logger.info("Test info message");
expect(logs).toHaveLength(1);
expect(logs[0].level).toBe("info");
expect(logs[0].msg).toBe("Test info message");
expect(logs[0].time).toMatch(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/);
});
it("should log debug with timestamp and DEBUG level", () => {
logger.debug("Test debug message");
expect(logs).toHaveLength(1);
expect(logs[0].level).toBe("debug");
expect(logs[0].msg).toBe("Test debug message");
expect(logs[0].time).toMatch(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/);
});
it("should support structured logging with data objects", () => {
logger.info({ userId: 123, action: "login" }, "User logged in");
expect(logs).toHaveLength(1);
expect(logs[0].level).toBe("info");
expect(logs[0].msg).toBe("User logged in");
expect(logs[0].userId).toBe(123);
expect(logs[0].action).toBe("login");
});
it("should log multiple messages in order", () => {
logger.info("First message");
logger.warn("Second message");
logger.error("Third message");
expect(logs).toHaveLength(3);
expect(logs[0].msg).toBe("First message");
expect(logs[0].level).toBe("info");
expect(logs[1].msg).toBe("Second message");
expect(logs[1].level).toBe("warn");
expect(logs[2].msg).toBe("Third message");
expect(logs[2].level).toBe("error");
});
});
