Logging

Author: dahlia

.vscode/settings.json

@@ -26,6 +26,7 @@
   },
   "cSpell.words": [
     "fedify",
+    "logtape",
     "unlisten",
     "UNLOGGED"
   ]

README.md

@@ -68,6 +68,14 @@ Changelog
 
 To be released.
 
+ -  Added some logging using [LogTape] for the sake of debugging.  The following
+    categories are used:
+
+     -  `["fedify", "postgres", "kv"]`
+     -  `["fedify", "postgres", "mq"]`
+
+[LogTape]: https://logtape.org/
+
 ### Version 0.2.2
 
 Released on November 18, 2024.

deno.json

@@ -10,6 +10,7 @@
   "imports": {
     "@deno/dnt": "jsr:@deno/dnt@^0.41.3",
     "@fedify/fedify": "jsr:@fedify/fedify@^1.0.0",
+    "@logtape/logtape": "jsr:@logtape/logtape@^0.8.0",
     "@std/assert": "jsr:@std/assert@^0.226.0",
     "@std/async": "jsr:@std/async@^1.0.5",
     "postgres": "npm:postgres@^3.4.5"

deno.lock

@@ -13,6 +13,10 @@ await Deno.writeTextFile(
         /^jsr:/,
         "npm:",
       ),
+      "@logtape/logtape": metadata.imports["@logtape/logtape"].replace(
+        /^jsr:/,
+        "npm:",
+      ),
     },
   }),
 );

dnt.ts

@@ -1,7 +1,10 @@
 import type { KvKey, KvStore, KvStoreSetOptions } from "@fedify/fedify";
+import { getLogger } from "@logtape/logtape";
 import type { JSONValue, Parameter, Sql } from "postgres";
 import { driverSerializesJson } from "./utils.ts";
 
+const logger = getLogger(["fedify", "postgres", "kv"]);
+
 /**
  * Options for the PostgreSQL key-value store.
  */
@@ -110,6 +113,9 @@ export class PostgresKvStore implements KvStore {
    */
   async initialize(): Promise<void> {
     if (this.#initialized) return;
+    logger.debug("Initializing the key-value store table {tableName}...", {
+      tableName: this.#tableName,
+    });
     await this.#sql`
       CREATE UNLOGGED TABLE IF NOT EXISTS ${this.#sql(this.#tableName)} (
         key text[] PRIMARY KEY,
@@ -120,6 +126,9 @@ export class PostgresKvStore implements KvStore {
     `;
     this.#driverSerializesJson = await driverSerializesJson(this.#sql);
     this.#initialized = true;
+    logger.debug("Initialized the key-value store table {tableName}.", {
+      tableName: this.#tableName,
+    });
   }
 
   /**

src/kv.ts

@@ -3,10 +3,13 @@ import type {
   MessageQueueEnqueueOptions,
   MessageQueueListenOptions,
 } from "@fedify/fedify";
+import { getLogger } from "@logtape/logtape";
 import type { JSONValue, Parameter, Sql } from "postgres";
 import postgres from "postgres";
 import { driverSerializesJson } from "./utils.ts";
 
+const logger = getLogger(["fedify", "postgres", "mq"]);
+
 /**
  * Options for the PostgreSQL message queue.
  */
@@ -85,14 +88,27 @@ export class PostgresMessageQueue implements MessageQueue {
   ): Promise<void> {
     await this.initialize();
     const delay = options?.delay ?? Temporal.Duration.from({ seconds: 0 });
+    if (options?.delay) {
+      logger.debug("Enqueuing a message with a delay of {delay}...", {
+        delay,
+        message,
+      });
+    } else {
+      logger.debug("Enqueuing a message...", { message });
+    }
     await this.#sql`
       INSERT INTO ${this.#sql(this.#tableName)} (message, delay)
       VALUES (
         ${this.#json(message)},
         ${delay.toString()}
       );
     `;
+    logger.debug("Enqueued a message.", { message });
     await this.#sql.notify(this.#channelName, delay.toString());
+    logger.debug("Notified the message queue channel {channelName}.", {
+      channelName: this.#channelName,
+      message,
+    });
   }
 
   async listen(
@@ -166,6 +182,9 @@ export class PostgresMessageQueue implements MessageQueue {
    */
   async initialize(): Promise<void> {
     if (this.#initialized) return;
+    logger.debug("Initializing the message queue table {tableName}...", {
+      tableName: this.#tableName,
+    });
     try {
       await this.#sql`
       CREATE TABLE IF NOT EXISTS ${this.#sql(this.#tableName)} (
@@ -175,16 +194,22 @@ export class PostgresMessageQueue implements MessageQueue {
         created timestamp with time zone DEFAULT CURRENT_TIMESTAMP
       );
     `;
-    } catch (e) {
+    } catch (error) {
       if (
-        !(e instanceof postgres.PostgresError &&
-          e.constraint_name === "pg_type_typname_nsp_index")
+        !(error instanceof postgres.PostgresError &&
+          error.constraint_name === "pg_type_typname_nsp_index")
       ) {
-        throw e;
+        logger.error("Failed to initialize the message queue table: {error}", {
+          error,
+        });
+        throw error;
       }
     }
     this.#driverSerializesJson = await driverSerializesJson(this.#sql);
     this.#initialized = true;
+    logger.debug("Initialized the message queue table {tableName}.", {
+      tableName: this.#tableName,
+    });
   }
 
   /**