Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/shared/src/logger.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// @ts-check

/**
Expand All @@ -5,6 +5,7 @@
* @property {(message:string) => void} debug
* @property {(message:string) => void} error
* @property {(message:string) => void} info
* @property {(message:string) => void} warning
* @property {() => boolean} isDebug
*/

Expand Down Expand Up @@ -51,6 +52,13 @@
isDebug() {
return this.#isDebug;
}

/**
* @param {string} message
*/
warning(message) {
console.warn(message);
}
}

// Singleton loggers
Expand Down
7 changes: 6 additions & 1 deletion .github/shared/test/logger.test.js
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
// @ts-check

import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { ConsoleLogger, debugLogger, defaultLogger } from "../src/logger";

describe("logger", () => {
let debugSpy, errorSpy, logSpy;
let debugSpy, errorSpy, logSpy, warnSpy;

beforeEach(() => {
debugSpy = vi.spyOn(console, "debug");
errorSpy = vi.spyOn(console, "error");
logSpy = vi.spyOn(console, "log");
warnSpy = vi.spyOn(console, "warn");
});

afterEach(() => {
debugSpy.mockRestore();
errorSpy.mockRestore();
logSpy.mockRestore();
warnSpy.mockRestore();
});

it.each([
Expand All @@ -29,6 +31,9 @@
logger.info("test info");
expect(logSpy).toBeCalledWith("test info");

logger.warning("test warning");
expect(warnSpy).toBeCalledWith("test warning");

logger.error("test error");
expect(errorSpy).toBeCalledWith("test error");

Expand Down
7 changes: 7 additions & 0 deletions .github/workflows/src/core-logger.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// @ts-check

/**
Expand Down Expand Up @@ -45,4 +45,11 @@
isDebug() {
return this.#core.isDebug();
}

/**
* @param {string} message
*/
warning(message) {
this.#core.warning(message);
}
}
9 changes: 9 additions & 0 deletions .github/workflows/test/core-logger.test.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import { describe, expect, it } from "vitest";
import { CoreLogger } from "../src/core-logger.js";
import { createMockCore } from "./mocks.js";
Expand Down Expand Up @@ -40,4 +40,13 @@

expect(core.isDebug).toBeCalled();
});

it("warning", async () => {
const core = createMockCore();
const logger = new CoreLogger(core);

logger.warning("test warning");

expect(core.warning).toBeCalledWith("test warning");
});
});
1 change: 1 addition & 0 deletions .github/workflows/test/mocks.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// @ts-check

import { RequestError } from "@octokit/request-error";
Expand Down Expand Up @@ -100,5 +100,6 @@
error: vi.fn(),
info: vi.fn(),
isDebug: vi.fn().mockReturnValue(false),
warning: vi.fn(),
};
}
Loading