@supabase/pg-delta 1.0.0-alpha.23 → 1.0.0-alpha.25

package/src/core/sort/cycle-breakers.test.ts

@@ -62,7 +62,9 @@ function fkConstraint(props: {
   fkColumn: string;
   targetSchema: string;
   targetTable: string;
+  targetColumn?: string;
 }) {
+  const targetColumn = props.targetColumn ?? "id";
   return {
     name: props.name,
     constraint_type: "f" as const,
@@ -78,7 +80,7 @@ function fkConstraint(props: {
     parent_table_schema: null,
     parent_table_name: null,
     key_columns: [props.fkColumn],
-    foreign_key_columns: ["id"],
+    foreign_key_columns: [targetColumn],
     foreign_key_table: props.targetTable,
     foreign_key_schema: props.targetSchema,
     foreign_key_table_is_partition: false,
@@ -91,7 +93,41 @@ function fkConstraint(props: {
     match_type: "s" as const,
     check_expression: null,
     owner: "postgres",
-    definition: `FOREIGN KEY (${props.fkColumn}) REFERENCES ${props.targetSchema}.${props.targetTable}(id)`,
+    definition: `FOREIGN KEY (${props.fkColumn}) REFERENCES ${props.targetSchema}.${props.targetTable}(${targetColumn})`,
+    comment: null,
+  };
+}
+
+function uniqueConstraint(name: string, column: string) {
+  return {
+    name,
+    constraint_type: "u" as const,
+    deferrable: false,
+    initially_deferred: false,
+    validated: true,
+    is_local: true,
+    no_inherit: false,
+    is_temporal: false,
+    is_partition_clone: false,
+    parent_constraint_schema: null,
+    parent_constraint_name: null,
+    parent_table_schema: null,
+    parent_table_name: null,
+    key_columns: [column],
+    foreign_key_columns: null,
+    foreign_key_table: null,
+    foreign_key_schema: null,
+    foreign_key_table_is_partition: null,
+    foreign_key_parent_schema: null,
+    foreign_key_parent_table: null,
+    foreign_key_effective_schema: null,
+    foreign_key_effective_table: null,
+    on_update: null,
+    on_delete: null,
+    match_type: null,
+    check_expression: null,
+    owner: "postgres",
+    definition: `UNIQUE (${column})`,
     comment: null,
   };
 }
@@ -448,6 +484,204 @@ describe("tryBreakCycleByChangeInjection", () => {
     expect(broken).toBeNull();
   });
 
+  test("publication FK-chain constraint-drop 3-cycle: injects terminal FK drop", () => {
+    // Schema:
+    //   publication p includes labs and posts
+    //   posts.lab_id REFERENCES labs(id)
+    // Diff drops posts and drops labs.unique_lab_id while also removing both
+    // tables from the publication. The FK edge from posts to the terminal
+    // constraint drop forms:
+    //   AlterPublicationDropTables → DropTable(posts)
+    //   DropTable(posts) → AlterTableDropConstraint(labs.unique_lab_id)
+    //   AlterTableDropConstraint(labs.unique_lab_id) → AlterPublicationDropTables
+    const tableLabs = new Table({
+      ...baseTableProps,
+      name: "labs",
+      columns: [{ ...integerColumn("id", 1), not_null: true }],
+      constraints: [uniqueConstraint("unique_lab_id", "id")],
+    });
+    const tablePosts = new Table({
+      ...baseTableProps,
+      name: "posts",
+      columns: [
+        { ...integerColumn("id", 1), not_null: true },
+        integerColumn("lab_id", 2),
+      ],
+      constraints: [
+        fkConstraint({
+          name: "posts_lab_id_fkey",
+          fkColumn: "lab_id",
+          targetSchema: "public",
+          targetTable: "labs",
+        }),
+      ],
+    });
+    const publication = new Publication({
+      name: "p",
+      owner: "postgres",
+      comment: null,
+      all_tables: false,
+      publish_insert: true,
+      publish_update: true,
+      publish_delete: true,
+      publish_truncate: true,
+      publish_via_partition_root: false,
+      tables: [
+        { schema: "public", name: "labs", columns: null, row_filter: null },
+        { schema: "public", name: "posts", columns: null, row_filter: null },
+      ],
+      schemas: [],
+    });
+
+    const terminalDrop = new AlterTableDropConstraint({
+      table: tableLabs,
+      constraint: tableLabs.constraints[0],
+    });
+    const changes: Change[] = [
+      new AlterPublicationDropTables({
+        publication,
+        tables: publication.tables,
+      }),
+      new DropTable({ table: tablePosts }),
+      terminalDrop,
+    ];
+
+    const broken = tryBreakCycleByChangeInjection([0, 1, 2], changes);
+    if (broken === null) throw new Error("expected breaker to fire");
+
+    const injectedDrops = broken.filter(
+      (change): change is AlterTableDropConstraint =>
+        change instanceof AlterTableDropConstraint &&
+        change.table.stableId === tablePosts.stableId,
+    );
+    expect(injectedDrops).toHaveLength(1);
+    expect(injectedDrops[0].constraint.name).toBe("posts_lab_id_fkey");
+
+    const rewrittenPostsDrop = broken.find(
+      (change): change is DropTable =>
+        change instanceof DropTable &&
+        change.table.stableId === tablePosts.stableId,
+    );
+    if (!rewrittenPostsDrop) throw new Error("missing rewritten DropTable");
+    expect(
+      rewrittenPostsDrop.externallyDroppedConstraints.has("posts_lab_id_fkey"),
+    ).toBe(true);
+    expect(broken).toContain(terminalDrop);
+  });
+
+  test("publication FK-chain constraint-drop 4-cycle: injects FK drops along the dropped-table chain", () => {
+    // Schema:
+    //   publication p includes labs, posts, and post_attachments
+    //   post_attachments.post_id REFERENCES posts(id)
+    //   posts.lab_id REFERENCES labs(id)
+    // Diff drops post_attachments and posts, drops labs.unique_lab_id,
+    // and removes all three tables from the publication.
+    const tableLabs = new Table({
+      ...baseTableProps,
+      name: "labs",
+      columns: [{ ...integerColumn("id", 1), not_null: true }],
+      constraints: [uniqueConstraint("unique_lab_id", "id")],
+    });
+    const tablePosts = new Table({
+      ...baseTableProps,
+      name: "posts",
+      columns: [
+        { ...integerColumn("id", 1), not_null: true },
+        integerColumn("lab_id", 2),
+      ],
+      constraints: [
+        fkConstraint({
+          name: "posts_lab_id_fkey",
+          fkColumn: "lab_id",
+          targetSchema: "public",
+          targetTable: "labs",
+        }),
+      ],
+    });
+    const tablePostAttachments = new Table({
+      ...baseTableProps,
+      name: "post_attachments",
+      columns: [
+        { ...integerColumn("id", 1), not_null: true },
+        integerColumn("post_id", 2),
+      ],
+      constraints: [
+        fkConstraint({
+          name: "post_attachments_post_id_fkey",
+          fkColumn: "post_id",
+          targetSchema: "public",
+          targetTable: "posts",
+        }),
+      ],
+    });
+    const publication = new Publication({
+      name: "p",
+      owner: "postgres",
+      comment: null,
+      all_tables: false,
+      publish_insert: true,
+      publish_update: true,
+      publish_delete: true,
+      publish_truncate: true,
+      publish_via_partition_root: false,
+      tables: [
+        { schema: "public", name: "labs", columns: null, row_filter: null },
+        {
+          schema: "public",
+          name: "post_attachments",
+          columns: null,
+          row_filter: null,
+        },
+        { schema: "public", name: "posts", columns: null, row_filter: null },
+      ],
+      schemas: [],
+    });
+
+    const terminalDrop = new AlterTableDropConstraint({
+      table: tableLabs,
+      constraint: tableLabs.constraints[0],
+    });
+    const changes: Change[] = [
+      new AlterPublicationDropTables({
+        publication,
+        tables: publication.tables,
+      }),
+      new DropTable({ table: tablePostAttachments }),
+      new DropTable({ table: tablePosts }),
+      terminalDrop,
+    ];
+
+    const broken = tryBreakCycleByChangeInjection([0, 1, 2, 3], changes);
+    if (broken === null) throw new Error("expected breaker to fire");
+
+    const injectedDropNames = broken
+      .filter(
+        (change): change is AlterTableDropConstraint =>
+          change instanceof AlterTableDropConstraint && change !== terminalDrop,
+      )
+      .map((change) => change.constraint.name)
+      .sort();
+    expect(injectedDropNames).toEqual([
+      "post_attachments_post_id_fkey",
+      "posts_lab_id_fkey",
+    ]);
+
+    for (const [tableId, constraintName] of [
+      [tablePostAttachments.stableId, "post_attachments_post_id_fkey"],
+      [tablePosts.stableId, "posts_lab_id_fkey"],
+    ] as const) {
+      const rewrittenDrop = broken.find(
+        (change): change is DropTable =>
+          change instanceof DropTable && change.table.stableId === tableId,
+      );
+      if (!rewrittenDrop) throw new Error(`missing DropTable for ${tableId}`);
+      expect(
+        rewrittenDrop.externallyDroppedConstraints.has(constraintName),
+      ).toBe(true);
+    }
+    expect(broken).toContain(terminalDrop);
+  });
+
   test("returns null for a cycle with no recognised pattern (e.g. publication-only)", () => {
     // Cycle of `AlterPublicationSetOwner` changes — neither FK nor
     // publication-column shape. Breaker must bail so the formatted

package/src/core/sort/cycle-breakers.ts

@@ -78,6 +78,35 @@ export function tryBreakCycleByChangeInjection(
   );
   if (pubColBroken) return pubColBroken;
 
+  // ─── Branch C: Publication ↔ dropped FK chain ↔ constraint drop ──────
+  // Triggered when publication membership is being removed for tables in
+  // the same drop phase as a FK chain, and the chain ends at a separately
+  // emitted `AlterTableDropConstraint` on a table that is also being
+  // removed from the publication.
+  //
+  // Example (4-change cycle):
+  //   AlterPublicationDropTables(p, [labs, posts, post_attachments])
+  //   DropTable(post_attachments)
+  //   DropTable(posts)
+  //   AlterTableDropConstraint(labs.unique_lab_id)
+  //
+  // Cycle:
+  //   publication:p → table:post_attachments
+  //   post_attachments.post_id_fkey → column:posts.id
+  //   posts.lab_id_fkey → constraint:labs.unique_lab_id
+  //   constraint:labs.unique_lab_id → table:labs
+  //
+  // Fix: inject explicit FK drops for the FK constraints claimed by the
+  // DropTables in the cycle, including FKs that point at the terminal
+  // dropped constraint. The publication and terminal constraint changes
+  // stay unchanged; only the intermediate FK ownership is reassigned from
+  // DropTable to dedicated AlterTableDropConstraint changes.
+  const pubFkConstraintBroken = tryBreakPublicationFkConstraintDropCycle(
+    cycleNodeIndexes,
+    phaseChanges,
+  );
+  if (pubFkConstraintBroken) return pubFkConstraintBroken;
+
   // No known pattern. Returning null lets sortPhaseChanges throw the
   // formatted CycleError with full diagnostic — better a clear bug
   // report than silently shipping a broken plan.
@@ -109,6 +138,34 @@ function tryBreakFkCycle(
     cycleDropTables.map((change) => change.table.stableId),
   );
 
+  return injectFkConstraintDropsForDropTables({
+    phaseChanges,
+    dropTables: cycleDropTables,
+    shouldInject: (fk, tableId) =>
+      isCrossCycleFkConstraint(fk, tableId, cycleTableIds),
+  });
+}
+
+type FkConstraintPredicate = (
+  fk: TableConstraintProps,
+  tableId: string,
+) => boolean;
+
+/**
+ * Shared FK-drop injection used by Branch A and Branch C. The caller owns
+ * the cycle-specific matcher; this helper only handles the mechanical
+ * rewrite: add dedicated `AlterTableDropConstraint` changes and rebuild
+ * affected `DropTable`s with updated `externallyDroppedConstraints`.
+ */
+function injectFkConstraintDropsForDropTables({
+  phaseChanges,
+  dropTables,
+  shouldInject,
+}: {
+  phaseChanges: readonly Change[];
+  dropTables: readonly DropTable[];
+  shouldInject: FkConstraintPredicate;
+}): Change[] | null {
   // For each DropTable in the cycle, find every FK whose referenced table
   // is also in the cycle. Each such FK becomes one injected
   // `AlterTableDropConstraint` and one entry on the source table's
@@ -120,16 +177,14 @@ function tryBreakFkCycle(
   const updatedExternalsByTableId = new Map<string, Set<string>>();
   let didMutate = false;
 
-  for (const dropTable of cycleDropTables) {
+  for (const dropTable of dropTables) {
     const tableId = dropTable.table.stableId;
     const existingExternals = new Set(dropTable.externallyDroppedConstraints);
     let tableMutated = false;
 
-    for (const fk of iterCrossCycleFkConstraints(
-      dropTable.table.constraints,
-      tableId,
-      cycleTableIds,
-    )) {
+    for (const fk of iterFkConstraints(dropTable.table.constraints)) {
+      if (!shouldInject(fk, tableId)) continue;
+
       // Skip if a same-table `AlterTableDropConstraint` is already in the
       // change list — could happen if a previous breaker iteration
       // injected one, or the diff layer emitted one explicitly.
@@ -187,35 +242,45 @@ function tryBreakFkCycle(
 }
 
 /**
- * Yield FK constraints on `constraints` whose referenced table is also a
- * member of the cycle (i.e. an FK strictly between two cycle DropTables).
+ * Yield FK constraints on `constraints`.
  *
- * Self-referencing FKs are skipped — they create a self-loop in the
- * dependency graph which the existing sort-phase handler resolves on its
- * own; injecting an `AlterTableDropConstraint` for a self-FK would just
- * add noise.
+ * Partition clones are skipped because PostgreSQL drops them when the
+ * parent constraint is dropped.
  */
-function* iterCrossCycleFkConstraints(
+function* iterFkConstraints(
   constraints: readonly TableConstraintProps[],
-  ownTableId: string,
-  cycleTableIds: ReadonlySet<string>,
 ): Iterable<TableConstraintProps> {
   for (const constraint of constraints) {
     if (constraint.constraint_type !== "f") continue;
     if (constraint.is_partition_clone) continue;
-    if (!constraint.foreign_key_schema || !constraint.foreign_key_table) {
-      continue;
-    }
-    const referencedId = stableId.table(
-      constraint.foreign_key_schema,
-      constraint.foreign_key_table,
-    );
-    if (referencedId === ownTableId) continue;
-    if (!cycleTableIds.has(referencedId)) continue;
     yield constraint;
   }
 }
 
+/**
+ * True when `constraint` references another DropTable in the cycle.
+ *
+ * Self-referencing FKs are skipped — they create a self-loop in the
+ * dependency graph which the existing sort-phase handler resolves on its
+ * own; injecting an `AlterTableDropConstraint` for a self-FK would just
+ * add noise.
+ */
+function isCrossCycleFkConstraint(
+  constraint: TableConstraintProps,
+  ownTableId: string,
+  cycleTableIds: ReadonlySet<string>,
+): boolean {
+  if (!constraint.foreign_key_schema || !constraint.foreign_key_table) {
+    return false;
+  }
+  const referencedId = stableId.table(
+    constraint.foreign_key_schema,
+    constraint.foreign_key_table,
+  );
+  if (referencedId === ownTableId) return false;
+  return cycleTableIds.has(referencedId);
+}
+
 /**
  * True iff `phaseChanges` already contains an explicit
  * `AlterTableDropConstraint(table, constraint)` for the given pair —
@@ -309,3 +374,98 @@ function tryBreakPublicationColumnCycle(
   });
   return rewritten;
 }
+
+/**
+ * Branch C worker — break a publication membership removal cycle where
+ * dropped tables form a FK chain ending at a separately dropped referenced
+ * constraint.
+ */
+function tryBreakPublicationFkConstraintDropCycle(
+  cycleNodeIndexes: readonly number[],
+  phaseChanges: readonly Change[],
+): Change[] | null {
+  let pubChange: AlterPublicationDropTables | null = null;
+  let terminalConstraintDrop: AlterTableDropConstraint | null = null;
+  const dropTables: DropTable[] = [];
+
+  for (const nodeIndex of cycleNodeIndexes) {
+    const change = phaseChanges[nodeIndex];
+    if (change instanceof AlterPublicationDropTables) {
+      if (pubChange !== null) return null;
+      pubChange = change;
+    } else if (change instanceof AlterTableDropConstraint) {
+      if (terminalConstraintDrop !== null) return null;
+      terminalConstraintDrop = change;
+    } else if (change instanceof DropTable) {
+      dropTables.push(change);
+    } else {
+      return null;
+    }
+  }
+
+  if (
+    pubChange === null ||
+    terminalConstraintDrop === null ||
+    dropTables.length === 0
+  ) {
+    return null;
+  }
+
+  const publicationTableIds = new Set<string>(
+    pubChange.tables.map((table) => stableId.table(table.schema, table.name)),
+  );
+  if (!publicationTableIds.has(terminalConstraintDrop.table.stableId)) {
+    return null;
+  }
+
+  for (const dropTable of dropTables) {
+    if (!publicationTableIds.has(dropTable.table.stableId)) return null;
+  }
+
+  const cycleDropTableIds = new Set(
+    dropTables.map((change) => change.table.stableId),
+  );
+  let hasFkToTerminalConstraint = false;
+
+  for (const dropTable of dropTables) {
+    for (const fk of iterFkConstraints(dropTable.table.constraints)) {
+      if (fkReferencesConstraint(fk, terminalConstraintDrop)) {
+        hasFkToTerminalConstraint = true;
+        break;
+      }
+    }
+    if (hasFkToTerminalConstraint) break;
+  }
+  if (!hasFkToTerminalConstraint) return null;
+
+  return injectFkConstraintDropsForDropTables({
+    phaseChanges,
+    dropTables,
+    shouldInject: (fk, tableId) =>
+      isCrossCycleFkConstraint(fk, tableId, cycleDropTableIds) ||
+      fkReferencesConstraint(fk, terminalConstraintDrop),
+  });
+}
+
+function fkReferencesConstraint(
+  fk: TableConstraintProps,
+  constraintDrop: AlterTableDropConstraint,
+): boolean {
+  if (
+    fk.foreign_key_schema !== constraintDrop.table.schema ||
+    fk.foreign_key_table !== constraintDrop.table.name ||
+    fk.foreign_key_columns === null
+  ) {
+    return false;
+  }
+
+  return sameOrderedStrings(
+    fk.foreign_key_columns,
+    constraintDrop.constraint.key_columns,
+  );
+}
+
+function sameOrderedStrings(left: readonly string[], right: readonly string[]) {
+  if (left.length !== right.length) return false;
+  return left.every((value, index) => value === right[index]);
+}