@logtape/logtape 0.1.0 → 0.2.0-dev.19

package/README.md

@@ -63,7 +63,7 @@ the application to set up LogTape):
 ~~~~ typescript
 import { configure, getConsoleSink } from "@logtape/logtape";
 
-configure({
+await configure({
   sinks: { console: getConsoleSink() },
   filters: {},
   loggers: [
@@ -140,7 +140,7 @@ Here's an example of setting log levels for different categories:
 ~~~~ typescript
 import { configure, getConsoleSink } from "@logtape/logtape";
 
-configure({
+await configure({
   sinks: {
     console: getConsoleSink(),
   },
@@ -169,7 +169,7 @@ Here's a simple example of a sink that writes log messages to console:
 ~~~~ typescript
 import { configure } from "@logtape/logtape";
 
-configure({
+await configure({
   sinks: {
     console(record) {
       console.log(record.message);
@@ -187,7 +187,7 @@ provides a console sink:
 ~~~~ typescript
 import { configure, getConsoleSink } from "@logtape/logtape";
 
-configure({
+await configure({
   sinks: {
     console: getConsoleSink(),
   },
@@ -209,7 +209,7 @@ messages to the standard error:
 
 ~~~~ typescript
 // Deno:
-configure({
+await configure({
   sinks: {
     stream: getStreamSink(Deno.stderr.writable),
   },
@@ -221,7 +221,7 @@ configure({
 // Node.js:
 import stream from "node:stream";
 
-configure({
+await configure({
   sinks: {
     stream: getStreamSink(stream.Writable.toWeb(process.stderr)),
   },
@@ -256,7 +256,7 @@ writes log messages to a file:
 ~~~~ typescript
 import { getFileSink } from "@logtape/logtape";
 
-configure({
+await configure({
   sinks: {
     file: getFileSink("my-app.log"),
   },
@@ -283,7 +283,7 @@ export type TextFormatter = (record: LogRecord) => string;
 Here's an example of a text formatter that writes log messages in a JSON format:
 
 ~~~~ typescript
-configure({
+await configure({
   sinks: {
     stream: getStreamSink(Deno.stderr.writable, {
       formatter: JSON.stringify,
@@ -309,6 +309,40 @@ disposableSink[Symbol.dispose] = () => {
 };
 ~~~~
 
+A sync can be asynchronously disposed of as well.  The type of an asynchronous
+disposable sink is: `Sink & AsyncDisposable`.  You can create an asynchronous
+disposable sink by defining a `[Symbol.asyncDispose]` method:
+
+~~~~ typescript
+const asyncDisposableSink: Sink & AsyncDisposable = (record: LogRecord) => {
+  console.log(record.message);
+};
+asyncDisposableSink[Symbol.asyncDispose] = async () => {
+  console.log("Disposed!");
+};
+~~~~
+
+### Explicit disposal
+
+You can explicitly dispose of a sink by calling the `dispose()` method.  It is
+useful when you want to flush the buffer of a sink without blocking returning
+a response in edge functions.  Here's an example of using the `dispose()`
+with [`ctx.waitUntil()`] in Cloudflare Workers:
+
+~~~~ typescript
+import { configure, dispose } from "@logtape/logtape";
+
+export default {
+  async fetch(request, env, ctx) {
+    await configure({ /* ... */ });
+    // ...
+    ctx.waitUntil(dispose());
+  }
+}
+~~~~
+
+[`ctx.waitUntil()`]: https://developers.cloudflare.com/workers/runtime-apis/context/#waituntil
+
 
 Testing
 -------
@@ -326,16 +360,16 @@ the following code shows how to reset the configuration after a test
 import { configure, reset } from "@logtape/logtape";
 
 Deno.test("my test", async (t) => {
-  await t.step("set up", () => {
-    configure({ /* ... */ });
+  await t.step("set up", async () => {
+    await configure({ /* ... */ });
   });
 
   await t.step("run test", () => {
     // Run the test
   });
 
-  await t.step("tear down", () => {
-    reset();
+  await t.step("tear down", async () => {
+    await reset();
   });
 });
 ~~~~
@@ -350,7 +384,7 @@ import { type LogRecord, configure } from "@logtape/logtape";
 
 const buffer: LogRecord[] = [];
 
-configure({
+await configure({
   sinks: {
     buffer: buffer.push.bind(buffer),
   },

package/esm/config.js

@@ -10,6 +10,10 @@ let configured = false;
  * Disposables to dispose when resetting the configuration.
  */
 const disposables = new Set();
+/**
+ * Async disposables to dispose when resetting the configuration.
+ */
+const asyncDisposables = new Set();
 /**
  * Configure the loggers with the specified configuration.
  *
@@ -18,7 +22,7 @@ const disposables = new Set();
  *
  * @example
  * ```typescript
- * configure({
+ * await configure({
  *   sinks: {
  *     console: getConsoleSink(),
  *   },
@@ -49,11 +53,11 @@ const disposables = new Set();
  *
  * @param config The configuration.
  */
-export function configure(config) {
+export async function configure(config) {
     if (configured && !config.reset) {
         throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
     }
-    reset();
+    await reset();
     configured = true;
     let metaConfigured = false;
     for (const cfg of config.loggers) {
@@ -68,7 +72,7 @@ export function configure(config) {
         for (const sinkId of cfg.sinks ?? []) {
             const sink = config.sinks[sinkId];
             if (!sink) {
-                reset();
+                await reset();
                 throw new ConfigError(`Sink not found: ${sinkId}.`);
             }
             logger.sinks.push(sink);
@@ -78,18 +82,26 @@ export function configure(config) {
         for (const filterId of cfg.filters ?? []) {
             const filter = config.filters[filterId];
             if (filter === undefined) {
-                reset();
+                await reset();
                 throw new ConfigError(`Filter not found: ${filterId}.`);
             }
             logger.filters.push(toFilter(filter));
         }
     }
     for (const sink of Object.values(config.sinks)) {
+        if (Symbol.asyncDispose in sink) {
+            asyncDisposables.add(sink);
+        }
         if (Symbol.dispose in sink)
             disposables.add(sink);
     }
     for (const filter of Object.values(config.filters)) {
-        if (filter != null && typeof filter !== "string" && Symbol.dispose in filter)
+        if (filter == null || typeof filter === "string")
+            continue;
+        if (Symbol.asyncDispose in filter) {
+            asyncDisposables.add(filter);
+        }
+        if (Symbol.dispose in filter)
             disposables.add(filter);
     }
     if ("process" in dntShim.dntGlobalThis) { // @ts-ignore: It's fine to use process in Node
@@ -114,18 +126,24 @@ export function configure(config) {
 /**
  * Reset the configuration.  Mostly for testing purposes.
  */
-export function reset() {
-    dispose();
+export async function reset() {
+    await dispose();
     LoggerImpl.getLogger([]).resetDescendants();
     configured = false;
 }
 /**
  * Dispose of the disposables.
  */
-export function dispose() {
+export async function dispose() {
     for (const disposable of disposables)
         disposable[Symbol.dispose]();
     disposables.clear();
+    const promises = [];
+    for (const disposable of asyncDisposables) {
+        promises.push(disposable[Symbol.asyncDispose]());
+        asyncDisposables.delete(disposable);
+    }
+    await Promise.all(promises);
 }
 /**
  * A configuration error.

package/esm/mod.js

@@ -1,4 +1,4 @@
-export { ConfigError, configure, reset, } from "./config.js";
+export { ConfigError, configure, dispose, reset, } from "./config.js";
 export { getFileSink } from "./filesink.node.js";
 export { getLevelFilter, toFilter, } from "./filter.js";
 export { defaultConsoleFormatter, defaultTextFormatter, } from "./formatter.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/logtape",
-  "version": "0.1.0",
+  "version": "0.2.0-dev.19+9c900230",
   "description": "Simple logging library for Deno/Node.js/Bun/browsers",
   "keywords": [
     "logging",

package/script/config.js

@@ -36,6 +36,10 @@ let configured = false;
  * Disposables to dispose when resetting the configuration.
  */
 const disposables = new Set();
+/**
+ * Async disposables to dispose when resetting the configuration.
+ */
+const asyncDisposables = new Set();
 /**
  * Configure the loggers with the specified configuration.
  *
@@ -44,7 +48,7 @@ const disposables = new Set();
  *
  * @example
  * ```typescript
- * configure({
+ * await configure({
  *   sinks: {
  *     console: getConsoleSink(),
  *   },
@@ -75,11 +79,11 @@ const disposables = new Set();
  *
  * @param config The configuration.
  */
-function configure(config) {
+async function configure(config) {
     if (configured && !config.reset) {
         throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
     }
-    reset();
+    await reset();
     configured = true;
     let metaConfigured = false;
     for (const cfg of config.loggers) {
@@ -94,7 +98,7 @@ function configure(config) {
         for (const sinkId of cfg.sinks ?? []) {
             const sink = config.sinks[sinkId];
             if (!sink) {
-                reset();
+                await reset();
                 throw new ConfigError(`Sink not found: ${sinkId}.`);
             }
             logger.sinks.push(sink);
@@ -104,18 +108,26 @@ function configure(config) {
         for (const filterId of cfg.filters ?? []) {
             const filter = config.filters[filterId];
             if (filter === undefined) {
-                reset();
+                await reset();
                 throw new ConfigError(`Filter not found: ${filterId}.`);
             }
             logger.filters.push((0, filter_js_1.toFilter)(filter));
         }
     }
     for (const sink of Object.values(config.sinks)) {
+        if (Symbol.asyncDispose in sink) {
+            asyncDisposables.add(sink);
+        }
         if (Symbol.dispose in sink)
             disposables.add(sink);
     }
     for (const filter of Object.values(config.filters)) {
-        if (filter != null && typeof filter !== "string" && Symbol.dispose in filter)
+        if (filter == null || typeof filter === "string")
+            continue;
+        if (Symbol.asyncDispose in filter) {
+            asyncDisposables.add(filter);
+        }
+        if (Symbol.dispose in filter)
             disposables.add(filter);
     }
     if ("process" in dntShim.dntGlobalThis) { // @ts-ignore: It's fine to use process in Node
@@ -141,8 +153,8 @@ exports.configure = configure;
 /**
  * Reset the configuration.  Mostly for testing purposes.
  */
-function reset() {
-    dispose();
+async function reset() {
+    await dispose();
     logger_js_1.LoggerImpl.getLogger([]).resetDescendants();
     configured = false;
 }
@@ -150,10 +162,16 @@ exports.reset = reset;
 /**
  * Dispose of the disposables.
  */
-function dispose() {
+async function dispose() {
     for (const disposable of disposables)
         disposable[Symbol.dispose]();
     disposables.clear();
+    const promises = [];
+    for (const disposable of asyncDisposables) {
+        promises.push(disposable[Symbol.asyncDispose]());
+        asyncDisposables.delete(disposable);
+    }
+    await Promise.all(promises);
 }
 exports.dispose = dispose;
 /**

package/script/mod.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStreamSink = exports.getConsoleSink = exports.getLogger = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = exports.getFileSink = exports.reset = exports.configure = exports.ConfigError = void 0;
+exports.getStreamSink = exports.getConsoleSink = exports.getLogger = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = exports.getFileSink = exports.reset = exports.dispose = exports.configure = exports.ConfigError = void 0;
 var config_js_1 = require("./config.js");
 Object.defineProperty(exports, "ConfigError", { enumerable: true, get: function () { return config_js_1.ConfigError; } });
 Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return config_js_1.configure; } });
+Object.defineProperty(exports, "dispose", { enumerable: true, get: function () { return config_js_1.dispose; } });
 Object.defineProperty(exports, "reset", { enumerable: true, get: function () { return config_js_1.reset; } });
 var filesink_node_js_1 = require("./filesink.node.js");
 Object.defineProperty(exports, "getFileSink", { enumerable: true, get: function () { return filesink_node_js_1.getFileSink; } });

package/types/config.d.ts

@@ -55,7 +55,7 @@ export interface LoggerConfig<TSinkId extends string, TFilterId extends string>
  *
  * @example
  * ```typescript
- * configure({
+ * await configure({
  *   sinks: {
  *     console: getConsoleSink(),
  *   },
@@ -86,15 +86,15 @@ export interface LoggerConfig<TSinkId extends string, TFilterId extends string>
  *
  * @param config The configuration.
  */
-export declare function configure<TSinkId extends string, TFilterId extends string>(config: Config<TSinkId, TFilterId>): void;
+export declare function configure<TSinkId extends string, TFilterId extends string>(config: Config<TSinkId, TFilterId>): Promise<void>;
 /**
  * Reset the configuration.  Mostly for testing purposes.
  */
-export declare function reset(): void;
+export declare function reset(): Promise<void>;
 /**
  * Dispose of the disposables.
  */
-export declare function dispose(): void;
+export declare function dispose(): Promise<void>;
 /**
  * A configuration error.
  */

package/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAkB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACtE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAC3B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CACzB;AAYD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,SAAS,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,EACxE,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,QA0EnC;AAED;;GAEG;AACH,wBAAgB,KAAK,SAIpB;AAED;;GAEG;AACH,wBAAgB,OAAO,SAGtB;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC;;;OAGG;gBACS,OAAO,EAAE,MAAM;CAI5B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAkB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACtE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAC3B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CACzB;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAsB,SAAS,CAC7B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM,EACxB,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CA8EnD;AAED;;GAEG;AACH,wBAAsB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAI3C;AAED;;GAEG;AACH,wBAAsB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAS7C;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC;;;OAGG;gBACS,OAAO,EAAE,MAAM;CAI5B"}

package/types/deps/jsr.io/@std/assert/0.222.1/assert_rejects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert_rejects.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert_rejects.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,EAAE,EAAE,MAAM,WAAW,CAAC,OAAO,CAAC,EAC9B,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,OAAO,CAAC,CAAC;AACpB;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,EACnD,EAAE,EAAE,MAAM,WAAW,CAAC,OAAO,CAAC,EAE9B,UAAU,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EACrC,WAAW,CAAC,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/types/mod.d.ts

@@ -1,4 +1,4 @@
-export { type Config, ConfigError, configure, type LoggerConfig, reset, } from "./config.js";
+export { type Config, ConfigError, configure, dispose, type LoggerConfig, reset, } from "./config.js";
 export { getFileSink } from "./filesink.node.js";
 export { type Filter, type FilterLike, getLevelFilter, toFilter, } from "./filter.js";
 export { type ConsoleFormatter, defaultConsoleFormatter, defaultTextFormatter, type TextFormatter, } from "./formatter.js";

package/types/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,cAAc,EACd,aAAa,EACb,KAAK,IAAI,EACT,KAAK,iBAAiB,GACvB,MAAM,WAAW,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,cAAc,EACd,aAAa,EACb,KAAK,IAAI,EACT,KAAK,iBAAiB,GACvB,MAAM,WAAW,CAAC"}