Colota - Android GPS Location tracker
const originalDev = (globalThis as any).__DEV__
beforeEach(() => {
jest.spyOn(console, "log").mockImplementation()
jest.spyOn(console, "warn").mockImplementation()
jest.spyOn(console, "error").mockImplementation()
})
afterEach(() => {
jest.restoreAllMocks()
jest.resetModules()
;(globalThis as any).__DEV__ = originalDev
})
function loadLogger() {
return require("../logger").logger
}
describe("logger", () => {
describe("in development (__DEV__ = true)", () => {
beforeEach(() => {
;(globalThis as any).__DEV__ = true
})
it("debug logs via console.log", () => {
const logger = loadLogger()
logger.debug("test message", 123)
expect(console.log).toHaveBeenCalledWith("test message", 123)
})
it("info logs via console.log", () => {
const logger = loadLogger()
logger.info("info message")
expect(console.log).toHaveBeenCalledWith("info message")
})
it("warn logs via console.warn", () => {
const logger = loadLogger()
logger.warn("warning")
expect(console.warn).toHaveBeenCalledWith("warning")
})
it("error logs via console.error", () => {
const logger = loadLogger()
logger.error("error", new Error("test"))
expect(console.error).toHaveBeenCalledWith("error", expect.any(Error))
})
})
describe("in production (__DEV__ = false)", () => {
beforeEach(() => {
;(globalThis as any).__DEV__ = false
})
it("debug is suppressed", () => {
const logger = loadLogger()
logger.debug("should not appear")
expect(console.log).not.toHaveBeenCalled()
})
it("info is suppressed", () => {
const logger = loadLogger()
logger.info("should not appear")
expect(console.log).not.toHaveBeenCalled()
})
it("warn still logs", () => {
const logger = loadLogger()
logger.warn("visible warning")
expect(console.warn).toHaveBeenCalledWith("visible warning")
})
it("error still logs", () => {
const logger = loadLogger()
logger.error("visible error")
expect(console.error).toHaveBeenCalledWith("visible error")
})
})
describe("log buffer", () => {
beforeEach(() => {
;(globalThis as any).__DEV__ = true
})
function loadBuffer() {
jest.resetModules()
const mod = require("../logger")
return {
logger: mod.logger,
getLogEntries: mod.getLogEntries
}
}
it("always captures log entries", () => {
const { logger, getLogEntries } = loadBuffer()
logger.info("test message")
const entries = getLogEntries()
expect(entries).toHaveLength(1)
expect(entries[0].level).toBe("INFO")
expect(entries[0].message).toBe("test message")
expect(entries[0].timestamp).toBeTruthy()
})
it("captures all log levels", () => {
const { logger, getLogEntries } = loadBuffer()
logger.debug("d")
logger.info("i")
logger.warn("w")
logger.error("e")
const entries = getLogEntries()
expect(entries).toHaveLength(4)
expect(entries.map((e: any) => e.level)).toEqual(["DEBUG", "INFO", "WARN", "ERROR"])
})
it("caps buffer at MAX_BUFFER_SIZE", () => {
const { logger, getLogEntries } = loadBuffer()
for (let i = 0; i < 2100; i++) {
logger.info(`msg ${i}`)
}
const entries = getLogEntries()
expect(entries.length).toBeLessThanOrEqual(2000)
expect(entries[entries.length - 1].message).toBe("msg 2099")
})
it("formats Error objects", () => {
const { logger, getLogEntries } = loadBuffer()
logger.error("failed:", new Error("something broke"))
expect(getLogEntries()[0].message).toBe("failed: something broke")
})
it("formats objects as JSON", () => {
const { logger, getLogEntries } = loadBuffer()
logger.info("data:", { key: "value" })
expect(getLogEntries()[0].message).toBe('data: {"key":"value"}')
})
})
})
describe("what the buffer captures", () => {
/**
* The preview opens on every level now, so nothing here decides a default. What still matters is
* that the buffer keeps DEBUG: the filter is a view and the exported file is not, so dropping a
* level at the source would empty the one diagnostic this project runs on.
*/
it("keeps every level, because the filter is a view and the export is not", () => {
const mod = require("../logger")
mod.logger.debug("zone lookup")
mod.logger.info("sync tick")
const levels = mod.getLogEntries().map((e: { level: string }) => e.level)
expect(levels).toContain("DEBUG")
expect(levels).toContain("INFO")
})
})