@supabase/pg-delta 1.0.0-alpha.3 → 1.0.0-alpha.30

package/src/core/objects/rls-policy/changes/rls-policy.base.ts

@@ -0,0 +1,20 @@
+import { BaseChange } from "../../base.change.ts";
+import type { RlsPolicy } from "../rls-policy.model.ts";
+
+abstract class BaseRlsPolicyChange extends BaseChange {
+  abstract readonly policy: RlsPolicy;
+  abstract readonly scope: "object" | "comment";
+  readonly objectType = "rls_policy" as const;
+}
+
+export abstract class CreateRlsPolicyChange extends BaseRlsPolicyChange {
+  readonly operation = "create" as const;
+}
+
+export abstract class AlterRlsPolicyChange extends BaseRlsPolicyChange {
+  readonly operation = "alter" as const;
+}
+
+export abstract class DropRlsPolicyChange extends BaseRlsPolicyChange {
+  readonly operation = "drop" as const;
+}

package/src/core/objects/rls-policy/changes/rls-policy.comment.ts

@@ -0,0 +1,70 @@
+import type { SerializeOptions } from "../../../integrations/serialize/serialize.types.ts";
+import { quoteLiteral } from "../../base.change.ts";
+import { stableId } from "../../utils.ts";
+import type { RlsPolicy } from "../rls-policy.model.ts";
+import {
+  CreateRlsPolicyChange,
+  DropRlsPolicyChange,
+} from "./rls-policy.base.ts";
+
+export type CommentRlsPolicy =
+  | CreateCommentOnRlsPolicy
+  | DropCommentOnRlsPolicy;
+
+export class CreateCommentOnRlsPolicy extends CreateRlsPolicyChange {
+  public readonly policy: RlsPolicy;
+  public readonly scope = "comment" as const;
+
+  constructor(props: { policy: RlsPolicy }) {
+    super();
+    this.policy = props.policy;
+  }
+
+  get creates() {
+    return [stableId.comment(this.policy.stableId)];
+  }
+
+  get requires() {
+    return [this.policy.stableId];
+  }
+
+  serialize(_options?: SerializeOptions): string {
+    return [
+      "COMMENT ON POLICY",
+      this.policy.name,
+      "ON",
+      `${this.policy.schema}.${this.policy.table_name}`,
+      "IS",
+      // biome-ignore lint/style/noNonNullAssertion: rls policy comment is not nullable in this case
+      quoteLiteral(this.policy.comment!),
+    ].join(" ");
+  }
+}
+
+export class DropCommentOnRlsPolicy extends DropRlsPolicyChange {
+  public readonly policy: RlsPolicy;
+  public readonly scope = "comment" as const;
+
+  constructor(props: { policy: RlsPolicy }) {
+    super();
+    this.policy = props.policy;
+  }
+
+  get drops() {
+    return [stableId.comment(this.policy.stableId)];
+  }
+
+  get requires() {
+    return [stableId.comment(this.policy.stableId), this.policy.stableId];
+  }
+
+  serialize(_options?: SerializeOptions): string {
+    return [
+      "COMMENT ON POLICY",
+      this.policy.name,
+      "ON",
+      `${this.policy.schema}.${this.policy.table_name}`,
+      "IS NULL",
+    ].join(" ");
+  }
+}

package/src/core/objects/rls-policy/changes/rls-policy.create.test.ts

