@dbx-tools/postgres 0.6.62
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +225 -0
- package/index.ts +10 -0
- package/lib/exports.d.ts +1 -0
- package/lib/exports.js +6 -0
- package/lib/index.d.ts +6 -0
- package/lib/index.js +8 -0
- package/lib/src/advisory-lock.d.ts +51 -0
- package/lib/src/advisory-lock.js +111 -0
- package/lib/src/topic-bus.d.ts +272 -0
- package/lib/src/topic-bus.js +506 -0
- package/lib/tsconfig.tsbuildinfo +1 -0
- package/package.json +74 -0
- package/src/advisory-lock.ts +148 -0
- package/src/topic-bus.ts +655 -0
package/README.md
ADDED
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
# `@dbx-tools/postgres`
|
|
2
|
+
|
|
3
|
+
Connection-correct PostgreSQL primitives for Node.js: advisory locks that hold the
|
|
4
|
+
connection they lock, and a structured topic bus over `LISTEN`/`NOTIFY`.
|
|
5
|
+
|
|
6
|
+
Both work against a plain `pg.Pool` or anything structurally compatible with one,
|
|
7
|
+
including the pool AppKit's Lakebase plugin exports — so a Databricks App gets
|
|
8
|
+
them without a second database client or connection pool.
|
|
9
|
+
|
|
10
|
+
## Key Features
|
|
11
|
+
|
|
12
|
+
- Converts an arbitrary structured key (string, array, object, `Date`, or an
|
|
13
|
+
explicit `bigint`) into a stable signed 64-bit advisory-lock identifier.
|
|
14
|
+
- Derives a legal Postgres channel name from whatever identifies a channel, so no
|
|
15
|
+
call site has to sanitize an app name or a tenant id into an identifier.
|
|
16
|
+
- Holds a session lock on one dedicated pooled connection for the whole callback,
|
|
17
|
+
and hands that connection to the callback so protected work runs on it.
|
|
18
|
+
- Holds a transaction lock released atomically by `COMMIT` or `ROLLBACK`, which is
|
|
19
|
+
what one-time schema installation needs.
|
|
20
|
+
- Broadcasts a `type`/`metadata`/`body` envelope to every listening process over
|
|
21
|
+
`pg_notify`, filtered by topic in-process.
|
|
22
|
+
- Fills in project, machine, process, deployment, and optional AppKit sender
|
|
23
|
+
context automatically, with caller metadata always winning.
|
|
24
|
+
- Rejects a payload that would not survive a JSON round trip unchanged, at the
|
|
25
|
+
call site rather than on the wire.
|
|
26
|
+
- Reconnects a dropped listener with bounded backoff while subscribers remain.
|
|
27
|
+
|
|
28
|
+
## Advisory Locks
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import { withAdvisoryLock } from "@dbx-tools/postgres";
|
|
32
|
+
import { Pool } from "pg";
|
|
33
|
+
|
|
34
|
+
const pool = new Pool();
|
|
35
|
+
|
|
36
|
+
await withAdvisoryLock(pool, ["invoice", invoiceId], async (client) => {
|
|
37
|
+
await client.query("UPDATE invoices SET status = 'sent' WHERE id = $1", [invoiceId]);
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Run the protected work on the `client` the callback receives. A `pool.query()`
|
|
42
|
+
inside the callback may land on a different connection, which is not the one
|
|
43
|
+
holding the lock.
|
|
44
|
+
|
|
45
|
+
Use the transaction-scoped helper for one-time database work:
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
import { withAdvisoryTransactionLock } from "@dbx-tools/postgres";
|
|
49
|
+
|
|
50
|
+
await withAdvisoryTransactionLock(pool, { schema: "my_feature", version: 1 }, async (client) => {
|
|
51
|
+
await client.query("CREATE TABLE IF NOT EXISTS my_feature.events (id bigint primary key)");
|
|
52
|
+
});
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
`advisoryLockId(key)` exposes the same reduction on its own. A `bigint` key is
|
|
56
|
+
used directly (narrowed to 64 bits) rather than hashed, so a lock can interoperate
|
|
57
|
+
with another implementation that publishes its numeric lock id — `pgmq`'s
|
|
58
|
+
installer lock, for instance. Anything else is canonicalized with
|
|
59
|
+
`object.toStableKey` from `@dbx-tools/shared-core` and hashed, so key order in an
|
|
60
|
+
object does not matter while a `1` and a `"1"` stay different locks. An array is
|
|
61
|
+
read as several parts, so `["invoice", 7]` and `"invoice_7"` are different locks. A
|
|
62
|
+
non-finite number or a cyclic key throws `TypeError` rather than yielding an
|
|
63
|
+
identity two callers could disagree about.
|
|
64
|
+
|
|
65
|
+
## Topic Bus
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
import { PostgresTopicBus } from "@dbx-tools/postgres";
|
|
69
|
+
|
|
70
|
+
const bus = new PostgresTopicBus(pool, {
|
|
71
|
+
metadata: async () => ({ publicIp: await resolvePublicIp() }),
|
|
72
|
+
onError: (cause) => logger.error("bus", { cause }),
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
const unsubscribe = await bus.listen("orders", ({ type, metadata, body }) => {
|
|
76
|
+
console.log(type, metadata.project, body);
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
await bus.broadcast("orders", {
|
|
80
|
+
type: "order.updated",
|
|
81
|
+
metadata: { traceId: "abc-123" },
|
|
82
|
+
body: { orderId: "123", status: "ready" },
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
await unsubscribe();
|
|
86
|
+
await bus.close();
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Every process listening on the channel receives every message; there are no
|
|
90
|
+
competing consumers. That makes the bus right for live fan-out — an SSE stream per
|
|
91
|
+
browser tab, a cache invalidation, a presence ping — and wrong for work
|
|
92
|
+
distribution. Use a table or a queue when a subscriber needs acks or replay.
|
|
93
|
+
|
|
94
|
+
### The Envelope
|
|
95
|
+
|
|
96
|
+
| Field | Source | Notes |
|
|
97
|
+
| ------------- | ------ | ------------------------------------------------------------------ |
|
|
98
|
+
| `id` | bus | Unique per message across instances. Use it to dedupe or as `id:`. |
|
|
99
|
+
| `topic` | bus | The `broadcast` topic. Listeners on other topics never see it. |
|
|
100
|
+
| `type` | caller | Event name, e.g. `order.updated`. Required, non-blank. |
|
|
101
|
+
| `metadata` | merged | Automatic context under the caller's. See below. |
|
|
102
|
+
| `body` | caller | Passed through unchanged. |
|
|
103
|
+
| `publishedAt` | bus | ISO-8601, from the publisher's clock — not the database's. |
|
|
104
|
+
|
|
105
|
+
`publishedAt` and `id` are for display and dedupe. Neither orders messages from
|
|
106
|
+
different instances reliably.
|
|
107
|
+
|
|
108
|
+
### Metadata Precedence
|
|
109
|
+
|
|
110
|
+
Weakest to strongest: automatic machine context, then AppKit sender identity, then
|
|
111
|
+
the bus's `metadata` option, then the per-message `metadata`. A key present at a
|
|
112
|
+
stronger layer is never overwritten, so passing `project` explicitly replaces the
|
|
113
|
+
inferred one.
|
|
114
|
+
|
|
115
|
+
Automatic keys, each omitted when it resolves to nothing: `project` (from
|
|
116
|
+
`DATABRICKS_APP_NAME`, `DATABRICKS_BUNDLE_NAME`, `PROJECT_NAME`, or
|
|
117
|
+
`npm_package_name`), `publicIp` (from `PUBLIC_IP`, `DATABRICKS_PUBLIC_IP`, or
|
|
118
|
+
`HOST_IP`), `hostname`, `cwd`, `platform`, `pid`, `environment`, `appName`,
|
|
119
|
+
`deploymentId`, and `databricksHost`. CPU architecture, runtime name, and runtime
|
|
120
|
+
version are left out on purpose: they are constant per deployment and every
|
|
121
|
+
message would pay for them against the payload limit.
|
|
122
|
+
|
|
123
|
+
`publicIp` is only read from the environment. The bus makes no network call to
|
|
124
|
+
discover one — pass a `metadata` function for that, which is also how to attach
|
|
125
|
+
context a process learns after construction. The function runs on every broadcast,
|
|
126
|
+
so memoize anything expensive.
|
|
127
|
+
|
|
128
|
+
With the optional `@databricks/appkit` peer installed and a user execution context
|
|
129
|
+
active, `senderId`, `senderName`, and `senderEmail` are added too. AppKit is
|
|
130
|
+
imported lazily and never required; outside a request, or without the package, the
|
|
131
|
+
bus just skips those keys.
|
|
132
|
+
|
|
133
|
+
### What A Message May Contain
|
|
134
|
+
|
|
135
|
+
The body and metadata must survive `JSON.parse(JSON.stringify(x))` unchanged, which
|
|
136
|
+
is stricter than `JSON.stringify` not throwing. A `Date` becomes a string, `NaN`
|
|
137
|
+
and `Infinity` become `null`, a `Map` becomes `{}`, and `undefined` vanishes — each
|
|
138
|
+
reaches the listener as something other than what was sent, so all of them throw
|
|
139
|
+
`TypeError` at the call instead. Cycles, functions, symbols, bigints, and class
|
|
140
|
+
instances are rejected for the same reason.
|
|
141
|
+
|
|
142
|
+
The rule lives in `@dbx-tools/shared-core` as `object.isSerializableValue` and
|
|
143
|
+
`object.SerializableValue`, so a route can apply the same check to an untrusted
|
|
144
|
+
request body and answer 400 rather than 500, and a browser-side caller can share
|
|
145
|
+
the type.
|
|
146
|
+
|
|
147
|
+
The encoded envelope is capped at 7900 bytes, under PostgreSQL's 8000-byte
|
|
148
|
+
`NOTIFY` limit, and a larger one throws `RangeError`. Automatic metadata counts
|
|
149
|
+
against that, so broadcast a reference and let the receiver fetch anything big.
|
|
150
|
+
|
|
151
|
+
### Connections, Lifecycle, And Failure
|
|
152
|
+
|
|
153
|
+
Publishing borrows a pooled connection per call. Listening cannot: `LISTEN` is
|
|
154
|
+
session state, so the bus checks out ONE dedicated client and keeps it for as long
|
|
155
|
+
as it has subscribers, however many topics and listeners are registered. Size the
|
|
156
|
+
pool with that long-lived checkout in mind.
|
|
157
|
+
|
|
158
|
+
Nothing connects until the first `listen`, or an explicit `start()` when you would
|
|
159
|
+
rather find out about a connection problem at boot. `close()` releases the client
|
|
160
|
+
and is required — register it with the host's shutdown hook. A closed bus stays
|
|
161
|
+
closed and throws instead of silently reconnecting.
|
|
162
|
+
|
|
163
|
+
When the notification connection drops, the bus reconnects on its own: immediately
|
|
164
|
+
first, then doubling from 250ms to a 5s ceiling, indefinitely, for as long as
|
|
165
|
+
subscribers remain. A Postgres restart or a rotated Lakebase credential recovers
|
|
166
|
+
without intervention. Messages published during the gap are lost. Every failed
|
|
167
|
+
attempt, every dropped connection, and every listener that throws is reported
|
|
168
|
+
through `onError`, which defaults to swallowing them — wire it to a logger in
|
|
169
|
+
anything long-running. A failing listener never affects the publisher or the other
|
|
170
|
+
listeners.
|
|
171
|
+
|
|
172
|
+
One channel carries many topics, so adding a topic costs nothing; give a genuinely
|
|
173
|
+
high-volume unrelated stream its own channel instead, since every listening
|
|
174
|
+
session decodes every message on the channel.
|
|
175
|
+
|
|
176
|
+
### Naming A Channel
|
|
177
|
+
|
|
178
|
+
`channel` takes whatever identifies the channel, not a pre-sanitized identifier —
|
|
179
|
+
a name, a tenant id, a `[env, feature]` pair, a config object. One value or many:
|
|
180
|
+
an array is read as several parts, anything else as one.
|
|
181
|
+
|
|
182
|
+
```ts
|
|
183
|
+
new PostgresTopicBus(pool, { channel: "billing-events" }).channelName;
|
|
184
|
+
// "billing_events_3x55ck"
|
|
185
|
+
new PostgresTopicBus(pool, { channel: ["billing", "production"] }).channelName;
|
|
186
|
+
// "billing_production_008jgf"
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
The parts are tokenized into the readable half and a short hash of their canonical
|
|
190
|
+
form (`object.toStableKey`) is appended. The hash is what makes the mapping
|
|
191
|
+
trustworthy: tokenizing alone is lossy, so `my-app`, `my_app`, and `myApp` would
|
|
192
|
+
collapse onto one channel, and a name long enough to hit Postgres's 63-character
|
|
193
|
+
limit would collide with anything sharing its leading tokens. With the suffix the
|
|
194
|
+
readable part stays readable and distinct inputs stay distinct — including
|
|
195
|
+
`["billing", "prod"]` versus `"billing_prod"`, which differ in structure.
|
|
196
|
+
|
|
197
|
+
Derivation is deterministic across processes and runs, so every participant that
|
|
198
|
+
passes equivalent parts lands on the same channel without coordinating. Object key
|
|
199
|
+
order does not matter; a different spelling does. Read `bus.channelName` to see
|
|
200
|
+
what a set of parts resolved to, or to confirm two processes agree. Defaults to a
|
|
201
|
+
shared `dbx_tools_topic_bus` channel.
|
|
202
|
+
|
|
203
|
+
## Why A Separate Package?
|
|
204
|
+
|
|
205
|
+
Advisory locks are connection-scoped, and that is easy to get wrong invisibly:
|
|
206
|
+
taking the lock with `pool.query()` and doing the protected work with another
|
|
207
|
+
`pool.query()` can use two different connections, so the lock protects nothing and
|
|
208
|
+
the code looks correct. The same applies to `LISTEN`, which is session state a
|
|
209
|
+
pooled query cannot hold. This package owns both lifecycles once, with no
|
|
210
|
+
dependency beyond `pg`, so a consumer that only needs a lock does not pull in a
|
|
211
|
+
message bus, an AppKit runtime, or a queue extension.
|
|
212
|
+
|
|
213
|
+
AppKit exposes Lakebase but has no lock helper and no message bus, so there is no
|
|
214
|
+
native surface to prefer here.
|
|
215
|
+
|
|
216
|
+
## Module Map
|
|
217
|
+
|
|
218
|
+
| Module | Purpose |
|
|
219
|
+
| -------------- | ------------------------------------------------------------------ |
|
|
220
|
+
| `advisoryLock` | Stable lock IDs plus session- and transaction-scoped lock helpers. |
|
|
221
|
+
| `topicBus` | Structured topic broadcast/listen over PostgreSQL `NOTIFY`. |
|
|
222
|
+
|
|
223
|
+
Both modules are also flattened onto the package root, so
|
|
224
|
+
`import { withAdvisoryLock, PostgresTopicBus } from "@dbx-tools/postgres"` works
|
|
225
|
+
without the namespace.
|
package/index.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// GENERATED by projen watch - DO NOT EDIT.
|
|
2
|
+
// Regenerated from the exporting modules in ./src.
|
|
3
|
+
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
|
+
|
|
5
|
+
export * as advisoryLock from "./src/advisory-lock.ts";
|
|
6
|
+
export * as topicBus from "./src/topic-bus.ts";
|
|
7
|
+
export type { AdvisoryLockKey, PgPoolLike, PgQueryable } from "./src/advisory-lock.ts";
|
|
8
|
+
export { PostgresTopicBus } from "./src/topic-bus.ts";
|
|
9
|
+
export type { TopicMetadata, TopicMessage, TopicPublishInput, TopicListener, TopicMetadataProvider, PostgresTopicBusOptions } from "./src/topic-bus.ts";
|
|
10
|
+
export * from "./exports.ts";
|
package/lib/exports.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { advisoryLockId, withAdvisoryLock, withAdvisoryTransactionLock, } from "./src/advisory-lock.ts";
|
package/lib/exports.js
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// Flat re-exports layered onto the generated `index.ts` barrel, which publishes
|
|
2
|
+
// each module as a namespace (`advisoryLock`, `topicBus`) and does not lift
|
|
3
|
+
// functions to the package root. These are the call-site names, so they are
|
|
4
|
+
// importable directly from `@dbx-tools/postgres`.
|
|
5
|
+
export { advisoryLockId, withAdvisoryLock, withAdvisoryTransactionLock, } from "./src/advisory-lock.js";
|
|
6
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXhwb3J0cy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL2V4cG9ydHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsZ0ZBQWdGO0FBQ2hGLDRFQUE0RTtBQUM1RSw0RUFBNEU7QUFDNUUsa0RBQWtEO0FBQ2xELE9BQU8sRUFDTCxjQUFjLEVBQ2QsZ0JBQWdCLEVBQ2hCLDJCQUEyQixHQUM1QixNQUFNLHdCQUF3QixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gRmxhdCByZS1leHBvcnRzIGxheWVyZWQgb250byB0aGUgZ2VuZXJhdGVkIGBpbmRleC50c2AgYmFycmVsLCB3aGljaCBwdWJsaXNoZXNcbi8vIGVhY2ggbW9kdWxlIGFzIGEgbmFtZXNwYWNlIChgYWR2aXNvcnlMb2NrYCwgYHRvcGljQnVzYCkgYW5kIGRvZXMgbm90IGxpZnRcbi8vIGZ1bmN0aW9ucyB0byB0aGUgcGFja2FnZSByb290LiBUaGVzZSBhcmUgdGhlIGNhbGwtc2l0ZSBuYW1lcywgc28gdGhleSBhcmVcbi8vIGltcG9ydGFibGUgZGlyZWN0bHkgZnJvbSBgQGRieC10b29scy9wb3N0Z3Jlc2AuXG5leHBvcnQge1xuICBhZHZpc29yeUxvY2tJZCxcbiAgd2l0aEFkdmlzb3J5TG9jayxcbiAgd2l0aEFkdmlzb3J5VHJhbnNhY3Rpb25Mb2NrLFxufSBmcm9tIFwiLi9zcmMvYWR2aXNvcnktbG9jay50c1wiO1xuIl19
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export * as advisoryLock from "./src/advisory-lock.ts";
|
|
2
|
+
export * as topicBus from "./src/topic-bus.ts";
|
|
3
|
+
export type { AdvisoryLockKey, PgPoolLike, PgQueryable } from "./src/advisory-lock.ts";
|
|
4
|
+
export { PostgresTopicBus } from "./src/topic-bus.ts";
|
|
5
|
+
export type { TopicMetadata, TopicMessage, TopicPublishInput, TopicListener, TopicMetadataProvider, PostgresTopicBusOptions } from "./src/topic-bus.ts";
|
|
6
|
+
export * from "./exports.ts";
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// GENERATED by projen watch - DO NOT EDIT.
|
|
2
|
+
// Regenerated from the exporting modules in ./src.
|
|
3
|
+
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
|
+
export * as advisoryLock from "./src/advisory-lock.js";
|
|
5
|
+
export * as topicBus from "./src/topic-bus.js";
|
|
6
|
+
export { PostgresTopicBus } from "./src/topic-bus.js";
|
|
7
|
+
export * from "./exports.js";
|
|
8
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxPQUFPLEtBQUssWUFBWSxNQUFNLHdCQUF3QixDQUFDO0FBQ3ZELE9BQU8sS0FBSyxRQUFRLE1BQU0sb0JBQW9CLENBQUM7QUFFL0MsT0FBTyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFFdEQsY0FBYyxjQUFjLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBHRU5FUkFURUQgYnkgcHJvamVuIHdhdGNoIC0gRE8gTk9UIEVESVQuXG4vLyBSZWdlbmVyYXRlZCBmcm9tIHRoZSBleHBvcnRpbmcgbW9kdWxlcyBpbiAuL3NyYy5cbi8vIEhhbmQgZWRpdHMgYXJlIG92ZXJ3cml0dGVuIG9uIHRoZSBuZXh0IHdhdGNoOyB0aGlzIGZpbGUgaXMgcmVhZC1vbmx5LlxuXG5leHBvcnQgKiBhcyBhZHZpc29yeUxvY2sgZnJvbSBcIi4vc3JjL2Fkdmlzb3J5LWxvY2sudHNcIjtcbmV4cG9ydCAqIGFzIHRvcGljQnVzIGZyb20gXCIuL3NyYy90b3BpYy1idXMudHNcIjtcbmV4cG9ydCB0eXBlIHsgQWR2aXNvcnlMb2NrS2V5LCBQZ1Bvb2xMaWtlLCBQZ1F1ZXJ5YWJsZSB9IGZyb20gXCIuL3NyYy9hZHZpc29yeS1sb2NrLnRzXCI7XG5leHBvcnQgeyBQb3N0Z3Jlc1RvcGljQnVzIH0gZnJvbSBcIi4vc3JjL3RvcGljLWJ1cy50c1wiO1xuZXhwb3J0IHR5cGUgeyBUb3BpY01ldGFkYXRhLCBUb3BpY01lc3NhZ2UsIFRvcGljUHVibGlzaElucHV0LCBUb3BpY0xpc3RlbmVyLCBUb3BpY01ldGFkYXRhUHJvdmlkZXIsIFBvc3RncmVzVG9waWNCdXNPcHRpb25zIH0gZnJvbSBcIi4vc3JjL3RvcGljLWJ1cy50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZXhwb3J0cy50c1wiO1xuIl19
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Advisory-lock helpers for any `pg.Pool`-compatible pool.
|
|
3
|
+
*
|
|
4
|
+
* PostgreSQL advisory locks belong to a connection, not a pool. These helpers
|
|
5
|
+
* reserve one pooled client for the full callback, acquire the lock on that
|
|
6
|
+
* client, and release both in the correct order.
|
|
7
|
+
*
|
|
8
|
+
* @module
|
|
9
|
+
*/
|
|
10
|
+
import type { Pool, PoolClient, QueryResult, QueryResultRow } from "pg";
|
|
11
|
+
/**
|
|
12
|
+
* What names a lock. Anything reducible to a stable identity: a string, an id, a
|
|
13
|
+
* `["invoice", id]` pair, a config object, or an explicit `bigint` to interoperate
|
|
14
|
+
* with another implementation's published lock id.
|
|
15
|
+
*
|
|
16
|
+
* One value or many: an array is read as multiple parts, anything else as a single
|
|
17
|
+
* part. So `["invoice", 7]` and `"invoice_7"` are different locks, since the
|
|
18
|
+
* canonical form sees different structure.
|
|
19
|
+
*/
|
|
20
|
+
export type AdvisoryLockKey = unknown;
|
|
21
|
+
/** Structural pool shape accepted by the lock helpers. */
|
|
22
|
+
export type PgPoolLike = Pick<Pool, "connect">;
|
|
23
|
+
/** Structural query shape shared by `pg.PoolClient` and AppKit Lakebase. */
|
|
24
|
+
export interface PgQueryable {
|
|
25
|
+
query<T extends QueryResultRow = QueryResultRow>(text: string, values?: unknown[]): Promise<QueryResult<T>>;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Convert an arbitrary structured key into PostgreSQL's signed 64-bit advisory
|
|
29
|
+
* lock namespace. A bigint is preserved directly so callers can interoperate
|
|
30
|
+
* with another implementation that publishes its lock ID.
|
|
31
|
+
*
|
|
32
|
+
* Everything else is canonicalized with `object.toStableKey` and hashed, so key
|
|
33
|
+
* order in an object does not matter while a `1` and a `"1"` stay different locks.
|
|
34
|
+
* A cycle, a non-finite number, or a function/symbol key throws `TypeError`
|
|
35
|
+
* rather than yielding an identity two callers could disagree about.
|
|
36
|
+
*/
|
|
37
|
+
export declare function advisoryLockId(key: AdvisoryLockKey): bigint;
|
|
38
|
+
/**
|
|
39
|
+
* Hold a session advisory lock for the duration of `fn`.
|
|
40
|
+
*
|
|
41
|
+
* The callback receives the dedicated `PoolClient` that owns the lock. Use it
|
|
42
|
+
* for any operation that must be protected by the lock.
|
|
43
|
+
*/
|
|
44
|
+
export declare function withAdvisoryLock<T>(pool: PgPoolLike, key: AdvisoryLockKey, fn: (client: PoolClient) => Promise<T> | T): Promise<T>;
|
|
45
|
+
/**
|
|
46
|
+
* Run `fn` in a transaction while holding a transaction advisory lock.
|
|
47
|
+
*
|
|
48
|
+
* The lock is released atomically by `COMMIT` or `ROLLBACK`, making this the
|
|
49
|
+
* right primitive for one-time schema installation and migrations.
|
|
50
|
+
*/
|
|
51
|
+
export declare function withAdvisoryTransactionLock<T>(pool: PgPoolLike, key: AdvisoryLockKey, fn: (client: PoolClient) => Promise<T> | T): Promise<T>;
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Advisory-lock helpers for any `pg.Pool`-compatible pool.
|
|
3
|
+
*
|
|
4
|
+
* PostgreSQL advisory locks belong to a connection, not a pool. These helpers
|
|
5
|
+
* reserve one pooled client for the full callback, acquire the lock on that
|
|
6
|
+
* client, and release both in the correct order.
|
|
7
|
+
*
|
|
8
|
+
* @module
|
|
9
|
+
*/
|
|
10
|
+
import { createHash } from "node:crypto";
|
|
11
|
+
import { object } from "@dbx-tools/shared-core";
|
|
12
|
+
const SIGNED_BIGINT_BITS = 64;
|
|
13
|
+
/**
|
|
14
|
+
* Convert an arbitrary structured key into PostgreSQL's signed 64-bit advisory
|
|
15
|
+
* lock namespace. A bigint is preserved directly so callers can interoperate
|
|
16
|
+
* with another implementation that publishes its lock ID.
|
|
17
|
+
*
|
|
18
|
+
* Everything else is canonicalized with `object.toStableKey` and hashed, so key
|
|
19
|
+
* order in an object does not matter while a `1` and a `"1"` stay different locks.
|
|
20
|
+
* A cycle, a non-finite number, or a function/symbol key throws `TypeError`
|
|
21
|
+
* rather than yielding an identity two callers could disagree about.
|
|
22
|
+
*/
|
|
23
|
+
export function advisoryLockId(key) {
|
|
24
|
+
if (typeof key === "bigint")
|
|
25
|
+
return BigInt.asIntN(SIGNED_BIGINT_BITS, key);
|
|
26
|
+
const parts = object.toOneOrMany(key);
|
|
27
|
+
const digest = createHash("sha256")
|
|
28
|
+
.update(parts.map((part) => object.toStableKey(part)).join("\u0000"))
|
|
29
|
+
.digest();
|
|
30
|
+
return digest.readBigInt64BE(0);
|
|
31
|
+
}
|
|
32
|
+
async function acquire(client, id, transaction) {
|
|
33
|
+
const fn = transaction ? "pg_advisory_xact_lock" : "pg_advisory_lock";
|
|
34
|
+
await client.query(`SELECT ${fn}($1::bigint)`, [id.toString()]);
|
|
35
|
+
}
|
|
36
|
+
async function unlock(client, id) {
|
|
37
|
+
const result = await client.query("SELECT pg_advisory_unlock($1::bigint) AS unlocked", [id.toString()]);
|
|
38
|
+
if (result.rows[0]?.unlocked !== true) {
|
|
39
|
+
throw new Error(`Postgres advisory lock ${id} was not held by this connection`);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Hold a session advisory lock for the duration of `fn`.
|
|
44
|
+
*
|
|
45
|
+
* The callback receives the dedicated `PoolClient` that owns the lock. Use it
|
|
46
|
+
* for any operation that must be protected by the lock.
|
|
47
|
+
*/
|
|
48
|
+
export async function withAdvisoryLock(pool, key, fn) {
|
|
49
|
+
const id = advisoryLockId(key);
|
|
50
|
+
const client = await pool.connect();
|
|
51
|
+
let acquired = false;
|
|
52
|
+
let failed = false;
|
|
53
|
+
let failure;
|
|
54
|
+
let value;
|
|
55
|
+
try {
|
|
56
|
+
await acquire(client, id, false);
|
|
57
|
+
acquired = true;
|
|
58
|
+
value = await fn(client);
|
|
59
|
+
}
|
|
60
|
+
catch (error) {
|
|
61
|
+
failed = true;
|
|
62
|
+
failure = error;
|
|
63
|
+
}
|
|
64
|
+
let unlockFailure;
|
|
65
|
+
if (acquired) {
|
|
66
|
+
try {
|
|
67
|
+
await unlock(client, id);
|
|
68
|
+
}
|
|
69
|
+
catch (error) {
|
|
70
|
+
unlockFailure = error;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
client.release(unlockFailure instanceof Error ? unlockFailure : undefined);
|
|
74
|
+
if (failed)
|
|
75
|
+
throw failure;
|
|
76
|
+
if (unlockFailure !== undefined)
|
|
77
|
+
throw unlockFailure;
|
|
78
|
+
return value;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Run `fn` in a transaction while holding a transaction advisory lock.
|
|
82
|
+
*
|
|
83
|
+
* The lock is released atomically by `COMMIT` or `ROLLBACK`, making this the
|
|
84
|
+
* right primitive for one-time schema installation and migrations.
|
|
85
|
+
*/
|
|
86
|
+
export async function withAdvisoryTransactionLock(pool, key, fn) {
|
|
87
|
+
const id = advisoryLockId(key);
|
|
88
|
+
const client = await pool.connect();
|
|
89
|
+
let releaseError;
|
|
90
|
+
try {
|
|
91
|
+
await client.query("BEGIN");
|
|
92
|
+
await acquire(client, id, true);
|
|
93
|
+
const value = await fn(client);
|
|
94
|
+
await client.query("COMMIT");
|
|
95
|
+
return value;
|
|
96
|
+
}
|
|
97
|
+
catch (error) {
|
|
98
|
+
try {
|
|
99
|
+
await client.query("ROLLBACK");
|
|
100
|
+
}
|
|
101
|
+
catch (rollbackError) {
|
|
102
|
+
releaseError =
|
|
103
|
+
rollbackError instanceof Error ? rollbackError : new Error(String(rollbackError));
|
|
104
|
+
}
|
|
105
|
+
throw error;
|
|
106
|
+
}
|
|
107
|
+
finally {
|
|
108
|
+
client.release(releaseError);
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"advisory-lock.js","sourceRoot":"","sources":["../../src/advisory-lock.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGhD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AA0B9B;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,GAAoB;IACjD,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC;SAChC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACpE,MAAM,EAAE,CAAC;IACZ,OAAO,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,MAAmB,EAAE,EAAU,EAAE,WAAoB;IAC1E,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,kBAAkB,CAAC;IACtE,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,MAAmB,EAAE,EAAU;IACnD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAC/B,mDAAmD,EACnD,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAChB,CAAC;IACF,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,0BAA0B,EAAE,kCAAkC,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,IAAgB,EAChB,GAAoB,EACpB,EAA0C;IAE1C,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACpC,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,OAAgB,CAAC;IACrB,IAAI,KAAoB,CAAC;IAEzB,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACjC,QAAQ,GAAG,IAAI,CAAC;QAChB,KAAK,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,GAAG,IAAI,CAAC;QACd,OAAO,GAAG,KAAK,CAAC;IAClB,CAAC;IAED,IAAI,aAAsB,CAAC;IAC3B,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,GAAG,KAAK,CAAC;QACxB,CAAC;IACH,CAAC;IACD,MAAM,CAAC,OAAO,CAAC,aAAa,YAAY,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAE3E,IAAI,MAAM;QAAE,MAAM,OAAO,CAAC;IAC1B,IAAI,aAAa,KAAK,SAAS;QAAE,MAAM,aAAa,CAAC;IACrD,OAAO,KAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,IAAgB,EAChB,GAAoB,EACpB,EAA0C;IAE1C,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACpC,IAAI,YAA+B,CAAC;IACpC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5B,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,aAAa,EAAE,CAAC;YACvB,YAAY;gBACV,aAAa,YAAY,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;QACtF,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC","sourcesContent":["/**\n * Advisory-lock helpers for any `pg.Pool`-compatible pool.\n *\n * PostgreSQL advisory locks belong to a connection, not a pool. These helpers\n * reserve one pooled client for the full callback, acquire the lock on that\n * client, and release both in the correct order.\n *\n * @module\n */\n\nimport { createHash } from \"node:crypto\";\nimport { object } from \"@dbx-tools/shared-core\";\nimport type { Pool, PoolClient, QueryResult, QueryResultRow } from \"pg\";\n\nconst SIGNED_BIGINT_BITS = 64;\n\n/**\n * What names a lock. Anything reducible to a stable identity: a string, an id, a\n * `[\"invoice\", id]` pair, a config object, or an explicit `bigint` to interoperate\n * with another implementation's published lock id.\n *\n * One value or many: an array is read as multiple parts, anything else as a single\n * part. So `[\"invoice\", 7]` and `\"invoice_7\"` are different locks, since the\n * canonical form sees different structure.\n */\nexport type AdvisoryLockKey = unknown;\n\n/** Structural pool shape accepted by the lock helpers. */\nexport type PgPoolLike = Pick<Pool, \"connect\">;\n\n/** Structural query shape shared by `pg.PoolClient` and AppKit Lakebase. */\nexport interface PgQueryable {\n  query<T extends QueryResultRow = QueryResultRow>(\n    text: string,\n    values?: unknown[],\n  ): Promise<QueryResult<T>>;\n}\n\ntype UnlockRow = QueryResultRow & { unlocked: boolean };\n\n/**\n * Convert an arbitrary structured key into PostgreSQL's signed 64-bit advisory\n * lock namespace. A bigint is preserved directly so callers can interoperate\n * with another implementation that publishes its lock ID.\n *\n * Everything else is canonicalized with `object.toStableKey` and hashed, so key\n * order in an object does not matter while a `1` and a `\"1\"` stay different locks.\n * A cycle, a non-finite number, or a function/symbol key throws `TypeError`\n * rather than yielding an identity two callers could disagree about.\n */\nexport function advisoryLockId(key: AdvisoryLockKey): bigint {\n  if (typeof key === \"bigint\") return BigInt.asIntN(SIGNED_BIGINT_BITS, key);\n  const parts = object.toOneOrMany(key);\n  const digest = createHash(\"sha256\")\n    .update(parts.map((part) => object.toStableKey(part)).join(\"\\u0000\"))\n    .digest();\n  return digest.readBigInt64BE(0);\n}\n\nasync function acquire(client: PgQueryable, id: bigint, transaction: boolean): Promise<void> {\n  const fn = transaction ? \"pg_advisory_xact_lock\" : \"pg_advisory_lock\";\n  await client.query(`SELECT ${fn}($1::bigint)`, [id.toString()]);\n}\n\nasync function unlock(client: PgQueryable, id: bigint): Promise<void> {\n  const result = await client.query<UnlockRow>(\n    \"SELECT pg_advisory_unlock($1::bigint) AS unlocked\",\n    [id.toString()],\n  );\n  if (result.rows[0]?.unlocked !== true) {\n    throw new Error(`Postgres advisory lock ${id} was not held by this connection`);\n  }\n}\n\n/**\n * Hold a session advisory lock for the duration of `fn`.\n *\n * The callback receives the dedicated `PoolClient` that owns the lock. Use it\n * for any operation that must be protected by the lock.\n */\nexport async function withAdvisoryLock<T>(\n  pool: PgPoolLike,\n  key: AdvisoryLockKey,\n  fn: (client: PoolClient) => Promise<T> | T,\n): Promise<T> {\n  const id = advisoryLockId(key);\n  const client = await pool.connect();\n  let acquired = false;\n  let failed = false;\n  let failure: unknown;\n  let value: T | undefined;\n\n  try {\n    await acquire(client, id, false);\n    acquired = true;\n    value = await fn(client);\n  } catch (error) {\n    failed = true;\n    failure = error;\n  }\n\n  let unlockFailure: unknown;\n  if (acquired) {\n    try {\n      await unlock(client, id);\n    } catch (error) {\n      unlockFailure = error;\n    }\n  }\n  client.release(unlockFailure instanceof Error ? unlockFailure : undefined);\n\n  if (failed) throw failure;\n  if (unlockFailure !== undefined) throw unlockFailure;\n  return value as T;\n}\n\n/**\n * Run `fn` in a transaction while holding a transaction advisory lock.\n *\n * The lock is released atomically by `COMMIT` or `ROLLBACK`, making this the\n * right primitive for one-time schema installation and migrations.\n */\nexport async function withAdvisoryTransactionLock<T>(\n  pool: PgPoolLike,\n  key: AdvisoryLockKey,\n  fn: (client: PoolClient) => Promise<T> | T,\n): Promise<T> {\n  const id = advisoryLockId(key);\n  const client = await pool.connect();\n  let releaseError: Error | undefined;\n  try {\n    await client.query(\"BEGIN\");\n    await acquire(client, id, true);\n    const value = await fn(client);\n    await client.query(\"COMMIT\");\n    return value;\n  } catch (error) {\n    try {\n      await client.query(\"ROLLBACK\");\n    } catch (rollbackError) {\n      releaseError =\n        rollbackError instanceof Error ? rollbackError : new Error(String(rollbackError));\n    }\n    throw error;\n  } finally {\n    client.release(releaseError);\n  }\n}\n"]}
|