@fedify/postgres 2.4.0-dev.1655 → 2.4.0-pr.934.40

package/README.md

@@ -25,6 +25,15 @@ const federation = createFederation({
 });
 ~~~~
 
+`PostgresKvStore` uses a crash-safe logged table by default.  For transient
+data where losing the table contents after a PostgreSQL crash is acceptable,
+pass `{ unlogged: true }` as its second constructor argument.
+
+When a store created by an earlier version still uses an unlogged table, its
+next initialization converts that table to logged storage.  PostgreSQL rewrites
+the table and takes an `ACCESS EXCLUSIVE` lock during this one-time migration,
+so schedule the upgrade accordingly for a large or busy table.
+
 [JSR badge]: https://jsr.io/badges/@fedify/postgres
 [JSR]: https://jsr.io/@fedify/postgres
 [npm badge]: https://img.shields.io/npm/v/@fedify/postgres?logo=npm

package/dist/kv.cjs

@@ -8,6 +8,9 @@ const logger = (0, require("@logtape/logtape").getLogger)([
 	"postgres",
 	"kv"
 ]);
+function quoteIdentifier(identifier) {
+	return `"${identifier.replaceAll("\"", "\"\"").replaceAll(".", "\".\"")}"`;
+}
 /**
 * A key–value store that uses PostgreSQL as the underlying storage.
 *
@@ -26,7 +29,9 @@ const logger = (0, require("@logtape/logtape").getLogger)([
 var PostgresKvStore = class {
 	#sql;
 	#tableName;
+	#unlogged;
 	#initialized;
+	#initializing;
 	#driverSerializesJson = false;
 	/**
 	* Creates a new PostgreSQL key–value store.
@@ -36,6 +41,7 @@ var PostgresKvStore = class {
 	constructor(sql, options = {}) {
 		this.#sql = sql;
 		this.#tableName = options.tableName ?? "fedify_kv_v2";
+		this.#unlogged = options.unlogged ?? false;
 		this.#initialized = options.initialized ?? false;
 	}
 	async #expire() {
@@ -78,6 +84,54 @@ var PostgresKvStore = class {
 		await this.#expire();
 	}
 	/**
+	* {@inheritDoc KvStore.cas}
+	* @since 2.4.0
+	*/
+	async cas(key, expectedValue, newValue, options) {
+		await this.initialize();
+		const ttl = options?.ttl == null ? null : options.ttl.toString();
+		if (expectedValue === void 0 && newValue === void 0) return await this.get(key) === void 0;
+		let result;
+		if (expectedValue === void 0) result = await this.#sql`
+        INSERT INTO ${this.#sql(this.#tableName)} AS existing
+          (key, value, created, ttl)
+        VALUES (
+          ${key},
+          ${this.#json(newValue)},
+          CURRENT_TIMESTAMP,
+          ${ttl}
+        )
+        ON CONFLICT (key)
+          DO UPDATE SET
+            value = EXCLUDED.value,
+            created = EXCLUDED.created,
+            ttl = EXCLUDED.ttl
+          WHERE existing.ttl IS NOT NULL
+            AND existing.created + existing.ttl <= CURRENT_TIMESTAMP
+        RETURNING key;
+      `;
+		else if (newValue === void 0) result = await this.#sql`
+        DELETE FROM ${this.#sql(this.#tableName)}
+        WHERE key = ${key}
+          AND (ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP)
+          AND value = ${this.#json(expectedValue)}
+        RETURNING key;
+      `;
+		else result = await this.#sql`
+        UPDATE ${this.#sql(this.#tableName)}
+        SET
+          value = ${this.#json(newValue)},
+          created = CURRENT_TIMESTAMP,
+          ttl = ${ttl}
+        WHERE key = ${key}
+          AND (ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP)
+          AND value = ${this.#json(expectedValue)}
+        RETURNING key;
+      `;
+		await this.#expire();
+		return result.length > 0;
+	}
+	/**
 	* {@inheritDoc KvStore.list}
 	* @since 1.10.0
 	*/
@@ -112,18 +166,43 @@ var PostgresKvStore = class {
 	*/
 	async initialize() {
 		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,
-        value jsonb NOT NULL,
-        created timestamp with time zone DEFAULT CURRENT_TIMESTAMP,
-        ttl interval
-      );
-    `;
-		this.#driverSerializesJson = await require_utils.driverSerializesJson(this.#sql);
-		this.#initialized = true;
-		logger.debug("Initialized the key–value store table {tableName}.", { tableName: this.#tableName });
+		this.#initializing ??= (async () => {
+			logger.debug("Initializing the key–value store table {tableName}...", { tableName: this.#tableName });
+			if (this.#unlogged) await this.#sql`
+          CREATE UNLOGGED TABLE IF NOT EXISTS ${this.#sql(this.#tableName)} (
+            key text[] PRIMARY KEY,
+            value jsonb NOT NULL,
+            created timestamp with time zone DEFAULT CURRENT_TIMESTAMP,
+            ttl interval
+          );
+        `;
+			else {
+				await this.#sql`
+          CREATE TABLE IF NOT EXISTS ${this.#sql(this.#tableName)} (
+            key text[] PRIMARY KEY,
+            value jsonb NOT NULL,
+            created timestamp with time zone DEFAULT CURRENT_TIMESTAMP,
+            ttl interval
+          );
+        `;
+				if ((await this.#sql`
+          SELECT relpersistence
+          FROM pg_class
+          WHERE oid = to_regclass(${quoteIdentifier(this.#tableName)});
+        `)[0]?.relpersistence === "u") await this.#sql`
+            ALTER TABLE ${this.#sql(this.#tableName)} SET LOGGED;
+          `;
+			}
+			this.#driverSerializesJson = await require_utils.driverSerializesJson(this.#sql);
+			this.#initialized = true;
+			logger.debug("Initialized the key–value store table {tableName}.", { tableName: this.#tableName });
+		})();
+		try {
+			await this.#initializing;
+		} catch (error) {
+			this.#initializing = void 0;
+			throw error;
+		}
 	}
 	/**
 	* Drops the table used by the key–value store.  Does nothing if the table

package/dist/kv.d.cts

@@ -18,6 +18,13 @@ interface PostgresKvStoreOptions {
   * @default `false`
   */
   readonly initialized?: boolean;
+  /**
+  * Whether to use an unlogged table.  Unlogged tables are faster, but are
+  * truncated after a PostgreSQL crash and are not replicated.  `false` by
+  * default.
+  * @default `false`
+  */
+  readonly unlogged?: boolean;
 }
 /**
 * A key–value store that uses PostgreSQL as the underlying storage.
@@ -46,6 +53,11 @@ declare class PostgresKvStore implements KvStore {
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
   /**
+  * {@inheritDoc KvStore.cas}
+  * @since 2.4.0
+  */
+  cas(key: KvKey, expectedValue: unknown, newValue: unknown, options?: KvStoreSetOptions): Promise<boolean>;
+  /**
   * {@inheritDoc KvStore.list}
   * @since 1.10.0
   */

package/dist/kv.d.ts

@@ -18,6 +18,13 @@ interface PostgresKvStoreOptions {
   * @default `false`
   */
   readonly initialized?: boolean;
+  /**
+  * Whether to use an unlogged table.  Unlogged tables are faster, but are
+  * truncated after a PostgreSQL crash and are not replicated.  `false` by
+  * default.
+  * @default `false`
+  */
+  readonly unlogged?: boolean;
 }
 /**
 * A key–value store that uses PostgreSQL as the underlying storage.
@@ -46,6 +53,11 @@ declare class PostgresKvStore implements KvStore {
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
   /**
+  * {@inheritDoc KvStore.cas}
+  * @since 2.4.0
+  */
+  cas(key: KvKey, expectedValue: unknown, newValue: unknown, options?: KvStoreSetOptions): Promise<boolean>;
+  /**
   * {@inheritDoc KvStore.list}
   * @since 1.10.0
   */

package/dist/kv.js

@@ -7,6 +7,9 @@ const logger = getLogger([
 	"postgres",
 	"kv"
 ]);
+function quoteIdentifier(identifier) {
+	return `"${identifier.replaceAll("\"", "\"\"").replaceAll(".", "\".\"")}"`;
+}
 /**
 * A key–value store that uses PostgreSQL as the underlying storage.
 *
@@ -25,7 +28,9 @@ const logger = getLogger([
 var PostgresKvStore = class {
 	#sql;
 	#tableName;
+	#unlogged;
 	#initialized;
+	#initializing;
 	#driverSerializesJson = false;
 	/**
 	* Creates a new PostgreSQL key–value store.
@@ -35,6 +40,7 @@ var PostgresKvStore = class {
 	constructor(sql, options = {}) {
 		this.#sql = sql;
 		this.#tableName = options.tableName ?? "fedify_kv_v2";
+		this.#unlogged = options.unlogged ?? false;
 		this.#initialized = options.initialized ?? false;
 	}
 	async #expire() {
@@ -77,6 +83,54 @@ var PostgresKvStore = class {
 		await this.#expire();
 	}
 	/**
+	* {@inheritDoc KvStore.cas}
+	* @since 2.4.0
+	*/
+	async cas(key, expectedValue, newValue, options) {
+		await this.initialize();
+		const ttl = options?.ttl == null ? null : options.ttl.toString();
+		if (expectedValue === void 0 && newValue === void 0) return await this.get(key) === void 0;
+		let result;
+		if (expectedValue === void 0) result = await this.#sql`
+        INSERT INTO ${this.#sql(this.#tableName)} AS existing
+          (key, value, created, ttl)
+        VALUES (
+          ${key},
+          ${this.#json(newValue)},
+          CURRENT_TIMESTAMP,
+          ${ttl}
+        )
+        ON CONFLICT (key)
+          DO UPDATE SET
+            value = EXCLUDED.value,
+            created = EXCLUDED.created,
+            ttl = EXCLUDED.ttl
+          WHERE existing.ttl IS NOT NULL
+            AND existing.created + existing.ttl <= CURRENT_TIMESTAMP
+        RETURNING key;
+      `;
+		else if (newValue === void 0) result = await this.#sql`
+        DELETE FROM ${this.#sql(this.#tableName)}
+        WHERE key = ${key}
+          AND (ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP)
+          AND value = ${this.#json(expectedValue)}
+        RETURNING key;
+      `;
+		else result = await this.#sql`
+        UPDATE ${this.#sql(this.#tableName)}
+        SET
+          value = ${this.#json(newValue)},
+          created = CURRENT_TIMESTAMP,
+          ttl = ${ttl}
+        WHERE key = ${key}
+          AND (ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP)
+          AND value = ${this.#json(expectedValue)}
+        RETURNING key;
+      `;
+		await this.#expire();
+		return result.length > 0;
+	}
+	/**
 	* {@inheritDoc KvStore.list}
 	* @since 1.10.0
 	*/
@@ -111,18 +165,43 @@ var PostgresKvStore = class {
 	*/
 	async initialize() {
 		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,
-        value jsonb NOT NULL,
-        created timestamp with time zone DEFAULT CURRENT_TIMESTAMP,
-        ttl interval
-      );
-    `;
-		this.#driverSerializesJson = await driverSerializesJson(this.#sql);
-		this.#initialized = true;
-		logger.debug("Initialized the key–value store table {tableName}.", { tableName: this.#tableName });
+		this.#initializing ??= (async () => {
+			logger.debug("Initializing the key–value store table {tableName}...", { tableName: this.#tableName });
+			if (this.#unlogged) await this.#sql`
+          CREATE UNLOGGED TABLE IF NOT EXISTS ${this.#sql(this.#tableName)} (
+            key text[] PRIMARY KEY,
+            value jsonb NOT NULL,
+            created timestamp with time zone DEFAULT CURRENT_TIMESTAMP,
+            ttl interval
+          );
+        `;
+			else {
+				await this.#sql`
+          CREATE TABLE IF NOT EXISTS ${this.#sql(this.#tableName)} (
+            key text[] PRIMARY KEY,
+            value jsonb NOT NULL,
+            created timestamp with time zone DEFAULT CURRENT_TIMESTAMP,
+            ttl interval
+          );
+        `;
+				if ((await this.#sql`
+          SELECT relpersistence
+          FROM pg_class
+          WHERE oid = to_regclass(${quoteIdentifier(this.#tableName)});
+        `)[0]?.relpersistence === "u") await this.#sql`
+            ALTER TABLE ${this.#sql(this.#tableName)} SET LOGGED;
+          `;
+			}
+			this.#driverSerializesJson = await driverSerializesJson(this.#sql);
+			this.#initialized = true;
+			logger.debug("Initialized the key–value store table {tableName}.", { tableName: this.#tableName });
+		})();
+		try {
+			await this.#initializing;
+		} catch (error) {
+			this.#initializing = void 0;
+			throw error;
+		}
 	}
 	/**
 	* Drops the table used by the key–value store.  Does nothing if the table

package/dist/mq.cjs

@@ -57,6 +57,7 @@ function getCreatedIndexName(tableName) {
 * ```
 */
 var PostgresMessageQueue = class {
+	atomicEnqueueMany = false;
 	#sql;
 	#tableName;
 	#channelName;

package/dist/mq.d.cts

@@ -62,6 +62,7 @@ interface PostgresMessageQueueOptions {
 */
 declare class PostgresMessageQueue implements MessageQueue {
   #private;
+  readonly atomicEnqueueMany = false;
   constructor(sql: Sql<{}>, options?: PostgresMessageQueueOptions);
   enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
   enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;

package/dist/mq.d.ts

@@ -62,6 +62,7 @@ interface PostgresMessageQueueOptions {
 */
 declare class PostgresMessageQueue implements MessageQueue {
   #private;
+  readonly atomicEnqueueMany = false;
   constructor(sql: Sql<{}>, options?: PostgresMessageQueueOptions);
   enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
   enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;

package/dist/mq.js

@@ -52,6 +52,7 @@ function getCreatedIndexName(tableName) {
 * ```
 */
 var PostgresMessageQueue = class {
+	atomicEnqueueMany = false;
 	#sql;
 	#tableName;
 	#channelName;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/postgres",
-  "version": "2.4.0-dev.1655+b8f3c3d5",
+  "version": "2.4.0-pr.934.40+3331d302",
   "description": "PostgreSQL drivers for Fedify",
   "keywords": [
     "fedify",
@@ -71,15 +71,15 @@
   },
   "peerDependencies": {
     "postgres": "^3.4.7",
-    "@fedify/fedify": "^2.4.0-dev.1655+b8f3c3d5"
+    "@fedify/fedify": "^2.4.0-pr.934.40+3331d302"
   },
   "devDependencies": {
     "@js-temporal/polyfill": "^0.5.1",
     "@std/async": "npm:@jsr/std__async@^1.0.13",
     "tsdown": "^0.22.0",
     "typescript": "^6.0.0",
-    "@fedify/fixture": "^2.0.0",
-    "@fedify/testing": "^2.4.0-dev.1655+b8f3c3d5"
+    "@fedify/testing": "^2.4.0-pr.934.40+3331d302",
+    "@fedify/fixture": "^2.0.0"
   },
   "scripts": {
     "build:self": "tsdown",