@rebasepro/server-postgres 0.10.0 → 0.10.1-canary.0a881d4
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/dist/PostgresBootstrapper.d.ts +7 -3
- package/dist/auth/services.d.ts +43 -4
- package/dist/backup/backup-logic.d.ts +23 -0
- package/dist/backup/backup-service.d.ts +44 -2
- package/dist/backup/pg-tools.d.ts +41 -1
- package/dist/chunk-DSJWtz9O.js +40 -0
- package/dist/cli-helpers.d.ts +33 -1
- package/dist/ensure-collection-tables-C9gy4STB.js +304 -0
- package/dist/ensure-collection-tables-C9gy4STB.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.es.js +1480 -4648
- package/dist/index.es.js.map +1 -1
- package/dist/schema/auth-schema.d.ts +170 -0
- package/dist/schema/destructive-sql.d.ts +49 -0
- package/dist/schema/ensure-collection-tables.d.ts +79 -0
- package/dist/schema/generate-postgres-ddl-logic.d.ts +4 -1
- package/dist/services/cdc/CdcListener.d.ts +7 -14
- package/dist/services/channel-bus/ChannelBus.d.ts +29 -0
- package/dist/services/channel-bus/PostgresChannelBus.d.ts +111 -0
- package/dist/services/channel-bus/index.d.ts +55 -0
- package/dist/services/channel-history.d.ts +11 -0
- package/dist/services/channel-presence.d.ts +66 -0
- package/dist/services/pg-notify-listener.d.ts +47 -0
- package/dist/services/realtimeService.d.ts +114 -6
- package/dist/src-CBgtrPhJ.js +336 -0
- package/dist/src-CBgtrPhJ.js.map +1 -0
- package/dist/src-DG6ZsQQ3.js +4026 -0
- package/dist/src-DG6ZsQQ3.js.map +1 -0
- package/package.json +8 -9
- package/src/PostgresBootstrapper.ts +72 -3
- package/src/auth/ensure-tables.ts +91 -3
- package/src/auth/services.ts +186 -48
- package/src/backup/backup-cli.ts +60 -1
- package/src/backup/backup-cron.ts +24 -1
- package/src/backup/backup-logic.ts +62 -0
- package/src/backup/backup-service.ts +132 -13
- package/src/backup/pg-tools.ts +70 -2
- package/src/cli-helpers.ts +82 -27
- package/src/cli.ts +152 -6
- package/src/index.ts +4 -0
- package/src/schema/auth-schema.ts +41 -3
- package/src/schema/destructive-sql.ts +94 -0
- package/src/schema/doctor.ts +6 -6
- package/src/schema/ensure-collection-tables.test.ts +156 -0
- package/src/schema/ensure-collection-tables.ts +297 -0
- package/src/schema/generate-drizzle-schema-logic.ts +13 -9
- package/src/schema/generate-postgres-ddl-logic.ts +22 -15
- package/src/schema/introspect-db-inference.ts +13 -13
- package/src/schema/introspect-db-logic.ts +6 -6
- package/src/services/cdc/CdcListener.ts +27 -91
- package/src/services/channel-bus/ChannelBus.ts +44 -0
- package/src/services/channel-bus/PostgresChannelBus.ts +299 -0
- package/src/services/channel-bus/index.ts +123 -0
- package/src/services/channel-history.ts +35 -0
- package/src/services/channel-presence.ts +148 -0
- package/src/services/pg-notify-listener.ts +137 -0
- package/src/services/realtimeService.ts +383 -14
|
@@ -51,10 +51,11 @@ export function inferPropertyFromData(
|
|
|
51
51
|
}
|
|
52
52
|
}
|
|
53
53
|
|
|
54
|
-
//
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
54
|
+
// No currency heuristic. `admin.currency` was never a declared option and
|
|
55
|
+
// nothing reads it, so a column called `price` got a block of config that did
|
|
56
|
+
// nothing — invisible because this generator emits *source text*, which no
|
|
57
|
+
// typechecker ever saw. Reinstate it by adding `currency` to
|
|
58
|
+
// AdminNumberOptions first, and something that renders it.
|
|
58
59
|
}
|
|
59
60
|
|
|
60
61
|
// ── JSON / JSONB Analysis ────────────────────────────────────────────
|
|
@@ -169,11 +170,10 @@ export function inferPropertyFromData(
|
|
|
169
170
|
if (isPk) extraLines.push(" isId: \"cuid\"");
|
|
170
171
|
}
|
|
171
172
|
|
|
172
|
-
//
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
}
|
|
173
|
+
// No colour heuristic. `admin.color` was never a declared option and nothing
|
|
174
|
+
// reads it — the same dead branch `currency` was. This generator emits *source
|
|
175
|
+
// text*, so no typechecker ever saw either. Reinstate by adding the option and
|
|
176
|
+
// something that renders it first.
|
|
177
177
|
|
|
178
178
|
// Text Lengths, Multiline & Markdown
|
|
179
179
|
let maxLength = 0;
|
|
@@ -212,9 +212,9 @@ export function inferPropertyFromData(
|
|
|
212
212
|
if (allAbsoluteUrls) {
|
|
213
213
|
const isImage = validValues.some(v => typeof v === "string" && v.match(/\.(jpeg|jpg|gif|png|webp|svg)/i));
|
|
214
214
|
if (isImage || isMedia) {
|
|
215
|
-
extraLines.push("
|
|
215
|
+
extraLines.push(" url: true,\n admin: {\n urlPreview: \"image\"\n }");
|
|
216
216
|
} else {
|
|
217
|
-
extraLines.push("
|
|
217
|
+
extraLines.push(" url: true");
|
|
218
218
|
}
|
|
219
219
|
} else {
|
|
220
220
|
const hasFileExtension = validValues.some(v => typeof v === "string" && v.match(/\.[a-zA-Z0-9]+$/));
|
|
@@ -225,9 +225,9 @@ export function inferPropertyFromData(
|
|
|
225
225
|
extraLines.push(` storage: {\n storagePath: "${inferredStoragePath}"\n }`);
|
|
226
226
|
} else if (isUrl) {
|
|
227
227
|
if (isMedia) {
|
|
228
|
-
extraLines.push("
|
|
228
|
+
extraLines.push(" url: true,\n admin: {\n urlPreview: \"image\"\n }");
|
|
229
229
|
} else {
|
|
230
|
-
extraLines.push("
|
|
230
|
+
extraLines.push(" url: true");
|
|
231
231
|
}
|
|
232
232
|
}
|
|
233
233
|
}
|
|
@@ -569,11 +569,11 @@ export function generateCollectionFile(
|
|
|
569
569
|
// Date auto-value heuristics
|
|
570
570
|
if (finalPropType === "date") {
|
|
571
571
|
if (colNameLower === "created_at" || colNameLower === "createdat") {
|
|
572
|
-
extra += "\n autoValue: \"on_create\",\n
|
|
572
|
+
extra += "\n autoValue: \"on_create\",\n admin: {\n readOnly: true,\n hideFromCollection: true\n },";
|
|
573
573
|
} else if (colNameLower === "updated_at" || colNameLower === "updatedat") {
|
|
574
|
-
extra += "\n autoValue: \"on_update\",\n
|
|
574
|
+
extra += "\n autoValue: \"on_update\",\n admin: {\n readOnly: true,\n hideFromCollection: true\n },";
|
|
575
575
|
} else if (col.column_default && (col.column_default.includes("now()") || col.column_default.includes("CURRENT_TIMESTAMP"))) {
|
|
576
|
-
extra += "\n autoValue: \"on_create\",\n
|
|
576
|
+
extra += "\n autoValue: \"on_create\",\n admin: {\n readOnly: true\n },";
|
|
577
577
|
}
|
|
578
578
|
}
|
|
579
579
|
|
|
@@ -604,13 +604,13 @@ export function generateCollectionFile(
|
|
|
604
604
|
if (isMedia) {
|
|
605
605
|
extra += `\n storage: {\n storagePath: "${tableName}/${col.column_name}"\n },`;
|
|
606
606
|
} else if (isUrl) {
|
|
607
|
-
extra += "\n
|
|
607
|
+
extra += "\n url: true,";
|
|
608
608
|
} else if (colNameLower === "description" || colNameLower === "summary" || colNameLower === "excerpt") {
|
|
609
|
-
extra += "\n multiline: true,";
|
|
609
|
+
extra += "\n admin: {\n multiline: true\n },";
|
|
610
610
|
} else if (colNameLower === "content" || colNameLower === "body") {
|
|
611
611
|
extra += "\n multiline: true,\n markdown: true,";
|
|
612
612
|
} else if (col.data_type === "text") {
|
|
613
|
-
extra += "\n multiline: true,";
|
|
613
|
+
extra += "\n admin: {\n multiline: true\n },";
|
|
614
614
|
}
|
|
615
615
|
}
|
|
616
616
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Client as PgClient } from "pg";
|
|
2
1
|
import { logger } from "@rebasepro/server";
|
|
3
2
|
import { CDC_CHANNEL } from "./trigger-cdc";
|
|
3
|
+
import { PgNotifyListener } from "../pg-notify-listener";
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* A single database change captured by the CDC triggers and delivered over the
|
|
@@ -54,22 +54,30 @@ export function parseCdcPayload(payload: string): CdcChangeEvent | null {
|
|
|
54
54
|
/**
|
|
55
55
|
* Dedicated Postgres LISTEN client for database-level CDC.
|
|
56
56
|
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
57
|
+
* A {@link PgNotifyListener} — a connection outside the Drizzle pool that stays
|
|
58
|
+
* open and repairs itself — plus the parsing that turns a `rebase_cdc` payload
|
|
59
|
+
* into a change event. Each backend instance runs one, so every instance
|
|
60
|
+
* observes every committed change regardless of which instance (or external
|
|
61
|
+
* process) made the write.
|
|
62
62
|
*/
|
|
63
63
|
export class CdcListener {
|
|
64
|
-
private
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
64
|
+
private readonly listener: PgNotifyListener;
|
|
65
|
+
|
|
66
|
+
constructor(connectionString: string, onEvent: (event: CdcChangeEvent) => void | Promise<void>) {
|
|
67
|
+
this.listener = new PgNotifyListener({
|
|
68
|
+
connectionString,
|
|
69
|
+
channel: CDC_CHANNEL,
|
|
70
|
+
logLabel: "[CDC]",
|
|
71
|
+
onPayload: (payload) => {
|
|
72
|
+
const event = parseCdcPayload(payload);
|
|
73
|
+
if (!event) {
|
|
74
|
+
logger.warn("⚠️ [CDC] Dropping unparseable change notification.");
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
return onEvent(event);
|
|
78
|
+
}
|
|
79
|
+
});
|
|
80
|
+
}
|
|
73
81
|
|
|
74
82
|
/**
|
|
75
83
|
* Connect and begin listening. Idempotent.
|
|
@@ -78,90 +86,18 @@ export class CdcListener {
|
|
|
78
86
|
* established (or `LISTEN` is refused), this rejects so callers — notably
|
|
79
87
|
* `REALTIME_CDC=auto` — can detect an unusable connection and fall back to
|
|
80
88
|
* app-level realtime. Once the initial connection succeeds, later drops
|
|
81
|
-
* self-heal
|
|
89
|
+
* self-heal in the background.
|
|
82
90
|
*/
|
|
83
91
|
async start(): Promise<void> {
|
|
84
|
-
if (this.
|
|
92
|
+
if (this.listener.active) {
|
|
85
93
|
logger.warn("⚠️ [CDC] CdcListener.start() called but already running. Ignoring.");
|
|
86
94
|
return;
|
|
87
95
|
}
|
|
88
|
-
this.
|
|
89
|
-
try {
|
|
90
|
-
await this.connect({ initial: true });
|
|
91
|
-
} catch (err) {
|
|
92
|
-
this.running = false;
|
|
93
|
-
throw err;
|
|
94
|
-
}
|
|
96
|
+
await this.listener.start();
|
|
95
97
|
}
|
|
96
98
|
|
|
97
99
|
/** Stop listening and release the connection. */
|
|
98
100
|
async stop(): Promise<void> {
|
|
99
|
-
this.
|
|
100
|
-
if (this.reconnectTimer) {
|
|
101
|
-
clearTimeout(this.reconnectTimer);
|
|
102
|
-
this.reconnectTimer = undefined;
|
|
103
|
-
}
|
|
104
|
-
if (this.client) {
|
|
105
|
-
try {
|
|
106
|
-
await this.client.end();
|
|
107
|
-
} catch { /* ignore close errors */ }
|
|
108
|
-
this.client = undefined;
|
|
109
|
-
}
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
private async connect({ initial = false }: { initial?: boolean } = {}): Promise<void> {
|
|
113
|
-
try {
|
|
114
|
-
const client = new PgClient({ connectionString: this.connectionString });
|
|
115
|
-
|
|
116
|
-
client.on("error", (err) => {
|
|
117
|
-
logger.error("❌ [CDC] LISTEN client error", { detail: err.message });
|
|
118
|
-
this.scheduleReconnect();
|
|
119
|
-
});
|
|
120
|
-
|
|
121
|
-
client.on("end", () => {
|
|
122
|
-
if (this.running) {
|
|
123
|
-
logger.warn("⚠️ [CDC] LISTEN client disconnected unexpectedly.");
|
|
124
|
-
this.scheduleReconnect();
|
|
125
|
-
}
|
|
126
|
-
});
|
|
127
|
-
|
|
128
|
-
client.on("notification", (msg) => {
|
|
129
|
-
if (!msg.payload) return;
|
|
130
|
-
const event = parseCdcPayload(msg.payload);
|
|
131
|
-
if (!event) {
|
|
132
|
-
logger.warn("⚠️ [CDC] Dropping unparseable change notification.");
|
|
133
|
-
return;
|
|
134
|
-
}
|
|
135
|
-
// Never let a handler rejection escape into the pg client.
|
|
136
|
-
Promise.resolve(this.onEvent(event)).catch((err) =>
|
|
137
|
-
logger.error("❌ [CDC] Error handling change event", { error: err })
|
|
138
|
-
);
|
|
139
|
-
});
|
|
140
|
-
|
|
141
|
-
await client.connect();
|
|
142
|
-
await client.query(`LISTEN ${CDC_CHANNEL}`);
|
|
143
|
-
this.client = client;
|
|
144
|
-
logger.info(`📡 [CDC] Listening for database changes on channel "${CDC_CHANNEL}".`);
|
|
145
|
-
} catch (err) {
|
|
146
|
-
// Surface the initial failure so callers can choose to fall back;
|
|
147
|
-
// for reconnects, keep retrying quietly in the background.
|
|
148
|
-
if (initial) throw err;
|
|
149
|
-
logger.error("❌ [CDC] Failed to connect LISTEN client", { error: err });
|
|
150
|
-
this.scheduleReconnect();
|
|
151
|
-
}
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
private scheduleReconnect(): void {
|
|
155
|
-
if (!this.running || this.reconnectTimer) return;
|
|
156
|
-
|
|
157
|
-
this.reconnectTimer = setTimeout(async () => {
|
|
158
|
-
this.reconnectTimer = undefined;
|
|
159
|
-
if (!this.running) return;
|
|
160
|
-
if (this.client) {
|
|
161
|
-
try { await this.client.end(); } catch { /* ignore */ }
|
|
162
|
-
this.client = undefined;
|
|
163
|
-
}
|
|
164
|
-
await this.connect();
|
|
165
|
-
}, CdcListener.RECONNECT_DELAY_MS);
|
|
101
|
+
await this.listener.stop();
|
|
166
102
|
}
|
|
167
103
|
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Runtime pieces of the channel bus that are not the contract itself.
|
|
3
|
+
*
|
|
4
|
+
* The interface, the frame shape and the implementer's contract live in
|
|
5
|
+
* `@rebasepro/types` (`types/channel_bus.ts`), so a transport shipped as its own
|
|
6
|
+
* package — a Redis one, say — depends on the contract and not on this database
|
|
7
|
+
* adapter. They are re-exported here for convenience: code already importing
|
|
8
|
+
* from the adapter should not have to know where the types are declared.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
import type { ChannelBusFrame } from "@rebasepro/types";
|
|
12
|
+
|
|
13
|
+
export type {
|
|
14
|
+
ChannelBus,
|
|
15
|
+
ChannelBusFrame,
|
|
16
|
+
ChannelBusHandler,
|
|
17
|
+
ChannelBusConfig,
|
|
18
|
+
ChannelBusSetting
|
|
19
|
+
} from "@rebasepro/types";
|
|
20
|
+
export { isChannelBusInstance } from "@rebasepro/types";
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* The default: no cross-instance delivery at all.
|
|
24
|
+
*
|
|
25
|
+
* This is what every deployment ran before the bus existed, and what a
|
|
26
|
+
* single-instance deployment should keep running — `publish` resolves without
|
|
27
|
+
* touching the network, so the broadcast path is the same handful of `ws.send`
|
|
28
|
+
* calls it always was.
|
|
29
|
+
*/
|
|
30
|
+
export class MemoryChannelBus {
|
|
31
|
+
readonly kind = "memory" as const;
|
|
32
|
+
readonly maxFrameBytes = Infinity;
|
|
33
|
+
|
|
34
|
+
async start(): Promise<void> { /* nothing to connect */ }
|
|
35
|
+
|
|
36
|
+
async publish(): Promise<void> { /* nowhere to publish to */ }
|
|
37
|
+
|
|
38
|
+
async stop(): Promise<void> { /* nothing to release */ }
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/** Encoded size of a frame, for a transport's size check. */
|
|
42
|
+
export function frameByteLength(frame: ChannelBusFrame): number {
|
|
43
|
+
return Buffer.byteLength(JSON.stringify(frame), "utf8");
|
|
44
|
+
}
|
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Channel bus over Postgres LISTEN/NOTIFY.
|
|
3
|
+
*
|
|
4
|
+
* Chosen because it needs nothing that a Rebase deployment does not already
|
|
5
|
+
* have — the same database, the same direct URL the CDC listener uses. Three
|
|
6
|
+
* properties of `NOTIFY` shape everything below:
|
|
7
|
+
*
|
|
8
|
+
* - **8000 bytes per payload.** Presence and cursors fit with room to spare; a
|
|
9
|
+
* scene snapshot does not. Rather than truncate or drop, an oversized frame
|
|
10
|
+
* on a *retained* channel is published as a pointer — the body is already in
|
|
11
|
+
* `rebase.channel_messages` with a sequence number, so the receiver reads it
|
|
12
|
+
* back. That is the same trick the entity path uses (notify an address,
|
|
13
|
+
* refetch the row), applied to a different table. On an ephemeral channel
|
|
14
|
+
* there is nothing to point at, so the publish is refused loudly instead of
|
|
15
|
+
* reaching some instances and not others.
|
|
16
|
+
*
|
|
17
|
+
* - **A notify is a query on the primary database.** Not a slow one, but it
|
|
18
|
+
* competes with the application's real queries, and that — not throughput —
|
|
19
|
+
* is what actually limits this transport. Measured, it carried ~10k
|
|
20
|
+
* cross-instance messages/second and stayed flat out to eight instances; what
|
|
21
|
+
* it should not do is spend 10k queries/second of the database's budget on
|
|
22
|
+
* cursor movement. Hence the batching below.
|
|
23
|
+
*
|
|
24
|
+
* - **Delivery is best-effort.** Retained channels repair themselves through
|
|
25
|
+
* the client's history replay, so a lost frame costs a live update rather
|
|
26
|
+
* than correctness. That is what makes coalescing safe.
|
|
27
|
+
*/
|
|
28
|
+
|
|
29
|
+
import { sql } from "drizzle-orm";
|
|
30
|
+
import { NodePgDatabase } from "drizzle-orm/node-postgres";
|
|
31
|
+
import { logger } from "@rebasepro/server";
|
|
32
|
+
import { PgNotifyListener } from "../pg-notify-listener";
|
|
33
|
+
import { ChannelBus, ChannelBusFrame, ChannelBusHandler, frameByteLength } from "./ChannelBus";
|
|
34
|
+
|
|
35
|
+
/** NOTIFY channel carrying channel-bus frames. */
|
|
36
|
+
export const CHANNEL_BUS_NOTIFY_CHANNEL = "rebase_channel_bus";
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Postgres refuses a NOTIFY payload of 8000 bytes or more. The margin below it
|
|
40
|
+
* is for nothing in particular — it is there so that a payload which passes this
|
|
41
|
+
* check cannot fail at the server for being a few bytes over.
|
|
42
|
+
*/
|
|
43
|
+
export const PG_NOTIFY_MAX_PAYLOAD_BYTES = 7500;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* How long a batching window stays open.
|
|
47
|
+
*
|
|
48
|
+
* Ten milliseconds is below the threshold where a human notices a cursor lag,
|
|
49
|
+
* and it is the difference between one query per message and one query per
|
|
50
|
+
* window under load. Set to 0 to disable coalescing entirely.
|
|
51
|
+
*/
|
|
52
|
+
export const DEFAULT_BATCH_WINDOW_MS = 10;
|
|
53
|
+
|
|
54
|
+
/** JSON overhead per frame inside a batch: the wrapping array's comma. */
|
|
55
|
+
const BATCH_SEPARATOR_BYTES = 1;
|
|
56
|
+
/** JSON overhead of the batch envelope itself: `{"batch":[]}`. */
|
|
57
|
+
const BATCH_ENVELOPE_BYTES = 12;
|
|
58
|
+
|
|
59
|
+
interface PendingFrame {
|
|
60
|
+
frame: ChannelBusFrame;
|
|
61
|
+
bytes: number;
|
|
62
|
+
resolve: () => void;
|
|
63
|
+
reject: (error: unknown) => void;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export class PostgresChannelBus implements ChannelBus {
|
|
67
|
+
readonly kind = "postgres" as const;
|
|
68
|
+
readonly maxFrameBytes = PG_NOTIFY_MAX_PAYLOAD_BYTES;
|
|
69
|
+
|
|
70
|
+
private listener?: PgNotifyListener;
|
|
71
|
+
private readonly batchWindowMs: number;
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Frames waiting for the current window to close.
|
|
75
|
+
*
|
|
76
|
+
* The window is opened by a publish that found none open, and that publish
|
|
77
|
+
* is sent *immediately* rather than joining a batch — see {@link publish}.
|
|
78
|
+
*/
|
|
79
|
+
private pending: PendingFrame[] = [];
|
|
80
|
+
private pendingBytes = BATCH_ENVELOPE_BYTES;
|
|
81
|
+
private windowTimer?: ReturnType<typeof setTimeout>;
|
|
82
|
+
private stopped = false;
|
|
83
|
+
|
|
84
|
+
constructor(
|
|
85
|
+
private readonly db: NodePgDatabase<Record<string, unknown>>,
|
|
86
|
+
private readonly connectionString: string,
|
|
87
|
+
options: { batchWindowMs?: number } = {}
|
|
88
|
+
) {
|
|
89
|
+
const configured = options.batchWindowMs;
|
|
90
|
+
this.batchWindowMs = typeof configured === "number" && configured >= 0
|
|
91
|
+
? configured
|
|
92
|
+
: DEFAULT_BATCH_WINDOW_MS;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
async start(handler: ChannelBusHandler): Promise<void> {
|
|
96
|
+
this.stopped = false;
|
|
97
|
+
this.listener = new PgNotifyListener({
|
|
98
|
+
connectionString: this.connectionString,
|
|
99
|
+
channel: CHANNEL_BUS_NOTIFY_CHANNEL,
|
|
100
|
+
logLabel: "[ChannelBus]",
|
|
101
|
+
onPayload: async (payload) => {
|
|
102
|
+
const frames = parseChannelBusPayload(payload);
|
|
103
|
+
if (!frames.length) {
|
|
104
|
+
logger.warn("⚠️ [ChannelBus] Dropping unparseable payload.");
|
|
105
|
+
return;
|
|
106
|
+
}
|
|
107
|
+
// In order: a batch preserves the sender's publish order, and a
|
|
108
|
+
// retained channel's consumers rely on it.
|
|
109
|
+
for (const frame of frames) await handler(frame);
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
await this.listener.start();
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Publish, coalescing under load.
|
|
117
|
+
*
|
|
118
|
+
* The window is *leading edge*: a publish arriving when no window is open is
|
|
119
|
+
* sent straight away and opens one, so an idle channel pays no added latency
|
|
120
|
+
* at all. Frames arriving while it is open are collected and leave together
|
|
121
|
+
* when it closes. The effect is that cost tracks elapsed time rather than
|
|
122
|
+
* message count — one query per window instead of one per message — which is
|
|
123
|
+
* the same shape as the retention pruning throttle, for the same reason.
|
|
124
|
+
*
|
|
125
|
+
* The returned promise settles when the frame has actually left, not when it
|
|
126
|
+
* was queued, so the contract ("reaches the other instances, or rejects")
|
|
127
|
+
* still holds.
|
|
128
|
+
*/
|
|
129
|
+
async publish(frame: ChannelBusFrame): Promise<void> {
|
|
130
|
+
if (this.batchWindowMs === 0 || this.stopped) {
|
|
131
|
+
await this.send([frame]);
|
|
132
|
+
return;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (!this.windowTimer) {
|
|
136
|
+
this.openWindow();
|
|
137
|
+
await this.send([frame]);
|
|
138
|
+
return;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
const bytes = frameByteLength(frame) + BATCH_SEPARATOR_BYTES;
|
|
142
|
+
|
|
143
|
+
// A batch is one NOTIFY payload, so the 8 KB ceiling applies to the
|
|
144
|
+
// whole batch. Send what we have rather than let the frame push it over.
|
|
145
|
+
if (this.pending.length && this.pendingBytes + bytes > this.maxFrameBytes) {
|
|
146
|
+
this.flush();
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
return new Promise<void>((resolve, reject) => {
|
|
150
|
+
this.pending.push({ frame, bytes, resolve, reject });
|
|
151
|
+
this.pendingBytes += bytes;
|
|
152
|
+
});
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
async stop(): Promise<void> {
|
|
156
|
+
this.stopped = true;
|
|
157
|
+
if (this.windowTimer) {
|
|
158
|
+
clearTimeout(this.windowTimer);
|
|
159
|
+
this.windowTimer = undefined;
|
|
160
|
+
}
|
|
161
|
+
// Anything still queued belongs to clients that are already waiting on
|
|
162
|
+
// it; dropping it on shutdown would be a silent loss where a flush costs
|
|
163
|
+
// one more query.
|
|
164
|
+
this.flush();
|
|
165
|
+
await this.listener?.stop();
|
|
166
|
+
this.listener = undefined;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
private openWindow(): void {
|
|
170
|
+
this.windowTimer = setTimeout(() => {
|
|
171
|
+
this.windowTimer = undefined;
|
|
172
|
+
if (this.pending.length) {
|
|
173
|
+
// Still busy: send this window's frames and open the next one,
|
|
174
|
+
// so a sustained stream keeps costing one query per window.
|
|
175
|
+
this.flush();
|
|
176
|
+
this.openWindow();
|
|
177
|
+
}
|
|
178
|
+
// Otherwise leave it closed, so the next publish after a quiet
|
|
179
|
+
// moment goes out immediately.
|
|
180
|
+
}, this.batchWindowMs);
|
|
181
|
+
|
|
182
|
+
// Housekeeping must never hold the process open.
|
|
183
|
+
(this.windowTimer as unknown as { unref?: () => void }).unref?.();
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/** Send everything queued and settle the promises waiting on it. */
|
|
187
|
+
private flush(): void {
|
|
188
|
+
if (!this.pending.length) return;
|
|
189
|
+
|
|
190
|
+
const batch = this.pending;
|
|
191
|
+
this.pending = [];
|
|
192
|
+
this.pendingBytes = BATCH_ENVELOPE_BYTES;
|
|
193
|
+
|
|
194
|
+
this.send(batch.map(p => p.frame))
|
|
195
|
+
.then(() => { for (const p of batch) p.resolve(); })
|
|
196
|
+
.catch((error) => { for (const p of batch) p.reject(error); });
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* One NOTIFY.
|
|
201
|
+
*
|
|
202
|
+
* A single frame goes out in the plain, unwrapped shape. That is not just
|
|
203
|
+
* economy: during a rolling deploy an instance running the previous build
|
|
204
|
+
* understands only that shape, and low-rate traffic — presence, the tail of
|
|
205
|
+
* a session — is exactly what is flowing while pods restart. Batching only
|
|
206
|
+
* appears under load, which shrinks the mixed-version window to almost
|
|
207
|
+
* nothing.
|
|
208
|
+
*/
|
|
209
|
+
private async send(frames: ChannelBusFrame[]): Promise<void> {
|
|
210
|
+
if (!frames.length) return;
|
|
211
|
+
const payload = frames.length === 1
|
|
212
|
+
? JSON.stringify(frames[0])
|
|
213
|
+
: JSON.stringify({ batch: frames });
|
|
214
|
+
|
|
215
|
+
await this.db.execute(sql`SELECT pg_notify(${CHANNEL_BUS_NOTIFY_CHANNEL}, ${payload})`);
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* Parse a bus payload into the frames it carries.
|
|
221
|
+
*
|
|
222
|
+
* Accepts both wire shapes — a bare frame and a `{ batch: [...] }` envelope —
|
|
223
|
+
* so an instance on the new build understands one on the old. Returns an empty
|
|
224
|
+
* array for anything unrecognisable: a malformed or future-versioned message
|
|
225
|
+
* must never take the listener down.
|
|
226
|
+
*/
|
|
227
|
+
export function parseChannelBusPayload(payload: string): ChannelBusFrame[] {
|
|
228
|
+
let parsed: unknown;
|
|
229
|
+
try {
|
|
230
|
+
parsed = JSON.parse(payload);
|
|
231
|
+
} catch {
|
|
232
|
+
return [];
|
|
233
|
+
}
|
|
234
|
+
if (!parsed || typeof parsed !== "object") return [];
|
|
235
|
+
|
|
236
|
+
const batch = (parsed as { batch?: unknown }).batch;
|
|
237
|
+
if (Array.isArray(batch)) {
|
|
238
|
+
return batch
|
|
239
|
+
.map(entry => coerceFrame(entry))
|
|
240
|
+
.filter((frame): frame is ChannelBusFrame => frame !== null);
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
const single = coerceFrame(parsed);
|
|
244
|
+
return single ? [single] : [];
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Parse a single bus frame, returning null for anything that is not a frame we
|
|
249
|
+
* understand.
|
|
250
|
+
*/
|
|
251
|
+
export function parseChannelBusFrame(payload: string): ChannelBusFrame | null {
|
|
252
|
+
try {
|
|
253
|
+
return coerceFrame(JSON.parse(payload));
|
|
254
|
+
} catch {
|
|
255
|
+
return null;
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
function coerceFrame(value: unknown): ChannelBusFrame | null {
|
|
260
|
+
if (!value || typeof value !== "object") return null;
|
|
261
|
+
|
|
262
|
+
const obj = value as Record<string, unknown>;
|
|
263
|
+
const sid = typeof obj.sid === "string" ? obj.sid : undefined;
|
|
264
|
+
const channel = typeof obj.channel === "string" ? obj.channel : undefined;
|
|
265
|
+
if (!sid || !channel) return null;
|
|
266
|
+
|
|
267
|
+
switch (obj.kind) {
|
|
268
|
+
case "broadcast":
|
|
269
|
+
if (typeof obj.event !== "string") return null;
|
|
270
|
+
return {
|
|
271
|
+
kind: "broadcast",
|
|
272
|
+
sid,
|
|
273
|
+
channel,
|
|
274
|
+
event: obj.event,
|
|
275
|
+
from: typeof obj.from === "string" ? obj.from : undefined,
|
|
276
|
+
seq: typeof obj.seq === "number" ? obj.seq : undefined,
|
|
277
|
+
payload: obj.payload
|
|
278
|
+
};
|
|
279
|
+
case "broadcast_ref":
|
|
280
|
+
if (typeof obj.seq !== "number") return null;
|
|
281
|
+
return {
|
|
282
|
+
kind: "broadcast_ref",
|
|
283
|
+
sid,
|
|
284
|
+
channel,
|
|
285
|
+
from: typeof obj.from === "string" ? obj.from : undefined,
|
|
286
|
+
seq: obj.seq
|
|
287
|
+
};
|
|
288
|
+
case "presence_diff":
|
|
289
|
+
return {
|
|
290
|
+
kind: "presence_diff",
|
|
291
|
+
sid,
|
|
292
|
+
channel,
|
|
293
|
+
joins: (obj.joins ?? {}) as Record<string, Record<string, unknown>>,
|
|
294
|
+
leaves: (obj.leaves ?? {}) as Record<string, Record<string, unknown>>
|
|
295
|
+
};
|
|
296
|
+
default:
|
|
297
|
+
return null;
|
|
298
|
+
}
|
|
299
|
+
}
|