@zukhruf/mutex 0.3.40 → 0.3.42

package/dist/lock-stores/mysql/get-lock-dialect.js

@@ -0,0 +1,80 @@
+import { untilAborted } from '@zukhruf/async';
+import { keyDigest } from "../../shared/key-digest.js";
+/**
+ * The name of the user lock, made on the server from the database of the
+ * session and the digest of the key (the one `?`). A user lock belongs to
+ * the whole server, but the token source belongs to one database, so the
+ * lock belongs to one database too. SHA-256 gives 64 lowercase hex
+ * characters: the limit of MySQL, and the same under a comparison with or
+ * without case. With no database, the name is NULL, and the statement fails.
+ */
+export const lockName = "SHA2(CONCAT(DATABASE(), ':', ?), 256)";
+/** `GET_LOCK` gives 1 for a grant and 0 for a timeout; NULL is an error, for example a killed statement. */
+function granted(row, server) {
+    const locked = row?.['locked'];
+    if (locked === null || locked === undefined) {
+        throw new Error(`GET_LOCK of ${server} gave NULL.`);
+    }
+    return Number(locked) === 1;
+}
+function isRow(value) {
+    return typeof value === 'object' && value !== null;
+}
+/**
+ * The dialect of a user lock (`GET_LOCK`) for each key. The name of each lock
+ * includes the database of the session, so the locks belong to one database.
+ * The client sends the key digest as 64 lowercase hex characters.
+ */
+export function getLockDialect(server) {
+    const runOn = (session) => async (sql, values) => {
+        const result = await server.run(session, sql, values);
+        if (!Array.isArray(result))
+            return undefined;
+        const first = result[0];
+        return isRow(first) ? first : undefined;
+    };
+    return {
+        server: server.server,
+        lockName: (key) => keyDigest(key).toString('hex'),
+        // A timeout of `GET_LOCK` (MariaDB's longest is one year) waits again.
+        wait: async (session, { name }, signal) => {
+            for (;;) {
+                const row = await untilAborted(runOn(session)(server.waitStatement, [name]), signal);
+                if (granted(row, server.server))
+                    return;
+            }
+        },
+        try: async (session, { name }) => granted(await runOn(session)(`SELECT GET_LOCK(${lockName}, 0) AS locked`, [
+            name,
+        ]), server.server),
+        mint: (session) => server.mint(runOn(session)),
+        // `IS_USED_LOCK` never acquires the lock. It gives NULL for a free lock.
+        holds: async (session, { name }) => {
+            const row = await runOn(session)(`SELECT IS_USED_LOCK(${lockName}) = CONNECTION_ID() AS held`, [name]);
+            return Number(row?.['held']) === 1;
+        },
+        release: async (session, { name }) => {
+            const row = await runOn(session)(`SELECT RELEASE_LOCK(${lockName}) AS released`, [name]);
+            return Number(row?.['released']) === 1;
+        },
+        /** Reads `IS_USED_LOCK`, which never acquires the lock. A session with no database fails. */
+        isHeld: async (session, { name }) => {
+            const row = await runOn(session)(`SELECT IS_USED_LOCK(${lockName}) AS holder, DATABASE() AS db`, [name]);
+            if (row?.['db'] === null) {
+                throw new Error(`The ${server.server} session has no database.`);
+            }
+            return row?.['holder'] !== null;
+        },
+        detach: (session, { error, end }) => {
+            session.off('error', error);
+            session.off('end', end);
+        },
+        giveBack: (session) => server.giveBack(session),
+        destroy: (session) => session.destroy(),
+    };
+}
+/** Quotes one identifier for MySQL and MariaDB. */
+export function quoteName(name) {
+    return `\`${name.replaceAll('`', '``')}\``;
+}
+//# sourceMappingURL=get-lock-dialect.js.map

