@rebasepro/server-postgres 0.0.1-canary.fc811d7 → 0.9.1-canary.09aaf62
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/PostgresBackendDriver.d.ts +25 -2
- package/dist/PostgresBootstrapper.d.ts +10 -0
- 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 +2005 -2583
- 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/security/policy-drift.d.ts +46 -5
- package/dist/security/rls-enforcement.d.ts +27 -2
- 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/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 +7 -0
- package/dist/services/row-pipeline.d.ts +63 -0
- package/package.json +15 -17
- package/src/PostgresBackendDriver.ts +127 -13
- package/src/PostgresBootstrapper.ts +68 -26
- 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.ts +19 -2
- 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 +64 -3
- 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/collection-helpers.ts +164 -47
- package/src/services/dataService.ts +3 -2
- package/src/services/index.ts +1 -0
- package/src/services/realtimeService.ts +40 -19
- package/src/services/row-pipeline.ts +239 -0
- package/src/utils/drizzle-conditions.ts +13 -0
- package/src/websocket.ts +4 -1
- 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
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { CollectionConfig, NumberProperty, Property, Relation, RelationProperty, SecurityOperation, SecurityRule, StringProperty, isPostgresCollectionConfig, DateProperty, ArrayProperty, MapProperty, ReferenceProperty, VectorProperty, BinaryProperty } from "@rebasepro/types";
|
|
2
|
-
import { getEnumVarName, getTableName, resolveCollectionRelations, findRelation, securityRuleToConditions, policyToPostgres } from "@rebasepro/common";
|
|
3
|
-
import { toSnakeCase } from "@rebasepro/utils";
|
|
4
|
-
import { createHash } from "crypto";
|
|
5
|
-
import { getEffectiveSecurityRules } from "./auth-default-policies";
|
|
2
|
+
import { getEnumVarName, getTableName, resolveCollectionRelations, findRelation, securityRuleToConditions, policyToPostgres, getEffectiveSecurityRules, getInjectedSecurityRules, resolveJunctionSpecs, getJunctionSecurityRules, getJunctionCollectionConfig } from "@rebasepro/common";
|
|
3
|
+
import { toSnakeCase, getPolicyNamesForRule } from "@rebasepro/utils";
|
|
6
4
|
|
|
7
5
|
// --- Helper Functions ---
|
|
8
6
|
|
|
@@ -44,22 +42,6 @@ const isIdProperty = (propName: string, prop: Property, collection: CollectionCo
|
|
|
44
42
|
return !hasExplicitId && propName === "id";
|
|
45
43
|
};
|
|
46
44
|
|
|
47
|
-
const getPolicyNameHash = (rule: SecurityRule): string => {
|
|
48
|
-
const data = JSON.stringify({
|
|
49
|
-
a: rule.access,
|
|
50
|
-
m: rule.mode,
|
|
51
|
-
op: rule.operation,
|
|
52
|
-
ops: rule.operations?.slice().sort(),
|
|
53
|
-
own: rule.ownerField,
|
|
54
|
-
rol: rule.roles?.slice().sort(),
|
|
55
|
-
pg: rule.pgRoles?.slice().sort(),
|
|
56
|
-
u: rule.using,
|
|
57
|
-
w: rule.withCheck,
|
|
58
|
-
c: rule.condition,
|
|
59
|
-
ch: rule.check
|
|
60
|
-
});
|
|
61
|
-
return createHash("sha1").update(data).digest("hex").substring(0, 7);
|
|
62
|
-
};
|
|
63
45
|
|
|
64
46
|
type ResolveCollection = (slug: string) => CollectionConfig | undefined;
|
|
65
47
|
|
|
@@ -69,14 +51,10 @@ const generatePolicyDdl = (collection: CollectionConfig, rule: SecurityRule, res
|
|
|
69
51
|
? rule.operations
|
|
70
52
|
: [rule.operation ?? "all"];
|
|
71
53
|
|
|
72
|
-
const
|
|
54
|
+
const policyNames = getPolicyNamesForRule(rule, tableName);
|
|
73
55
|
|
|
74
56
|
return ops.map((op, opIdx) => {
|
|
75
|
-
|
|
76
|
-
? (ops.length > 1 ? `${rule.name}_${op}` : rule.name)
|
|
77
|
-
: `${tableName}_${op}_${ruleHash}${ops.length > 1 ? `_${opIdx}` : ""}`;
|
|
78
|
-
|
|
79
|
-
return generateSinglePolicyDdl(collection, rule, op, policyName, resolveCollection);
|
|
57
|
+
return generateSinglePolicyDdl(collection, rule, op, policyNames[opIdx], resolveCollection);
|
|
80
58
|
}).join("");
|
|
81
59
|
};
|
|
82
60
|
|
|
@@ -248,6 +226,10 @@ export const generatePostgresDdl = async (
|
|
|
248
226
|
});
|
|
249
227
|
if (ddl.endsWith(";\n")) ddl += "\n";
|
|
250
228
|
|
|
229
|
+
// Junction policy derivation needs every declaring side of each junction,
|
|
230
|
+
// not just the first relation that reached it in the walk below.
|
|
231
|
+
const junctionSpecs = resolveJunctionSpecs(collections);
|
|
232
|
+
|
|
251
233
|
const allTablesToGenerate = new Map<string, {
|
|
252
234
|
collection: CollectionConfig,
|
|
253
235
|
isJunction?: boolean,
|
|
@@ -283,6 +265,11 @@ export const generatePostgresDdl = async (
|
|
|
283
265
|
|
|
284
266
|
// 3. Generate tables
|
|
285
267
|
const fkStatements: string[] = [];
|
|
268
|
+
// Policies are emitted after every CREATE TABLE, like the FK constraints:
|
|
269
|
+
// a policy may reference other tables (a junction's derived policies always
|
|
270
|
+
// reference both endpoints; `policy.existsIn` references a join table), and
|
|
271
|
+
// CREATE POLICY validates those relations at creation time.
|
|
272
|
+
const policyStatements: string[] = [];
|
|
286
273
|
for (const [tableName, {
|
|
287
274
|
collection,
|
|
288
275
|
isJunction,
|
|
@@ -315,6 +302,25 @@ export const generatePostgresDdl = async (
|
|
|
315
302
|
|
|
316
303
|
fkStatements.push(`ALTER TABLE "${schema}"."${baseTableName}" ADD CONSTRAINT "${baseTableName}_${sourceColumn}_fkey" FOREIGN KEY ("${sourceColumn}") REFERENCES "${sourceSchema}"."${sourceTable}" ("${sourceId}") ON DELETE ${onDelete.toUpperCase()};`);
|
|
317
304
|
fkStatements.push(`ALTER TABLE "${schema}"."${baseTableName}" ADD CONSTRAINT "${baseTableName}_${targetColumn}_fkey" FOREIGN KEY ("${targetColumn}") REFERENCES "${targetSchema}"."${targetTable}" ("${targetId}") ON DELETE ${onDelete.toUpperCase()};`);
|
|
305
|
+
|
|
306
|
+
if (options.includePolicies) {
|
|
307
|
+
// Junction tables are generated tables like any other: locked by
|
|
308
|
+
// default, with derived policies — reads follow the endpoints'
|
|
309
|
+
// visibility, writes follow the declaring side's update rules.
|
|
310
|
+
// Without this they were the one kind of generated table with no
|
|
311
|
+
// RLS at all, readable and writable by every signed-in user.
|
|
312
|
+
ddl += `ALTER TABLE "${schema}"."${baseTableName}" ENABLE ROW LEVEL SECURITY;\n`;
|
|
313
|
+
ddl += `\n`;
|
|
314
|
+
|
|
315
|
+
const spec = junctionSpecs.get(baseTableName);
|
|
316
|
+
if (spec) {
|
|
317
|
+
const junctionCollection = getJunctionCollectionConfig(spec);
|
|
318
|
+
const resolveCollection: ResolveCollection = (slug) => collections.find(c => c.slug === slug || getTableName(c) === slug);
|
|
319
|
+
getJunctionSecurityRules(spec).forEach((rule: SecurityRule) => {
|
|
320
|
+
policyStatements.push(generatePolicyDdl(junctionCollection, rule, resolveCollection));
|
|
321
|
+
});
|
|
322
|
+
}
|
|
323
|
+
}
|
|
318
324
|
} else if (!isJunction) {
|
|
319
325
|
ddl += `CREATE TABLE "${schema}"."${baseTableName}" (\n`;
|
|
320
326
|
const columns: string[] = [];
|
|
@@ -436,9 +442,8 @@ export const generatePostgresDdl = async (
|
|
|
436
442
|
if (securityRules.length > 0) {
|
|
437
443
|
const resolveCollection: ResolveCollection = (slug) => collections.find(c => c.slug === slug || getTableName(c) === slug);
|
|
438
444
|
securityRules.forEach((rule: SecurityRule) => {
|
|
439
|
-
|
|
445
|
+
policyStatements.push(generatePolicyDdl(collection, rule, resolveCollection));
|
|
440
446
|
});
|
|
441
|
-
ddl += "\n";
|
|
442
447
|
}
|
|
443
448
|
}
|
|
444
449
|
}
|
|
@@ -449,6 +454,12 @@ export const generatePostgresDdl = async (
|
|
|
449
454
|
ddl += fkStatements.join("\n") + "\n\n";
|
|
450
455
|
}
|
|
451
456
|
|
|
457
|
+
if (policyStatements.length > 0) {
|
|
458
|
+
ddl += "-- Row Level Security Policies\n";
|
|
459
|
+
ddl += policyStatements.join("");
|
|
460
|
+
ddl += "\n";
|
|
461
|
+
}
|
|
462
|
+
|
|
452
463
|
return ddl;
|
|
453
464
|
};
|
|
454
465
|
|
|
@@ -478,13 +489,50 @@ export const generatePostgresPoliciesDdl = (collections: CollectionConfig[]): st
|
|
|
478
489
|
const securityRules = getEffectiveSecurityRules(collection);
|
|
479
490
|
if (securityRules.length > 0) {
|
|
480
491
|
const resolveCollection: ResolveCollection = (slug) => collections.find(c => c.slug === slug || getTableName(c) === slug);
|
|
492
|
+
const injectedNames = new Set(getInjectedSecurityRules(collection).map((rule) => rule.name));
|
|
493
|
+
|
|
481
494
|
securityRules.forEach((rule: SecurityRule) => {
|
|
495
|
+
// Say which policies the author did not write. They are permissive,
|
|
496
|
+
// so they OR with the declared rules and widen the final ACL beyond
|
|
497
|
+
// what `securityRules` reads like — and re-appear after any manual
|
|
498
|
+
// DROP, because a push asserts the declared state.
|
|
499
|
+
if (rule.name && injectedNames.has(rule.name)) {
|
|
500
|
+
ddl += `-- Injected by Rebase (not from this collection's securityRules).\n`;
|
|
501
|
+
ddl += `-- Set \`disableDefaultPolicies: true\` on "${collection.slug}" to drop these and own its RLS outright.\n`;
|
|
502
|
+
}
|
|
482
503
|
ddl += generatePolicyDdl(collection, rule, resolveCollection);
|
|
483
504
|
});
|
|
484
505
|
ddl += "\n";
|
|
485
506
|
}
|
|
486
507
|
}
|
|
487
508
|
|
|
509
|
+
// Junction tables are generated from `through` relations, not declared as
|
|
510
|
+
// collections, so the walk above never sees them. They get the same
|
|
511
|
+
// treatment as any generated table: locked by default, with derived
|
|
512
|
+
// policies — reads follow the endpoints, writes follow the declaring
|
|
513
|
+
// side's update rules.
|
|
514
|
+
const junctionSpecs = resolveJunctionSpecs(collections);
|
|
515
|
+
for (const spec of junctionSpecs.values()) {
|
|
516
|
+
ddl += `ALTER TABLE "${spec.schema}"."${spec.table}" ENABLE ROW LEVEL SECURITY;\n`;
|
|
517
|
+
ddl += `\n`;
|
|
518
|
+
|
|
519
|
+
const junctionRules = getJunctionSecurityRules(spec);
|
|
520
|
+
if (junctionRules.length === 0) continue;
|
|
521
|
+
|
|
522
|
+
const junctionCollection = getJunctionCollectionConfig(spec);
|
|
523
|
+
const resolveCollection: ResolveCollection = (slug) => collections.find(c => c.slug === slug || getTableName(c) === slug);
|
|
524
|
+
const declaringSlugs = spec.declaringSides.map(s => s.collection.slug).join('", "');
|
|
525
|
+
|
|
526
|
+
ddl += `-- Derived by Rebase for the junction "${spec.table}" (no collection declares it).\n`;
|
|
527
|
+
ddl += `-- Reads require both endpoint rows to be visible; writes follow the update\n`;
|
|
528
|
+
ddl += `-- rules of "${declaringSlugs}". Set \`disableDefaultPolicies: true\` on the\n`;
|
|
529
|
+
ddl += `-- declaring collection(s) to drop these and police the junction yourself.\n`;
|
|
530
|
+
junctionRules.forEach((rule: SecurityRule) => {
|
|
531
|
+
ddl += generatePolicyDdl(junctionCollection, rule, resolveCollection);
|
|
532
|
+
});
|
|
533
|
+
ddl += "\n";
|
|
534
|
+
}
|
|
535
|
+
|
|
488
536
|
return ddl;
|
|
489
537
|
};
|
|
490
538
|
|
|
@@ -30,6 +30,7 @@ async function main() {
|
|
|
30
30
|
"--force": Boolean,
|
|
31
31
|
"--schema": String,
|
|
32
32
|
"--data-inference": Boolean,
|
|
33
|
+
"--no-data-inference": Boolean,
|
|
33
34
|
"-o": "--output",
|
|
34
35
|
"-c": "--collections",
|
|
35
36
|
"-f": "--force"
|
|
@@ -166,8 +167,14 @@ async function main() {
|
|
|
166
167
|
logger.info(chalk.blue(`Found ${tablesMap.size} tables (including ${joinTables.size} detected join tables).`));
|
|
167
168
|
|
|
168
169
|
let runDataInference = false;
|
|
169
|
-
if (args["--data-inference"]
|
|
170
|
+
if (args["--no-data-inference"]) {
|
|
171
|
+
runDataInference = false;
|
|
172
|
+
} else if (args["--data-inference"] !== undefined) {
|
|
170
173
|
runDataInference = args["--data-inference"];
|
|
174
|
+
} else if (!process.stdin.isTTY) {
|
|
175
|
+
// No terminal to answer the question below (scaffolding scripts, CI,
|
|
176
|
+
// `rebase init --introspect`) — asking would hang forever.
|
|
177
|
+
logger.info(chalk.gray("Skipping data inference (non-interactive run; pass --data-inference to enable)."));
|
|
171
178
|
} else {
|
|
172
179
|
const rl = readline.createInterface({
|
|
173
180
|
input: process.stdin,
|
|
@@ -236,7 +243,17 @@ async function main() {
|
|
|
236
243
|
const merged = mergeIndexContent(existing, generatedFiles);
|
|
237
244
|
fs.writeFileSync(indexPath, merged, "utf-8");
|
|
238
245
|
} else {
|
|
239
|
-
|
|
246
|
+
// --force replaces collections derived from the database, but the
|
|
247
|
+
// directory can also hold hand-written ones with no table in the
|
|
248
|
+
// introspected schema (the auth users collection lives in
|
|
249
|
+
// "rebase"). The backend discovers the whole directory, so an
|
|
250
|
+
// index listing only introspected tables would silently drop them
|
|
251
|
+
// from the admin UI while the API still served them.
|
|
252
|
+
const siblings = fs.readdirSync(outDir)
|
|
253
|
+
.filter(f => f.endsWith(".ts") && f !== "index.ts")
|
|
254
|
+
.map(f => f.replace(/\.ts$/, ""));
|
|
255
|
+
const allFiles = [...new Set([...generatedFiles, ...siblings])];
|
|
256
|
+
const indexContent = generateIndexContent(allFiles);
|
|
240
257
|
fs.writeFileSync(indexPath, indexContent, "utf-8");
|
|
241
258
|
}
|
|
242
259
|
logger.info(chalk.green(` ✓ ${indexPath}`));
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { describe, expect, it, jest, afterEach } from "@jest/globals";
|
|
2
|
+
import { logger } from "@rebasepro/server";
|
|
3
|
+
|
|
4
|
+
import { warnOnAnonymousGrants } from "./rls-enforcement";
|
|
5
|
+
|
|
6
|
+
/** Capture what the operator would actually see at boot. */
|
|
7
|
+
function captureWarning(fn: () => void): string | null {
|
|
8
|
+
const spy = jest.spyOn(logger, "warn").mockImplementation(() => undefined as never);
|
|
9
|
+
try {
|
|
10
|
+
fn();
|
|
11
|
+
return spy.mock.calls.length > 0 ? String(spy.mock.calls[0][0]) : null;
|
|
12
|
+
} finally {
|
|
13
|
+
spy.mockRestore();
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const collectionWith = (slug: string, using: string) => ({
|
|
18
|
+
slug,
|
|
19
|
+
securityRules: [{ name: "authenticated_access", operation: "all", using, withCheck: using }]
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
afterEach(() => jest.restoreAllMocks());
|
|
23
|
+
|
|
24
|
+
describe("warnOnAnonymousGrants", () => {
|
|
25
|
+
// The rule found in a real app, across 8 collections of PII. It reads as
|
|
26
|
+
// "any logged-in user" and grants every anonymous visitor read and write.
|
|
27
|
+
const FROM_THE_WILD = "auth.uid() IS NOT NULL AND auth.uid() != 'anon'";
|
|
28
|
+
|
|
29
|
+
it("reports both mistakes in the rule from the wild", () => {
|
|
30
|
+
const warning = captureWarning(() => warnOnAnonymousGrants([collectionWith("talents", FROM_THE_WILD)]));
|
|
31
|
+
|
|
32
|
+
expect(warning).toContain("auth.uid() IS NOT NULL");
|
|
33
|
+
expect(warning).toContain("'anon' is a Supabase convention");
|
|
34
|
+
expect(warning).toContain("policy.authenticated()");
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
it("groups by mistake and names every collection it appears on", () => {
|
|
38
|
+
const warning = captureWarning(() => warnOnAnonymousGrants(
|
|
39
|
+
["talents", "companies", "contact_messages"].map(s => collectionWith(s, FROM_THE_WILD))
|
|
40
|
+
));
|
|
41
|
+
|
|
42
|
+
expect(warning).toContain("talents");
|
|
43
|
+
expect(warning).toContain("companies");
|
|
44
|
+
expect(warning).toContain("contact_messages");
|
|
45
|
+
// Grouped, not repeated once per collection: the same habit across 8
|
|
46
|
+
// collections should not print the same paragraph 16 times.
|
|
47
|
+
expect(warning!.match(/Supabase convention/g)).toHaveLength(1);
|
|
48
|
+
expect(warning).toContain("3 rule(s)");
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it("catches the bare tautology, which carries no literal to notice", () => {
|
|
52
|
+
const warning = captureWarning(() => warnOnAnonymousGrants([collectionWith("talents", "auth.uid() IS NOT NULL")]));
|
|
53
|
+
|
|
54
|
+
expect(warning).toContain("auth.uid() IS NOT NULL");
|
|
55
|
+
expect(warning).not.toContain("Supabase convention");
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it("says nothing about rules that are actually correct", () => {
|
|
59
|
+
const warning = captureWarning(() => warnOnAnonymousGrants([
|
|
60
|
+
{ slug: "talents", securityRules: [{ name: "own_rows", operation: "all", ownerField: "owner_id" }] },
|
|
61
|
+
collectionWith("posts", `auth.uid() != 'anonymous'`),
|
|
62
|
+
{ slug: "public_page", securityRules: [{ name: "read", operation: "select", access: "public" }] }
|
|
63
|
+
] as never));
|
|
64
|
+
|
|
65
|
+
expect(warning).toBeNull();
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it("says nothing when no collection has rules at all", () => {
|
|
69
|
+
expect(captureWarning(() => warnOnAnonymousGrants([{ slug: "empty" }]))).toBeNull();
|
|
70
|
+
});
|
|
71
|
+
});
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { describe, expect, it } from "@jest/globals";
|
|
2
2
|
import type { CollectionConfig } from "@rebasepro/types";
|
|
3
3
|
|
|
4
|
-
import { checkPolicyDrift, parseExpectedPolicies, formatPolicyDrift, hasDrift, type Queryable } from "./policy-drift";
|
|
4
|
+
import { checkPolicyDrift, parseExpectedPolicies, formatPolicyDrift, hasDrift, dropOrphanedPolicies, isGeneratedPolicyName, type PolicyRef, type Queryable } from "./policy-drift";
|
|
5
5
|
import { generatePostgresPoliciesDdl } from "../schema/generate-postgres-ddl-logic";
|
|
6
6
|
|
|
7
7
|
function collection(slug: string): CollectionConfig {
|
|
@@ -23,6 +23,17 @@ function dbWith(rows: Record<string, unknown>[]): Queryable {
|
|
|
23
23
|
return { query: async () => ({ rows: rows as never[] }) };
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
+
/** A pg_policies row matching an expected policy, clauses and all. */
|
|
27
|
+
function liveRow(p: PolicyRef, overrides: Record<string, unknown> = {}) {
|
|
28
|
+
return {
|
|
29
|
+
schemaname: p.schema, tablename: p.table, policyname: p.name, roles: p.roles, cmd: p.command,
|
|
30
|
+
// Postgres rewrites the text it stores; only presence is compared.
|
|
31
|
+
qual: p.hasUsing ? "(rewritten by postgres)" : null,
|
|
32
|
+
with_check: p.hasWithCheck ? "(rewritten by postgres)" : null,
|
|
33
|
+
...overrides
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
|
|
26
37
|
describe("parseExpectedPolicies", () => {
|
|
27
38
|
it("reads the DDL that db push actually applies", () => {
|
|
28
39
|
const ddl = generatePostgresPoliciesDdl([collection("authors")]);
|
|
@@ -38,11 +49,8 @@ describe("checkPolicyDrift", () => {
|
|
|
38
49
|
it("reports nothing when the database matches the collections", async () => {
|
|
39
50
|
const cols = [collection("authors")];
|
|
40
51
|
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
41
|
-
const live = expected.map((p) => ({
|
|
42
|
-
schemaname: p.schema, tablename: p.table, policyname: p.name, roles: p.roles, cmd: p.command
|
|
43
|
-
}));
|
|
44
52
|
|
|
45
|
-
const drift = await checkPolicyDrift(dbWith(
|
|
53
|
+
const drift = await checkPolicyDrift(dbWith(expected.map((p) => liveRow(p))), cols);
|
|
46
54
|
|
|
47
55
|
expect(hasDrift(drift)).toBe(false);
|
|
48
56
|
expect(formatPolicyDrift(drift)).toBe("");
|
|
@@ -62,8 +70,8 @@ describe("checkPolicyDrift", () => {
|
|
|
62
70
|
const cols = [collection("customers")];
|
|
63
71
|
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
64
72
|
const live = [
|
|
65
|
-
...expected.map((p) => (
|
|
66
|
-
{ schemaname: "public", tablename: "customers", policyname: "test_policy", roles: ["authenticated"], cmd: "ALL" }
|
|
73
|
+
...expected.map((p) => liveRow(p)),
|
|
74
|
+
{ schemaname: "public", tablename: "customers", policyname: "test_policy", roles: ["authenticated"], cmd: "ALL", qual: "true", with_check: null }
|
|
67
75
|
];
|
|
68
76
|
|
|
69
77
|
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
@@ -76,11 +84,8 @@ describe("checkPolicyDrift", () => {
|
|
|
76
84
|
it("flags a policy whose roles were changed underneath it as diverged", async () => {
|
|
77
85
|
const cols = [collection("orders")];
|
|
78
86
|
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
// Someone re-granted it to a role requests never run as.
|
|
82
|
-
roles: ["authenticated"], cmd: p.command
|
|
83
|
-
}));
|
|
87
|
+
// Someone re-granted it to a role requests never run as.
|
|
88
|
+
const live = expected.map((p) => liveRow(p, { roles: ["authenticated"] }));
|
|
84
89
|
|
|
85
90
|
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
86
91
|
|
|
@@ -89,9 +94,38 @@ describe("checkPolicyDrift", () => {
|
|
|
89
94
|
expect(formatPolicyDrift(drift)).toContain("Diverged");
|
|
90
95
|
});
|
|
91
96
|
|
|
97
|
+
it("flags a policy whose expression the database is missing entirely", async () => {
|
|
98
|
+
// A real production database had jobs.public_read_published stored as
|
|
99
|
+
// SELECT / {public} / USING NULL: every field this used to compare
|
|
100
|
+
// matched, drift reported zero, and the policy denied 100% of reads.
|
|
101
|
+
const cols = [collection("jobs")];
|
|
102
|
+
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
103
|
+
const select = expected.find((p) => p.command === "SELECT" && p.roles.includes("public"))!;
|
|
104
|
+
const live = expected.map((p) => (p === select ? liveRow(p, { qual: null }) : liveRow(p)));
|
|
105
|
+
|
|
106
|
+
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
107
|
+
|
|
108
|
+
expect(drift.diverged).toHaveLength(1);
|
|
109
|
+
expect(drift.diverged[0].differences.join(" ")).toContain("USING: expected an expression, database has none");
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
it("does not mistake an expression Postgres rewrote for a missing one", async () => {
|
|
113
|
+
// The reason expression text is not compared: what comes back out of
|
|
114
|
+
// pg_policies never matches what went in.
|
|
115
|
+
const cols = [collection("posts")];
|
|
116
|
+
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
117
|
+
const live = expected.map((p) => liveRow(p, {
|
|
118
|
+
qual: p.hasUsing ? "((auth.uid() IS NOT NULL) AND ((auth.uid())::text <> 'anonymous'::text))" : null
|
|
119
|
+
}));
|
|
120
|
+
|
|
121
|
+
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
122
|
+
|
|
123
|
+
expect(hasDrift(drift)).toBe(false);
|
|
124
|
+
});
|
|
125
|
+
|
|
92
126
|
it("parses roles when the driver returns the raw {a,b} text form", async () => {
|
|
93
127
|
const cols = [collection("tags")];
|
|
94
|
-
const live = [{ schemaname: "public", tablename: "tags", policyname: "test_policy", roles: "{authenticated,anon}", cmd: "ALL" }];
|
|
128
|
+
const live = [{ schemaname: "public", tablename: "tags", policyname: "test_policy", roles: "{authenticated,anon}", cmd: "ALL", qual: "true", with_check: null }];
|
|
95
129
|
|
|
96
130
|
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
97
131
|
|
|
@@ -104,7 +138,7 @@ describe("checkPolicyDrift", () => {
|
|
|
104
138
|
// Note a collection with no securityRules is NOT this case — it still
|
|
105
139
|
// generates default (admin-only) policies.
|
|
106
140
|
const drift = await checkPolicyDrift(
|
|
107
|
-
dbWith([{ schemaname: "public", tablename: "x", policyname: "p", roles: ["public"], cmd: "ALL" }]),
|
|
141
|
+
dbWith([{ schemaname: "public", tablename: "x", policyname: "p", roles: ["public"], cmd: "ALL", qual: "true", with_check: null }]),
|
|
108
142
|
[]
|
|
109
143
|
);
|
|
110
144
|
|
|
@@ -120,3 +154,108 @@ describe("checkPolicyDrift", () => {
|
|
|
120
154
|
expect(drift.missing.length).toBeGreaterThan(0);
|
|
121
155
|
});
|
|
122
156
|
});
|
|
157
|
+
|
|
158
|
+
describe("isGeneratedPolicyName", () => {
|
|
159
|
+
it("recognises the generator's own shape", () => {
|
|
160
|
+
expect(isGeneratedPolicyName("documents_insert_a1b2c3d", "documents")).toBe(true);
|
|
161
|
+
// One rule spanning several operations appends the operation index.
|
|
162
|
+
expect(isGeneratedPolicyName("documents_update_a1b2c3d_1", "documents")).toBe(true);
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it("does not claim names a human could have written", () => {
|
|
166
|
+
expect(isGeneratedPolicyName("owner_access", "documents")).toBe(false);
|
|
167
|
+
expect(isGeneratedPolicyName("documents_default_admin_read", "documents")).toBe(false);
|
|
168
|
+
// Right shape, wrong table — belongs to something else.
|
|
169
|
+
expect(isGeneratedPolicyName("teams_insert_a1b2c3d", "documents")).toBe(false);
|
|
170
|
+
// A digest is 7 lowercase hex characters, nothing else.
|
|
171
|
+
expect(isGeneratedPolicyName("documents_insert_notahex", "documents")).toBe(false);
|
|
172
|
+
expect(isGeneratedPolicyName("documents_grant_a1b2c3d", "documents")).toBe(false);
|
|
173
|
+
});
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
describe("dropOrphanedPolicies", () => {
|
|
177
|
+
/** Records the DDL issued so the test can assert on what was dropped. */
|
|
178
|
+
function recordingDb(rows: Record<string, unknown>[]) {
|
|
179
|
+
const executed: string[] = [];
|
|
180
|
+
const db: Queryable = {
|
|
181
|
+
query: async (text: string) => {
|
|
182
|
+
if (!/^SELECT/i.test(text)) executed.push(text);
|
|
183
|
+
return { rows: rows as never[] };
|
|
184
|
+
}
|
|
185
|
+
};
|
|
186
|
+
return { db, executed };
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
it("drops the policy a rule edit superseded", async () => {
|
|
190
|
+
// The reported failure: tightening a rule renames its policy, and the
|
|
191
|
+
// permissive original stays live and keeps ORing itself back in.
|
|
192
|
+
const cols = [collection("documents")];
|
|
193
|
+
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
194
|
+
const stale = {
|
|
195
|
+
schemaname: "public", tablename: "documents", policyname: "documents_insert_dead1ee",
|
|
196
|
+
roles: ["public"], cmd: "INSERT", qual: null, with_check: "true"
|
|
197
|
+
};
|
|
198
|
+
const live = [...expected.map((p) => liveRow(p)), stale];
|
|
199
|
+
|
|
200
|
+
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
201
|
+
const { db, executed } = recordingDb(live);
|
|
202
|
+
const { dropped, kept } = await dropOrphanedPolicies(db, drift, cols);
|
|
203
|
+
|
|
204
|
+
expect(dropped).toHaveLength(1);
|
|
205
|
+
expect(dropped[0].name).toBe("documents_insert_dead1ee");
|
|
206
|
+
expect(kept).toHaveLength(0);
|
|
207
|
+
expect(executed).toEqual([
|
|
208
|
+
'DROP POLICY IF EXISTS "documents_insert_dead1ee" ON "public"."documents"'
|
|
209
|
+
]);
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
it("leaves a hand-written policy alone and reports it instead", async () => {
|
|
213
|
+
const cols = [collection("documents")];
|
|
214
|
+
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
215
|
+
const live = [
|
|
216
|
+
...expected.map((p) => liveRow(p)),
|
|
217
|
+
{ schemaname: "public", tablename: "documents", policyname: "ops_break_glass", roles: ["public"], cmd: "ALL", qual: "true", with_check: null }
|
|
218
|
+
];
|
|
219
|
+
|
|
220
|
+
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
221
|
+
const { db, executed } = recordingDb(live);
|
|
222
|
+
const { dropped, kept } = await dropOrphanedPolicies(db, drift, cols);
|
|
223
|
+
|
|
224
|
+
expect(dropped).toHaveLength(0);
|
|
225
|
+
expect(kept.map((p) => p.name)).toEqual(["ops_break_glass"]);
|
|
226
|
+
expect(executed).toEqual([]);
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
it("never touches a table the collections do not describe", async () => {
|
|
230
|
+
// Another application sharing the schema owns this table; a
|
|
231
|
+
// generator-shaped name there is coincidence, not our leftover.
|
|
232
|
+
const cols = [collection("documents")];
|
|
233
|
+
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
234
|
+
const live = [
|
|
235
|
+
...expected.map((p) => liveRow(p)),
|
|
236
|
+
{ schemaname: "public", tablename: "legacy", policyname: "legacy_select_a1b2c3d", roles: ["public"], cmd: "SELECT", qual: "true", with_check: null }
|
|
237
|
+
];
|
|
238
|
+
|
|
239
|
+
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
240
|
+
const { db, executed } = recordingDb(live);
|
|
241
|
+
const { dropped, kept } = await dropOrphanedPolicies(db, drift, cols);
|
|
242
|
+
|
|
243
|
+
expect(dropped).toHaveLength(0);
|
|
244
|
+
expect(kept.map((p) => p.name)).toEqual(["legacy_select_a1b2c3d"]);
|
|
245
|
+
expect(executed).toEqual([]);
|
|
246
|
+
});
|
|
247
|
+
|
|
248
|
+
it("does nothing when the database already matches", async () => {
|
|
249
|
+
const cols = [collection("documents")];
|
|
250
|
+
const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(cols));
|
|
251
|
+
const live = expected.map((p) => liveRow(p));
|
|
252
|
+
|
|
253
|
+
const drift = await checkPolicyDrift(dbWith(live), cols);
|
|
254
|
+
const { db, executed } = recordingDb(live);
|
|
255
|
+
const { dropped, kept } = await dropOrphanedPolicies(db, drift, cols);
|
|
256
|
+
|
|
257
|
+
expect(dropped).toHaveLength(0);
|
|
258
|
+
expect(kept).toHaveLength(0);
|
|
259
|
+
expect(executed).toEqual([]);
|
|
260
|
+
});
|
|
261
|
+
});
|