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

package/src/core/objects/procedure/changes/procedure.privilege.ts

@@ -0,0 +1,188 @@
+import {
+  formatObjectPrivilegeList,
+  getObjectKindPrefix,
+} from "../../base.privilege.ts";
+import { stableId } from "../../utils.ts";
+import type { Procedure } from "../procedure.model.ts";
+import { AlterProcedureChange } from "./procedure.base.ts";
+
+export type ProcedurePrivilege =
+  | GrantProcedurePrivileges
+  | RevokeProcedurePrivileges
+  | RevokeGrantOptionProcedurePrivileges;
+
+/**
+ * Grant privileges on a procedure.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-grant.html
+ *
+ * Synopsis
+ * ```sql
+ * GRANT { EXECUTE | ALL [ PRIVILEGES ] }
+ *    ON { { FUNCTION | PROCEDURE | ROUTINE } routine_name [ ( [ [ argmode ] [ arg_name ] arg_type [, ...] ] ) ] [, ...]
+ *         | ALL { FUNCTIONS | PROCEDURES | ROUTINES } IN SCHEMA schema_name [, ...] }
+ *    TO role_specification [, ...] [ WITH GRANT OPTION ]
+ *    [ GRANTED BY role_specification ]
+ * ```
+ */
+export class GrantProcedurePrivileges extends AlterProcedureChange {
+  public readonly procedure: Procedure;
+  public readonly grantee: string;
+  public readonly privileges: { privilege: string; grantable: boolean }[];
+  public readonly version: number | undefined;
+  public readonly scope = "privilege" as const;
+
+  constructor(props: {
+    procedure: Procedure;
+    grantee: string;
+    privileges: { privilege: string; grantable: boolean }[];
+    version?: number;
+  }) {
+    super();
+    this.procedure = props.procedure;
+    this.grantee = props.grantee;
+    this.privileges = props.privileges;
+    this.version = props.version;
+  }
+
+  get creates() {
+    return [stableId.acl(this.procedure.stableId, this.grantee)];
+  }
+
+  get requires() {
+    return [this.procedure.stableId, stableId.role(this.grantee)];
+  }
+
+  serialize(): string {
+    const hasGrantable = this.privileges.some((p) => p.grantable);
+    const hasBase = this.privileges.some((p) => !p.grantable);
+    if (hasGrantable && hasBase) {
+      throw new Error(
+        "GrantProcedurePrivileges expects privileges with uniform grantable flag",
+      );
+    }
+    const withGrant = hasGrantable ? " WITH GRANT OPTION" : "";
+    const objectKind = this.procedure.kind === "p" ? "PROCEDURE" : "FUNCTION";
+    const kindPrefix = getObjectKindPrefix(objectKind);
+    const list = this.privileges.map((p) => p.privilege);
+    const privSql = formatObjectPrivilegeList(objectKind, list, this.version);
+    const procedureName = `${this.procedure.schema}.${this.procedure.name}`;
+    const args = this.procedure.argument_types?.join(", ") ?? "";
+    // Always include parentheses for privilege statements, even for zero-argument procedures/functions
+    const signature = `${procedureName}(${args})`;
+    return `GRANT ${privSql} ${kindPrefix} ${signature} TO ${this.grantee}${withGrant}`;
+  }
+}
+
+/**
+ * Revoke privileges on a procedure.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-revoke.html
+ *
+ * Synopsis
+ * ```sql
+ * REVOKE [ GRANT OPTION FOR ]
+ *     { { EXECUTE | ALL [ PRIVILEGES ] } }
+ *     ON { FUNCTION | PROCEDURE | ROUTINE } routine_name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...]
+ *     FROM role_specification [, ...]
+ *     [ GRANTED BY role_specification ]
+ *     [ CASCADE | RESTRICT ]
+ * ```
+ */
+export class RevokeProcedurePrivileges extends AlterProcedureChange {
+  public readonly procedure: Procedure;
+  public readonly grantee: string;
+  public readonly privileges: { privilege: string; grantable: boolean }[];
+  public readonly version: number | undefined;
+  public readonly scope = "privilege" as const;
+
+  constructor(props: {
+    procedure: Procedure;
+    grantee: string;
+    privileges: { privilege: string; grantable: boolean }[];
+    version?: number;
+  }) {
+    super();
+    this.procedure = props.procedure;
+    this.grantee = props.grantee;
+    this.privileges = props.privileges;
+    this.version = props.version;
+  }
+
+  get drops() {
+    // Return ACL ID for dependency tracking, even though this is an ALTER operation
+    // Phase assignment now uses operation type, so this won't affect phase placement
+    return [stableId.acl(this.procedure.stableId, this.grantee)];
+  }
+
+  get requires() {
+    return [
+      stableId.acl(this.procedure.stableId, this.grantee),
+      this.procedure.stableId,
+      stableId.role(this.grantee),
+    ];
+  }
+
+  serialize(): string {
+    const objectKind = this.procedure.kind === "p" ? "PROCEDURE" : "FUNCTION";
+    const kindPrefix = getObjectKindPrefix(objectKind);
+    const list = this.privileges.map((p) => p.privilege);
+    const privSql = formatObjectPrivilegeList(objectKind, list, this.version);
+    const procedureName = `${this.procedure.schema}.${this.procedure.name}`;
+    const args = this.procedure.argument_types?.join(", ") ?? "";
+    // Always include parentheses for privilege statements, even for zero-argument procedures/functions
+    const signature = `${procedureName}(${args})`;
+    return `REVOKE ${privSql} ${kindPrefix} ${signature} FROM ${this.grantee}`;
+  }
+}
+
+/**
+ * Revoke grant option for privileges on a procedure.
+ *
+ * This removes the ability to grant the privilege to others, but keeps the privilege itself.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-revoke.html
+ */
+export class RevokeGrantOptionProcedurePrivileges extends AlterProcedureChange {
+  public readonly procedure: Procedure;
+  public readonly grantee: string;
+  public readonly privilegeNames: string[];
+  public readonly version: number | undefined;
+  public readonly scope = "privilege" as const;
+
+  constructor(props: {
+    procedure: Procedure;
+    grantee: string;
+    privilegeNames: string[];
+    version?: number;
+  }) {
+    super();
+    this.procedure = props.procedure;
+    this.grantee = props.grantee;
+    this.privilegeNames = [...new Set(props.privilegeNames)].sort();
+    this.version = props.version;
+  }
+
+  get requires() {
+    return [
+      stableId.acl(this.procedure.stableId, this.grantee),
+      this.procedure.stableId,
+      stableId.role(this.grantee),
+    ];
+  }
+
+  serialize(): string {
+    const objectKind = this.procedure.kind === "p" ? "PROCEDURE" : "FUNCTION";
+    const kindPrefix = getObjectKindPrefix(objectKind);
+    const privSql = formatObjectPrivilegeList(
+      objectKind,
+      this.privilegeNames,
+      this.version,
+    );
+    const procedureName = `${this.procedure.schema}.${this.procedure.name}`;
+    const args = this.procedure.argument_types?.join(", ") ?? "";
+    // Always include parentheses for privilege statements, even for zero-argument procedures/functions
+    const signature = `${procedureName}(${args})`;
+    return `REVOKE GRANT OPTION FOR ${privSql} ${kindPrefix} ${signature} FROM ${this.grantee}`;
+  }
+}