package/dist/lock-stores/mysql/get-lock-dialect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-lock-dialect.js","sourceRoot":"","sources":["../../../src/lock-stores/mysql/get-lock-dialect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAqCvD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,uCAAuC,CAAC;AAEhE,4GAA4G;AAC5G,SAAS,OAAO,CAAC,GAAoB,EAAE,MAAc;IACnD,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC/B,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,eAAe,MAAM,aAAa,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,KAAK,CAAC,KAAc;IAC3B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,MAA8B;IAE9B,MAAM,KAAK,GACT,CAAC,OAAgB,EAAgB,EAAE,CACnC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;QACpB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,OAAO,SAAS,CAAC;QAC7C,MAAM,KAAK,GAAY,MAAM,CAAC,CAAC,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1C,CAAC,CAAC;IACJ,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QACjD,uEAAuE;QACvE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE;YACxC,SAAS,CAAC;gBACR,MAAM,GAAG,GAAG,MAAM,YAAY,CAC5B,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,EAC5C,MAAM,CACP,CAAC;gBACF,IAAI,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;oBAAE,OAAO;YAC1C,CAAC;QACH,CAAC;QACD,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAC/B,OAAO,CACL,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC,mBAAmB,QAAQ,gBAAgB,EAAE;YAChE,IAAI;SACL,CAAC,EACF,MAAM,CAAC,MAAM,CACd;QACH,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9C,yEAAyE;QACzE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YACjC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAC9B,uBAAuB,QAAQ,6BAA6B,EAC5D,CAAC,IAAI,CAAC,CACP,CAAC;YACF,OAAO,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YACnC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAC9B,uBAAuB,QAAQ,eAAe,EAC9C,CAAC,IAAI,CAAC,CACP,CAAC;YACF,OAAO,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC;QACD,6FAA6F;QAC7F,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAClC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAC9B,uBAAuB,QAAQ,+BAA+B,EAC9D,CAAC,IAAI,CAAC,CACP,CAAC;YACF,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,OAAO,MAAM,CAAC,MAAM,2BAA2B,CAAC,CAAC;YACnE,CAAC;YACD,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;QAClC,CAAC;QACD,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YAClC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC/C,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;KACxC,CAAC;AACJ,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,OAAO,KAAK,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC;AAC7C,CAAC"}

package/dist/lock-stores/mysql/index.d.ts

@@ -0,0 +1,2 @@
+export { MysqlStore, type MysqlSession, type MysqlStoreOptions, } from './mysql-store.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/lock-stores/mysql/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lock-stores/mysql/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,KAAK,YAAY,EACjB,KAAK,iBAAiB,GACvB,MAAM,kBAAkB,CAAC"}

package/dist/lock-stores/mysql/index.js

@@ -0,0 +1,2 @@
+export { MysqlStore, } from "./mysql-store.js";
+//# sourceMappingURL=index.js.map

package/dist/lock-stores/mysql/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lock-stores/mysql/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,GAGX,MAAM,kBAAkB,CAAC"}

package/dist/lock-stores/mysql/mysql-store.d.ts

@@ -0,0 +1,37 @@
+import { SessionLockStore } from '../session/session-lock-store.ts';
+import { type GetLockSession } from './get-lock-dialect.ts';
+/**
+ * One connection to the MySQL server: only the methods that the store calls.
+ * A `PoolConnection` of `mysql2/promise` fits it.
+ */
+export interface MysqlSession extends GetLockSession {
+    query(sql: string, values: unknown[]): Promise<[unknown, unknown]>;
+    /** Gives the session back to its pool. */
+    release(): void;
+}
+export interface MysqlStoreOptions {
+    /** Gives a new session. The store owns each session that it gets. */
+    connect(): Promise<MysqlSession>;
+    /**
+     * The name of an existing table in the database of the session, with one
+     * row and one `BIGINT UNSIGNED` column `id`, for the fencing tokens. The
+     * store runs no DDL.
+     */
+    table: string;
+    /**
+     * Milliseconds between two heartbeats of a holder, and the time limit of
+     * each heartbeat: the longest time that a holder can work after its session
+     * ended, before its signal aborts.
+     */
+    heartbeatInterval: number;
+}
+/**
+ * Holds a MySQL user lock (`GET_LOCK`) for each key, on a session of its own.
+ * The server releases the lock when the session ends, so a holder that stops
+ * never leaves a key locked. Every process on every machine that reaches one
+ * MySQL database shares the locks.
+ */
+export declare class MysqlStore extends SessionLockStore<MysqlSession> {
+    constructor({ connect, table, heartbeatInterval }: MysqlStoreOptions);
+}
+//# sourceMappingURL=mysql-store.d.ts.map

package/dist/lock-stores/mysql/mysql-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mysql-store.d.ts","sourceRoot":"","sources":["../../../src/lock-stores/mysql/mysql-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAEL,KAAK,cAAc,EAIpB,MAAM,uBAAuB,CAAC;AAE/B;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACnE,0CAA0C;IAC1C,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IACjC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,gBAAgB,CAAC,YAAY,CAAC;gBAChD,EAAE,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAE,iBAAiB;CAMrE"}

package/dist/lock-stores/mysql/mysql-store.js