@@ -0,0 +1,209 @@
+import { describe, expect, test } from "bun:test";
+import { assertValidSql } from "../../../test-utils/assert-valid-sql.ts";
+import { stableId } from "../../utils.ts";
+import { RlsPolicy } from "../rls-policy.model.ts";
+import { CreateRlsPolicy } from "./rls-policy.create.ts";
+
+describe("rls-policy", () => {
+  test("create minimal", async () => {
+    const policy = new RlsPolicy({
+      schema: "public",
+      name: "test_policy_min",
+      table_name: "test_table",
+      command: "*",
+      permissive: true,
+      roles: [],
+      using_expression: null,
+      with_check_expression: null,
+      owner: "test",
+      comment: null,
+      referenced_relations: [],
+      referenced_procedures: [],
+    });
+
+    const change = new CreateRlsPolicy({
+      policy,
+    });
+
+    await assertValidSql(change.serialize());
+
+    expect(change.serialize()).toBe(
+      "CREATE POLICY test_policy_min ON public.test_table",
+    );
+  });
+
+  test("create", async () => {
+    const policy = new RlsPolicy({
+      schema: "public",
+      name: "test_policy",
+      table_name: "test_table",
+      command: "r",
+      permissive: true,
+      roles: ["public"],
+      using_expression: "user_id = current_user_id()",
+      with_check_expression: null,
+      owner: "test",
+      comment: null,
+      referenced_relations: [],
+      referenced_procedures: [],
+    });
+
+    const change = new CreateRlsPolicy({
+      policy,
+    });
+
+    await assertValidSql(change.serialize());
+
+    expect(change.serialize()).toBe(
+      "CREATE POLICY test_policy ON public.test_table FOR SELECT USING (user_id = current_user_id())",
+    );
+  });
+
+  test("create with all options", async () => {
+    const policy = new RlsPolicy({
+      schema: "public",
+      name: "test_policy_all",
+      table_name: "test_table",
+      command: "w",
+      permissive: false,
+      roles: ["role1", "role2"],
+      using_expression: "expr1",
+      with_check_expression: "expr2",
+      owner: "test",
+      comment: null,
+      referenced_relations: [],
+      referenced_procedures: [],
+    });
+
+    const change = new CreateRlsPolicy({
+      policy,
+    });
+
+    await assertValidSql(change.serialize());
+
+    expect(change.serialize()).toBe(
+      "CREATE POLICY test_policy_all ON public.test_table AS RESTRICTIVE FOR UPDATE TO role1, role2 USING (expr1) WITH CHECK (expr2)",
+    );
+  });
+
+  test("requires referenced relations reported by pg_depend", () => {
+    const policy = new RlsPolicy({
+      schema: "app",
+      name: "cross_relation_policy",
+      table_name: "accounts",
+      command: "r",
+      permissive: true,
+      roles: ["public"],
+      using_expression:
+        "(EXISTS (SELECT 1 FROM app.users) AND EXISTS (SELECT 1 FROM app.active_accounts))",
+      with_check_expression:
+        "(id IN (SELECT account_id FROM app.memberships WHERE active))",
+      owner: "test",
+      comment: null,
+      referenced_relations: [
+        { kind: "table", schema: "app", name: "users" },
+        { kind: "table", schema: "app", name: "memberships" },
+        { kind: "view", schema: "app", name: "active_accounts" },
+        { kind: "materialized_view", schema: "app", name: "account_stats" },
+        { kind: "foreign_table", schema: "app", name: "remote_profiles" },
+      ],
+      referenced_procedures: [],
+    });
+
+    const change = new CreateRlsPolicy({ policy });
+
+    expect(change.requires).toContain(stableId.table("app", "users"));
+    expect(change.requires).toContain(stableId.table("app", "memberships"));
+    expect(change.requires).toContain(stableId.view("app", "active_accounts"));
+    expect(change.requires).toContain(
+      stableId.materializedView("app", "account_stats"),
+    );
+    expect(change.requires).toContain(
+      stableId.foreignTable("app", "remote_profiles"),
+    );
+  });
+
+  test("requires referenced procedures reported by pg_depend", () => {
+    const policy = new RlsPolicy({
+      schema: "app",
+      name: "function_guarded_policy",
+      table_name: "accounts",
+      command: "r",
+      permissive: true,
+      roles: ["public"],
+      using_expression: "public.is_admin()",
+      with_check_expression: null,
+      owner: "test",
+      comment: null,
+      referenced_relations: [],
+      referenced_procedures: [
+        { schema: "public", name: "is_admin", argument_types: [] },
+        {
+          schema: "public",
+          name: "has_role",
+          argument_types: ["text", "integer"],
+        },
+      ],
+    });
+
+    const change = new CreateRlsPolicy({ policy });
+
+    expect(change.requires).toContain(stableId.procedure("public", "is_admin"));
+    expect(change.requires).toContain(
+      stableId.procedure("public", "has_role", "text,integer"),
+    );
+  });
+
+  test("does not require additional objects when referenced lists are empty", () => {
+    const policy = new RlsPolicy({
+      schema: "app",
+      name: "simple_policy",
+      table_name: "accounts",
+      command: "*",
+      permissive: true,
+      roles: [],
+      using_expression: null,
+      with_check_expression: null,
+      owner: "test",
+      comment: null,
+      referenced_relations: [],
+      referenced_procedures: [],
+    });
+
+    const change = new CreateRlsPolicy({ policy });
+
+    expect(change.requires).toEqual([
+      stableId.schema("app"),
+      stableId.table("app", "accounts"),
+      stableId.role("test"),
+    ]);
+  });
+
+  // Sequences referenced via nextval() are a known gap. pg_depend only
+  // records the sequence edge when the argument is written as a regclass
+  // literal (e.g. `nextval('app.seq'::regclass)`); bare string literals
+  // produce no pg_depend row. Tracked in
+  // https://github.com/supabase/pg-toolbelt/issues/220.
+  test.skip("requires referenced sequences (follow-up)", () => {
+    const policy = new RlsPolicy({
+      schema: "app",
+      name: "sequence_policy",
+      table_name: "accounts",
+      command: "r",
+      permissive: true,
+      roles: ["public"],
+      using_expression: "id < nextval('app.next_id'::regclass)",
+      with_check_expression: null,
+      owner: "test",
+      comment: null,
+      referenced_relations: [],
+      referenced_procedures: [],
+    });
+
+    const change = new CreateRlsPolicy({ policy });
+
+    // Expected once the gap is closed:
+    //   expect(change.requires).toContain(stableId.sequence("app", "next_id"));
+    expect(change.requires.length).toBeGreaterThan(0);
+  });
+});

