Skip to content

Commit 1597cb0

Browse files
test(logging): cover the Logger timer error paths
The three `No such label` throws and the aggregate paths had no test, so renaming `WebpackLogger` to `Logger` pulled uncovered lines into the diff.
1 parent 31f7415 commit 1597cb0

1 file changed

Lines changed: 76 additions & 0 deletions

File tree

‎test/unitCases/Logger.unittest.js‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
"use strict";
2+
3+
const { Logger, LogType } = require("../../lib/logging/Logger");
4+
5+
/**
6+
* @returns {{ logger: Logger, entries: [string, EXPECTED_ANY[]][] }} a logger recording what it logged
7+
*/
8+
const createLogger = () => {
9+
/** @type {[string, EXPECTED_ANY[]][]} */
10+
const entries = [];
11+
const logger = new Logger(
12+
(type, args) => entries.push([type, args || []]),
13+
(name) => createLogger().logger
14+
);
15+
return { logger, entries };
16+
};
17+
18+
describe("Logger", () => {
19+
it("should log the elapsed time of a started label", () => {
20+
const { logger, entries } = createLogger();
21+
logger.time("build");
22+
logger.timeLog("build");
23+
logger.timeEnd("build");
24+
expect(entries).toHaveLength(2);
25+
for (const [type, args] of entries) {
26+
expect(type).toBe(LogType.time);
27+
expect(args[0]).toBe("build");
28+
expect(typeof args[1]).toBe("number");
29+
expect(typeof args[2]).toBe("number");
30+
}
31+
});
32+
33+
it("should throw for a label that was never started", () => {
34+
const { logger } = createLogger();
35+
expect(() => logger.timeLog("missing")).toThrow(
36+
"No such label 'missing' for Logger.timeLog()"
37+
);
38+
expect(() => logger.timeEnd("missing")).toThrow(
39+
"No such label 'missing' for Logger.timeEnd()"
40+
);
41+
expect(() => logger.timeAggregate("missing")).toThrow(
42+
"No such label 'missing' for Logger.timeAggregate()"
43+
);
44+
});
45+
46+
it("should throw once a label has been ended", () => {
47+
const { logger } = createLogger();
48+
logger.time("build");
49+
logger.timeEnd("build");
50+
expect(() => logger.timeEnd("build")).toThrow(
51+
"No such label 'build' for Logger.timeEnd()"
52+
);
53+
});
54+
55+
it("should sum the aggregated times of a label", () => {
56+
const { logger, entries } = createLogger();
57+
logger.time("hash");
58+
logger.timeAggregate("hash");
59+
logger.time("hash");
60+
logger.timeAggregate("hash");
61+
expect(entries).toHaveLength(0);
62+
logger.timeAggregateEnd("hash");
63+
expect(entries).toHaveLength(1);
64+
expect(entries[0][0]).toBe(LogType.time);
65+
expect(entries[0][1][0]).toBe("hash");
66+
});
67+
68+
it("should ignore ending an aggregate that was never collected", () => {
69+
const { logger, entries } = createLogger();
70+
logger.timeAggregateEnd("never");
71+
logger.time("other");
72+
logger.timeAggregate("other");
73+
logger.timeAggregateEnd("missing");
74+
expect(entries).toHaveLength(0);
75+
});
76+
});

0 commit comments

Comments
 (0)