@@ -0,0 +1,35 @@
+import { SessionLockStore } from "../session/session-lock-store.js";
+import { getLockDialect, lockName, quoteName, } from "./get-lock-dialect.js";
+/**
+ * Holds a MySQL user lock (`GET_LOCK`) for each key, on a session of its own.
+ * The server releases the lock when the session ends, so a holder that stops
+ * never leaves a key locked. Every process on every machine that reaches one
+ * MySQL database shares the locks.
+ */
+export class MysqlStore extends SessionLockStore {
+    constructor({ connect, table, heartbeatInterval }) {
+        super({ connect, heartbeatInterval }, getLockDialect(mysqlServer(quoteName(table))));
+    }
+}
+function mysqlServer(table) {
+    return {
+        server: 'MySQL',
+        // A negative timeout waits with no limit. The hint lifts the session's
+        // max_execution_time, which interrupts a waiting GET_LOCK.
+        waitStatement: `SELECT /*+ SET_VAR(max_execution_time = 0) */ GET_LOCK(${lockName}, -1) AS locked`,
+        run: async (session, sql, values) => (await session.query(sql, values))[0],
+        giveBack: (session) => session.release(),
+        // The sequence of the MySQL manual (LAST_INSERT_ID(expr)). An UPDATE that
+        // changes no row leaves LAST_INSERT_ID() at the session's last token.
+        mint: async (run) => {
+            await run(`UPDATE ${table} SET id = LAST_INSERT_ID(id + 1)`, []);
+            const row = await run('SELECT CAST(LAST_INSERT_ID() AS CHAR) AS token, ROW_COUNT() AS updated', []);
+            const updated = Number(row?.['updated']);
+            if (updated !== 1 || typeof row?.['token'] !== 'string') {
+                throw new Error(`The token table ${table} must have exactly one row; the update changed ${updated}.`);
+            }
+            return BigInt(row['token']);
+        },
+    };
+}
+//# sourceMappingURL=mysql-store.js.map

package/dist/lock-stores/mysql/mysql-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mysql-store.js","sourceRoot":"","sources":["../../../src/lock-stores/mysql/mysql-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAGL,cAAc,EACd,QAAQ,EACR,SAAS,GACV,MAAM,uBAAuB,CAAC;AA6B/B;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,gBAA8B;IAC5D,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAqB;QAClE,KAAK,CACH,EAAE,OAAO,EAAE,iBAAiB,EAAE,EAC9B,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAC9C,CAAC;IACJ,CAAC;CACF;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,OAAO;QACL,MAAM,EAAE,OAAO;QACf,uEAAuE;QACvE,2DAA2D;QAC3D,aAAa,EAAE,0DAA0D,QAAQ,iBAAiB;QAClG,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;QACxC,0EAA0E;QAC1E,sEAAsE;QACtE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YAClB,MAAM,GAAG,CAAC,UAAU,KAAK,kCAAkC,EAAE,EAAE,CAAC,CAAC;YACjE,MAAM,GAAG,GAAG,MAAM,GAAG,CACnB,wEAAwE,EACxE,EAAE,CACH,CAAC;YACF,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;YACzC,IAAI,OAAO,KAAK,CAAC,IAAI,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACxD,MAAM,IAAI,KAAK,CACb,mBAAmB,KAAK,kDAAkD,OAAO,GAAG,CACrF,CAAC;YACJ,CAAC;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9B,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/lock-stores/postgres/postgres-store.d.ts

@@ -1,5 +1,4 @@
-import type { LockHandle } from '../../mutex/lease.ts';
-import type { AcquireOptions, LockStore } from '../../mutex/lock-store.ts';
+import { SessionLockStore } from '../session/session-lock-store.ts';
 /**
  * One connection to the Postgres server: only the methods that the store
  * calls. A `PoolClient` of `pg` (node-postgres) fits it.
@@ -36,12 +35,7 @@ export interface PostgresStoreOptions {
  * first one gets a session: one session per key per process, however many
  * callers wait, and first-come order within the process.
  */
