Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BREAKING(log): remove WARNING log level #4258

Merged
merged 3 commits into from
Feb 2, 2024
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: 4 additions & 4 deletions log/base_handler_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Deno.test("simpleHandler", function () {
[
"DEBUG debug-test",
"INFO info-test",
"WARNING warning-test",
"WARN warn-test",
"ERROR error-test",
"CRITICAL critical-test",
],
Expand All @@ -34,14 +34,14 @@ Deno.test("simpleHandler", function () {
LogLevels.INFO,
[
"INFO info-test",
"WARNING warning-test",
"WARN warn-test",
"ERROR error-test",
"CRITICAL critical-test",
],
],
[
LogLevels.WARNING,
["WARNING warning-test", "ERROR error-test", "CRITICAL critical-test"],
LogLevels.WARN,
["WARN warn-test", "ERROR error-test", "CRITICAL critical-test"],
],
[LogLevels.ERROR, ["ERROR error-test", "CRITICAL critical-test"]],
[LogLevels.CRITICAL, ["CRITICAL critical-test"]],
Expand Down
2 changes: 1 addition & 1 deletion log/console_handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export class ConsoleHandler extends BaseHandler {
case LogLevels.INFO:
msg = blue(msg);
break;
case LogLevels.WARNING:
case LogLevels.WARN:
msg = yellow(msg);
break;
case LogLevels.ERROR:
Expand Down
16 changes: 8 additions & 8 deletions log/file_handler_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Deno.test({
}
}

using testFileHandler = new TestFileHandler("WARNING", {
using testFileHandler = new TestFileHandler("WARN", {
filename: LOG_FILE,
mode: "w",
});
Expand All @@ -35,7 +35,7 @@ Deno.test({
new LogRecord({
msg: "The starry heavens above me and the moral law within me.",
args: [],
level: LogLevels.WARNING,
level: LogLevels.WARN,
loggerName: "default",
}),
);
Expand All @@ -46,7 +46,7 @@ Deno.test({
Deno.test({
name: "FileHandler with mode 'w' will wipe clean existing log file",
async fn() {
const fileHandler = new FileHandler("WARNING", {
const fileHandler = new FileHandler("WARN", {
filename: LOG_FILE,
mode: "w",
});
Expand All @@ -56,7 +56,7 @@ Deno.test({
new LogRecord({
msg: "Hello World",
args: [],
level: LogLevels.WARNING,
level: LogLevels.WARN,
loggerName: "default",
}),
);
Expand All @@ -68,7 +68,7 @@ Deno.test({
new LogRecord({
msg: "Hello World",
args: [],
level: LogLevels.WARNING,
level: LogLevels.WARN,
loggerName: "default",
}),
);
Expand All @@ -83,7 +83,7 @@ Deno.test({
Deno.test({
name: "FileHandler with mode 'x' will throw if log file already exists",
fn() {
using fileHandler = new FileHandler("WARNING", {
using fileHandler = new FileHandler("WARN", {
filename: LOG_FILE,
mode: "x",
});
Expand All @@ -100,7 +100,7 @@ Deno.test({
Deno.test({
name: "Window unload flushes buffer",
async fn() {
const fileHandler = new FileHandler("WARNING", {
const fileHandler = new FileHandler("WARN", {
filename: LOG_FILE,
mode: "w",
});
Expand All @@ -126,7 +126,7 @@ Deno.test({
Deno.test({
name: "FileHandler: Critical logs trigger immediate flush",
async fn() {
using fileHandler = new FileHandler("WARNING", {
using fileHandler = new FileHandler("WARN", {
filename: LOG_FILE,
mode: "w",
});
Expand Down
5 changes: 2 additions & 3 deletions log/levels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ export const LogLevels = {
NOTSET: 0,
DEBUG: 10,
INFO: 20,
/** @deprecated (will be removed after 0.214.0) Will be changed to {@linkcode WARN}. */
WARNING: 30,
WARN: 30,
ERROR: 40,
CRITICAL: 50,
} as const;
Expand All @@ -30,7 +29,7 @@ const byLevel: Record<LogLevel, LevelName> = {
[LogLevels.NOTSET]: "NOTSET",
[LogLevels.DEBUG]: "DEBUG",
[LogLevels.INFO]: "INFO",
[LogLevels.WARNING]: "WARNING",
[LogLevels.WARN]: "WARN",
[LogLevels.ERROR]: "ERROR",
[LogLevels.CRITICAL]: "CRITICAL",
};
Expand Down
13 changes: 1 addition & 12 deletions log/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,24 +181,13 @@ export class Logger {
return this.#log(LogLevels.INFO, msg, ...args);
}

/** @deprecated (will be removed after 0.214.0) Use {@linkcode warn} instead. */
warning<T>(msg: () => T, ...args: unknown[]): T | undefined;
/** @deprecated (will be removed after 0.214.0) Use {@linkcode warn} instead. */
warning<T>(msg: T extends GenericFunction ? never : T, ...args: unknown[]): T;
warning<T>(
msg: (T extends GenericFunction ? never : T) | (() => T),
...args: unknown[]
): T | undefined {
return this.warn(msg as () => T, ...args);
}

warn<T>(msg: () => T, ...args: unknown[]): T | undefined;
warn<T>(msg: T extends GenericFunction ? never : T, ...args: unknown[]): T;
warn<T>(
msg: (T extends GenericFunction ? never : T) | (() => T),
...args: unknown[]
): T | undefined {
return this.#log(LogLevels.WARNING, msg, ...args);
return this.#log(LogLevels.WARN, msg, ...args);
}

error<T>(msg: () => T, ...args: unknown[]): T | undefined;
Expand Down
16 changes: 8 additions & 8 deletions log/logger_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Deno.test("logFunctions", function () {
assertEquals(handler.messages, [
"DEBUG foo",
"INFO bar",
"WARNING baz",
"WARN baz",
"ERROR boo",
"CRITICAL doo",
]);
Expand All @@ -97,14 +97,14 @@ Deno.test("logFunctions", function () {

assertEquals(handler.messages, [
"INFO bar",
"WARNING baz",
"WARN baz",
"ERROR boo",
"CRITICAL doo",
]);

handler = doLog("WARNING");
handler = doLog("WARN");

assertEquals(handler.messages, ["WARNING baz", "ERROR boo", "CRITICAL doo"]);
assertEquals(handler.messages, ["WARN baz", "ERROR boo", "CRITICAL doo"]);

handler = doLog("ERROR");

Expand Down Expand Up @@ -182,8 +182,8 @@ Deno.test(
assertEquals(data5, 3);
const data6: number = logger.warn(3, 1);
assertEquals(data6, 3);
assertEquals(handler.messages[4], "WARNING 3");
assertEquals(handler.messages[5], "WARNING 3");
assertEquals(handler.messages[4], "WARN 3");
assertEquals(handler.messages[5], "WARN 3");

// bigint
const data7: bigint = logger.error(5n);
Expand Down Expand Up @@ -222,8 +222,8 @@ Deno.test(
assertEquals(data15, "abc");
const data16: string | undefined = logger.warn(fn, 1);
assertEquals(data16, "abc");
assertEquals(handler.messages[14], "WARNING abc");
assertEquals(handler.messages[15], "WARNING abc");
assertEquals(handler.messages[14], "WARN abc");
assertEquals(handler.messages[15], "WARN abc");

// object
const data17: { payload: string; other: number } = logger.error({
Expand Down
4 changes: 2 additions & 2 deletions log/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
* handlers: {
* console: new log.ConsoleHandler("DEBUG"),
*
* file: new log.FileHandler("WARNING", {
* file: new log.FileHandler("WARN", {
* filename: "./log.txt",
* // you can change format of output message using any keys in `LogRecord`.
* formatter: (record) => `${record.levelName} ${record.msg}`,
Expand All @@ -173,7 +173,7 @@
*
* // get default logger.
* logger = log.getLogger();
* logger.debug("fizz"); // logs to `console`, because `file` handler requires "WARNING" level.
* logger.debug("fizz"); // logs to `console`, because `file` handler requires "WARN" level.
* logger.warn(41256); // logs to both `console` and `file` handlers.
*
* // get custom logger
Expand Down
6 changes: 3 additions & 3 deletions log/mod_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ Deno.test({
assertEquals(testHandler.messages[2], "CRITICAL critical");

testHandler.messages = [];
logger.level = LogLevels.WARNING;
assertEquals(logger.levelName, "WARNING");
assertEquals(logger.level, LogLevels.WARNING);
logger.level = LogLevels.WARN;
assertEquals(logger.levelName, "WARN");
assertEquals(logger.level, LogLevels.WARN);

logger.debug("debug2");
logger.error("error2");
Expand Down
16 changes: 8 additions & 8 deletions log/rotating_file_handler_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Deno.test({
new TextEncoder().encode("hello world"),
);

const fileHandler = new RotatingFileHandler("WARNING", {
const fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 50,
maxBackupCount: 3,
Expand All @@ -56,7 +56,7 @@ Deno.test({
LOG_FILE + ".3",
new TextEncoder().encode("hello world"),
);
using fileHandler = new RotatingFileHandler("WARNING", {
using fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 50,
maxBackupCount: 3,
Expand All @@ -78,7 +78,7 @@ Deno.test({
Deno.test({
name: "RotatingFileHandler with first rollover, monitor step by step",
async fn() {
using fileHandler = new RotatingFileHandler("WARNING", {
using fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 25,
maxBackupCount: 3,
Expand Down Expand Up @@ -127,7 +127,7 @@ Deno.test({
Deno.test({
name: "RotatingFileHandler with first rollover, check all at once",
async fn() {
const fileHandler = new RotatingFileHandler("WARNING", {
const fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 25,
maxBackupCount: 3,
Expand Down Expand Up @@ -187,7 +187,7 @@ Deno.test({
new TextEncoder().encode("original log.3 file"),
);

const fileHandler = new RotatingFileHandler("WARNING", {
const fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 2,
maxBackupCount: 3,
Expand Down Expand Up @@ -232,7 +232,7 @@ Deno.test({
fn() {
assertThrows(
() => {
const fileHandler = new RotatingFileHandler("WARNING", {
const fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 0,
maxBackupCount: 3,
Expand All @@ -251,7 +251,7 @@ Deno.test({
fn() {
assertThrows(
() => {
const fileHandler = new RotatingFileHandler("WARNING", {
const fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 50,
maxBackupCount: 0,
Expand All @@ -268,7 +268,7 @@ Deno.test({
Deno.test({
name: "RotatingFileHandler: rotate on byte length, not msg length",
async fn() {
const fileHandler = new RotatingFileHandler("WARNING", {
const fileHandler = new RotatingFileHandler("WARN", {
filename: LOG_FILE,
maxBytes: 7,
maxBackupCount: 1,
Expand Down
2 changes: 1 addition & 1 deletion log/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Deno.test("defaultHandlers", async function () {
} = {
DEBUG: log.debug,
INFO: log.info,
WARNING: log.warn,
WARN: log.warn,
ERROR: log.error,
CRITICAL: log.critical,
};
Expand Down
26 changes: 0 additions & 26 deletions log/warn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,3 @@ export function warn<T>(
}
return getLogger("default").warn(msg, ...args);
}

/**
* @deprecated (will be removed after 0.214.0) Use {@linkcode warn} instead.
*
* Log with warning level, using default logger.
*/
export function warning<T>(msg: () => T, ...args: unknown[]): T | undefined;
/**
* @deprecated (will be removed after 0.214.0) Use {@linkcode warn} instead.
*
* Log with warning level, using default logger.
*/
export function warning<T>(
msg: T extends GenericFunction ? never : T,
...args: unknown[]
): T;
export function warning<T>(
msg: (T extends GenericFunction ? never : T) | (() => T),
...args: unknown[]
): T | undefined {
// Assist TS compiler with pass-through generic type
if (msg instanceof Function) {
return warn(msg, ...args);
}
return warn(msg, ...args);
}
Loading