Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix(schema): fix false extension DROP+CREATE and phantom schema in PG Schema Sync (#19449)
Vincent Huang46038a59bcaa
diff --git a/backend/plugin/schema/pg/extension_test.go b/backend/plugin/schema/pg/extension_test.goindex a287b710fe..9476c61703 100644--- a/backend/plugin/schema/pg/extension_test.go+++ b/backend/plugin/schema/pg/extension_test.go@@ -590,6 +590,126 @@ func TestExtensionNotFilteredByArchiveSchemaFilter(t *testing.T) {require.Equal(t, "test_table", filtered.TableChanges[0].TableName)}+// TestExtensionSchemaSyncBug reproduces the customer-reported bug where Schema Sync:+// 1. Incorrectly generates DROP EXTENSION even though the extension is identical in source and target+// 2. Generates CREATE SCHEMA for a phantom schema named after the extension+//+// Root causes:+// - Bug 1: EnterCreateextensionstmt doesn't parse VERSION from SQL → compareExtensions sees false mismatch+// - Bug 2: EnterCommentstmt treats COMMENT ON EXTENSION as COMMENT ON SCHEMA → creates phantom schema+func TestExtensionSchemaSyncBug(t *testing.T) {+ t.Run("Bug1_version_not_parsed_from_SQL", func(t *testing.T) {+ // The raw schema dump (produced by writeExtension) includes VERSION.+ // GetDatabaseMetadata must parse it back correctly.+ sql := `CREATE EXTENSION IF NOT EXISTS "pg_trgm" WITH SCHEMA "tecbatch" VERSION '1.6';`++ metadata, err := GetDatabaseMetadata(sql)+ require.NoError(t, err)+ require.NotNil(t, metadata)+ require.Len(t, metadata.Extensions, 1, "Should have exactly 1 extension")++ ext := metadata.Extensions[0]+ require.Equal(t, "pg_trgm", ext.Name)+ require.Equal(t, "tecbatch", ext.Schema)+ require.Equal(t, "1.6", ext.Version, "BUG: VERSION not parsed from CREATE EXTENSION statement")+ })++ t.Run("Bug2_comment_on_extension_creates_phantom_schema", func(t *testing.T) {+ // COMMENT ON EXTENSION should NOT create a schema entry.+ sql := `CREATE SCHEMA IF NOT EXISTS "tecbatch";+CREATE EXTENSION IF NOT EXISTS "pg_trgm" WITH SCHEMA "tecbatch" VERSION '1.6';+COMMENT ON EXTENSION "pg_trgm" IS 'text similarity measurement and index searching based on trigrams';`++ metadata, err := GetDatabaseMetadata(sql)+ require.NoError(t, err)+ require.NotNil(t, metadata)++ // Should only have "public" (always created) and "tecbatch" schemas.+ // Must NOT have a "pg_trgm" schema.+ for _, s := range metadata.Schemas {+ require.NotEqual(t, "pg_trgm", s.Name,+ "BUG: COMMENT ON EXTENSION created a phantom schema named after the extension")+ }++ // Extension description should be populated (not lost).+ require.Len(t, metadata.Extensions, 1)+ require.Equal(t, "text similarity measurement and index searching based on trigrams",+ metadata.Extensions[0].Description,+ "BUG: COMMENT ON EXTENSION description not stored in extension metadata")+ })++ t.Run("Full_pipeline_no_false_diff", func(t *testing.T) {+ // Simulate the exact Schema Sync flow:+ // "old" = target DB metadata from live DB sync (has version + description)+ // "new" = source DB metadata parsed from raw schema dump++ // --- "old" metadata: target DB (from getExtensions live query) ---+ oldMetadata := &storepb.DatabaseSchemaMetadata{+ Extensions: []*storepb.ExtensionMetadata{+ {+ Name: "pg_trgm",+ Schema: "tecbatch",+ Version: "1.6",+ Description: "text similarity measurement and index searching based on trigrams",+ },+ },+ Schemas: []*storepb.SchemaMetadata{+ {Name: "public"},+ {Name: "tecbatch"},+ },+ }++ // --- "new" SQL: source DB schema dump (from writeExtension) ---+ sourceSQL := `CREATE SCHEMA IF NOT EXISTS "tecbatch";++CREATE EXTENSION IF NOT EXISTS "pg_trgm" WITH SCHEMA "tecbatch" VERSION '1.6';++COMMENT ON EXTENSION "pg_trgm" IS 'text similarity measurement and index searching based on trigrams';++CREATE OR REPLACE FUNCTION "tecbatch"."contains_one_of"(str character varying, match_strs character varying[], match_case boolean)+ RETURNS boolean+ LANGUAGE plpgsql+ IMMUTABLE+AS $function$+DECLARE+ result boolean := false;+BEGIN+ RETURN result;+END;+$function$;`++ // Parse source SQL (this is the buggy path)+ newMetadata, err := GetDatabaseMetadata(sourceSQL)+ require.NoError(t, err)++ // Build model objects for differ+ oldModel := model.NewDatabaseMetadata(oldMetadata, nil, nil, storepb.Engine_POSTGRES, false)+ newModel := model.NewDatabaseMetadata(newMetadata, nil, nil, storepb.Engine_POSTGRES, false)++ // Run differ+ diff, err := schema.GetDatabaseSchemaDiff(storepb.Engine_POSTGRES, oldModel, newModel)+ require.NoError(t, err)++ // Generate migration DDL+ migration, err := generateMigration(diff)+ require.NoError(t, err)++ // The source and target have identical extensions → migration should be empty+ // (or at most contain the function CREATE which is expected).+ require.NotContains(t, migration, "DROP EXTENSION",+ "BUG: Schema Sync incorrectly drops pg_trgm extension that exists in both databases")+ require.NotContains(t, migration, `CREATE SCHEMA IF NOT EXISTS "pg_trgm"`,+ "BUG: Schema Sync creates phantom pg_trgm schema from COMMENT ON EXTENSION")+ require.NotContains(t, migration, "CREATE EXTENSION",+ "BUG: Schema Sync recreates pg_trgm extension even though it's identical")++ // Log the migration for debugging if any assertions above fail+ if t.Failed() {+ t.Logf("Generated migration (should be empty or function-only):\n%s", migration)+ }+ })+}+// TestExtensionRoundtripNoDiff tests that dumping SDL from database doesn't create false diffs// This reproduces the issue where:// 1. User creates extension with format A (e.g., manual SQL)diff --git a/backend/plugin/schema/pg/get_database_metadata.go b/backend/plugin/schema/pg/get_database_metadata.goindex e928f64f7d..2faefc77c5 100644--- a/backend/plugin/schema/pg/get_database_metadata.go+++ b/backend/plugin/schema/pg/get_database_metadata.go@@ -1807,13 +1807,21 @@ func (e *metadataExtractor) EnterCommentstmt(ctx *parser.CommentstmtContext) {return}- // Handle COMMENT ON SCHEMA+ // Handle COMMENT ON SCHEMA / EXTENSION / etc.if ctx.Object_type_name() != nil && ctx.Name() != nil {- // COMMENT ON SCHEMA name IS comment_text- schemaName := pgparser.NormalizePostgreSQLName(ctx.Name())- if schemaName != "" {- schema := e.getOrCreateSchema(schemaName)- schema.Comment = comment+ objectType := strings.ToUpper(ctx.Object_type_name().GetText())+ name := pgparser.NormalizePostgreSQLName(ctx.Name())+ switch objectType {+ case "SCHEMA":+ if name != "" {+ schema := e.getOrCreateSchema(name)+ schema.Comment = comment+ }+ case "EXTENSION":+ if ext, exists := e.extensions[name]; exists {+ ext.Description = comment+ }+ default:}return}@@ -2235,22 +2243,34 @@ func (e *metadataExtractor) EnterCreateextensionstmt(ctx *parser.CreateextensionSchema: "public", // Default schema}- // Extract schema from extension options if present- if optList := ctx.Create_extension_opt_list(); optList != nil {- for _, optItem := range optList.AllCreate_extension_opt_item() {- if optItem == nil {- continue- }- // Check if this is a SCHEMA option- if optItem.SCHEMA() != nil && optItem.Name() != nil {- schemaName := pgparser.NormalizePostgreSQLName(optItem.Name())- extension.Schema = schemaName- break- }+ extractExtensionOptions(extension, ctx.Create_extension_opt_list())+ e.extensions[extension.Name] = extension+}++// extractExtensionOptions populates Schema and Version from CREATE EXTENSION options.+func extractExtensionOptions(extension *storepb.ExtensionMetadata, optList parser.ICreate_extension_opt_listContext) {+ if optList == nil {+ return+ }+ for _, optItem := range optList.AllCreate_extension_opt_item() {+ if optItem == nil {+ continue+ }+ if optItem.SCHEMA() != nil && optItem.Name() != nil {+ extension.Schema = pgparser.NormalizePostgreSQLName(optItem.Name())+ }+ if optItem.VERSION_P() != nil && optItem.Nonreservedword_or_sconst() != nil {+ extension.Version = stripSingleQuotes(optItem.Nonreservedword_or_sconst().GetText())}}+}- e.extensions[extension.Name] = extension+// stripSingleQuotes removes surrounding single quotes from a SQL string constant.+func stripSingleQuotes(s string) string {+ if len(s) >= 2 && s[0] == '\'' && s[len(s)-1] == '\'' {+ return s[1 : len(s)-1]+ }+ return s}// EnterDefinestmt is called when entering a define statement (CREATE TYPE AS ENUM)