feat: filter out noise from diff output

* only diff functions, tables, types, (materialized) views
* ignore diffs from auth, extensions, pgbouncer, realtime, storage,
supabase_realtime
* ignore extension objects

Author: soedirgo

internal/db/changes/changes.go

@@ -196,7 +196,7 @@ EOSQL
 	// 2. Diff it (target) with local db (source), write it as a new migration.
 	{
 		out, err := utils.DockerExec(ctx, utils.DifferId, []string{
-			"sh", "-c", "/venv/bin/python3 -u cli.py " +
+			"sh", "-c", "/venv/bin/python3 -u cli.py --json-diff " +
 				"'postgres://postgres:postgres@" + utils.DbId + ":5432/" + currBranch + "' " +
 				"'postgres://postgres:postgres@" + utils.DbId + ":5432/" + utils.ShadowDbName + "'",
 		})

internal/db/commit/commit.go

@@ -197,7 +197,7 @@ EOSQL
 	// 2. Diff it (target) with local db (source), write it as a new migration.
 	{
 		out, err := utils.DockerExec(ctx, utils.DifferId, []string{
-			"sh", "-c", "/venv/bin/python3 -u cli.py " +
+			"sh", "-c", "/venv/bin/python3 -u cli.py --json-diff " +
 				"'postgres://postgres:postgres@" + utils.DbId + ":5432/" + currBranch + "' " +
 				"'postgres://postgres:postgres@" + utils.DbId + ":5432/" + utils.ShadowDbName + "'",
 		})

internal/db/remote/commit/commit.go

@@ -353,7 +353,7 @@ EOSQL
 			&container.Config{
 				Image: utils.DifferImage,
 				Entrypoint: []string{
-					"sh", "-c", "/venv/bin/python3 -u cli.py " +
+					"sh", "-c", "/venv/bin/python3 -u cli.py --json-diff " +
 						"'" + url + "' " +
 						"'postgres://postgres:postgres@" + dbId + ":5432/postgres'",
 				},

internal/utils/utils.go

@@ -26,18 +26,18 @@ import (
 	"github.com/spf13/viper"
 )
 
-type (
-	DiffEntry struct {
-		Type             string  `json:"type"`
-		Title            string  `json:"title"`
-		Status           string  `json:"status"`
-		SourceDdl        string  `json:"source_ddl"`
-		TargetDdl        string  `json:"target_ddl"`
-		DiffDdl          string  `json:"diff_ddl"`
-		GroupName        string  `json:"group_name"`
-		SourceSchemaName *string `json:"source_schema_name"`
-	}
-)
+type DiffDependencies struct {
+	Type string `json:"type"`
+}
+
+type DiffEntry struct {
+	Type             string             `json:"type"`
+	Status           string             `json:"status"`
+	DiffDdl          string             `json:"diff_ddl"`
+	GroupName        string             `json:"group_name"`
+	Dependencies     []DiffDependencies `json:"dependencies"`
+	SourceSchemaName *string            `json:"source_schema_name"`
+}
 
 const (
 	ShadowDbName   = "supabase_shadow"
@@ -281,16 +281,6 @@ func GetGitRoot() (*string, error) {
 	}
 }
 
-func IsSchemaIgnoredFromDump(schema string) bool {
-	ignoredSchemas := []string{"auth", "extensions", "pgbouncer", "storage"}
-	for _, s := range ignoredSchemas {
-		if s == schema {
-			return true
-		}
-	}
-	return false
-}
-
 type (
 	StatusMsg   string
 	ProgressMsg *float64
@@ -391,7 +381,66 @@ func ProcessDiffOutput(p *tea.Program, out io.Reader) ([]byte, error) {
 	// TODO: Remove when https://github.com/supabase/pgadmin4/issues/24 is fixed.
 	diffBytes := bytes.TrimPrefix(diffBytesBuf.Bytes(), []byte("NOTE: Configuring authentication for DESKTOP mode.\n"))
 
-	return diffBytes, nil
+	return filterDiffOutput(diffBytes)
+}
+
+func filterDiffOutput(diffBytes []byte) ([]byte, error) {
+	var diffJson []DiffEntry
+	if err := json.Unmarshal(diffBytes, &diffJson); err != nil {
+		return nil, err
+	}
+
+	filteredDiffDdls := []string{`-- This script was generated by the Schema Diff utility in pgAdmin 4
+-- For the circular dependencies, the order in which Schema Diff writes the objects is not very sophisticated
+-- and may require manual changes to the script to ensure changes are applied in the correct order.
+-- Please report an issue for any failure with the reproduction steps.`}
+
+	for _, diffEntry := range diffJson {
+		if diffEntry.Status == "Identical" || diffEntry.DiffDdl == "" {
+			continue
+		}
+
+		switch diffEntry.Type {
+		case "function", "mview", "table", "trigger_function", "type", "view":
+			// skip
+		default:
+			continue
+		}
+
+		{
+			doContinue := false
+			for _, dep := range diffEntry.Dependencies {
+				if dep.Type == "extension" {
+					doContinue = true
+					break
+				}
+			}
+
+			if doContinue {
+				continue
+			}
+		}
+
+		if isSchemaIgnored(diffEntry.GroupName) ||
+			// Needed at least for trigger_function
+			(diffEntry.SourceSchemaName != nil && isSchemaIgnored(*diffEntry.SourceSchemaName)) {
+			continue
+		}
+
+		filteredDiffDdls = append(filteredDiffDdls, strings.TrimSpace(diffEntry.DiffDdl))
+	}
+
+	return []byte(strings.Join(filteredDiffDdls, "\n\n") + "\n"), nil
+}
+
+func isSchemaIgnored(schema string) bool {
+	ignoredSchemas := []string{"auth", "extensions", "pgbouncer", "realtime", "storage", "supabase_migrations"}
+	for _, s := range ignoredSchemas {
+		if s == schema {
+			return true
+		}
+	}
+	return false
 }
 
 func ProcessPsqlOutput(out io.Reader, p *tea.Program) error {