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

package/src/core/expand-replace-dependencies.ts

@@ -0,0 +1,707 @@
+import type { Catalog } from "./catalog.model.ts";
+import type { Change } from "./change.types.ts";
+import type { ObjectDiffContext } from "./objects/diff-context.ts";
+import { CreateDomain } from "./objects/domain/changes/domain.create.ts";
+import { DropDomain } from "./objects/domain/changes/domain.drop.ts";
+import { CreateIndex } from "./objects/index/changes/index.create.ts";
+import { DropIndex } from "./objects/index/changes/index.drop.ts";
+import { CreateMaterializedView } from "./objects/materialized-view/changes/materialized-view.create.ts";
+import { DropMaterializedView } from "./objects/materialized-view/changes/materialized-view.drop.ts";
+import { buildCreateMaterializedViewChanges } from "./objects/materialized-view/materialized-view.diff.ts";
+import { CreateProcedure } from "./objects/procedure/changes/procedure.create.ts";
+import { DropProcedure } from "./objects/procedure/changes/procedure.drop.ts";
+import { CreateCommentOnRlsPolicy } from "./objects/rls-policy/changes/rls-policy.comment.ts";
+import { CreateRlsPolicy } from "./objects/rls-policy/changes/rls-policy.create.ts";
+import { DropRlsPolicy } from "./objects/rls-policy/changes/rls-policy.drop.ts";
+import { AlterTableAddConstraint } from "./objects/table/changes/table.alter.ts";
+import { CreateCommentOnConstraint } from "./objects/table/changes/table.comment.ts";
+import { CreateTable } from "./objects/table/changes/table.create.ts";
+import { DropTable } from "./objects/table/changes/table.drop.ts";
+import { CreateCompositeType } from "./objects/type/composite-type/changes/composite-type.create.ts";
+import { DropCompositeType } from "./objects/type/composite-type/changes/composite-type.drop.ts";
+import { CreateEnum } from "./objects/type/enum/changes/enum.create.ts";
+import { DropEnum } from "./objects/type/enum/changes/enum.drop.ts";
+import { CreateRange } from "./objects/type/range/changes/range.create.ts";
+import { DropRange } from "./objects/type/range/changes/range.drop.ts";
+import { stableId } from "./objects/utils.ts";
+import { CreateView } from "./objects/view/changes/view.create.ts";
+import { DropView } from "./objects/view/changes/view.drop.ts";
+import { buildCreateViewChanges } from "./objects/view/view.diff.ts";
+
+type ResolvedObject =
+  | {
+      kind: "table";
+      main: Catalog["tables"][string];
+      branch: Catalog["tables"][string];
+    }
+  | {
+      kind: "view";
+      main: Catalog["views"][string];
+      branch: Catalog["views"][string];
+    }
+  | {
+      kind: "index";
+      main: Catalog["indexes"][string];
+      branch: Catalog["indexes"][string];
+      branchIndexableObject: Catalog["indexableObjects"][string] | undefined;
+    }
+  | {
+      kind: "materialized_view";
+      main: Catalog["materializedViews"][string];
+      branch: Catalog["materializedViews"][string];
+    }
+  | {
+      kind: "procedure";
+      main: Catalog["procedures"][string];
+      branch: Catalog["procedures"][string];
+    }
+  | {
+      kind: "rls_policy";
+      main: Catalog["rlsPolicies"][string];
+      branch: Catalog["rlsPolicies"][string];
+    }
+  | {
+      kind: "enum";
+      main: Catalog["enums"][string];
+      branch: Catalog["enums"][string];
+    }
+  | {
+      kind: "range";
+      main: Catalog["ranges"][string];
+      branch: Catalog["ranges"][string];
+    }
+  | {
+      kind: "composite_type";
+      main: Catalog["compositeTypes"][string];
+      branch: Catalog["compositeTypes"][string];
+    }
+  | {
+      kind: "domain";
+      main: Catalog["domains"][string];
+      branch: Catalog["domains"][string];
+    };
+
+/**
+ * For objects we are replacing (drop + create), ensure that any dependents are also
+ * replaced so that destructive drops succeed. Uses dependency edges from pg_depend
+ * (already captured in Catalog.depends) plus change metadata (creates/drops/requires).
+ *
+ * New changes are appended; ordering and any multi-statement cycle normalization
+ * are handled later by post-diff helpers and the sorter.
+ */
+interface ExpandReplaceDependenciesResult {
+  changes: Change[];
+  replacedTableIds: ReadonlySet<string>;
+}
+
+export function expandReplaceDependencies({
+  changes,
+  mainCatalog,
+  branchCatalog,
+  diffContext,
+}: {
+  changes: Change[];
+  mainCatalog: Catalog;
+  branchCatalog: Catalog;
+  diffContext?: Pick<
+    ObjectDiffContext,
+    "version" | "currentUser" | "defaultPrivilegeState"
+  >;
+}): ExpandReplaceDependenciesResult {
+  const createdIds = new Set<string>();
+  const droppedIds = new Set<string>();
+
+  for (const change of changes) {
+    for (const id of change.creates ?? []) createdIds.add(id);
+    for (const id of change.drops ?? []) droppedIds.add(id);
+  }
+
+  const replaceRoots = new Set<string>();
+  for (const id of createdIds) {
+    if (droppedIds.has(id)) {
+      replaceRoots.add(id);
+    }
+  }
+
+  const promotedRlsPolicyIds = new Set<string>();
+  const additions: Change[] = collectInvalidatedRlsPolicyReplacements({
+    changes,
+    mainCatalog,
+    branchCatalog,
+    createdIds,
+    droppedIds,
+    promotedRlsPolicyIds,
+  });
+
+  // Procedure stableIds are signature-qualified
+  // (`procedure:schema.name(argtypes)`), so a function whose parameter types
+  // change has different ids in `createdIds` and `droppedIds` and would not
+  // appear in the intersection above. Treat any dropped procedure whose
+  // `(schema, name)` matches a created procedure as a replace root so
+  // dependents referencing the old signature via pg_depend get promoted to
+  // DROP+CREATE.
+  const createdProcedureNames = new Set<string>();
+  for (const id of createdIds) {
+    const key = parseProcedureSchemaName(id);
+    if (key) createdProcedureNames.add(key);
+  }
+  for (const id of droppedIds) {
+    const key = parseProcedureSchemaName(id);
+    if (key && createdProcedureNames.has(key)) {
+      replaceRoots.add(id);
+    }
+  }
+
+  // Drop-only objects (no matching create — typically a renamed-away table or
+  // type) are also expansion roots: anything in main that depends on them via
+  // pg_depend must drop before the parent does. Without this seed, a renamed
+  // table whose dependent view stays in the branch catalog (with an updated
+  // definition that no longer references the old name) would still try to
+  // run DROP TABLE old_name while old_name is referenced by the view, which
+  // PostgreSQL refuses without CASCADE. The walk below promotes the surviving
+  // dependent to DROP+CREATE so its drop is sequenced before the parent drop.
+  for (const id of droppedIds) {
+    if (createdIds.has(id)) continue;
+    if (replaceRoots.has(id)) continue;
+    // Only seed for object kinds that can have catalog dependents we know
+    // how to recreate via buildReplaceChanges.
+    if (
+      id.startsWith("table:") ||
+      id.startsWith("view:") ||
+      id.startsWith("materializedView:") ||
+      id.startsWith("type:") ||
+      id.startsWith("domain:")
+    ) {
+      replaceRoots.add(id);
+    }
+  }
+
+  if (replaceRoots.size === 0 && additions.length === 0) {
+    return {
+      changes,
+      replacedTableIds: new Set<string>(),
+    };
+  }
+
+  // Build referenced -> dependents adjacency from main catalog dependencies.
+  const dependentsByReferenced = new Map<string, Set<string>>();
+  for (const dep of mainCatalog.depends) {
+    let list = dependentsByReferenced.get(dep.referenced_stable_id);
+    if (!list) {
+      list = new Set<string>();
+      dependentsByReferenced.set(dep.referenced_stable_id, list);
+    }
+    list.add(dep.dependent_stable_id);
+  }
+
+  const visitedTargets = new Set<string>();
+  const visitedRefs = new Set<string>(replaceRoots);
+  const queue: string[] = [...replaceRoots];
+  // Tables being replaced by an expansion-added DropTable+CreateTable pair.
+  // Any pre-existing targeted AlterTable*(T) object-scope change is superseded
+  // by the replacement and must be removed to avoid contradictions (e.g. an
+  // AlterTableDropColumn on a table that is about to be dropped) and the
+  // associated drop-phase cycle with the catalog constraint→column edge.
+  const tablesReplacedByExpansion = new Set<string>();
+
+  while (queue.length > 0) {
+    const refId = queue.shift() as string;
+    const dependents = dependentsByReferenced.get(refId);
+    if (!dependents) continue;
+
+    for (const dependentRaw of dependents) {
+      if (
+        isOwnedSequenceColumnDependency(
+          refId,
+          dependentRaw,
+          mainCatalog,
+          branchCatalog,
+        )
+      ) {
+        continue;
+      }
+
+      // Continue traversing the dependency graph from the raw dependent id.
+      if (!visitedRefs.has(dependentRaw)) {
+        visitedRefs.add(dependentRaw);
+        queue.push(dependentRaw);
+      }
+
+      const targetId = normalizeDependentId(dependentRaw);
+      if (!targetId) continue;
+
+      // Also traverse using the normalized owning object id (e.g., table for a column).
+      if (!visitedRefs.has(targetId)) {
+        visitedRefs.add(targetId);
+        queue.push(targetId);
+      }
+
+      if (visitedTargets.has(targetId)) continue;
+      visitedTargets.add(targetId);
+
+      // Already handled (either original replace or previously added).
+      if (createdIds.has(targetId) && droppedIds.has(targetId)) continue;
+      if (replaceRoots.has(targetId)) continue;
+
+      const resolved = resolveObjectForStableId(
+        targetId,
+        mainCatalog,
+        branchCatalog,
+      );
+      if (!resolved) continue;
+
+      const hasCreate = createdIds.has(targetId);
+      const hasDrop = droppedIds.has(targetId);
+
+      const addDrop = !hasDrop;
+      const addCreate = !hasCreate;
+
+      if (!addDrop && !addCreate) continue;
+
+      const replacementChanges = buildReplaceChanges(resolved, {
+        addDrop,
+        addCreate,
+        diffContext,
+      });
+      if (!replacementChanges) continue;
+
+      additions.push(...replacementChanges);
+      if (resolved.kind === "rls_policy") {
+        promotedRlsPolicyIds.add(targetId);
+      }
+
+      // If we added a DropTable(T) for an existing table, mark T so any
+      // pre-existing object-scope AlterTable*(T) changes get dropped below —
+      // the DropTable+CreateTable pair supersedes all structural alterations.
+      if (resolved.kind === "table" && addDrop) {
+        tablesReplacedByExpansion.add(targetId);
+      }
+
+      // Track new creates/drops so we don't duplicate work for downstream dependents.
+      for (const change of replacementChanges) {
+        for (const id of change.creates ?? []) createdIds.add(id);
+        for (const id of change.drops ?? []) droppedIds.add(id);
+      }
+    }
+  }
+
+  if (additions.length === 0) {
+    return {
+      changes,
+      replacedTableIds: tablesReplacedByExpansion,
+    };
+  }
+
+  return {
+    changes: [
+      ...removeSupersededRlsPolicyAlters(changes, promotedRlsPolicyIds),
+      ...additions,
+    ],
+    replacedTableIds: tablesReplacedByExpansion,
+  };
+}
+
+function collectInvalidatedRlsPolicyReplacements({
+  changes,
+  mainCatalog,
+  branchCatalog,
+  createdIds,
+  droppedIds,
+  promotedRlsPolicyIds,
+}: {
+  changes: Change[];
+  mainCatalog: Catalog;
+  branchCatalog: Catalog;
+  createdIds: Set<string>;
+  droppedIds: Set<string>;
+  promotedRlsPolicyIds: Set<string>;
+}): Change[] {
+  // In-place rewrites report stable ids through `invalidates`: the referenced
+  // object keeps its identity, but dependents bound to the old definition must
+  // be torn down first. RLS policy expressions are tracked in pg_depend, so use
+  // those catalog edges to promote only policies that depend on an invalidated
+  // id, without coupling this expansion pass to a concrete table-change class.
+  const invalidatedIds = new Set<string>();
+  for (const change of changes) {
+    for (const invalidatedId of change.invalidates) {
+      invalidatedIds.add(invalidatedId);
+    }
+  }
+  if (invalidatedIds.size === 0) return [];
+
+  const replacements: Change[] = [];
+  for (const dep of mainCatalog.depends) {
+    if (!invalidatedIds.has(dep.referenced_stable_id)) continue;
+
+    const targetId = normalizeDependentId(dep.dependent_stable_id);
+    if (!targetId?.startsWith("rlsPolicy:")) continue;
+    if (promotedRlsPolicyIds.has(targetId)) continue;
+    if (createdIds.has(targetId) && droppedIds.has(targetId)) continue;
+
+    const resolved = resolveObjectForStableId(
+      targetId,
+      mainCatalog,
+      branchCatalog,
+    );
+    if (!resolved || resolved.kind !== "rls_policy") continue;
+
+    const addDrop = !droppedIds.has(targetId);
+    const addCreate = !createdIds.has(targetId);
+    const replacementChanges = buildReplaceChanges(resolved, {
+      addDrop,
+      addCreate,
+    });
+    if (!replacementChanges) continue;
+
+    replacements.push(...replacementChanges);
+    promotedRlsPolicyIds.add(targetId);
+    for (const change of replacementChanges) {
+      for (const id of change.creates ?? []) createdIds.add(id);
+      for (const id of change.drops ?? []) droppedIds.add(id);
+    }
+  }
+
+  return replacements;
+}
+
+function removeSupersededRlsPolicyAlters(
+  changes: Change[],
+  promotedRlsPolicyIds: ReadonlySet<string>,
+): Change[] {
+  if (promotedRlsPolicyIds.size === 0) return changes;
+  return changes.filter((change) => {
+    if (change.objectType !== "rls_policy" || change.operation !== "alter") {
+      return true;
+    }
+    return !promotedRlsPolicyIds.has(change.policy.stableId);
+  });
+}
+
+function isOwnedSequenceColumnDependency(
+  referencedId: string,
+  dependentId: string,
+  mainCatalog: Catalog,
+  branchCatalog: Catalog,
+): boolean {
+  // When a sequence replace root is still OWNED BY the same column, the
+  // sequence->column pg_depend edge is bookkeeping for ownership, not a signal
+  // that the whole owning table needs to be replaced. Skipping that edge keeps
+  // expandReplaceDependencies focused on recreating the sequence itself.
+  if (
+    !referencedId.startsWith("sequence:") ||
+    !dependentId.startsWith("column:")
+  ) {
+    return false;
+  }
+
+  const sequence =
+    branchCatalog.sequences[referencedId] ??
+    mainCatalog.sequences[referencedId];
+  if (
+    !sequence?.owned_by_schema ||
+    !sequence.owned_by_table ||
+    !sequence.owned_by_column
+  ) {
+    return false;
+  }
+
+  return (
+    dependentId ===
+    stableId.column(
+      sequence.owned_by_schema,
+      sequence.owned_by_table,
+      sequence.owned_by_column,
+    )
+  );
+}
+
+function parseProcedureSchemaName(stableId: string): string | null {
+  if (!stableId.startsWith("procedure:")) return null;
+  const paren = stableId.indexOf("(");
+  if (paren === -1) return null;
+  return stableId.slice("procedure:".length, paren);
+}
+
+function normalizeDependentId(dependentId: string): string | null {
+  let id = dependentId;
+
+  while (id.startsWith("comment:")) {
+    id = id.slice("comment:".length);
+  }
+
+  if (
+    id.startsWith("acl:") ||
+    id.startsWith("defacl:") ||
+    id.startsWith("membership:") ||
+    id.startsWith("role:") ||
+    id.startsWith("schema:")
+  ) {
+    return null;
+  }
+
+  if (id.startsWith("column:")) {
+    const parts = id.slice("column:".length).split(".");
+    if (parts.length >= 2) {
+      const [schema, table] = parts;
+      return `table:${schema}.${table}`;
+    }
+    return null;
+  }
+
+  if (id.startsWith("constraint:")) {
+    const parts = id.slice("constraint:".length).split(".");
+    if (parts.length >= 2) {
+      const [schema, table] = parts;
+      return `table:${schema}.${table}`;
+    }
+    return null;
+  }
+
+  return id;
+}
+
+function resolveObjectForStableId(
+  stableId: string,
+  mainCatalog: Catalog,
+  branchCatalog: Catalog,
+): ResolvedObject | null {
+  if (stableId.startsWith("table:")) {
+    const main = mainCatalog.tables[stableId];
+    const branch = branchCatalog.tables[stableId];
+    return main && branch ? { kind: "table", main, branch } : null;
+  }
+
+  if (stableId.startsWith("view:")) {
+    const main = mainCatalog.views[stableId];
+    const branch = branchCatalog.views[stableId];
+    return main && branch ? { kind: "view", main, branch } : null;
+  }
+
+  if (stableId.startsWith("materializedView:")) {
+    const main = mainCatalog.materializedViews[stableId];
+    const branch = branchCatalog.materializedViews[stableId];
+    return main && branch ? { kind: "materialized_view", main, branch } : null;
+  }
+
+  if (stableId.startsWith("index:")) {
+    const main = mainCatalog.indexes[stableId];
+    const branch = branchCatalog.indexes[stableId];
+    return main && branch
+      ? {
+          kind: "index",
+          main,
+          branch,
+          branchIndexableObject:
+            branchCatalog.indexableObjects[branch.tableStableId],
+        }
+      : null;
+  }
+
+  if (stableId.startsWith("procedure:")) {
+    const main = mainCatalog.procedures[stableId];
+    const branch = branchCatalog.procedures[stableId];
+    return main && branch ? { kind: "procedure", main, branch } : null;
+  }
+
+  if (stableId.startsWith("rlsPolicy:")) {
+    const main = mainCatalog.rlsPolicies[stableId];
+    const branch = branchCatalog.rlsPolicies[stableId];
+    return main && branch ? { kind: "rls_policy", main, branch } : null;
+  }
+
+  if (stableId.startsWith("domain:")) {
+    const main = mainCatalog.domains[stableId];
+    const branch = branchCatalog.domains[stableId];
+    return main && branch ? { kind: "domain", main, branch } : null;
+  }
+
+  if (stableId.startsWith("type:")) {
+    const enumMain = mainCatalog.enums[stableId];
+    const enumBranch = branchCatalog.enums[stableId];
+    if (enumMain && enumBranch) {
+      return { kind: "enum", main: enumMain, branch: enumBranch };
+    }
+
+    const rangeMain = mainCatalog.ranges[stableId];
+    const rangeBranch = branchCatalog.ranges[stableId];
+    if (rangeMain && rangeBranch) {
+      return { kind: "range", main: rangeMain, branch: rangeBranch };
+    }
+
+    const compositeMain = mainCatalog.compositeTypes[stableId];
+    const compositeBranch = branchCatalog.compositeTypes[stableId];
+    if (compositeMain && compositeBranch) {
+      return {
+        kind: "composite_type",
+        main: compositeMain,
+        branch: compositeBranch,
+      };
+    }
+  }
+
+  return null;
+}
+
+function buildReplaceChanges(
+  resolved: ResolvedObject,
+  options: {
+    addDrop: boolean;
+    addCreate: boolean;
+    diffContext?: Pick<
+      ObjectDiffContext,
+      "version" | "currentUser" | "defaultPrivilegeState"
+    >;
+  },
+): Change[] | null {
+  const { addDrop, addCreate, diffContext } = options;
+
+  if (!addDrop && !addCreate) return null;
+
+  switch (resolved.kind) {
+    case "table":
+      return [
+        ...(addDrop ? [new DropTable({ table: resolved.main })] : []),
+        ...(addCreate
+          ? [
+              new CreateTable({ table: resolved.branch }),
+              ...((resolved.branch.constraints ?? [])
+                .filter((c) => !c.is_partition_clone)
+                .flatMap((constraint) => {
+                  const items: Change[] = [
+                    new AlterTableAddConstraint({
+                      table: resolved.branch,
+                      constraint,
+                    }),
+                  ];
+                  if (
+                    constraint.comment !== null &&
+                    constraint.comment !== undefined
+                  ) {
+                    items.push(
+                      new CreateCommentOnConstraint({
+                        table: resolved.branch,
+                        constraint,
+                      }),
+                    );
+                  }
+                  return items;
+                }) as Change[]),
+            ]
+          : []),
+      ];
+    case "view":
+      return [
+        ...(addDrop ? [new DropView({ view: resolved.main })] : []),
+        ...(addCreate
+          ? buildCreateViewReplacementChanges(resolved.branch, diffContext)
+          : []),
+      ];
+    case "materialized_view":
+      return [
+        ...(addDrop
+          ? [new DropMaterializedView({ materializedView: resolved.main })]
+          : []),
+        ...(addCreate
+          ? diffContext
+            ? buildCreateMaterializedViewChanges(diffContext, resolved.branch)
+            : [
+                new CreateMaterializedView({
+                  materializedView: resolved.branch,
+                }),
+              ]
+          : []),
+      ];
+    case "index":
+      // Constraint-owned, primary, and partition-attached indexes are managed
+      // by the owning constraint or parent-index DDL, not standalone
+      // CREATE INDEX / DROP INDEX. The `case "table":` branch above already
+      // recreates constraints via AlterTableAddConstraint; emitting a
+      // standalone drop/create here would fail in PostgreSQL
+      // ("cannot drop index ... because constraint ... requires it") or
+      // duplicate the index the constraint recreates. Skip matches
+      // diffIndexes (packages/pg-delta/src/core/objects/index/index.diff.ts).
+      if (
+        resolved.main.is_owned_by_constraint ||
+        resolved.main.is_primary ||
+        resolved.main.is_index_partition ||
+        resolved.branch.is_owned_by_constraint ||
+        resolved.branch.is_primary ||
+        resolved.branch.is_index_partition
+      ) {
+        return null;
+      }
+      return [
+        ...(addDrop ? [new DropIndex({ index: resolved.main })] : []),
+        ...(addCreate
+          ? [
+              new CreateIndex({
+                index: resolved.branch,
+                indexableObject: resolved.branchIndexableObject,
+              }),
+            ]
+          : []),
+      ];
+    case "procedure":
+      return [
+        ...(addDrop ? [new DropProcedure({ procedure: resolved.main })] : []),
+        ...(addCreate
+          ? [new CreateProcedure({ procedure: resolved.branch })]
+          : []),
+      ];
+    case "rls_policy":
+      return [
+        ...(addDrop ? [new DropRlsPolicy({ policy: resolved.main })] : []),
+        ...(addCreate
+          ? [
+              new CreateRlsPolicy({ policy: resolved.branch }),
+              ...(resolved.branch.comment !== null
+                ? [new CreateCommentOnRlsPolicy({ policy: resolved.branch })]
+                : []),
+            ]
+          : []),
+      ];
+    case "enum":
+      return [
+        ...(addDrop ? [new DropEnum({ enum: resolved.main })] : []),
+        ...(addCreate ? [new CreateEnum({ enum: resolved.branch })] : []),
+      ];
+    case "range":
+      return [
+        ...(addDrop ? [new DropRange({ range: resolved.main })] : []),
+        ...(addCreate ? [new CreateRange({ range: resolved.branch })] : []),
+      ];
+    case "composite_type":
+      return [
+        ...(addDrop
+          ? [new DropCompositeType({ compositeType: resolved.main })]
+          : []),
+        ...(addCreate
+          ? [new CreateCompositeType({ compositeType: resolved.branch })]
+          : []),
+      ];
+    case "domain":
+      return [
+        ...(addDrop ? [new DropDomain({ domain: resolved.main })] : []),
+        ...(addCreate ? [new CreateDomain({ domain: resolved.branch })] : []),
+      ];
+    default:
+      return null;
+  }
+}
+
+function buildCreateViewReplacementChanges(
+  view: Catalog["views"][string],
+  diffContext:
+    | Pick<
+        ObjectDiffContext,
+        "version" | "currentUser" | "defaultPrivilegeState"
+      >
+    | undefined,
+): Change[] {
+  // Dependency-closure replacements synthesize a create without going through
+  // `diffViews`, so replay the same owner/comment/security-label/ACL metadata
+  // that a normal non-alterable view replacement would emit.
+  return diffContext
+    ? buildCreateViewChanges(diffContext, view)
+    : [new CreateView({ view })];
+}