@rebasepro/server-postgres 0.9.1-canary.c0d4c07 → 0.9.1-canary.d906fb7

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.
@@ -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, dropOrphanedPolicies, isGeneratedPolicyName, type PolicyRef, type Queryable } from "./policy-drift";
4
+ import { checkPolicyDrift, parseExpectedPolicies, formatPolicyDrift, hasDrift, 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 {
@@ -154,108 +154,3 @@ describe("checkPolicyDrift", () => {
154
154
  expect(drift.missing.length).toBeGreaterThan(0);
155
155
  });
156
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
- });
@@ -192,62 +192,6 @@ export async function checkPolicyDrift(
192
192
  return drift;
193
193
  }
194
194
 
195
- /**
196
- * Does this name look like one the generator produced for this table?
197
- *
198
- * Unnamed rules compile to `<table>_<op>_<sha1[0:7]>` (plus `_<idx>` when one
199
- * rule spans several operations), and the hash covers the rule's semantics — so
200
- * *editing* a rule renames its policy. The policy under the old name is left
201
- * behind by `db push`, which only DROPs the names it is about to CREATE, and
202
- * Postgres ORs PERMISSIVE policies together: a superseded `USING (true)` keeps
203
- * granting everything no matter how tight its replacement is.
204
- *
205
- * Matching the shape is what makes dropping them safe. A hand-written policy
206
- * would have to collide with a 7-hex digest to be mistaken for generated one;
207
- * a policy named anything else is left alone and merely reported, because a
208
- * custom name is indistinguishable from one someone wrote in SQL on purpose.
209
- */
210
- export function isGeneratedPolicyName(name: string, table: string): boolean {
211
- return new RegExp(`^${table.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}_(select|insert|update|delete|all)_[0-9a-f]{7}(_\\d+)?$`)
212
- .test(name);
213
- }
214
-
215
- export interface OrphanCleanup {
216
- /** Superseded generated policies that were dropped. */
217
- dropped: PolicyRef[];
218
- /** Orphans left in place because their names are not generator-shaped. */
219
- kept: PolicyRef[];
220
- }
221
-
222
- /**
223
- * Drop the policies an earlier push superseded but never removed.
224
- *
225
- * Only touches tables the collections describe — a table with no expected
226
- * policy is not ours to reconcile, and scanning by schema alone would sweep up
227
- * policies belonging to something else sharing the database.
228
- */
229
- export async function dropOrphanedPolicies(
230
- client: Queryable,
231
- drift: PolicyDrift,
232
- collections: CollectionConfig[]
233
- ): Promise<OrphanCleanup> {
234
- const expected = parseExpectedPolicies(generatePostgresPoliciesDdl(collections));
235
- const managed = new Set(expected.map((p) => `${p.schema}.${p.table}`));
236
-
237
- const cleanup: OrphanCleanup = { dropped: [], kept: [] };
238
- for (const p of drift.orphaned) {
239
- if (!managed.has(`${p.schema}.${p.table}`) || !isGeneratedPolicyName(p.name, p.table)) {
240
- cleanup.kept.push(p);
241
- continue;
242
- }
243
- // Identifiers are quoted, and the name came from pg_policies rather than
244
- // from user input, so it is already a valid identifier.
245
- await client.query(`DROP POLICY IF EXISTS "${p.name}" ON "${p.schema}"."${p.table}"`);
246
- cleanup.dropped.push(p);
247
- }
248
- return cleanup;
249
- }
250
-
251
195
  export const hasDrift = (d: PolicyDrift): boolean =>
252
196
  d.missing.length > 0 || d.orphaned.length > 0 || d.diverged.length > 0;
253
197
 
@@ -91,30 +91,6 @@ function coerceDeclaredNumbers(
91
91
  }
92
92
 
93
93
  /** Render one target row in the requested style. */
94
- /**
95
- * Drop every column the collection marked `excludeFromApi`.
96
- *
97
- * Password hashes and verification tokens have to be readable server-side but
98
- * must never reach a client — and "never" has to mean every exit from this
99
- * pipeline, including relation targets, or a secret leaks through whichever
100
- * path was overlooked. Keyed by both the property name and its column name,
101
- * since a row can arrive keyed either way depending on the caller.
102
- */
103
- function stripExcluded(
104
- row: Record<string, unknown>,
105
- collection: CollectionConfig
106
- ): Record<string, unknown> {
107
- const properties = collection.properties as Record<string, Property> | undefined;
108
- if (!properties) return row;
109
-
110
- for (const [key, property] of Object.entries(properties)) {
111
- if (!property?.excludeFromApi) continue;
112
- delete row[key];
113
- if (property.columnName) delete row[property.columnName];
114
- }
115
- return row;
116
- }
117
-
118
94
  function renderTarget(
119
95
  targetRow: Record<string, unknown>,
120
96
  targetCollection: CollectionConfig,
@@ -124,7 +100,7 @@ function renderTarget(
124
100
  if (style === "inline") {
125
101
  // The target's columns, and only those: its address is the consumer's
126
102
  // to derive, and merging one in overwrites a real `id` column.
127
- return stripExcluded(coerceDeclaredNumbers({ ...targetRow }, targetCollection), targetCollection);
103
+ return coerceDeclaredNumbers({ ...targetRow }, targetCollection);
128
104
  }
129
105
 
130
106
  const address = relationTargetAddress(targetRow, targetCollection, registry);
@@ -192,7 +168,7 @@ export function toCmsRow(
192
168
  }
193
169
  }
194
170
 
195
- return stripExcluded(normalized, collection);
171
+ return normalized;
196
172
  }
197
173
 
198
174
  /**
@@ -235,5 +211,5 @@ export function toRestRow(
235
211
  }
236
212
  }
237
213
 
238
- return stripExcluded(flat, collection);
214
+ return flat;
239
215
  }