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

package/src/core/objects/publication/publication.diff.ts

@@ -0,0 +1,247 @@
+import { diffObjects } from "../base.diff.ts";
+import type { ObjectDiffContext } from "../diff-context.ts";
+import { deepEqual } from "../utils.ts";
+import {
+  AlterPublicationAddSchemas,
+  AlterPublicationAddTables,
+  AlterPublicationDropSchemas,
+  AlterPublicationDropTables,
+  AlterPublicationSetOptions,
+  AlterPublicationSetOwner,
+} from "./changes/publication.alter.ts";
+import {
+  CreateCommentOnPublication,
+  DropCommentOnPublication,
+} from "./changes/publication.comment.ts";
+import { CreatePublication } from "./changes/publication.create.ts";
+import { DropPublication } from "./changes/publication.drop.ts";
+import type { PublicationChange } from "./changes/publication.types.ts";
+import type {
+  Publication,
+  PublicationTableProps,
+} from "./publication.model.ts";
+
+export function diffPublications(
+  ctx: Pick<ObjectDiffContext, "currentUser">,
+  main: Record<string, Publication>,
+  branch: Record<string, Publication>,
+): PublicationChange[] {
+  const { created, dropped, altered } = diffObjects(main, branch);
+  const changes: PublicationChange[] = [];
+
+  for (const id of created) {
+    const publication = branch[id];
+    changes.push(new CreatePublication({ publication }));
+
+    // OWNER: If the publication should be owned by someone other than the current user,
+    // emit ALTER PUBLICATION ... OWNER TO after creation
+    if (publication.owner !== ctx.currentUser) {
+      changes.push(
+        new AlterPublicationSetOwner({
+          publication,
+          owner: publication.owner,
+        }),
+      );
+    }
+
+    if (publication.comment !== null) {
+      changes.push(new CreateCommentOnPublication({ publication }));
+    }
+  }
+
+  for (const id of dropped) {
+    changes.push(new DropPublication({ publication: main[id] }));
+  }
+
+  for (const id of altered) {
+    const mainPublication = main[id];
+    const branchPublication = branch[id];
+
+    if (mainPublication.all_tables && !branchPublication.all_tables) {
+      changes.push(new DropPublication({ publication: mainPublication }));
+      changes.push(new CreatePublication({ publication: branchPublication }));
+      if (branchPublication.comment !== null) {
+        changes.push(
+          new CreateCommentOnPublication({ publication: branchPublication }),
+        );
+      }
+      continue;
+    }
+
+    const operationsChanged =
+      mainPublication.publish_insert !== branchPublication.publish_insert ||
+      mainPublication.publish_update !== branchPublication.publish_update ||
+      mainPublication.publish_delete !== branchPublication.publish_delete ||
+      mainPublication.publish_truncate !== branchPublication.publish_truncate;
+
+    const publishViaPartitionRootChanged =
+      mainPublication.publish_via_partition_root !==
+      branchPublication.publish_via_partition_root;
+
+    if (operationsChanged || publishViaPartitionRootChanged) {
+      changes.push(
+        new AlterPublicationSetOptions({
+          publication: branchPublication,
+          setPublish: operationsChanged,
+          setPublishViaPartitionRoot: publishViaPartitionRootChanged,
+        }),
+      );
+    }
+
+    let handledObjectLists = false;
+
+    if (mainPublication.all_tables !== branchPublication.all_tables) {
+      handledObjectLists = true;
+      // Changing the all_tables mode requires DROP + CREATE because
+      // ALTER PUBLICATION does not support SET ALL TABLES.
+      changes.push(new DropPublication({ publication: mainPublication }));
+      changes.push(new CreatePublication({ publication: branchPublication }));
+      if (branchPublication.comment !== null) {
+        changes.push(
+          new CreateCommentOnPublication({
+            publication: branchPublication,
+          }),
+        );
+      }
+      continue;
+    }
+
+    if (!handledObjectLists && !branchPublication.all_tables) {
+      const tableDiff = diffPublicationTables(
+        mainPublication.tables,
+        branchPublication.tables,
+      );
+      if (tableDiff.tablesToDrop.length > 0) {
+        changes.push(
+          new AlterPublicationDropTables({
+            publication: mainPublication,
+            tables: tableDiff.tablesToDrop,
+          }),
+        );
+      }
+      if (tableDiff.tablesToAdd.length > 0) {
+        changes.push(
+          new AlterPublicationAddTables({
+            publication: branchPublication,
+            tables: tableDiff.tablesToAdd,
+          }),
+        );
+      }
+
+      const schemaDiff = diffPublicationSchemas(
+        mainPublication.schemas,
+        branchPublication.schemas,
+      );
+      if (schemaDiff.schemasToDrop.length > 0) {
+        changes.push(
+          new AlterPublicationDropSchemas({
+            publication: mainPublication,
+            schemas: schemaDiff.schemasToDrop,
+          }),
+        );
+      }
+      if (schemaDiff.schemasToAdd.length > 0) {
+        changes.push(
+          new AlterPublicationAddSchemas({
+            publication: branchPublication,
+            schemas: schemaDiff.schemasToAdd,
+          }),
+        );
+      }
+    }
+
+    if (mainPublication.owner !== branchPublication.owner) {
+      changes.push(
+        new AlterPublicationSetOwner({
+          publication: branchPublication,
+          owner: branchPublication.owner,
+        }),
+      );
+    }
+
+    if (mainPublication.comment !== branchPublication.comment) {
+      if (branchPublication.comment === null) {
+        if (mainPublication.comment !== null) {
+          changes.push(
+            new DropCommentOnPublication({ publication: mainPublication }),
+          );
+        }
+      } else {
+        changes.push(
+          new CreateCommentOnPublication({ publication: branchPublication }),
+        );
+      }
+    }
+  }
+
+  return changes;
+}
+
+function diffPublicationTables(
+  mainTables: PublicationTableProps[],
+  branchTables: PublicationTableProps[],
+) {
+  const mainMap = new Map(
+    mainTables.map((table) => [`${table.schema}.${table.name}`, table]),
+  );
+  const branchMap = new Map(
+    branchTables.map((table) => [`${table.schema}.${table.name}`, table]),
+  );
+
+  const tablesToDropMap = new Map<string, PublicationTableProps>();
+  const tablesToAddMap = new Map<string, PublicationTableProps>();
+
+  for (const [key, mainTable] of mainMap) {
+    if (!branchMap.has(key)) {
+      tablesToDropMap.set(key, mainTable);
+    }
+  }
+
+  for (const [key, branchTable] of branchMap) {
+    const mainTable = mainMap.get(key);
+    if (!mainTable) {
+      tablesToAddMap.set(key, branchTable);
+      continue;
+    }
+
+    const mainComparable = {
+      columns: mainTable.columns,
+      row_filter: mainTable.row_filter,
+    };
+    const branchComparable = {
+      columns: branchTable.columns,
+      row_filter: branchTable.row_filter,
+    };
+
+    if (!deepEqual(mainComparable, branchComparable)) {
+      tablesToDropMap.set(key, mainTable);
+      tablesToAddMap.set(key, branchTable);
+    }
+  }
+
+  const tablesToDrop = Array.from(tablesToDropMap.values()).sort((a, b) => {
+    return a.schema.localeCompare(b.schema) || a.name.localeCompare(b.name);
+  });
+  const tablesToAdd = Array.from(tablesToAddMap.values()).sort((a, b) => {
+    return a.schema.localeCompare(b.schema) || a.name.localeCompare(b.name);
+  });
+
+  return { tablesToDrop, tablesToAdd };
+}
+
+function diffPublicationSchemas(
+  mainSchemas: string[],
+  branchSchemas: string[],
+) {
+  const mainSet = new Set(mainSchemas);
+  const branchSet = new Set(branchSchemas);
+
+  const schemasToDrop = [...mainSet.difference(branchSet)].sort((a, b) =>
+    a.localeCompare(b),
+  );
+  const schemasToAdd = [...branchSet.difference(mainSet)].sort((a, b) =>
+    a.localeCompare(b),
+  );
+
+  return { schemasToDrop, schemasToAdd };
+}

