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

package/src/core/objects/materialized-view/changes/materialized-view.privilege.ts

@@ -0,0 +1,212 @@
+import {
+  formatObjectPrivilegeList,
+  getObjectKindPrefix,
+} from "../../base.privilege.ts";
+import { stableId } from "../../utils.ts";
+import type { MaterializedView } from "../materialized-view.model.ts";
+import { AlterMaterializedViewChange } from "./materialized-view.base.ts";
+
+export type MaterializedViewPrivilege =
+  | GrantMaterializedViewPrivileges
+  | RevokeMaterializedViewPrivileges
+  | RevokeGrantOptionMaterializedViewPrivileges;
+
+/**
+ * Grant privileges on a materialized view.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-grant.html
+ *
+ * Synopsis
+ * ```sql
+ * GRANT { { SELECT | INSERT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER }
+ *     [, ...] | ALL [ PRIVILEGES ] }
+ *     ON { [ TABLE ] table_name [, ...] }
+ *     TO role_specification [, ...] [ WITH GRANT OPTION ]
+ *     [ GRANTED BY role_specification ]
+ * ```
+ */
+export class GrantMaterializedViewPrivileges extends AlterMaterializedViewChange {
+  public readonly materializedView: MaterializedView;
+  public readonly grantee: string;
+  public readonly privileges: { privilege: string; grantable: boolean }[];
+  public readonly columns?: string[];
+  public readonly version: number | undefined;
+  public readonly scope = "privilege" as const;
+
+  constructor(props: {
+    materializedView: MaterializedView;
+    grantee: string;
+    privileges: { privilege: string; grantable: boolean }[];
+    columns?: string[];
+    version?: number;
+  }) {
+    super();
+    this.materializedView = props.materializedView;
+    this.grantee = props.grantee;
+    this.privileges = props.privileges;
+    this.columns = props.columns
+      ? [...new Set(props.columns)].sort()
+      : undefined;
+    this.version = props.version;
+  }
+
+  get creates() {
+    return [stableId.acl(this.materializedView.stableId, this.grantee)];
+  }
+
+  get requires() {
+    return [this.materializedView.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(
+        "GrantMaterializedViewPrivileges expects privileges with uniform grantable flag",
+      );
+    }
+    const withGrant = hasGrantable ? " WITH GRANT OPTION" : "";
+    const kindPrefix = getObjectKindPrefix("MATERIALIZED VIEW");
+    const list = this.privileges.map((p) => p.privilege);
+    const privSql = formatObjectPrivilegeList(
+      "MATERIALIZED VIEW",
+      list,
+      this.version,
+    );
+    const materializedViewName = `${this.materializedView.schema}.${this.materializedView.name}`;
+
+    // Add column list if present
+    const columnClause = this.columns ? ` (${this.columns.join(", ")})` : "";
+
+    return `GRANT ${privSql}${columnClause} ${kindPrefix} ${materializedViewName} TO ${this.grantee}${withGrant}`;
+  }
+}
+
+/**
+ * Revoke privileges on a materialized view.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-revoke.html
+ *
+ * Synopsis
+ * ```sql
+ * REVOKE [ GRANT OPTION FOR ]
+ *     { { SELECT | INSERT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER }
+ *     [, ...] | ALL [ PRIVILEGES ] }
+ *     ON { [ TABLE ] table_name [, ...] }
+ *     FROM role_specification [, ...]
+ *     [ GRANTED BY role_specification ]
+ *     [ CASCADE | RESTRICT ]
+ * ```
+ */
+export class RevokeMaterializedViewPrivileges extends AlterMaterializedViewChange {
+  public readonly materializedView: MaterializedView;
+  public readonly grantee: string;
+  public readonly privileges: { privilege: string; grantable: boolean }[];
+  public readonly columns?: string[];
+  public readonly version: number | undefined;
+  public readonly scope = "privilege" as const;
+
+  constructor(props: {
+    materializedView: MaterializedView;
+    grantee: string;
+    privileges: { privilege: string; grantable: boolean }[];
+    columns?: string[];
+    version?: number;
+  }) {
+    super();
+    this.materializedView = props.materializedView;
+    this.grantee = props.grantee;
+    this.privileges = props.privileges;
+    this.columns = props.columns
+      ? [...new Set(props.columns)].sort()
+      : undefined;
+    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.materializedView.stableId, this.grantee)];
+  }
+
+  get requires() {
+    return [
+      stableId.acl(this.materializedView.stableId, this.grantee),
+      this.materializedView.stableId,
+      stableId.role(this.grantee),
+    ];
+  }
+
+  serialize(): string {
+    const kindPrefix = getObjectKindPrefix("MATERIALIZED VIEW");
+    const list = this.privileges.map((p) => p.privilege);
+    const privSql = formatObjectPrivilegeList(
+      "MATERIALIZED VIEW",
+      list,
+      this.version,
+    );
+    const materializedViewName = `${this.materializedView.schema}.${this.materializedView.name}`;
+
+    // Add column list if present
+    const columnClause = this.columns ? ` (${this.columns.join(", ")})` : "";
+
+    return `REVOKE ${privSql}${columnClause} ${kindPrefix} ${materializedViewName} FROM ${this.grantee}`;
+  }
+}
+
+/**
+ * Revoke grant option for privileges on a materialized view.
+ *
+ * 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 RevokeGrantOptionMaterializedViewPrivileges extends AlterMaterializedViewChange {
+  public readonly materializedView: MaterializedView;
+  public readonly grantee: string;
+  public readonly privilegeNames: string[];
+  public readonly columns?: string[];
+  public readonly version: number | undefined;
+  public readonly scope = "privilege" as const;
+
+  constructor(props: {
+    materializedView: MaterializedView;
+    grantee: string;
+    privilegeNames: string[];
+    columns?: string[];
+    version?: number;
+  }) {
+    super();
+    this.materializedView = props.materializedView;
+    this.grantee = props.grantee;
+    this.privilegeNames = [...new Set(props.privilegeNames)].sort();
+    this.columns = props.columns
+      ? [...new Set(props.columns)].sort()
+      : undefined;
+    this.version = props.version;
+  }
+
+  get requires() {
+    return [
+      stableId.acl(this.materializedView.stableId, this.grantee),
+      this.materializedView.stableId,
+      stableId.role(this.grantee),
+    ];
+  }
+
+  serialize(): string {
+    const kindPrefix = getObjectKindPrefix("MATERIALIZED VIEW");
+    const privSql = formatObjectPrivilegeList(
+      "MATERIALIZED VIEW",
+      this.privilegeNames,
+      this.version,
+    );
+    const materializedViewName = `${this.materializedView.schema}.${this.materializedView.name}`;
+
+    // Add column list if present
+    const columnClause = this.columns ? ` (${this.columns.join(", ")})` : "";
+
+    return `REVOKE GRANT OPTION FOR ${privSql}${columnClause} ${kindPrefix} ${materializedViewName} FROM ${this.grantee}`;
+  }
+}

package/src/core/objects/materialized-view/changes/materialized-view.types.ts

@@ -0,0 +1,12 @@
+import type { AlterMaterializedView } from "./materialized-view.alter.ts";
+import type { CommentMaterializedView } from "./materialized-view.comment.ts";
+import type { CreateMaterializedView } from "./materialized-view.create.ts";
+import type { DropMaterializedView } from "./materialized-view.drop.ts";
+import type { MaterializedViewPrivilege } from "./materialized-view.privilege.ts";
+
+export type MaterializedViewChange =
+  | AlterMaterializedView
+  | CommentMaterializedView
+  | CreateMaterializedView
+  | DropMaterializedView
+  | MaterializedViewPrivilege;

package/src/core/objects/materialized-view/materialized-view.diff.test.ts

@@ -0,0 +1,102 @@
+import { describe, expect, test } from "bun:test";
+import { DefaultPrivilegeState } from "../base.default-privileges.ts";
+import {
+  AlterMaterializedViewChangeOwner,
+  AlterMaterializedViewSetStorageParams,
+} from "./changes/materialized-view.alter.ts";
+import { CreateMaterializedView } from "./changes/materialized-view.create.ts";
+import { DropMaterializedView } from "./changes/materialized-view.drop.ts";
+import { diffMaterializedViews } from "./materialized-view.diff.ts";
+import {
+  MaterializedView,
+  type MaterializedViewProps,
+} from "./materialized-view.model.ts";
+
+const base: MaterializedViewProps = {
+  schema: "public",
+  name: "mv1",
+  definition: "select 1",
+  row_security: false,
+  force_row_security: false,
+  has_indexes: false,
+  has_rules: false,
+  has_triggers: false,
+  has_subclasses: false,
+  is_populated: true,
+  replica_identity: "d",
+  is_partition: false,
+  options: null,
+  partition_bound: null,
+  owner: "o1",
+  comment: null,
+  columns: [],
+  privileges: [],
+};
+
+const testContext = {
+  version: 170000,
+  currentUser: "postgres",
+  defaultPrivilegeState: new DefaultPrivilegeState({}),
+  mainRoles: {},
+};
+
+describe.concurrent("materialized-view.diff", () => {
+  test("create and drop", () => {
+    const mv = new MaterializedView(base);
+    const created = diffMaterializedViews(
+      testContext,
+      {},
+      { [mv.stableId]: mv },
+    );
+    expect(created[0]).toBeInstanceOf(CreateMaterializedView);
+    const dropped = diffMaterializedViews(
+      testContext,
+      { [mv.stableId]: mv },
+      {},
+    );
+    expect(dropped[0]).toBeInstanceOf(DropMaterializedView);
+  });
+
+  test("alter owner", () => {
+    const main = new MaterializedView(base);
+    const branch = new MaterializedView({ ...base, owner: "o2" });
+    const changes = diffMaterializedViews(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes[0]).toBeInstanceOf(AlterMaterializedViewChangeOwner);
+  });
+
+  test("drop + create on non-alterable change", () => {
+    const main = new MaterializedView(base);
+    const branch = new MaterializedView({ ...base, definition: "select 2" });
+    const changes = diffMaterializedViews(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes).toHaveLength(2);
+    expect(changes[0]).toBeInstanceOf(DropMaterializedView);
+    expect(changes[1]).toBeInstanceOf(CreateMaterializedView);
+  });
+
+  test("alter storage parameters: set and reset", () => {
+    const main = new MaterializedView({
+      ...base,
+      options: ["fillfactor=90", "autovacuum_enabled=false"],
+    });
+    const branch = new MaterializedView({
+      ...base,
+      options: ["fillfactor=70", "user_catalog_table=true"],
+    });
+    const changes = diffMaterializedViews(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(
+      changes.some((c) => c instanceof AlterMaterializedViewSetStorageParams),
+    ).toBe(true);
+  });
+});