package/src/core/objects/procedure/changes/procedure.types.ts

@@ -0,0 +1,12 @@
+import type { AlterProcedure } from "./procedure.alter.ts";
+import type { CommentProcedure } from "./procedure.comment.ts";
+import type { CreateProcedure } from "./procedure.create.ts";
+import type { DropProcedure } from "./procedure.drop.ts";
+import type { ProcedurePrivilege } from "./procedure.privilege.ts";
+
+export type ProcedureChange =
+  | AlterProcedure
+  | CommentProcedure
+  | CreateProcedure
+  | DropProcedure
+  | ProcedurePrivilege;

package/src/core/objects/procedure/procedure.diff.test.ts

@@ -0,0 +1,161 @@
+import { describe, expect, test } from "bun:test";
+import { DefaultPrivilegeState } from "../base.default-privileges.ts";
+import {
+  AlterProcedureChangeOwner,
+  AlterProcedureSetConfig,
+  AlterProcedureSetLeakproof,
+  AlterProcedureSetParallel,
+  AlterProcedureSetSecurity,
+  AlterProcedureSetStrictness,
+  AlterProcedureSetVolatility,
+} from "./changes/procedure.alter.ts";
+import { CreateProcedure } from "./changes/procedure.create.ts";
+import { DropProcedure } from "./changes/procedure.drop.ts";
+import { diffProcedures } from "./procedure.diff.ts";
+import { Procedure, type ProcedureProps } from "./procedure.model.ts";
+
+const base: ProcedureProps = {
+  schema: "public",
+  name: "fn1",
+  kind: "f",
+  return_type: "int4",
+  return_type_schema: "pg_catalog",
+  language: "sql",
+  security_definer: false,
+  volatility: "v",
+  parallel_safety: "s",
+  is_strict: false,
+  leakproof: false,
+  returns_set: false,
+  argument_count: 0,
+  argument_default_count: 0,
+  argument_names: null,
+  argument_types: null,
+  all_argument_types: null,
+  argument_modes: null,
+  argument_defaults: null,
+  source_code: null,
+  binary_path: null,
+  sql_body: null,
+  definition:
+    "CREATE FUNCTION public.fn1() RETURNS int4 LANGUAGE sql AS $$SELECT NULL::int4$$",
+  config: null,
+  owner: "o1",
+  execution_cost: 0,
+  result_rows: 0,
+  comment: null,
+  privileges: [],
+};
+
+const testContext = {
+  version: 170000,
+  currentUser: "postgres",
+  defaultPrivilegeState: new DefaultPrivilegeState({}),
+  mainRoles: {},
+};
+
+describe.concurrent("procedure.diff", () => {
+  test("create and drop", () => {
+    const p = new Procedure(base);
+    const created = diffProcedures(testContext, {}, { [p.stableId]: p });
+    expect(created[0]).toBeInstanceOf(CreateProcedure);
+    const dropped = diffProcedures(testContext, { [p.stableId]: p }, {});
+    expect(dropped[0]).toBeInstanceOf(DropProcedure);
+  });
+
+  test("alter owner", () => {
+    const main = new Procedure(base);
+    const branch = new Procedure({ ...base, owner: "o2" });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterProcedureChangeOwner);
+  });
+
+  test("diff emits alter security when security_definer changes", () => {
+    const main = new Procedure(base);
+    const branch = new Procedure({ ...base, security_definer: true });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterProcedureSetSecurity);
+  });
+
+  test("diff emits config set/reset when config changes", () => {
+    const main = new Procedure({ ...base, config: ["search_path=public"] });
+    const branch = new Procedure({
+      ...base,
+      config: ["search_path=pg_temp", "work_mem=64MB"],
+    });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterProcedureSetConfig);
+  });
+
+  test("diff emits volatility change", () => {
+    const main = new Procedure(base);
+    const branch = new Procedure({ ...base, volatility: "i" });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterProcedureSetVolatility);
+  });
+
+  test("diff emits strictness change", () => {
+    const main = new Procedure(base);
+    const branch = new Procedure({ ...base, is_strict: true });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterProcedureSetStrictness);
+  });
+
+  test("diff emits leakproof change", () => {
+    const main = new Procedure(base);
+    const branch = new Procedure({ ...base, leakproof: true });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterProcedureSetLeakproof);
+  });
+
+  test("diff emits parallel safety change", () => {
+    const main = new Procedure(base);
+    const branch = new Procedure({ ...base, parallel_safety: "r" });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterProcedureSetParallel);
+  });
+
+  test("create or replace when non-alterable property changes", () => {
+    const main = new Procedure(base);
+    const branch = new Procedure({
+      ...base,
+      return_type: "text",
+      language: "plpgsql",
+    });
+    const changes = diffProcedures(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes).toHaveLength(1);
+    expect(changes[0]).toBeInstanceOf(CreateProcedure);
+  });
+});