package/src/core/objects/publication/publication.model.ts

@@ -0,0 +1,206 @@
+import { sql } from "@ts-safeql/sql-tag";
+import type { Pool } from "pg";
+import z from "zod";
+import { BasePgModel } from "../base.model.ts";
+
+const publicationTablePropsSchema = z.object({
+  schema: z.string(),
+  name: z.string(),
+  columns: z.array(z.string()).nullable(),
+  row_filter: z.string().nullable(),
+});
+
+const publicationPropsSchema = z.object({
+  name: z.string(),
+  owner: z.string(),
+  comment: z.string().nullable(),
+  all_tables: z.boolean(),
+  publish_insert: z.boolean(),
+  publish_update: z.boolean(),
+  publish_delete: z.boolean(),
+  publish_truncate: z.boolean(),
+  publish_via_partition_root: z.boolean(),
+  tables: z.array(publicationTablePropsSchema),
+  schemas: z.array(z.string()),
+});
+
+export type PublicationTableProps = z.infer<typeof publicationTablePropsSchema>;
+export type PublicationProps = z.infer<typeof publicationPropsSchema>;
+
+/**
+ * Logical replication publication definition extracted from pg_publication.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-createpublication.html
+ */
+export class Publication extends BasePgModel {
+  public readonly name: PublicationProps["name"];
+  public readonly owner: PublicationProps["owner"];
+  public readonly comment: PublicationProps["comment"];
+  public readonly all_tables: PublicationProps["all_tables"];
+  public readonly publish_insert: PublicationProps["publish_insert"];
+  public readonly publish_update: PublicationProps["publish_update"];
+  public readonly publish_delete: PublicationProps["publish_delete"];
+  public readonly publish_truncate: PublicationProps["publish_truncate"];
+  public readonly publish_via_partition_root: PublicationProps["publish_via_partition_root"];
+  public readonly tables: PublicationTableProps[];
+  public readonly schemas: PublicationProps["schemas"];
+
+  constructor(props: PublicationProps) {
+    super();
+
+    this.name = props.name;
+    this.owner = props.owner;
+    this.comment = props.comment;
+    this.all_tables = props.all_tables;
+    this.publish_insert = props.publish_insert;
+    this.publish_update = props.publish_update;
+    this.publish_delete = props.publish_delete;
+    this.publish_truncate = props.publish_truncate;
+    this.publish_via_partition_root = props.publish_via_partition_root;
+
+    const normalizedTables = props.tables.map((table) => ({
+      schema: table.schema,
+      name: table.name,
+      columns: table.columns
+        ? [...table.columns].sort((a, b) => a.localeCompare(b))
+        : null,
+      row_filter: table.row_filter,
+    }));
+
+    this.tables = normalizedTables.sort((a, b) => {
+      return a.schema.localeCompare(b.schema) || a.name.localeCompare(b.name);
+    });
+
+    this.schemas = [...props.schemas].sort((a, b) => a.localeCompare(b));
+  }
+
+  get stableId(): `publication:${string}` {
+    return `publication:${this.name}`;
+  }
+
+  get identityFields() {
+    return {
+      name: this.name,
+    };
+  }
+
+  get dataFields() {
+    return {
+      owner: this.owner,
+      comment: this.comment,
+      all_tables: this.all_tables,
+      publish_insert: this.publish_insert,
+      publish_update: this.publish_update,
+      publish_delete: this.publish_delete,
+      publish_truncate: this.publish_truncate,
+      publish_via_partition_root: this.publish_via_partition_root,
+      tables: this.tables,
+      schemas: this.schemas,
+    };
+  }
+
+  override stableSnapshot() {
+    const normalizedTables = this.tables.map((table) => ({
+      schema: table.schema,
+      name: table.name,
+      columns: table.columns
+        ? [...table.columns].sort((a, b) => a.localeCompare(b))
+        : null,
+      row_filter: table.row_filter,
+    }));
+
+    return {
+      identity: this.identityFields,
+      data: {
+        ...this.dataFields,
+        tables: normalizedTables.sort(
+          (a, b) =>
+            a.schema.localeCompare(b.schema) || a.name.localeCompare(b.name),
+        ),
+        schemas: [...this.schemas].sort((a, b) => a.localeCompare(b)),
+      },
+    };
+  }
+}
+
+/**
+ * Extract all logical replication publications from the database.
+ */
+export async function extractPublications(pool: Pool): Promise<Publication[]> {
+  const { rows } = await pool.query<PublicationProps>(sql`
+      with extension_oids as (
+        select objid
+        from pg_depend d
+        where d.refclassid = 'pg_extension'::regclass
+          and d.classid = 'pg_publication'::regclass
+      ),
+      publication_tables as (
+        select
+          pr.prpubid,
+          quote_ident(ns.nspname) as schema,
+          quote_ident(cls.relname) as name,
+          case
+            when pr.prattrs is null then null
+            else (
+              select json_agg(quote_ident(att.attname) order by cols.ord)
+              from unnest(pr.prattrs) with ordinality as cols(attnum, ord)
+              join pg_attribute att
+                on att.attrelid = pr.prrelid
+               and att.attnum = cols.attnum
+            )
+          end as columns,
+          pg_get_expr(pr.prqual, pr.prrelid) as row_filter
+        from pg_publication_rel pr
+        join pg_class cls on cls.oid = pr.prrelid
+        join pg_namespace ns on ns.oid = cls.relnamespace
+      ),
+      publication_schemas as (
+        select
+          pn.pnpubid,
+          quote_ident(ns.nspname) as schema
+        from pg_publication_namespace pn
+        join pg_namespace ns on ns.oid = pn.pnnspid
+      )
+      select
+        quote_ident(p.pubname) as name,
+        p.pubowner::regrole::text as owner,
+        obj_description(p.oid, 'pg_publication') as comment,
+        p.puballtables as all_tables,
+        p.pubinsert as publish_insert,
+        p.pubupdate as publish_update,
+        p.pubdelete as publish_delete,
+        p.pubtruncate as publish_truncate,
+        p.pubviaroot as publish_via_partition_root,
+        coalesce(
+          (
+            select json_agg(
+              json_build_object(
+                'schema', t.schema,
+                'name', t.name,
+                'columns', t.columns,
+                'row_filter', t.row_filter
+              )
+              order by t.schema, t.name
+            )
+            from publication_tables t
+            where t.prpubid = p.oid
+          ),
+          '[]'::json
+        ) as tables,
+        coalesce(
+          (
+            select json_agg(s.schema order by s.schema)
+            from publication_schemas s
+            where s.pnpubid = p.oid
+          ),
+          '[]'::json
+        ) as schemas
+      from pg_publication p
+      left join extension_oids e on e.objid = p.oid
+      where e.objid is null
+      order by 1
+  `);
+
+  const validated = rows.map((row) => publicationPropsSchema.parse(row));
+  return validated.map((row) => new Publication(row));
+}