-export declare class PostgresStore implements LockStore {
-    #private;
+export declare class PostgresStore extends SessionLockStore<PostgresSession> {
     constructor(options: PostgresStoreOptions);
-    acquire(key: string, options?: AcquireOptions): Promise<LockHandle>;
-    tryAcquire(key: string): Promise<LockHandle | undefined>;
-    /** Reads `pg_locks` on a short session, and never runs an advisory lock function. */
-    isHeld(key: string): Promise<boolean>;
 }
 //# sourceMappingURL=postgres-store.d.ts.map

package/dist/lock-stores/postgres/postgres-store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postgres-store.d.ts","sourceRoot":"","sources":["../../../src/lock-stores/postgres/postgres-store.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAG3E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,CACH,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,OAAO,EAAE,GAChB,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;KAAE,CAAC,CAAC;IAChD,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;IAC9D,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC;IAChD,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;IACvE,sEAAsE;IACtE,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,qEAAqE;IACrE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACpC,sFAAsF;IACtF,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAWD;;;;;;;;;GASG;AACH,qBAAa,aAAc,YAAW,SAAS;;gBAIjC,OAAO,EAAE,oBAAoB;IAInC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAUnE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAU9D,qFAAqF;IAC/E,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAkC5C"}
+{"version":3,"file":"postgres-store.d.ts","sourceRoot":"","sources":["../../../src/lock-stores/postgres/postgres-store.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,gBAAgB,EACjB,MAAM,kCAAkC,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,CACH,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,OAAO,EAAE,GAChB,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;KAAE,CAAC,CAAC;IAChD,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;IAC9D,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC;IAChD,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;IACvE,sEAAsE;IACtE,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,qEAAqE;IACrE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACpC,sFAAsF;IACtF,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAeD;;;;;;;;;GASG;AACH,qBAAa,aAAc,SAAQ,gBAAgB,CAAC,eAAe,CAAC;gBACtD,OAAO,EAAE,oBAAoB;CAG1C"}

package/dist/lock-stores/postgres/postgres-store.js

@@ -1,17 +1,16 @@
-import { createHash } from 'node:crypto';
-import { setTimeout as delay } from 'node:timers/promises';
 import { untilAborted } from '@zukhruf/async';
-import { FencingToken } from '@zukhruf/fencing';
-import { LeaseController } from '@zukhruf/lease';
-import { MemoryStore } from "../memory/memory-store.js";
-const heldQuery = `SELECT EXISTS (
-  SELECT 1 FROM pg_catalog.pg_locks
+import { keyDigest } from "../../shared/key-digest.js";
+import { SessionLockStore, } from "../session/session-lock-store.js";
+/** The granted advisory locks of a lock number in the database of the session. */
+const lockRows = `FROM pg_catalog.pg_locks
   WHERE locktype = 'advisory'
     AND database = (SELECT oid FROM pg_catalog.pg_database WHERE datname = pg_catalog.current_database())
     AND objsubid = 1
     AND ((classid::bigint << 32) | objid::bigint) = $1::bigint
-    AND granted
-) AS held`;
+    AND granted`;
+const heldQuery = `SELECT EXISTS (SELECT 1 ${lockRows}) AS held`;
+/** Whether the session of the heartbeat holds the lock. */
+const holdsQuery = `SELECT EXISTS (SELECT 1 ${lockRows} AND pid = pg_catalog.pg_backend_pid()) AS held`;
 /**
  * Holds a session-level advisory lock of Postgres for each key, on a session
  * of its own. The server releases the lock when the session ends, so a
@@ -22,233 +21,63 @@ const heldQuery = `SELECT EXISTS (
  * first one gets a session: one session per key per process, however many
  * callers wait, and first-come order within the process.
  */
-export class PostgresStore {
-    #inProcess = new MemoryStore();
-    #options;
+export class PostgresStore extends SessionLockStore {
     constructor(options) {
-        this.#options = options;
-    }
-    async acquire(key, options) {
-        const signal = options?.signal;
-        await using turn = new AsyncDisposableStack();
-        // Joining the in-process queue is synchronous, so the order is the order of the calls.
-        turn.use(await this.#inProcess.acquire(key, { signal }));
-        const session = await this.#session(key, signal);
-        await session.wait(signal);
-        return withTurn(await session.hold(), turn);
-    }
-    async tryAcquire(key) {
-        await using turn = new AsyncDisposableStack();
-        const inProcess = await this.#inProcess.tryAcquire(key);
-        if (!inProcess)
-            return undefined;
-        turn.use(inProcess);
-        const session = await this.#session(key, undefined);
-        if (!(await session.try()))
-            return undefined;
-        return withTurn(await session.hold(), turn);
-    }
-    /** Reads `pg_locks` on a short session, and never runs an advisory lock function. */
-    async isHeld(key) {
-        const session = new OwnedSession(await this.#options.connect());
-        try {
-            const [row] = await session.query(heldQuery, [lockNumber(key)]);
-            session.giveBack();
-            return row?.held === true;
-        }
-        catch (error) {
-            session.destroy();
-            throw error;
-        }
-    }
-    /** Gets a session for `key`. A cancel never waits for the pool: a session that comes later goes back at once. */
-    async #session(key, signal) {
-        const connecting = this.#options.connect();
-        try {
-            return new KeySession(new OwnedSession(await untilAborted(connecting, signal)), key, this.#options);
-        }
-        catch (error) {
-            if (signal?.aborted && error === signal.reason) {
-                void connecting.then((late) => late.release(false), () => { });
-            }
-            throw error;
-        }
+        super(options, postgresDialect(options));
     }
 }
 /**
- * The number of the advisory lock of `key`: the first 8 bytes of the SHA-256
- * digest of its UTF-16 code units, as a signed 64-bit integer. The code units,
- * not UTF-8, so that keys that differ only in a lone surrogate get different
- * numbers. Sent as text, because a JavaScript number cannot hold 64 bits.
+ * The number of the advisory lock of `key`: the first 8 bytes of the key
+ * digest, as a signed 64-bit integer. Sent as text, because a JavaScript
+ * number cannot hold 64 bits.
  */
 function lockNumber(key) {
-    return createHash('sha256')
-        .update(Buffer.from(key, 'utf16le'))
-        .digest()
-        .readBigInt64BE(0)
-        .toString();
-}
-/**
- * A session from `connect` that the store owns until it gives it back or
- * destroys it, once. Its `ended` signal aborts when the session emits `error`
- * or `end`. Its listeners stay on a destroyed session, because node-postgres
- * can emit `error` again after the close.
- */
-class OwnedSession {
-    #session;
-    #ended = new AbortController();
-    #owned = new AbortController();
-    #onError = (error) => this.#ended.abort(error);
-    #onEnd = () => this.#ended.abort(new Error('The Postgres session ended.'));
-    constructor(session) {
-        this.#session = session;
-        session.on('error', this.#onError);
-        session.on('end', this.#onEnd);
-    }
-    get ended() {
-        return this.#ended.signal;
-    }
-    async query(text, values) {
-        return (await this.#session.query(text, values)).rows;
-    }
-    /** The session holds nothing: it goes back to the pool with its own settings. */
-    giveBack() {
-        if (this.#owned.signal.aborted)
-            return;
-        this.#owned.abort();
-        this.#session.off('error', this.#onError);
-        this.#session.off('end', this.#onEnd);
-        this.#session.release(false);
-    }
-    /** The lock state of the session is not known: the server releases each lock of a session that ends. */
-    destroy() {
-        if (this.#owned.signal.aborted)
-            return;
-        this.#owned.abort();
-        this.#session.release(true);
-    }
+    return keyDigest(key).readBigInt64BE(0).toString();
 }
-/** One session for one key: it waits for the lock or tries it, then holds it with a heartbeat. */
-class KeySession {
-    #session;
-    #key;
-    #number;
-    #options;
-    #lease;
-    /** Aborts when the store stops holding: a release, or a lost session. */
-    #done = new AbortController();
-    constructor(session, key, options) {
-        this.#session = session;
-        this.#key = key;
-        this.#number = lockNumber(key);
-        this.#options = options;
-        this.#lease = new LeaseController(key);
-    }
-    /** Waits in Postgres' lock queue. A cancel closes the session, and the end of the session releases a late grant. */
-    async wait(signal) {
-        try {
+const rowsOf = async (session, text, values) => (await session.query(text, values)).rows;
+function postgresDialect(options) {
+    return {
+        server: 'Postgres',
+        lockName: lockNumber,
+        wait: async (session, { name }, signal) => {
             // A timeout of the pool must not stop the wait.
-            await this.#session.query('SET statement_timeout = 0; SET lock_timeout = 0', []);
-            await untilAborted(this.#session.query('SELECT pg_advisory_lock($1::bigint)', [
-                this.#number,
-            ]), signal);
-        }
-        catch (error) {
-            this.#session.destroy();
-            throw error;
-        }
-    }
-    async try() {
-        try {
-            const [row] = await this.#session.query('SELECT pg_try_advisory_lock($1::bigint) AS locked', [this.#number]);
-            if (row?.locked === true)
-                return true;
-        }
-        catch (error) {
-            this.#session.destroy();
-            throw error;
-        }
-        this.#session.giveBack();
-        return false;
-    }
-    /** Mints the token of a granted lock and starts the heartbeat. A failed mint releases the key. */
-    async hold() {
-        let token;
-        try {
-            const [row] = await this.#session.query('SELECT nextval($1::regclass)::text AS token', [this.#options.sequence]);
+            await session.query('SET statement_timeout = 0; SET lock_timeout = 0', []);
+            await untilAborted(session.query('SELECT pg_advisory_lock($1::bigint)', [name]), signal);
+        },
+        try: async (session, { name }) => {
+            const [row] = await rowsOf(session, 'SELECT pg_try_advisory_lock($1::bigint) AS locked', [name]);
+            return row?.locked === true;
+        },
+        mint: async (session) => {
+            const [row] = await rowsOf(session, 'SELECT nextval($1::regclass)::text AS token', [options.sequence]);
             if (typeof row?.token !== 'string') {
-                throw new Error(`nextval of sequence ${JSON.stringify(this.#options.sequence)} gave no number.`);
-            }
-            token = new FencingToken(BigInt(row.token));
-        }
-        catch (error) {
-            await this.#release();
-            throw error;
-        }
-        const ended = this.#session.ended;
-        ended.addEventListener('abort', () => this.#lose(ended.reason), {
-            once: true,
-            signal: this.#done.signal,
-        });
-        void this.#beat();
-        return {
-            token,
-            signal: this.#lease.signal,
-            [Symbol.asyncDispose]: () => this.#release(),
-        };
-    }
-    /** Sends `SELECT 1` each interval. A failed or late answer loses the lease. */
-    async #beat() {
-        const interval = this.#options.heartbeatInterval;
-        const done = this.#done.signal;
-        try {
-            for (;;) {
-                await delay(interval, undefined, { signal: done });
-                await untilAborted(this.#session.query('SELECT 1', []), AbortSignal.any([done, AbortSignal.timeout(interval)]));
-            }
-        }
-        catch (cause) {
-            if (!done.aborted)
-                this.#lose(cause);
-        }
-    }
-    /** Another holder can have the key now. */
-    #lose(cause) {
-        if (this.#done.signal.aborted)
-            return;
-        this.#done.abort();
-        this.#lease.lose(cause);
-        this.#session.destroy();
-    }
-    async #release() {
-        if (this.#done.signal.aborted)
-            return;
-        this.#done.abort();
-        try {
-            const [row] = await this.#session.query('SELECT pg_advisory_unlock($1::bigint) AS released', [this.#number]);
-            if (row?.released !== true) {
-                throw new Error(`The session did not hold the lock of ${JSON.stringify(this.#key)}.`);
+                throw new Error(`nextval of sequence ${JSON.stringify(options.sequence)} gave no number.`);
             }
-            await this.#session.query('RESET statement_timeout; RESET lock_timeout', []);
-        }
-        catch (cause) {
-            // A plain release would give the next borrower a lock that this session may still hold.
-            this.#lease.lose(cause);
-            this.#session.destroy();
-            return;
-        }
-        this.#lease.end();
-        this.#session.giveBack();
-    }
-}
-/** Releases the Postgres lock first, then lets the next caller in this process continue. */
-function withTurn(handle, turn) {
-    turn.use(handle);
-    const release = turn.move();
-    return {
-        token: handle.token,
-        signal: handle.signal,
-        [Symbol.asyncDispose]: () => release.disposeAsync(),
+            return BigInt(row.token);
+        },
+        holds: async (session, { name }) => {
+            const [row] = await rowsOf(session, holdsQuery, [name]);
+            return row?.held === true;
+        },
+        release: async (session, { name }) => {
+            const [row] = await rowsOf(session, 'SELECT pg_advisory_unlock($1::bigint) AS released', [name]);
+            if (row?.released !== true)
+                return false;
+            await session.query('RESET statement_timeout; RESET lock_timeout', []);
+            return true;
+        },
+        /** Reads `pg_locks`, and never runs an advisory lock function. */
+        isHeld: async (session, { name }) => {
+            const [row] = await rowsOf(session, heldQuery, [name]);
+            return row?.held === true;
+        },
+        detach: (session, { error, end }) => {
+            session.off('error', error);
+            session.off('end', end);
+        },
+        // The session holds nothing: it goes back to the pool with its own settings.
+        giveBack: (session) => session.release(false),
+        destroy: (session) => session.release(true),
     };
 }
 //# sourceMappingURL=postgres-store.js.map

package/dist/lock-stores/postgres/postgres-store.js.map

@@ -1 +1 @@
-{"version":3,"file":"postgres-store.js","sourceRoot":"","sources":["../../../src/lock-stores/postgres/postgres-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAIjD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AA+BxD,MAAM,SAAS,GAAG;;;;;;;UAOR,CAAC;AAEX;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAa;IACf,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC;IAC/B,QAAQ,CAAuB;IAExC,YAAY,OAA6B;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,OAAwB;QACjD,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;QAC/B,YAAY,IAAI,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC9C,uFAAuF;QACvF,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACjD,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,QAAQ,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAW;QAC1B,YAAY,IAAI,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS;YAAE,OAAO,SAAS,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACpB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC;YAAE,OAAO,SAAS,CAAC;QAC7C,OAAO,QAAQ,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,qFAAqF;IACrF,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAChE,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAO,GAAG,EAAE,IAAI,KAAK,IAAI,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,iHAAiH;IACjH,KAAK,CAAC,QAAQ,CACZ,GAAW,EACX,MAA+B;QAE/B,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,OAAO,IAAI,UAAU,CACnB,IAAI,YAAY,CAAC,MAAM,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,EACxD,GAAG,EACH,IAAI,CAAC,QAAQ,CACd,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,MAAM,EAAE,OAAO,IAAI,KAAK,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;gBAC/C,KAAK,UAAU,CAAC,IAAI,CAClB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAC7B,GAAG,EAAE,GAAE,CAAC,CACT,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,OAAO,UAAU,CAAC,QAAQ,CAAC;SACxB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;SACnC,MAAM,EAAE;SACR,cAAc,CAAC,CAAC,CAAC;SACjB,QAAQ,EAAE,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,YAAY;IACP,QAAQ,CAAkB;IAC1B,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IAC/B,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IAC/B,QAAQ,GAAG,CAAC,KAAY,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,EAAE,CACrB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAE9D,YAAY,OAAwB;QAClC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,KAAK,CACT,IAAY,EACZ,MAAiB;QAEjB,OAAO,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,CAAC;IAED,iFAAiF;IACjF,QAAQ;QACN,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QACvC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,wGAAwG;IACxG,OAAO;QACL,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QACvC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,kGAAkG;AAClG,MAAM,UAAU;IACL,QAAQ,CAAe;IACvB,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,QAAQ,CAAuB;IAC/B,MAAM,CAAkB;IACjC,yEAAyE;IAChE,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;IAEvC,YACE,OAAqB,EACrB,GAAW,EACX,OAA6B;QAE7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,oHAAoH;IACpH,KAAK,CAAC,IAAI,CAAC,MAA+B;QACxC,IAAI,CAAC;YACH,gDAAgD;YAChD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CACvB,iDAAiD,EACjD,EAAE,CACH,CAAC;YACF,MAAM,YAAY,CAChB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,qCAAqC,EAAE;gBACzD,IAAI,CAAC,OAAO;aACb,CAAC,EACF,MAAM,CACP,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG;QACP,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CACrC,mDAAmD,EACnD,CAAC,IAAI,CAAC,OAAO,CAAC,CACf,CAAC;YACF,IAAI,GAAG,EAAE,MAAM,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC;QACxC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,MAAM,KAAK,CAAC;QACd,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kGAAkG;IAClG,KAAK,CAAC,IAAI;QACR,IAAI,KAAmB,CAAC;QACxB,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CACrC,6CAA6C,EAC7C,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACzB,CAAC;YACF,IAAI,OAAO,GAAG,EAAE,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CACb,uBAAuB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAChF,CAAC;YACJ,CAAC;YACD,KAAK,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAClC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YAC9D,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;SAC1B,CAAC,CAAC;QACH,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO;YACL,KAAK;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE;SAC7C,CAAC;IACJ,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,KAAK;QACT,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAC/B,IAAI,CAAC;YACH,SAAS,CAAC;gBACR,MAAM,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnD,MAAM,YAAY,CAChB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,EACnC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CACvD,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,KAAc;QAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QACtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QACtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CACrC,mDAAmD,EACnD,CAAC,IAAI,CAAC,OAAO,CAAC,CACf,CAAC;YACF,IAAI,GAAG,EAAE,QAAQ,KAAK,IAAI,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CACb,wCAAwC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACrE,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CACvB,6CAA6C,EAC7C,EAAE,CACH,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,wFAAwF;YACxF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;CACF;AAED,4FAA4F;AAC5F,SAAS,QAAQ,CAAC,MAAkB,EAAE,IAA0B;IAC9D,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE;KACpD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"postgres-store.js","sourceRoot":"","sources":["../../../src/lock-stores/postgres/postgres-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAEL,gBAAgB,GACjB,MAAM,kCAAkC,CAAC;AA+B1C,kFAAkF;AAClF,MAAM,QAAQ,GAAG;;;;;gBAKD,CAAC;AAEjB,MAAM,SAAS,GAAG,2BAA2B,QAAQ,WAAW,CAAC;AAEjE,2DAA2D;AAC3D,MAAM,UAAU,GAAG,2BAA2B,QAAQ,iDAAiD,CAAC;AAExG;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAc,SAAQ,gBAAiC;IAClE,YAAY,OAA6B;QACvC,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AACrD,CAAC;AAED,MAAM,MAAM,GAAG,KAAK,EAClB,OAAwB,EACxB,IAAY,EACZ,MAAiB,EACjB,EAAE,CAAC,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAE9C,SAAS,eAAe,CACtB,OAA6B;IAE7B,OAAO;QACL,MAAM,EAAE,UAAU;QAClB,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE;YACxC,gDAAgD;YAChD,MAAM,OAAO,CAAC,KAAK,CACjB,iDAAiD,EACjD,EAAE,CACH,CAAC;YACF,MAAM,YAAY,CAChB,OAAO,CAAC,KAAK,CAAC,qCAAqC,EAAE,CAAC,IAAI,CAAC,CAAC,EAC5D,MAAM,CACP,CAAC;QACJ,CAAC;QACD,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAC/B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,MAAM,CACxB,OAAO,EACP,mDAAmD,EACnD,CAAC,IAAI,CAAC,CACP,CAAC;YACF,OAAO,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;QAC9B,CAAC;QACD,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACtB,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,MAAM,CACxB,OAAO,EACP,6CAA6C,EAC7C,CAAC,OAAO,CAAC,QAAQ,CAAC,CACnB,CAAC;YACF,IAAI,OAAO,GAAG,EAAE,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CACb,uBAAuB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAC1E,CAAC;YACJ,CAAC;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QACD,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YACjC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YACxD,OAAO,GAAG,EAAE,IAAI,KAAK,IAAI,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YACnC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,MAAM,CACxB,OAAO,EACP,mDAAmD,EACnD,CAAC,IAAI,CAAC,CACP,CAAC;YACF,IAAI,GAAG,EAAE,QAAQ,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YACzC,MAAM,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,EAAE,CAAC,CAAC;YACvE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,kEAAkE;QAClE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YACvD,OAAO,GAAG,EAAE,IAAI,KAAK,IAAI,CAAC;QAC5B,CAAC;QACD,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YAClC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,6EAA6E;QAC7E,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;QAC7C,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;KAC5C,CAAC;AACJ,CAAC"}

package/dist/lock-stores/session/session-lock-store.d.ts

@@ -0,0 +1,72 @@
+import type { LockHandle } from '../../mutex/lease.ts';
+import type { AcquireOptions, LockStore } from '../../mutex/lock-store.ts';
+/** The events of a session that tell the store that the session ended. */
+export interface SessionEvents {
+    on(event: 'error', listener: (error: Error) => void): unknown;
+    on(event: 'end', listener: () => void): unknown;
+}
+/** The listeners that the store puts on each session that it owns. */
+export interface SessionListeners {
+    error: (error: Error) => void;
+    end: () => void;
+}
+/** The lock of one key on the server. */
+export interface SessionLock {
+    key: string;
+    /** The name of the lock on the server, made from the key digest. */
+    name: string;
+}
+/** What differs between the servers of the SQL lock stores, and between their drivers. */
+export interface SessionLockDialect<Session extends SessionEvents> {
+    /** The name of the server in error messages. */
+    readonly server: string;
+    /** The name of the lock of `key` on the server. */
+    lockName(key: string): string;
+    /** Waits in the server's queue until the session holds the lock. A cancel of `signal` rejects at once. */
+    wait(session: Session, lock: SessionLock, signal: AbortSignal | undefined): Promise<void>;
+    /** Takes the lock only when no other session holds it. */
+    try(session: Session, lock: SessionLock): Promise<boolean>;
+    /** Gives the next fencing token. */
+    mint(session: Session): Promise<bigint>;
+    /** Whether this session holds the lock now. It never acquires the lock. */
+    holds(session: Session, lock: SessionLock): Promise<boolean>;
+    /** Releases the lock; `false` when the session did not hold it. */
+    release(session: Session, lock: SessionLock): Promise<boolean>;
+    /** Whether any session holds the lock now. It never acquires the lock. */
+    isHeld(session: Session, lock: SessionLock): Promise<boolean>;
+    /** Takes the store's listeners off a session that goes back to its pool. */
+    detach(session: Session, listeners: SessionListeners): void;
+    /** Gives back a session that holds nothing: to its pool, or by a close. */
+    giveBack(session: Session): void;
+    /** Ends the connection: the server then releases each lock of the session. */
+    destroy(session: Session): void;
+}
+export interface SessionLockStoreOptions<Session extends SessionEvents> {
+    /** Gives a new session. The store owns each session that it gets. */
+    connect(): Promise<Session>;
+    /**
+     * Milliseconds between two heartbeats of a holder, and the time limit of
+     * each heartbeat: the longest time that a holder can work after its session
+     * ended, before its signal aborts.
+     */
+    heartbeatInterval: number;
+}
+/**
+ * Holds a session-level lock of a SQL server for each key, on a session of
+ * its own. The server releases the lock when the session ends, so a holder
+ * that stops never leaves a key locked. Every process on every machine that
+ * reaches one database shares the locks.
+ *
+ * Callers in this process first line up in a queue in memory, so only the
+ * first one gets a session: one session per key per process, however many
+ * callers wait, and first-come order within the process.
+ */
+export declare class SessionLockStore<Session extends SessionEvents> implements LockStore {
+    #private;
+    constructor(options: SessionLockStoreOptions<Session>, dialect: SessionLockDialect<Session>);
+    acquire(key: string, options?: AcquireOptions): Promise<LockHandle>;
+    tryAcquire(key: string): Promise<LockHandle | undefined>;
+    /** Asks the server on a short session, and never acquires the lock. */
+    isHeld(key: string): Promise<boolean>;
+}
+//# sourceMappingURL=session-lock-store.d.ts.map

package/dist/lock-stores/session/session-lock-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-lock-store.d.ts","sourceRoot":"","sources":["../../../src/lock-stores/session/session-lock-store.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAG3E,0EAA0E;AAC1E,MAAM,WAAW,aAAa;IAC5B,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;IAC9D,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC;CACjD;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC9B,GAAG,EAAE,MAAM,IAAI,CAAC;CACjB;AAED,yCAAyC;AACzC,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;CACd;AAED,0FAA0F;AAC1F,MAAM,WAAW,kBAAkB,CAAC,OAAO,SAAS,aAAa;IAC/D,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,0GAA0G;IAC1G,IAAI,CACF,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,WAAW,GAAG,SAAS,GAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,0DAA0D;IAC1D,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,oCAAoC;IACpC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,2EAA2E;IAC3E,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7D,mEAAmE;IACnE,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/D,0EAA0E;IAC1E,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9D,4EAA4E;IAC5E,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC5D,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,8EAA8E;IAC9E,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB,CAAC,OAAO,SAAS,aAAa;IACpE,qEAAqE;IACrE,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5B;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,qBAAa,gBAAgB,CAC3B,OAAO,SAAS,aAAa,CAC7B,YAAW,SAAS;;gBAMlB,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC,EACzC,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAMtC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IASnE,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAQxD,uEAAuE;IACjE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAwC5C"}