package/src/core/objects/rls-policy/changes/rls-policy.create.ts

@@ -0,0 +1,128 @@
+import type { SerializeOptions } from "../../../integrations/serialize/serialize.types.ts";
+import { stableId } from "../../utils.ts";
+import type { RlsPolicy } from "../rls-policy.model.ts";
+import { CreateRlsPolicyChange } from "./rls-policy.base.ts";
+
+/**
+ * Create an RLS policy.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-createpolicy.html
+ *
+ * Synopsis
+ * ```sql
+ * CREATE POLICY name ON table_name
+ *     [ AS { PERMISSIVE | RESTRICTIVE } ]
+ *     [ FOR { ALL | SELECT | INSERT | UPDATE | DELETE } ]
+ *     [ TO { role_name | PUBLIC | CURRENT_ROLE | CURRENT_USER | SESSION_USER } [, ...] ]
+ *     [ USING ( using_expression ) ]
+ *     [ WITH CHECK ( with_check_expression ) ]
+ * ```
+ */
+export class CreateRlsPolicy extends CreateRlsPolicyChange {
+  public readonly policy: RlsPolicy;
+  public readonly scope = "object" as const;
+
+  constructor(props: { policy: RlsPolicy }) {
+    super();
+    this.policy = props.policy;
+  }
+
+  get creates() {
+    return [this.policy.stableId];
+  }
+
+  get requires() {
+    const dependencies = new Set<string>();
+
+    // Schema dependency
+    dependencies.add(stableId.schema(this.policy.schema));
+
+    // Table dependency
+    dependencies.add(
+      stableId.table(this.policy.schema, this.policy.table_name),
+    );
+
+    // Owner dependency
+    dependencies.add(stableId.role(this.policy.owner));
+
+    // Relations and functions referenced inside USING / WITH CHECK
+    // expressions must exist before the policy is created. These come from
+    // pg_depend (populated by PostgreSQL's recordDependencyOnExpr at policy
+    // creation), not from re-parsing the expression text.
+    for (const ref of this.policy.referenced_relations) {
+      switch (ref.kind) {
+        case "table":
+          dependencies.add(stableId.table(ref.schema, ref.name));
+          break;
+        case "view":
+          dependencies.add(stableId.view(ref.schema, ref.name));
+          break;
+        case "materialized_view":
+          dependencies.add(stableId.materializedView(ref.schema, ref.name));
+          break;
+        case "foreign_table":
+          dependencies.add(stableId.foreignTable(ref.schema, ref.name));
+          break;
+      }
+    }
+
+    for (const ref of this.policy.referenced_procedures) {
+      dependencies.add(
+        stableId.procedure(ref.schema, ref.name, ref.argument_types.join(",")),
+      );
+    }
+
+    return Array.from(dependencies);
+  }
+
+  serialize(_options?: SerializeOptions): string {
+    const parts: string[] = ["CREATE POLICY"];
+
+    // Add policy name
+    parts.push(this.policy.name);
+
+    // Add ON table
+    parts.push("ON", `${this.policy.schema}.${this.policy.table_name}`);
+
+    // Add AS RESTRICTIVE only if false (default is PERMISSIVE)
+    if (!this.policy.permissive) {
+      parts.push("AS RESTRICTIVE");
+    }
+
+    // Add FOR command
+    const commandMap: Record<string, string> = {
+      r: "FOR SELECT",
+      a: "FOR INSERT",
+      w: "FOR UPDATE",
+      d: "FOR DELETE",
+      "*": "FOR ALL",
+    };
+    // Default is FOR ALL; only print when not default
+    if (this.policy.command && this.policy.command !== "*") {
+      parts.push(commandMap[this.policy.command]);
+    }
+
+    // Add TO roles
+    // Default is TO PUBLIC; avoid printing explicit PUBLIC in CREATE
+    if (this.policy.roles && this.policy.roles.length > 0) {
+      const onlyPublic =
+        this.policy.roles.length === 1 &&
+        this.policy.roles[0].toLowerCase() === "public";
+      if (!onlyPublic) {
+        parts.push("TO", this.policy.roles.join(", "));
+      }
+    }
+
+    // Add USING expression
+    if (this.policy.using_expression) {
+      parts.push("USING", `(${this.policy.using_expression})`);
+    }
+
+    // Add WITH CHECK expression
+    if (this.policy.with_check_expression) {
+      parts.push("WITH CHECK", `(${this.policy.with_check_expression})`);
+    }
+
+    return parts.join(" ");
+  }
+}

