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

Add a naive sync configure implementation #29

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
226 changes: 226 additions & 0 deletions logtape/config.test.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
import { assertEquals } from "@std/assert/assert-equals";
import { assertRejects } from "@std/assert/assert-rejects";
import { assertStrictEquals } from "@std/assert/assert-strict-equals";
import assert from "node:assert/strict";
import {
type Config,
ConfigError,
configure,
configureSync,
getConfig,
reset,
resetSync,
} from "./config.ts";
import type { Filter } from "./filter.ts";
import { LoggerImpl } from "./logger.ts";
Expand Down Expand Up @@ -218,3 +221,226 @@ Deno.test("configure()", async (t) => {
});
}
});
Deno.test("configureSync()", async (t) => {
let disposed = 0;

await t.step("test", () => {
const bLogs: LogRecord[] = [];
const b: Sink & Disposable = (record) => bLogs.push(record);
b[Symbol.dispose] = () => ++disposed;
const cLogs: LogRecord[] = [];
const c: Sink = cLogs.push.bind(cLogs);
const y: Filter & Disposable = () => true;
y[Symbol.dispose] = () => ++disposed;
const config: Config<string, string> = {
sinks: { b, c },
filters: { y, debug: "debug" },
loggers: [
{
category: ["my-app", "foo"],
sinks: ["b"],
parentSinks: "override",
filters: ["y"],
},
{
category: ["my-app", "bar"],
sinks: ["c"],
filters: ["debug"],
level: "info", // deprecated
lowestLevel: "info",
},
],
};
configureSync(config);

const foo = LoggerImpl.getLogger(["my-app", "foo"]);
assertEquals(foo.sinks, [b]);
assertEquals(foo.filters, [y]);
assertEquals(foo.lowestLevel, "debug");
const bar = LoggerImpl.getLogger(["my-app", "bar"]);
assertEquals(bar.sinks, [c]);
assertEquals(bar.lowestLevel, "info");
bar.debug("ignored");
assertEquals(bLogs, []);
assertEquals(cLogs, []);
foo.warn("logged");
assertEquals(bLogs, [
{
level: "warning",
category: ["my-app", "foo"],
message: ["logged"],
rawMessage: "logged",
properties: {},
timestamp: bLogs[0].timestamp,
},
]);
assertEquals(cLogs, []);
bar.info("logged");
assertEquals(bLogs, [
{
level: "warning",
category: ["my-app", "foo"],
message: ["logged"],
rawMessage: "logged",
properties: {},
timestamp: bLogs[0].timestamp,
},
]);
assertEquals(cLogs, [
{
level: "info",
category: ["my-app", "bar"],
message: ["logged"],
rawMessage: "logged",
properties: {},
timestamp: cLogs[0].timestamp,
},
]);
assertStrictEquals(getConfig(), config);
});

await t.step("reconfigure", () => {
assert.throws(
() =>
configureSync({
sinks: {},
loggers: [{ category: "my-app" }],
}),
ConfigError,
"Already configured",
);
assertEquals(disposed, 0);

// No exception if reset is true:
const config = {
sinks: {},
loggers: [{ category: "my-app" }],
reset: true,
};
configureSync(config);
assertEquals(disposed, 2);
assertStrictEquals(getConfig(), config);
});

await t.step("tear down", () => {
resetSync();
assertStrictEquals(getConfig(), null);
});

await t.step("misconfiguration", () => {
assert.throws(
() =>
configureSync({
// deno-lint-ignore no-explicit-any
sinks: {} as any,
loggers: [
{
category: "my-app",
sinks: ["invalid"],
},
],
reset: true,
}),
ConfigError,
"Sink not found: invalid",
);
assertStrictEquals(getConfig(), null);

assert.throws(
() =>
configureSync({
sinks: {},
// deno-lint-ignore no-explicit-any
filters: {} as any,
loggers: [
{
category: "my-app",
filters: ["invalid"],
},
],
reset: true,
}),
ConfigError,
"Filter not found: invalid",
);
assertStrictEquals(getConfig(), null);
});

const metaCategories = [[], ["logtape"], ["logtape", "meta"]];
for (const metaCategory of metaCategories) {
await t.step("meta configuration: " + JSON.stringify(metaCategory), () => {
const config = {
sinks: {},
loggers: [
{
category: metaCategory,
sinks: [],
filters: [],
},
],
};
configureSync(config);

assertEquals(LoggerImpl.getLogger(["logger", "meta"]).sinks, []);
assertStrictEquals(getConfig(), config);
});

await t.step("tear down", () => {
resetSync();
assertStrictEquals(getConfig(), null);
});
}

await t.step("no async sinks", () => {
const aLogs: LogRecord[] = [];
const a: Sink & AsyncDisposable = (record) => aLogs.push(record);
a[Symbol.asyncDispose] = () => {
return Promise.resolve();
};
const config: Config<string, string> = {
sinks: { a },
loggers: [
{
category: "my-app",
sinks: ["a"],
},
],
};

assert.throws(
() => configureSync(config),
ConfigError,
"Async disposables cannot be used with configureSync",
);
assertStrictEquals(getConfig(), null);
});

await t.step("no async filters", () => {
const aLogs: LogRecord[] = [];
const a: Sink & Disposable = (record) => aLogs.push(record);
a[Symbol.dispose] = () => ++disposed;
const x: Filter & AsyncDisposable = () => true;
x[Symbol.asyncDispose] = () => {
++disposed;
return Promise.resolve();
};
const config: Config<string, string> = {
sinks: { a },
filters: { x },
loggers: [
{
category: "my-app",
sinks: ["a"],
filters: ["x"],
},
],
};

assert.throws(
() => configureSync(config),
ConfigError,
"Async disposables cannot be used with configureSync",
);
assertStrictEquals(getConfig(), null);
});
});
Loading