@rebasepro/server-postgres 0.0.1-canary.fc811d7 → 0.9.1-canary.0de22e0
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 +21 -0
- package/dist/PostgresBackendDriver.d.ts +43 -2
- package/dist/PostgresBootstrapper.d.ts +17 -1
- package/dist/auth/services.d.ts +16 -0
- package/dist/collections/buildRegistry.d.ts +27 -0
- package/dist/connection.d.ts +21 -0
- package/dist/data-transformer.d.ts +9 -2
- package/dist/index.es.js +2502 -2624
- package/dist/index.es.js.map +1 -1
- package/dist/module-dir.d.ts +1 -0
- package/dist/schema/doctor.d.ts +1 -1
- package/dist/schema/introspect-db-logic.d.ts +0 -5
- package/dist/schema/introspect-db-naming.d.ts +10 -0
- package/dist/security/policy-drift.d.ts +46 -5
- package/dist/security/rls-enforcement.d.ts +28 -3
- package/dist/services/FetchService.d.ts +4 -24
- package/dist/services/PersistService.d.ts +27 -1
- package/dist/services/RelationService.d.ts +34 -1
- package/dist/services/channel-history.d.ts +118 -0
- package/dist/services/collection-helpers.d.ts +79 -14
- package/dist/services/dataService.d.ts +3 -1
- package/dist/services/index.d.ts +1 -1
- package/dist/services/realtimeService.d.ts +76 -2
- package/dist/services/row-pipeline.d.ts +63 -0
- package/package.json +15 -40
- package/src/PostgresBackendDriver.ts +183 -18
- package/src/PostgresBootstrapper.ts +86 -27
- package/src/auth/ensure-tables.ts +73 -11
- package/src/auth/services.ts +49 -19
- package/src/cli-helpers.ts +2 -20
- package/src/cli.ts +60 -0
- package/src/collections/buildRegistry.ts +59 -0
- package/src/connection.ts +61 -1
- package/src/data-transformer.ts +11 -9
- package/src/databasePoolManager.ts +2 -0
- package/src/module-dir.ts +7 -0
- package/src/schema/doctor-cli.ts +5 -1
- package/src/schema/doctor.ts +45 -20
- package/src/schema/generate-drizzle-schema-logic.ts +24 -29
- package/src/schema/generate-postgres-ddl-logic.ts +76 -28
- package/src/schema/introspect-db-inference.ts +1 -1
- package/src/schema/introspect-db-logic.ts +1 -10
- package/src/schema/introspect-db-naming.ts +15 -0
- package/src/schema/introspect-db.ts +19 -2
- package/src/schema/introspect-runtime.ts +1 -1
- package/src/security/anonymous-grants.test.ts +71 -0
- package/src/security/policy-drift.test.ts +153 -14
- package/src/security/policy-drift.ts +128 -10
- package/src/security/rls-enforcement.ts +67 -6
- package/src/services/BranchService.ts +42 -10
- package/src/services/FetchService.ts +65 -270
- package/src/services/PersistService.ts +130 -14
- package/src/services/RelationService.ts +153 -94
- package/src/services/channel-history.ts +343 -0
- package/src/services/collection-helpers.ts +164 -47
- package/src/services/dataService.ts +3 -2
- package/src/services/index.ts +1 -0
- package/src/services/realtimeService.ts +237 -28
- package/src/services/row-pipeline.ts +239 -0
- package/src/utils/drizzle-conditions.ts +13 -0
- package/src/websocket.ts +34 -12
- package/dist/chunk-DSJWtz9O.js +0 -40
- package/dist/schema/auth-default-policies.d.ts +0 -10
- package/dist/src-Eh-CZosp.js +0 -595
- package/dist/src-Eh-CZosp.js.map +0 -1
- package/src/schema/auth-default-policies.ts +0 -125
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const moduleDir: string;
|
package/dist/schema/doctor.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { CollectionConfig, Property } from "@rebasepro/types";
|
|
|
2
2
|
export type IssueSeverity = "error" | "warning" | "info";
|
|
3
3
|
export interface DoctorIssue {
|
|
4
4
|
severity: IssueSeverity;
|
|
5
|
-
category: "missing_table" | "missing_column" | "type_mismatch" | "missing_constraint" | "schema_stale" | "missing_enum" | "enum_value_mismatch" | "missing_foreign_key" | "sdk_stale";
|
|
5
|
+
category: "missing_table" | "missing_column" | "type_mismatch" | "missing_constraint" | "schema_stale" | "missing_enum" | "enum_value_mismatch" | "missing_foreign_key" | "sdk_stale" | "sdk_not_generated";
|
|
6
6
|
table?: string;
|
|
7
7
|
column?: string;
|
|
8
8
|
expected?: string;
|
|
@@ -32,11 +32,6 @@ export interface TableMeta {
|
|
|
32
32
|
fks: ForeignKeyRow[];
|
|
33
33
|
}
|
|
34
34
|
export declare function singularize(word: string): string;
|
|
35
|
-
/**
|
|
36
|
-
* Convert a snake_case name to a human-readable Title Case label.
|
|
37
|
-
* e.g. "created_at" -> "Created At", "customer_id" -> "Customer Id"
|
|
38
|
-
*/
|
|
39
|
-
export declare function humanize(snakeName: string): string;
|
|
40
35
|
/**
|
|
41
36
|
* Convert a snake_case table name to a camelCase + "Collection" variable name.
|
|
42
37
|
* e.g. "company_token" -> "companyTokenCollection"
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Naming helpers shared by the introspection modules. These live apart from
|
|
3
|
+
* `introspect-db-logic.ts` because the inference pass needs them too, and
|
|
4
|
+
* importing them from there would close a cycle back through this module.
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Convert a snake_case name to a human-readable Title Case label.
|
|
8
|
+
* e.g. "created_at" -> "Created At", "customer_id" -> "Customer Id"
|
|
9
|
+
*/
|
|
10
|
+
export declare function humanize(snakeName: string): string;
|
|
@@ -22,6 +22,10 @@ export interface PolicyRef {
|
|
|
22
22
|
roles: string[];
|
|
23
23
|
/** SELECT / INSERT / UPDATE / DELETE / ALL. */
|
|
24
24
|
command: string;
|
|
25
|
+
/** Whether a USING clause is present at all (not what it says). */
|
|
26
|
+
hasUsing: boolean;
|
|
27
|
+
/** Whether a WITH CHECK clause is present at all (not what it says). */
|
|
28
|
+
hasWithCheck: boolean;
|
|
25
29
|
}
|
|
26
30
|
export interface PolicyDrift {
|
|
27
31
|
/** Described by the collections, absent from the database. */
|
|
@@ -45,13 +49,50 @@ export declare function parseExpectedPolicies(ddl: string): PolicyRef[];
|
|
|
45
49
|
/**
|
|
46
50
|
* Diff expected against live.
|
|
47
51
|
*
|
|
48
|
-
* Compares names, roles and
|
|
49
|
-
* *
|
|
50
|
-
* `with_check` when storing them (parenthesising, casting,
|
|
51
|
-
* so text comparison reports drift that does not exist, and
|
|
52
|
-
*
|
|
52
|
+
* Compares names, roles, command, and whether each clause exists — all exact
|
|
53
|
+
* values. Policy expression *text* is deliberately not compared: Postgres
|
|
54
|
+
* rewrites `qual`/`with_check` when storing them (parenthesising, casting,
|
|
55
|
+
* schema-qualifying), so text comparison reports drift that does not exist, and
|
|
56
|
+
* a check that cries wolf gets ignored.
|
|
57
|
+
*
|
|
58
|
+
* Presence is not text, though. A NULL `qual` is not a rewrite of an
|
|
59
|
+
* expression, it is the absence of one, and absence has no false-positive risk:
|
|
60
|
+
* either the generator emitted a clause or it did not. That distinction is worth
|
|
61
|
+
* the extra comparison — a production database was found with a SELECT policy
|
|
62
|
+
* whose `qual` was NULL, matching on every field this checked and denying 100%
|
|
63
|
+
* of reads. The same blindness would hide a policy that fails open.
|
|
53
64
|
*/
|
|
54
65
|
export declare function checkPolicyDrift(client: Queryable, collections: CollectionConfig[]): Promise<PolicyDrift>;
|
|
66
|
+
/**
|
|
67
|
+
* Does this name look like one the generator produced for this table?
|
|
68
|
+
*
|
|
69
|
+
* Unnamed rules compile to `<table>_<op>_<sha1[0:7]>` (plus `_<idx>` when one
|
|
70
|
+
* rule spans several operations), and the hash covers the rule's semantics — so
|
|
71
|
+
* *editing* a rule renames its policy. The policy under the old name is left
|
|
72
|
+
* behind by `db push`, which only DROPs the names it is about to CREATE, and
|
|
73
|
+
* Postgres ORs PERMISSIVE policies together: a superseded `USING (true)` keeps
|
|
74
|
+
* granting everything no matter how tight its replacement is.
|
|
75
|
+
*
|
|
76
|
+
* Matching the shape is what makes dropping them safe. A hand-written policy
|
|
77
|
+
* would have to collide with a 7-hex digest to be mistaken for generated one;
|
|
78
|
+
* a policy named anything else is left alone and merely reported, because a
|
|
79
|
+
* custom name is indistinguishable from one someone wrote in SQL on purpose.
|
|
80
|
+
*/
|
|
81
|
+
export declare function isGeneratedPolicyName(name: string, table: string): boolean;
|
|
82
|
+
export interface OrphanCleanup {
|
|
83
|
+
/** Superseded generated policies that were dropped. */
|
|
84
|
+
dropped: PolicyRef[];
|
|
85
|
+
/** Orphans left in place because their names are not generator-shaped. */
|
|
86
|
+
kept: PolicyRef[];
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Drop the policies an earlier push superseded but never removed.
|
|
90
|
+
*
|
|
91
|
+
* Only touches tables the collections describe — a table with no expected
|
|
92
|
+
* policy is not ours to reconcile, and scanning by schema alone would sweep up
|
|
93
|
+
* policies belonging to something else sharing the database.
|
|
94
|
+
*/
|
|
95
|
+
export declare function dropOrphanedPolicies(client: Queryable, drift: PolicyDrift, collections: CollectionConfig[]): Promise<OrphanCleanup>;
|
|
55
96
|
export declare const hasDrift: (d: PolicyDrift) => boolean;
|
|
56
97
|
/** Human-readable report; empty string when the database matches the config. */
|
|
57
98
|
export declare function formatPolicyDrift(drift: PolicyDrift): string;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { SQL } from "drizzle-orm";
|
|
2
|
+
import { SecurityRule } from "@rebasepro/types";
|
|
2
3
|
/**
|
|
3
4
|
* Unified RLS enforcement — the "user context vs server context" model.
|
|
4
5
|
*
|
|
@@ -50,7 +51,7 @@ export interface ConnectionPosture {
|
|
|
50
51
|
privileged: boolean;
|
|
51
52
|
}
|
|
52
53
|
export interface AuthContext {
|
|
53
|
-
|
|
54
|
+
uid: string;
|
|
54
55
|
/** Raw roles as carried on the user (strings or `{ id }` objects). */
|
|
55
56
|
roles: unknown[];
|
|
56
57
|
}
|
|
@@ -94,10 +95,34 @@ export declare function ensureAppRole(run: RawSqlRunner, schemas: string[]): Pro
|
|
|
94
95
|
* treat `auth.uid() IS NULL` as the trusted server context, and `auth.uid()`
|
|
95
96
|
* is `NULLIF(current_setting('app.user_id'), '')` — so an EMPTY user id would
|
|
96
97
|
* be read as NULL and silently escalate a user request to server privileges.
|
|
97
|
-
* Coerce empty/blank ids to
|
|
98
|
-
* than trusting every caller (e.g. realtime subscription auth) to do it.
|
|
98
|
+
* Coerce empty/blank ids to `ANONYMOUS_USER_ID` here, at the single chokepoint,
|
|
99
|
+
* rather than trusting every caller (e.g. realtime subscription auth) to do it.
|
|
100
|
+
* That sentinel is exported from `@rebasepro/types` because it leaks into rule
|
|
101
|
+
* semantics: it is why `auth.uid() IS NOT NULL` is true for anonymous requests.
|
|
99
102
|
*/
|
|
100
103
|
export declare function applyAuthContext(tx: SqlTx, auth: AuthContext, userRole?: string): Promise<void>;
|
|
104
|
+
/**
|
|
105
|
+
* Warn about rules that read as "signed-in users only" but admit anonymous
|
|
106
|
+
* callers — `auth.uid() IS NOT NULL`, or a comparison against another
|
|
107
|
+
* platform's magic user id such as `'anon'`.
|
|
108
|
+
*
|
|
109
|
+
* The sibling of {@link validatePolicyPgRoles}, for the more dangerous spelling
|
|
110
|
+
* of the same habit. A foreign `pgRoles` value makes a policy unreachable and
|
|
111
|
+
* the table reads empty — loud, and that guard throws. These do the opposite:
|
|
112
|
+
* the rule compiles to a grant, and nothing looks wrong until the data is
|
|
113
|
+
* already public.
|
|
114
|
+
*
|
|
115
|
+
* Warns rather than throws. Unlike an unreachable `pgRoles`, these rules are
|
|
116
|
+
* serving traffic today: refusing to boot would take an app offline to report a
|
|
117
|
+
* problem it already has, and on the read path it would take it offline
|
|
118
|
+
* *because* its data was exposed. Rewriting the author's SQL is not an option
|
|
119
|
+
* either — this is the escape hatch whose whole promise is that it means what it
|
|
120
|
+
* says. So: say so, loudly, and leave the rule alone.
|
|
121
|
+
*/
|
|
122
|
+
export declare function warnOnAnonymousGrants(collections: {
|
|
123
|
+
slug?: string;
|
|
124
|
+
securityRules?: readonly SecurityRule[];
|
|
125
|
+
}[]): void;
|
|
101
126
|
/**
|
|
102
127
|
* Reject `pgRoles` that this server can never satisfy.
|
|
103
128
|
*
|
|
@@ -40,44 +40,22 @@ export declare class FetchService {
|
|
|
40
40
|
* the target relation so actual row data is returned.
|
|
41
41
|
*/
|
|
42
42
|
private buildWithConfig;
|
|
43
|
-
/**
|
|
44
|
-
* Detect if a many-to-many relation uses a junction table in the Drizzle schema.
|
|
45
|
-
*/
|
|
46
|
-
private isJunctionRelation;
|
|
47
43
|
/**
|
|
48
44
|
* Get the Drizzle relation name on the junction table that points to the actual target row.
|
|
49
45
|
* For example, for posts_tags junction, this returns "tag_id" (the relation pointing to tags).
|
|
50
46
|
*/
|
|
51
47
|
private getJunctionTargetRelationName;
|
|
52
|
-
/**
|
|
53
|
-
* Convert a db.query result row (with nested relation objects) to a flat row.
|
|
54
|
-
* Handles:
|
|
55
|
-
* - Placing `id` at the top level as a string
|
|
56
|
-
* - Type normalization (dates, numbers, NaN) via normalizeDbValues
|
|
57
|
-
* - Converting nested relation objects to { id, path, __type: "relation" } for CMS
|
|
58
|
-
* - Flattening junction-table many-to-many results
|
|
59
|
-
*/
|
|
60
|
-
private drizzleResultToRow;
|
|
61
48
|
/**
|
|
62
49
|
* Post-fetch joinPath relations for a single flat row.
|
|
63
50
|
* joinPath relations cannot be expressed via Drizzle's `with` config,
|
|
64
51
|
* so they must be loaded separately after the primary query.
|
|
65
52
|
*/
|
|
66
53
|
private resolveJoinPathRelations;
|
|
67
|
-
/**
|
|
68
|
-
* Post-fetch joinPath relations for a batch of flat rows.
|
|
69
|
-
* Uses batch fetching to avoid N+1 queries for list views.
|
|
70
|
-
*/
|
|
71
|
-
private resolveJoinPathRelationsBatch;
|
|
72
54
|
/**
|
|
73
55
|
* Resolves joinPath relations for raw REST rows and directly injects them.
|
|
74
56
|
* Uses RelationService to query the database and maps results back to the flattened objects.
|
|
75
57
|
*/
|
|
76
58
|
private resolveJoinPathRelationsBatchRest;
|
|
77
|
-
/**
|
|
78
|
-
* Convert a db.query result row to a flat REST-style object with populated relations.
|
|
79
|
-
*/
|
|
80
|
-
private drizzleResultToRestRow;
|
|
81
59
|
/**
|
|
82
60
|
* Build db.query-compatible options from standard fetch options.
|
|
83
61
|
* Handles filter, search, orderBy, limit, and cursor-based pagination.
|
|
@@ -108,8 +86,10 @@ export declare class FetchService {
|
|
|
108
86
|
}): Promise<Record<string, unknown>[]>;
|
|
109
87
|
/**
|
|
110
88
|
* Fallback path used when db.query is unavailable.
|
|
111
|
-
*
|
|
112
|
-
*
|
|
89
|
+
*
|
|
90
|
+
* The primary path runs the results through `toCmsRow`, which maps
|
|
91
|
+
* relations from what drizzle already nested — no query per row. This one
|
|
92
|
+
* has no nesting to read, so it resolves relations itself, in batches.
|
|
113
93
|
*
|
|
114
94
|
* Process raw database results into flat rows with relations.
|
|
115
95
|
*/
|
|
@@ -12,6 +12,24 @@ export declare class PersistService {
|
|
|
12
12
|
private relationService;
|
|
13
13
|
private fetchService;
|
|
14
14
|
constructor(db: DrizzleClient, registry: PostgresCollectionRegistry);
|
|
15
|
+
/**
|
|
16
|
+
* Explain a write that matched no rows.
|
|
17
|
+
*
|
|
18
|
+
* Row-level security filters UPDATE and DELETE through the policy's USING
|
|
19
|
+
* clause instead of raising: a denied write is reported by Postgres exactly
|
|
20
|
+
* like a successful one that happened to match nothing. Left unchecked, a
|
|
21
|
+
* caller cannot tell "denied" from "done" — the write returns 200/204 and
|
|
22
|
+
* the row is untouched.
|
|
23
|
+
*
|
|
24
|
+
* Re-reading the target over the *same* RLS-scoped handle separates the two
|
|
25
|
+
* cases. A visible row means the policy rejected the write (403); an
|
|
26
|
+
* invisible one means there is nothing there to write for this caller (404,
|
|
27
|
+
* matching what a GET would say). The re-read is bound by the caller's own
|
|
28
|
+
* policies, so it discloses nothing a plain read wouldn't.
|
|
29
|
+
*
|
|
30
|
+
* Only reached when zero rows matched, so the happy path pays nothing.
|
|
31
|
+
*/
|
|
32
|
+
private explainZeroRowWrite;
|
|
15
33
|
/**
|
|
16
34
|
* Delete an row by ID
|
|
17
35
|
*/
|
|
@@ -22,8 +40,16 @@ export declare class PersistService {
|
|
|
22
40
|
deleteAll(collectionPath: string, _databaseId?: string): Promise<void>;
|
|
23
41
|
/**
|
|
24
42
|
* Save an row (create or update)
|
|
43
|
+
*
|
|
44
|
+
* With `options.upsert`, the row is written with INSERT ... ON CONFLICT DO
|
|
45
|
+
* UPDATE against the primary key rather than a plain UPDATE. That is one
|
|
46
|
+
* statement, so it cannot lose a race the way a read-then-write can, and it
|
|
47
|
+
* does not care whether the row already exists — which is what a re-runnable
|
|
48
|
+
* import needs.
|
|
25
49
|
*/
|
|
26
|
-
save<M extends Record<string, unknown>>(collectionPath: string, values: Partial<M>, id?: string | number, databaseId?: string
|
|
50
|
+
save<M extends Record<string, unknown>>(collectionPath: string, values: Partial<M>, id?: string | number, databaseId?: string, options?: {
|
|
51
|
+
upsert?: boolean;
|
|
52
|
+
}): Promise<Record<string, unknown>>;
|
|
27
53
|
/**
|
|
28
54
|
* Get the RelationService instance for external use
|
|
29
55
|
*/
|
|
@@ -20,6 +20,40 @@ export declare class RelationService {
|
|
|
20
20
|
private db;
|
|
21
21
|
private registry;
|
|
22
22
|
constructor(db: DrizzleClient, registry: PostgresCollectionRegistry);
|
|
23
|
+
/**
|
|
24
|
+
* One target row, as the {@link RelatedRow} everything here returns.
|
|
25
|
+
*
|
|
26
|
+
* Eight sites built this by hand, which is how the address came to be the
|
|
27
|
+
* target's first key column in all eight — one edit, eight places to miss.
|
|
28
|
+
*
|
|
29
|
+
* `resolveNested` is the one thing they did not agree on, and the
|
|
30
|
+
* disagreement was invisible: the single-parent fetches pass `db` and
|
|
31
|
+
* `registry` to `parseDataFromServer`, so the target's *own* relations get
|
|
32
|
+
* resolved too, while the batch paths deliberately do not — a query per
|
|
33
|
+
* target row is the N+1 the batching exists to avoid. Naming the parameter
|
|
34
|
+
* makes that a decision rather than a difference between two call sites
|
|
35
|
+
* nobody was comparing.
|
|
36
|
+
*/
|
|
37
|
+
private toRelatedRow;
|
|
38
|
+
/**
|
|
39
|
+
* A WHERE matching any of `parentIds`, by the whole key.
|
|
40
|
+
*
|
|
41
|
+
* A single key is an `IN (…)`. A composite one cannot be: matching
|
|
42
|
+
* `tenant_id IN (1, 1)` collects every row of tenant 1, so two parents that
|
|
43
|
+
* share their first column each receive the other's relations. It becomes
|
|
44
|
+
* an OR of ANDs — one exact address per parent — which Postgres indexes the
|
|
45
|
+
* same way it would a multi-column key lookup.
|
|
46
|
+
*/
|
|
47
|
+
private parentKeyCondition;
|
|
48
|
+
/**
|
|
49
|
+
* Reject a relation that cannot express a composite-keyed parent.
|
|
50
|
+
*
|
|
51
|
+
* `localKey` and `foreignKeyOnTarget` are single column names: one column
|
|
52
|
+
* cannot reference a two-column key, so such a relation has no correct
|
|
53
|
+
* reading. Left alone it would silently match on the first key column and
|
|
54
|
+
* hand a tenant's rows to its neighbour — say so instead.
|
|
55
|
+
*/
|
|
56
|
+
private assertSingleKeyAddressable;
|
|
23
57
|
/**
|
|
24
58
|
* Fetch rows related to a parent row through a specific relation
|
|
25
59
|
*/
|
|
@@ -72,7 +106,6 @@ export declare class RelationService {
|
|
|
72
106
|
relationKey: string;
|
|
73
107
|
relation: Relation;
|
|
74
108
|
newValue: unknown;
|
|
75
|
-
currentId?: string | number;
|
|
76
109
|
}>): Promise<void>;
|
|
77
110
|
/**
|
|
78
111
|
* Handle inverse relations with joinPath
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Ordered, replayable per-channel message history.
|
|
3
|
+
*
|
|
4
|
+
* Broadcast on its own is fire-and-forget to whoever is connected at the
|
|
5
|
+
* instant it is sent: fine for presence and for "someone saved" notifications,
|
|
6
|
+
* not enough for op-based collaborative editing, where a client that blinks
|
|
7
|
+
* out for two seconds has to resync a whole document rather than catch up on
|
|
8
|
+
* the four operations it missed. This adds the missing half — every retained
|
|
9
|
+
* broadcast gets a per-channel sequence number, and a client can ask for
|
|
10
|
+
* everything after the last one it saw.
|
|
11
|
+
*
|
|
12
|
+
* Three decisions worth stating, because each rules out a simpler-looking one:
|
|
13
|
+
*
|
|
14
|
+
* - **Retention is server-side and opt-in.** A channel is created by whoever
|
|
15
|
+
* names it, so a client-supplied history depth would let any visitor commit
|
|
16
|
+
* the backend to unbounded storage. And presence channels — the common case
|
|
17
|
+
* — must not pay for this: with no rules configured nothing is written, no
|
|
18
|
+
* table is created, and `broadcast` runs exactly the code it ran before.
|
|
19
|
+
*
|
|
20
|
+
* - **Sequence numbers come from the database, not from a counter in this
|
|
21
|
+
* process.** They have to survive a restart and be shared across instances;
|
|
22
|
+
* an in-memory counter would restart at 1 after a deploy and hand a
|
|
23
|
+
* reconnecting client a replay from the wrong era, silently.
|
|
24
|
+
*
|
|
25
|
+
* - **The cursor row outlives the messages it numbered.** Pruning is what
|
|
26
|
+
* makes retention affordable, but pruning the cursor along with the messages
|
|
27
|
+
* would restart the sequence and make `sinceSeq` mean something different
|
|
28
|
+
* before and after — the worst kind of bug, because replay would still
|
|
29
|
+
* return rows and they would look plausible. Cursors are tiny and are kept
|
|
30
|
+
* forever; see {@link prune}, which touches only `channel_messages`.
|
|
31
|
+
*/
|
|
32
|
+
import { NodePgDatabase } from "drizzle-orm/node-postgres";
|
|
33
|
+
import type { ChannelHistoryEntry, ChannelRetentionRule } from "@rebasepro/types";
|
|
34
|
+
/**
|
|
35
|
+
* Parse a retention TTL into milliseconds.
|
|
36
|
+
*
|
|
37
|
+
* Accepts a raw millisecond count or a short duration string (`"30s"`, `"15m"`,
|
|
38
|
+
* `"24h"`, `"7d"`). Returns undefined for anything unparseable, which the
|
|
39
|
+
* caller treats as "no TTL" — a misspelt duration must not silently become an
|
|
40
|
+
* aggressive one.
|
|
41
|
+
*/
|
|
42
|
+
export declare function parseTtlMs(ttl: number | string | undefined): number | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* Whether `channel` is covered by `rule`.
|
|
45
|
+
*
|
|
46
|
+
* Exact match, or a trailing `*` acting as a prefix. Not a general glob: this
|
|
47
|
+
* decides what reaches disk, and a pattern language whose reach is not obvious
|
|
48
|
+
* at a glance is the wrong tool for that job.
|
|
49
|
+
*/
|
|
50
|
+
export declare function channelMatchesRule(channel: string, rule: ChannelRetentionRule): boolean;
|
|
51
|
+
/** A rule with its TTL already resolved to milliseconds. */
|
|
52
|
+
export interface ResolvedRetention {
|
|
53
|
+
limit?: number;
|
|
54
|
+
ttlMs?: number;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Persistence and replay for retained channels.
|
|
58
|
+
*
|
|
59
|
+
* Inert unless constructed with at least one rule: {@link enabled} is false,
|
|
60
|
+
* {@link ensureTables} does nothing, and {@link retentionFor} answers undefined
|
|
61
|
+
* for every channel, so the realtime service never reaches the SQL below.
|
|
62
|
+
*/
|
|
63
|
+
export declare class ChannelHistoryStore {
|
|
64
|
+
private db;
|
|
65
|
+
private rules;
|
|
66
|
+
/** Resolved rule per channel name, so the match runs once per channel. */
|
|
67
|
+
private resolved;
|
|
68
|
+
/** Channel → timestamp of its last prune, for {@link PRUNE_THROTTLE_MS}. */
|
|
69
|
+
private lastPruned;
|
|
70
|
+
private tablesReady;
|
|
71
|
+
constructor(db: NodePgDatabase<Record<string, unknown>>, rules?: ChannelRetentionRule[]);
|
|
72
|
+
/** Whether any channel retains anything at all. */
|
|
73
|
+
get enabled(): boolean;
|
|
74
|
+
/**
|
|
75
|
+
* The retention that applies to `channel`, or undefined when none does.
|
|
76
|
+
*
|
|
77
|
+
* First matching rule wins, so callers order them most-specific first.
|
|
78
|
+
*/
|
|
79
|
+
retentionFor(channel: string): ResolvedRetention | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* Create the history tables. Idempotent, and a no-op when no rule is set —
|
|
82
|
+
* a deployment that never retains anything gets no schema for it.
|
|
83
|
+
*/
|
|
84
|
+
ensureTables(): Promise<void>;
|
|
85
|
+
/**
|
|
86
|
+
* Append a broadcast and return the sequence number it was given.
|
|
87
|
+
*
|
|
88
|
+
* The sequence is allocated by the same statement that stores the message,
|
|
89
|
+
* so a crash between the two is not a possibility. `ON CONFLICT DO UPDATE`
|
|
90
|
+
* takes a row lock on the channel's cursor, which is what makes concurrent
|
|
91
|
+
* broadcasts to one channel line up in a single order — and what keeps
|
|
92
|
+
* different channels from contending with each other at all.
|
|
93
|
+
*/
|
|
94
|
+
append(channel: string, event: string, payload: unknown, senderId?: string): Promise<{
|
|
95
|
+
seq: number;
|
|
96
|
+
at: string;
|
|
97
|
+
}>;
|
|
98
|
+
/**
|
|
99
|
+
* Everything retained for `channel` after `sinceSeq`, oldest first.
|
|
100
|
+
*
|
|
101
|
+
* `latestSeq` is reported whether or not the messages were capped, so a
|
|
102
|
+
* client that is further behind than one page can tell.
|
|
103
|
+
*/
|
|
104
|
+
replay(channel: string, sinceSeq?: number, limit?: number): Promise<{
|
|
105
|
+
messages: ChannelHistoryEntry[];
|
|
106
|
+
latestSeq: number;
|
|
107
|
+
}>;
|
|
108
|
+
/**
|
|
109
|
+
* Enforce a channel's retention bounds.
|
|
110
|
+
*
|
|
111
|
+
* Throttled per channel, so a burst of operations prunes once rather than
|
|
112
|
+
* once per message — the cost then tracks elapsed time instead of write
|
|
113
|
+
* volume, which is what makes retention affordable on a hot channel.
|
|
114
|
+
*/
|
|
115
|
+
prune(channel: string, retention: ResolvedRetention): Promise<number>;
|
|
116
|
+
/** Forget throttle and match caches. Called on shutdown. */
|
|
117
|
+
clear(): void;
|
|
118
|
+
}
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import { PgTable, AnyPgColumn } from "drizzle-orm/pg-core";
|
|
2
2
|
import { CollectionConfig } from "@rebasepro/types";
|
|
3
3
|
import { PostgresCollectionRegistry } from "../collections/PostgresCollectionRegistry";
|
|
4
|
+
export { buildCompositeId, parseIdValues, COMPOSITE_ID_SEPARATOR } from "@rebasepro/common";
|
|
5
|
+
export type { PrimaryKeyInfo } from "@rebasepro/common";
|
|
6
|
+
import type { PrimaryKeyInfo } from "@rebasepro/common";
|
|
4
7
|
/**
|
|
5
8
|
* Shared helper functions for row operations.
|
|
6
9
|
* These are used by FetchService, PersistService, and RelationService.
|
|
@@ -21,18 +24,80 @@ export interface DrizzleColumnMeta {
|
|
|
21
24
|
export declare function getColumnMeta(col: AnyPgColumn): DrizzleColumnMeta;
|
|
22
25
|
export declare function getCollectionByPath(collectionPath: string, registry: PostgresCollectionRegistry): CollectionConfig;
|
|
23
26
|
export declare function getTableForCollection(collection: CollectionConfig, registry: PostgresCollectionRegistry): PgTable<any>;
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
27
|
+
/**
|
|
28
|
+
* The key columns a collection's rows are addressed by.
|
|
29
|
+
*
|
|
30
|
+
* Three tiers, in order: properties marked `isId`, the primary keys of the
|
|
31
|
+
* drizzle schema, and finally a column literally named `id`. Only the first is
|
|
32
|
+
* visible to the browser, which is why a key known only to drizzle is reported
|
|
33
|
+
* at boot — see {@link warnOnKeysTheAdminCannotResolve}.
|
|
34
|
+
*
|
|
35
|
+
* Returns `[]` when nothing resolves, rather than throwing. It used to open by
|
|
36
|
+
* resolving the table, which throws when there is none — so the `isId` tier,
|
|
37
|
+
* which needs no table at all, was unreachable for exactly the collections
|
|
38
|
+
* most likely to have no table registered. Every caller that wanted "no keys"
|
|
39
|
+
* to mean "no keys" had to spell that out in a try/catch.
|
|
40
|
+
*
|
|
41
|
+
* Callers that cannot proceed without a key must say so themselves, naming the
|
|
42
|
+
* collection: an empty array here means "this collection has no address", which
|
|
43
|
+
* is a different answer in a notification (broadcast a wildcard) than in a save
|
|
44
|
+
* (fail).
|
|
45
|
+
*/
|
|
46
|
+
export declare function getPrimaryKeys(collection: CollectionConfig, registry: PostgresCollectionRegistry): PrimaryKeyInfo[];
|
|
47
|
+
/**
|
|
48
|
+
* The key columns, for callers that cannot do their job without one.
|
|
49
|
+
*
|
|
50
|
+
* {@link getPrimaryKeys} answers "what keys, if any" and returns `[]` for a
|
|
51
|
+
* collection with no address. Most of this driver, though, is building a WHERE
|
|
52
|
+
* clause and has no meaning without a key — for those, an empty array is not an
|
|
53
|
+
* answer, and indexing `[0]` into it produces `Cannot read properties of
|
|
54
|
+
* undefined` three frames from where the real problem is. This says what is
|
|
55
|
+
* wrong and which collection it is wrong about.
|
|
56
|
+
*/
|
|
57
|
+
export declare function requirePrimaryKeys(collection: CollectionConfig, registry: PostgresCollectionRegistry): PrimaryKeyInfo[];
|
|
58
|
+
/**
|
|
59
|
+
* Collections whose key the *browser* cannot resolve, and what it will do
|
|
60
|
+
* instead.
|
|
61
|
+
*
|
|
62
|
+
* The two sides resolve keys from different evidence. This driver reads, in
|
|
63
|
+
* order: properties marked `isId`, the primary keys of the Drizzle schema, then
|
|
64
|
+
* a column literally named `id`. The admin shares the `CollectionConfig` — it
|
|
65
|
+
* compiles the same collection files into its bundle — but never the Drizzle
|
|
66
|
+
* schema, so the middle tier is invisible to it.
|
|
67
|
+
*
|
|
68
|
+
* Nothing can normalize this at runtime: the server does not serve the admin
|
|
69
|
+
* its collections, so a key resolved here cannot be handed over there. The
|
|
70
|
+
* config files are the only thing both sides read, so the fix is an edit to
|
|
71
|
+
* them, and the most this can do is say exactly which edit.
|
|
72
|
+
*
|
|
73
|
+
* Two shapes, and the second is the dangerous one:
|
|
74
|
+
*
|
|
75
|
+
* - No `isId`, no `id` property → the admin resolves no address, warns in the
|
|
76
|
+
* console, and rows cannot be opened or linked.
|
|
77
|
+
* - No `isId`, but an `id` property that is *not* the key → the admin addresses
|
|
78
|
+
* rows by `id` while this driver reads the address as the real key. Nothing
|
|
79
|
+
* errors: the addresses look right and route wrong.
|
|
80
|
+
*/
|
|
81
|
+
export declare function findUnresolvableKeyCollections(collections: CollectionConfig[], registry: PostgresCollectionRegistry): {
|
|
82
|
+
collection: CollectionConfig;
|
|
83
|
+
keys: PrimaryKeyInfo[];
|
|
84
|
+
shadowedByIdProperty: boolean;
|
|
28
85
|
}[];
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
86
|
+
/**
|
|
87
|
+
* Report the collections from {@link findUnresolvableKeyCollections} at boot,
|
|
88
|
+
* with the edit that fixes each one.
|
|
89
|
+
*
|
|
90
|
+
* Grouped by failure, not by collection: the shadowed case is a routing bug and
|
|
91
|
+
* the silent case is a missing feature, and they deserve different urgency.
|
|
92
|
+
*/
|
|
93
|
+
export declare function warnOnKeysTheAdminCannotResolve(collections: CollectionConfig[], registry: PostgresCollectionRegistry): void;
|
|
94
|
+
/**
|
|
95
|
+
* The address of a row: derived from the collection's primary keys, because a
|
|
96
|
+
* row does not carry one — it is exactly its columns.
|
|
97
|
+
*
|
|
98
|
+
* Falls back to a literal `id` column, for a row that reached us from somewhere
|
|
99
|
+
* other than this driver. Returns `""` when there is no key and no `id` —
|
|
100
|
+
* callers decide what that means, since "unaddressable" is a different answer
|
|
101
|
+
* in a notification (broadcast a wildcard) than in a save (fail).
|
|
102
|
+
*/
|
|
103
|
+
export declare function deriveRowAddress(row: Record<string, unknown>, collection: CollectionConfig, registry: PostgresCollectionRegistry): string;
|
|
@@ -82,7 +82,9 @@ export declare class DataService implements DataRepository {
|
|
|
82
82
|
/**
|
|
83
83
|
* Save an row (create or update)
|
|
84
84
|
*/
|
|
85
|
-
save<M extends Record<string, unknown>>(collectionPath: string, values: Partial<M>, id?: string | number, databaseId?: string
|
|
85
|
+
save<M extends Record<string, unknown>>(collectionPath: string, values: Partial<M>, id?: string | number, databaseId?: string, options?: {
|
|
86
|
+
upsert?: boolean;
|
|
87
|
+
}): Promise<Record<string, unknown>>;
|
|
86
88
|
/**
|
|
87
89
|
* Delete an row by ID
|
|
88
90
|
*/
|
package/dist/services/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { FetchService } from "./FetchService";
|
|
2
2
|
export { PersistService } from "./PersistService";
|
|
3
3
|
export { RelationService } from "./RelationService";
|
|
4
|
-
export { getCollectionByPath, getTableForCollection, getPrimaryKeys, parseIdValues, buildCompositeId } from "./collection-helpers";
|
|
4
|
+
export { getCollectionByPath, getTableForCollection, getPrimaryKeys, deriveRowAddress, parseIdValues, buildCompositeId } from "./collection-helpers";
|