package/src/core/objects/rls-policy/changes/rls-policy.drop.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, test } from "bun:test";
+import { assertValidSql } from "../../../test-utils/assert-valid-sql.ts";
+import { RlsPolicy } from "../rls-policy.model.ts";
+import { DropRlsPolicy } from "./rls-policy.drop.ts";
+
+describe("rls-policy", () => {
+  test("drop", async () => {
+    const policy = new RlsPolicy({
+      schema: "public",
+      name: "test_policy",
+      table_name: "test_table",
+      command: "r",
+      permissive: true,
+      roles: ["public"],
+      using_expression: "user_id = current_user_id()",
+      with_check_expression: null,
+      owner: "test",
+      comment: null,
+      referenced_relations: [],
+      referenced_procedures: [],
+    });
+
+    const change = new DropRlsPolicy({
+      policy,
+    });
+
+    await assertValidSql(change.serialize());
+
+    expect(change.serialize()).toBe(
+      "DROP POLICY test_policy ON public.test_table",
+    );
+  });
+});

package/src/core/objects/rls-policy/changes/rls-policy.drop.ts

@@ -0,0 +1,40 @@
+import type { SerializeOptions } from "../../../integrations/serialize/serialize.types.ts";
+import type { RlsPolicy } from "../rls-policy.model.ts";
+import { DropRlsPolicyChange } from "./rls-policy.base.ts";
+
+/**
+ * Drop an RLS policy.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-droppolicy.html
+ *
+ * Synopsis
+ * ```sql
+ * DROP POLICY [ IF EXISTS ] name ON table_name [ CASCADE | RESTRICT ]
+ * ```
+ */
+export class DropRlsPolicy extends DropRlsPolicyChange {
+  public readonly policy: RlsPolicy;
+  public readonly scope = "object" as const;
+
+  constructor(props: { policy: RlsPolicy }) {
+    super();
+    this.policy = props.policy;
+  }
+
+  get drops() {
+    return [this.policy.stableId];
+  }
+
+  get requires() {
+    return [this.policy.stableId];
+  }
+
+  serialize(_options?: SerializeOptions): string {
+    return [
+      "DROP POLICY",
+      this.policy.name,
+      "ON",
+      `${this.policy.schema}.${this.policy.table_name}`,
+    ].join(" ");
+  }
+}

