feat: implement pg-delta flag for schema diff

Author: sweatybridge

cmd/db.go

@@ -87,6 +87,7 @@ var (
 	useMigra    bool
 	usePgAdmin  bool
 	usePgSchema bool
+	usePgDelta  bool
 	schema      []string
 	file        string
 
@@ -101,6 +102,8 @@ var (
 			if usePgSchema {
 				differ = diff.DiffPgSchema
 				fmt.Fprintln(os.Stderr, utils.Yellow("WARNING:"), "--use-pg-schema flag is experimental and may not include all entities, such as views and grants.")
+			} else if usePgDelta {
+				differ = diff.DiffPgDelta
 			}
 			return diff.Run(cmd.Context(), schema, file, flags.DbConfig, differ, afero.NewOsFs())
 		},
@@ -257,7 +260,8 @@ func init() {
 	diffFlags.BoolVar(&useMigra, "use-migra", true, "Use migra to generate schema diff.")
 	diffFlags.BoolVar(&usePgAdmin, "use-pgadmin", false, "Use pgAdmin to generate schema diff.")
 	diffFlags.BoolVar(&usePgSchema, "use-pg-schema", false, "Use pg-schema-diff to generate schema diff.")
-	dbDiffCmd.MarkFlagsMutuallyExclusive("use-migra", "use-pgadmin")
+	diffFlags.BoolVar(&usePgDelta, "use-pg-delta", false, "Use pg-delta to generate schema diff.")
+	dbDiffCmd.MarkFlagsMutuallyExclusive("use-migra", "use-pgadmin", "use-pg-schema", "use-pg-delta")
 	diffFlags.String("db-url", "", "Diffs against the database specified by the connection string (must be percent-encoded).")
 	diffFlags.Bool("linked", false, "Diffs local migration files against the linked project.")
 	diffFlags.Bool("local", true, "Diffs local migration files against the local database.")

internal/db/diff/pgdelta.go

@@ -0,0 +1,65 @@
+package diff
+
+import (
+	"bytes"
+	"context"
+	"strings"
+
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types/network"
+	"github.com/go-errors/errors"
+	"github.com/jackc/pgconn"
+	"github.com/jackc/pgx/v4"
+	"github.com/spf13/viper"
+	"github.com/supabase/cli/internal/gen/types"
+	"github.com/supabase/cli/internal/utils"
+)
+
+//go:embed templates/delta.ts
+var pgDeltaScript string
+
+func DiffPgDelta(ctx context.Context, source, target pgconn.Config, schema []string, options ...func(*pgx.ConnConfig)) (string, error) {
+	env := []string{
+		"SOURCE=" + utils.ToPostgresURL(source),
+		"TARGET=" + utils.ToPostgresURL(target),
+	}
+	if ca, err := types.GetRootCA(ctx, utils.ToPostgresURL(target), options...); err != nil {
+		return "", err
+	} else if len(ca) > 0 {
+		env = append(env, "SSL_CA="+ca)
+	}
+	if len(schema) > 0 {
+		env = append(env, "INCLUDED_SCHEMAS="+strings.Join(schema, ","))
+	} else {
+		env = append(env, "EXCLUDED_SCHEMAS="+strings.Join(managedSchemas, ","))
+	}
+	cmd := []string{"edge-runtime", "start", "--main-service=."}
+	if viper.GetBool("DEBUG") {
+		cmd = append(cmd, "--verbose")
+	}
+	cmdString := strings.Join(cmd, " ")
+	entrypoint := []string{"sh", "-c", `cat <<'EOF' > index.ts && ` + cmdString + `
+` + pgDeltaScript + `
+EOF
+`}
+	var out, stderr bytes.Buffer
+	if err := utils.DockerRunOnceWithConfig(
+		ctx,
+		container.Config{
+			Image:      utils.Config.EdgeRuntime.Image,
+			Env:        env,
+			Entrypoint: entrypoint,
+		},
+		container.HostConfig{
+			Binds:       []string{utils.EdgeRuntimeId + ":/root/.cache/deno:rw"},
+			NetworkMode: network.NetworkHost,
+		},
+		network.NetworkingConfig{},
+		"",
+		&out,
+		&stderr,
+	); err != nil && !strings.HasPrefix(stderr.String(), "main worker has been destroyed") {
+		return "", errors.Errorf("error diffing schema: %w:\n%s", err, stderr.String())
+	}
+	return out.String(), nil
+}

internal/db/diff/templates/delta.ts

@@ -0,0 +1,8 @@
+import { main } from "npm:@supabase/pg-delta@1.0.0-alpha.0";
+import { supabase } from "npm:@supabase/integrations";
+
+const source = Deno.env.get("SOURCE");
+const target = Deno.env.get("TARGET");
+
+const { migrationScript } = await main(source, target, supabase)
+console.log(migrationScript)