@fedify/postgres 0.3.0-dev.16 → 0.3.0-dev.17

package/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.

package/esm/src/kv.js

@@ -10,7 +10,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _PostgresKvStore_instances, _PostgresKvStore_sql, _PostgresKvStore_tableName, _PostgresKvStore_initialized, _PostgresKvStore_driverSerializesJson, _PostgresKvStore_expire, _PostgresKvStore_json;
+import { getLogger } from "@logtape/logtape";
 import { driverSerializesJson } from "./utils.js";
+const logger = getLogger(["fedify", "postgres", "kv"]);
 /**
  * A key-value store that uses PostgreSQL as the underlying storage.
  *
@@ -86,6 +88,9 @@ export class PostgresKvStore {
     async initialize() {
         if (__classPrivateFieldGet(this, _PostgresKvStore_initialized, "f"))
             return;
+        logger.debug("Initializing the key-value store table {tableName}...", {
+            tableName: __classPrivateFieldGet(this, _PostgresKvStore_tableName, "f"),
+        });
         await __classPrivateFieldGet(this, _PostgresKvStore_sql, "f").bind(this) `
       CREATE UNLOGGED TABLE IF NOT EXISTS ${__classPrivateFieldGet(this, _PostgresKvStore_sql, "f").call(this, __classPrivateFieldGet(this, _PostgresKvStore_tableName, "f"))} (
         key text[] PRIMARY KEY,
@@ -96,6 +101,9 @@ export class PostgresKvStore {
     `;
         __classPrivateFieldSet(this, _PostgresKvStore_driverSerializesJson, await driverSerializesJson(__classPrivateFieldGet(this, _PostgresKvStore_sql, "f")), "f");
         __classPrivateFieldSet(this, _PostgresKvStore_initialized, true, "f");
+        logger.debug("Initialized the key-value store table {tableName}.", {
+            tableName: __classPrivateFieldGet(this, _PostgresKvStore_tableName, "f"),
+        });
     }
     /**
      * Drops the table used by the key-value store.  Does nothing if the table

package/esm/src/mq.js

@@ -11,8 +11,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _PostgresMessageQueue_instances, _PostgresMessageQueue_sql, _PostgresMessageQueue_tableName, _PostgresMessageQueue_channelName, _PostgresMessageQueue_pollIntervalMs, _PostgresMessageQueue_initialized, _PostgresMessageQueue_driverSerializesJson, _PostgresMessageQueue_json;
 import * as dntShim from "../_dnt.shims.js";
+import { getLogger } from "@logtape/logtape";
 import postgres from "postgres";
 import { driverSerializesJson } from "./utils.js";
+const logger = getLogger(["fedify", "postgres", "mq"]);
 /**
  * A message queue that uses PostgreSQL as the underlying storage.
  *
@@ -53,6 +55,15 @@ export class PostgresMessageQueue {
     message, options) {
         await this.initialize();
         const delay = options?.delay ?? dntShim.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 __classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").bind(this) `
       INSERT INTO ${__classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").call(this, __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"))} (message, delay)
       VALUES (
@@ -60,7 +71,12 @@ export class PostgresMessageQueue {
         ${delay.toString()}
       );
     `;
+        logger.debug("Enqueued a message.", { message });
         await __classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").notify(__classPrivateFieldGet(this, _PostgresMessageQueue_channelName, "f"), delay.toString());
+        logger.debug("Notified the message queue channel {channelName}.", {
+            channelName: __classPrivateFieldGet(this, _PostgresMessageQueue_channelName, "f"),
+            message,
+        });
     }
     async listen(
     // deno-lint-ignore no-explicit-any
@@ -134,6 +150,9 @@ export class PostgresMessageQueue {
     async initialize() {
         if (__classPrivateFieldGet(this, _PostgresMessageQueue_initialized, "f"))
             return;
+        logger.debug("Initializing the message queue table {tableName}...", {
+            tableName: __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"),
+        });
         try {
             await __classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").bind(this) `
       CREATE TABLE IF NOT EXISTS ${__classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").call(this, __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"))} (
@@ -144,14 +163,20 @@ export class PostgresMessageQueue {
       );
     `;
         }
-        catch (e) {
-            if (!(e instanceof postgres.PostgresError &&
-                e.constraint_name === "pg_type_typname_nsp_index")) {
-                throw e;
+        catch (error) {
+            if (!(error instanceof postgres.PostgresError &&
+                error.constraint_name === "pg_type_typname_nsp_index")) {
+                logger.error("Failed to initialize the message queue table: {error}", {
+                    error,
+                });
+                throw error;
             }
         }
         __classPrivateFieldSet(this, _PostgresMessageQueue_driverSerializesJson, await driverSerializesJson(__classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f")), "f");
         __classPrivateFieldSet(this, _PostgresMessageQueue_initialized, true, "f");
+        logger.debug("Initialized the message queue table {tableName}.", {
+            tableName: __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"),
+        });
     }
     /**
      * Drops the message queue table if it exists.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/postgres",
-  "version": "0.3.0-dev.16+39d907e8",
+  "version": "0.3.0-dev.17+57e1e1d2",
   "description": "PostgreSQL drivers for Fedify",
   "keywords": [
     "fedify",
@@ -61,6 +61,7 @@
   ],
   "dependencies": {
     "@fedify/fedify": "^1.0.0",
+    "@logtape/logtape": "^0.8.0",
     "postgres": "^3.4.5",
     "@deno/shim-deno": "~0.18.0",
     "@js-temporal/polyfill": "^0.4.4"

package/script/src/kv.js

@@ -13,7 +13,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _PostgresKvStore_instances, _PostgresKvStore_sql, _PostgresKvStore_tableName, _PostgresKvStore_initialized, _PostgresKvStore_driverSerializesJson, _PostgresKvStore_expire, _PostgresKvStore_json;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostgresKvStore = void 0;
+const logtape_1 = require("@logtape/logtape");
 const utils_js_1 = require("./utils.js");
+const logger = (0, logtape_1.getLogger)(["fedify", "postgres", "kv"]);
 /**
  * A key-value store that uses PostgreSQL as the underlying storage.
  *
@@ -89,6 +91,9 @@ class PostgresKvStore {
     async initialize() {
         if (__classPrivateFieldGet(this, _PostgresKvStore_initialized, "f"))
             return;
+        logger.debug("Initializing the key-value store table {tableName}...", {
+            tableName: __classPrivateFieldGet(this, _PostgresKvStore_tableName, "f"),
+        });
         await __classPrivateFieldGet(this, _PostgresKvStore_sql, "f").bind(this) `
       CREATE UNLOGGED TABLE IF NOT EXISTS ${__classPrivateFieldGet(this, _PostgresKvStore_sql, "f").call(this, __classPrivateFieldGet(this, _PostgresKvStore_tableName, "f"))} (
         key text[] PRIMARY KEY,
@@ -99,6 +104,9 @@ class PostgresKvStore {
     `;
         __classPrivateFieldSet(this, _PostgresKvStore_driverSerializesJson, await (0, utils_js_1.driverSerializesJson)(__classPrivateFieldGet(this, _PostgresKvStore_sql, "f")), "f");
         __classPrivateFieldSet(this, _PostgresKvStore_initialized, true, "f");
+        logger.debug("Initialized the key-value store table {tableName}.", {
+            tableName: __classPrivateFieldGet(this, _PostgresKvStore_tableName, "f"),
+        });
     }
     /**
      * Drops the table used by the key-value store.  Does nothing if the table

package/script/src/mq.js

@@ -40,8 +40,10 @@ var _PostgresMessageQueue_instances, _PostgresMessageQueue_sql, _PostgresMessage
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostgresMessageQueue = void 0;
 const dntShim = __importStar(require("../_dnt.shims.js"));
+const logtape_1 = require("@logtape/logtape");
 const postgres_1 = __importDefault(require("postgres"));
 const utils_js_1 = require("./utils.js");
+const logger = (0, logtape_1.getLogger)(["fedify", "postgres", "mq"]);
 /**
  * A message queue that uses PostgreSQL as the underlying storage.
  *
@@ -82,6 +84,15 @@ class PostgresMessageQueue {
     message, options) {
         await this.initialize();
         const delay = options?.delay ?? dntShim.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 __classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").bind(this) `
       INSERT INTO ${__classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").call(this, __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"))} (message, delay)
       VALUES (
@@ -89,7 +100,12 @@ class PostgresMessageQueue {
         ${delay.toString()}
       );
     `;
+        logger.debug("Enqueued a message.", { message });
         await __classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").notify(__classPrivateFieldGet(this, _PostgresMessageQueue_channelName, "f"), delay.toString());
+        logger.debug("Notified the message queue channel {channelName}.", {
+            channelName: __classPrivateFieldGet(this, _PostgresMessageQueue_channelName, "f"),
+            message,
+        });
     }
     async listen(
     // deno-lint-ignore no-explicit-any
@@ -163,6 +179,9 @@ class PostgresMessageQueue {
     async initialize() {
         if (__classPrivateFieldGet(this, _PostgresMessageQueue_initialized, "f"))
             return;
+        logger.debug("Initializing the message queue table {tableName}...", {
+            tableName: __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"),
+        });
         try {
             await __classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").bind(this) `
       CREATE TABLE IF NOT EXISTS ${__classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f").call(this, __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"))} (
@@ -173,14 +192,20 @@ class PostgresMessageQueue {
       );
     `;
         }
-        catch (e) {
-            if (!(e instanceof postgres_1.default.PostgresError &&
-                e.constraint_name === "pg_type_typname_nsp_index")) {
-                throw e;
+        catch (error) {
+            if (!(error instanceof postgres_1.default.PostgresError &&
+                error.constraint_name === "pg_type_typname_nsp_index")) {
+                logger.error("Failed to initialize the message queue table: {error}", {
+                    error,
+                });
+                throw error;
             }
         }
         __classPrivateFieldSet(this, _PostgresMessageQueue_driverSerializesJson, await (0, utils_js_1.driverSerializesJson)(__classPrivateFieldGet(this, _PostgresMessageQueue_sql, "f")), "f");
         __classPrivateFieldSet(this, _PostgresMessageQueue_initialized, true, "f");
+        logger.debug("Initialized the message queue table {tableName}.", {
+            tableName: __classPrivateFieldGet(this, _PostgresMessageQueue_tableName, "f"),
+        });
     }
     /**
      * Drops the message queue table if it exists.

package/types/src/kv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kv.d.ts","sourceRoot":"","sources":["../../src/src/kv.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAwB,GAAG,EAAE,MAAM,UAAU,CAAC;AAG1D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,eAAgB,YAAW,OAAO;;IAO7C;;;;OAIG;gBAGD,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EACZ,OAAO,GAAE,sBAA2B;IAchC,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAWpD,GAAG,CACP,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,iBAAiB,GAAG,SAAS,GACtC,OAAO,CAAC,IAAI,CAAC;IAgBV,MAAM,CAAC,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IASvC;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAcjC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ5B"}
+{"version":3,"file":"kv.d.ts","sourceRoot":"","sources":["../../src/src/kv.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExE,OAAO,KAAK,EAAwB,GAAG,EAAE,MAAM,UAAU,CAAC;AAK1D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,eAAgB,YAAW,OAAO;;IAO7C;;;;OAIG;gBAGD,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EACZ,OAAO,GAAE,sBAA2B;IAchC,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAWpD,GAAG,CACP,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,iBAAiB,GAAG,SAAS,GACtC,OAAO,CAAC,IAAI,CAAC;IAgBV,MAAM,CAAC,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IASvC;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBjC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ5B"}

package/types/src/mq.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mq.d.ts","sourceRoot":"","sources":["../../src/src/mq.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,yBAAyB,EAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAwB,GAAG,EAAE,MAAM,UAAU,CAAC;AAI1D;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;CAC1E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,oBAAqB,YAAW,YAAY;;gBAWrD,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EACZ,OAAO,GAAE,2BAAgC;IAWrC,OAAO,CAEX,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,IAAI,CAAC;IAaV,MAAM,CAEV,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAC/C,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IA8DhB;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBjC;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ5B"}
+{"version":3,"file":"mq.d.ts","sourceRoot":"","sources":["../../src/src/mq.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,yBAAyB,EAC1B,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EAAwB,GAAG,EAAE,MAAM,UAAU,CAAC;AAM1D;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;CAC1E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,oBAAqB,YAAW,YAAY;;gBAWrD,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EACZ,OAAO,GAAE,2BAAgC;IAWrC,OAAO,CAEX,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,IAAI,CAAC;IA0BV,MAAM,CAEV,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAC/C,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IA8DhB;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAgCjC;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ5B"}