package/src/core/objects/publication/utils.ts

@@ -0,0 +1,55 @@
+import type {
+  Publication,
+  PublicationTableProps,
+} from "./publication.model.ts";
+
+function wrapRowFilter(expression: string): string {
+  const trimmed = expression.trim();
+  if (trimmed.startsWith("(") && trimmed.endsWith(")")) {
+    return trimmed;
+  }
+  return `(${trimmed})`;
+}
+
+export function formatPublicationTable(table: PublicationTableProps): string {
+  let clause = `TABLE ${table.schema}.${table.name}`;
+  if (table.columns && table.columns.length > 0) {
+    clause += ` (${table.columns.join(", ")})`;
+  }
+  if (table.row_filter) {
+    clause += ` WHERE ${wrapRowFilter(table.row_filter)}`;
+  }
+  return clause;
+}
+
+export function formatPublicationObjects(
+  tables: PublicationTableProps[],
+  schemas: string[],
+): string[] {
+  const clauses: string[] = [];
+  for (const table of tables) {
+    clauses.push(formatPublicationTable(table));
+  }
+  for (const schema of schemas) {
+    clauses.push(`TABLES IN SCHEMA ${schema}`);
+  }
+  return clauses;
+}
+
+export function getPublicationOperations(publication: Publication): string[] {
+  const operations: string[] = [];
+  if (publication.publish_insert) operations.push("insert");
+  if (publication.publish_update) operations.push("update");
+  if (publication.publish_delete) operations.push("delete");
+  if (publication.publish_truncate) operations.push("truncate");
+  return operations;
+}
+
+export function isDefaultPublicationOperations(publication: Publication) {
+  return (
+    publication.publish_insert &&
+    publication.publish_update &&
+    publication.publish_delete &&
+    publication.publish_truncate
+  );
+}