package/src/core/objects/rls-policy/changes/rls-policy.types.ts

@@ -0,0 +1,11 @@
+import type { AlterRlsPolicy } from "./rls-policy.alter.ts";
+import type { CommentRlsPolicy } from "./rls-policy.comment.ts";
+import type { CreateRlsPolicy } from "./rls-policy.create.ts";
+import type { DropRlsPolicy } from "./rls-policy.drop.ts";
+
+/** Union of all RLS policy-related change variants (`objectType: "rls_policy"`). @category Change Types */
+export type RlsPolicyChange =
+  | AlterRlsPolicy
+  | CommentRlsPolicy
+  | CreateRlsPolicy
+  | DropRlsPolicy;

package/src/core/objects/rls-policy/rls-policy.diff.test.ts

@@ -0,0 +1,81 @@
+import { describe, expect, test } from "bun:test";
+import {
+  AlterRlsPolicySetRoles,
+  AlterRlsPolicySetUsingExpression,
+  AlterRlsPolicySetWithCheckExpression,
+} from "./changes/rls-policy.alter.ts";
+import { CreateRlsPolicy } from "./changes/rls-policy.create.ts";
+import { DropRlsPolicy } from "./changes/rls-policy.drop.ts";
+import { diffRlsPolicies } from "./rls-policy.diff.ts";
+import { RlsPolicy, type RlsPolicyProps } from "./rls-policy.model.ts";
+
+const base: RlsPolicyProps = {
+  schema: "public",
+  name: "p1",
+  table_name: "t",
+  command: "r",
+  permissive: true,
+  roles: ["role1"],
+  using_expression: null,
+  with_check_expression: null,
+  owner: "o1",
+  comment: null,
+  referenced_relations: [],
+  referenced_procedures: [],
+};
+
+describe.concurrent("rls-policy.diff", () => {
+  test("create and drop", () => {
+    const p = new RlsPolicy(base);
+    const created = diffRlsPolicies({}, { [p.stableId]: p });
+    expect(created[0]).toBeInstanceOf(CreateRlsPolicy);
+    const dropped = diffRlsPolicies({ [p.stableId]: p }, {});
+    expect(dropped[0]).toBeInstanceOf(DropRlsPolicy);
+  });
+
+  test("alter roles", () => {
+    const main = new RlsPolicy(base);
+    const branch = new RlsPolicy({ ...base, roles: ["r1", "r2"] });
+    const changes = diffRlsPolicies(
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterRlsPolicySetRoles);
+  });
+
+  test("alter USING expression", () => {
+    const main = new RlsPolicy({ ...base, using_expression: "old_expr" });
+    const branch = new RlsPolicy({ ...base, using_expression: "new_expr" });
+    const changes = diffRlsPolicies(
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterRlsPolicySetUsingExpression);
+  });
+
+  test("alter WITH CHECK expression", () => {
+    const main = new RlsPolicy({ ...base, with_check_expression: "old" });
+    const branch = new RlsPolicy({ ...base, with_check_expression: "new" });
+    const changes = diffRlsPolicies(
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterRlsPolicySetWithCheckExpression);
+  });
+
+  test("drop and create when non-alterable property changes", () => {
+    const main = new RlsPolicy(base);
+    const branch = new RlsPolicy({
+      ...base,
+      command: "w",
+      permissive: false,
+    });
+    const changes = diffRlsPolicies(
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes).toHaveLength(2);
+    expect(changes[0]).toBeInstanceOf(DropRlsPolicy);
+    expect(changes[1]).toBeInstanceOf(CreateRlsPolicy);
+  });
+});