chore: update documentation and tests for improved compatibility handling

Author: zacateras

CHANGELOG.md

@@ -37,6 +37,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 - Treat legacy CLR table-valued function return-column collation clauses as compatible during comparison when SQL Server ignores them in the effective return shape.
 - Treat legacy explicit `NULL` tokens on CLR table-valued function return columns as compatible during comparison and preserve them during compatibility reconciliation when the rest of the definition matches.
 - Treat equivalent legacy `Assembly` scripts as compatible during comparison when they differ only by banner comments, wrapped or case-varied hex payload formatting, `PERMISSION_SET` spacing, or quoted versus bracketed `ADD FILE` names.
+- Rewrite programmable-object declaration lines to the current metadata name when SQL Server stores stale module text after an object rename.
+- Fix table-trigger scripting after the declaration rewrite change by resolving trigger schema without referencing a non-existent `sys.triggers.schema_id` column.
 - Trailing semicolon differences on `INSERT` statement lines in data scripts are now suppressed during comparison normalization; scripts emitted with and without statement terminators compare as compatible (#47).
 - Legacy `TableData` scripts now compare as compatible when they differ from canonical output only by `SET IDENTITY_INSERT` semicolons or top-level `N'...'` string literal prefixes, including inside multi-line `INSERT ... VALUES (...)` statements.
 - Empty separator lines are now ignored during `status` and `diff`, and whitespace-only separator lines compare as compatible after normalization.

specs/04-scripting.md

@@ -110,6 +110,7 @@ The following types are defined in this specification family and not fully imple
   - `SET QUOTED_IDENTIFIER <ON|OFF>` + `GO`
   - `SET ANSI_NULLS <ON|OFF>` + `GO`
 - Programmable-object body MUST be followed by `GO`.
+- Programmable-object declaration lines MUST reflect the current metadata schema/name even when the stored module text is stale after an object rename.
 - Object-level permissions and extended properties MUST be emitted after object DDL body.
 - Canonical programmable-object whitespace MUST be:
   - no blank line between the final header `GO` and the first definition line,

src/SqlChangeTracker/Sql/SqlServerScripter.cs

@@ -19,7 +19,7 @@ internal class SqlServerScripter
         @"^\s*\[[^\]]+\]\s+AS\s+",
         RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
     private static readonly Regex ModuleDeclarationLineRegex = new(
-        @"^(?<prefix>CREATE\s+(?:PROC(?:EDURE)?|FUNCTION|VIEW|TRIGGER)\s+)(?<name>(?:\[[^\]]+(?:\]\])*\]|[A-Za-z_][\w@#$]*)(?:\.(?:\[[^\]]+(?:\]\])*\]|[A-Za-z_][\w@#$]*))*)(?<suffix>.*)$",
+        @"^(?<indent>\s*)(?<prefix>CREATE(?:\s+OR\s+ALTER)?\s+(?:PROC(?:EDURE)?|FUNCTION|VIEW|TRIGGER)\s+)(?<name>(?:\[[^\]]+(?:\]\])*\]|[A-Za-z_][\w@#$]*)(?:\.(?:\[[^\]]+(?:\]\])*\]|[A-Za-z_][\w@#$]*))*)(?<suffix>.*)$",
         RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
     private static readonly Regex ClrTableValuedFunctionReturnColumnNullRegex = new(
         @"^(?<prefix>\s*(?:\[[^\]]+\]|[A-Za-z_][\w@#$]*)\s+(?:(?:\[[^\]]+\]|[A-Za-z_][\w@#$]*)(?:\.(?:\[[^\]]+\]|[A-Za-z_][\w@#$]*))?)(?:\s*\([^)]*\))?)\s+NULL(?<suffix>\s*,?\s*)$",
@@ -631,6 +631,8 @@ FROM sys.objects o
             definitionText = BuildClrTableValuedFunctionDefinition(connection, objectId, obj.Schema, obj.Name);
         }
 
+        definitionText = RewriteModuleDeclarationLine(definitionText, obj.Schema, obj.Name);
+
         var (lines, hasGoAfterDefinition) = BuildProgrammableObjectLines(
             definitionText,
             ansiNulls,
@@ -1039,6 +1041,8 @@ FROM sys.objects o
         var quotedIdentifier = reader.IsDBNull(2) || reader.GetBoolean(2);
         reader.Close();
 
+        definitionText = RewriteModuleDeclarationLine(definitionText, obj.Schema, obj.Name);
+
         var (lines, hasGoAfterDefinition) = BuildProgrammableObjectLines(
             definitionText,
             ansiNulls,
@@ -3885,7 +3889,7 @@ private static IEnumerable<string> ReadTableTriggers(
     {
         using var command = connection.CreateCommand();
         command.CommandText = @"
-SELECT t.name, m.definition, m.uses_ansi_nulls, m.uses_quoted_identifier
+SELECT OBJECT_SCHEMA_NAME(t.object_id), t.name, m.definition, m.uses_ansi_nulls, m.uses_quoted_identifier
 FROM sys.triggers t
 JOIN sys.sql_modules m ON m.object_id = t.object_id
 WHERE t.parent_class_desc = 'OBJECT_OR_COLUMN'
@@ -3898,10 +3902,12 @@ FROM sys.triggers t
         using var reader = command.ExecuteReader();
         while (reader.Read())
         {
-            var triggerName = reader.GetString(0);
-            var definitionText = reader.IsDBNull(1) ? string.Empty : reader.GetString(1);
-            var ansiNulls = reader.IsDBNull(2) || reader.GetBoolean(2);
-            var quotedIdentifier = reader.IsDBNull(3) || reader.GetBoolean(3);
+            var triggerSchema = reader.IsDBNull(0) ? string.Empty : reader.GetString(0);
+            var triggerName = reader.GetString(1);
+            var definitionText = reader.IsDBNull(2) ? string.Empty : reader.GetString(2);
+            var ansiNulls = reader.IsDBNull(3) || reader.GetBoolean(3);
+            var quotedIdentifier = reader.IsDBNull(4) || reader.GetBoolean(4);
+            definitionText = RewriteModuleDeclarationLine(definitionText, triggerSchema, triggerName);
             var triggerReferenceLines = TryGetReferenceTriggerBlock(referenceLines, triggerName);
             var (triggerLines, _) = BuildProgrammableObjectLines(
                 definitionText,
@@ -6452,6 +6458,33 @@ internal static string ApplyDefinitionFormatting(string definition, string[]? re
         return string.Join(Environment.NewLine, lines);
     }
 
+    internal static string RewriteModuleDeclarationLine(string definition, string schema, string name)
+    {
+        if (string.IsNullOrWhiteSpace(definition))
+        {
+            return definition;
+        }
+
+        var lines = definition.Split(new[] { "\r\n", "\n" }, StringSplitOptions.None);
+        for (var i = 0; i < lines.Length; i++)
+        {
+            var match = ModuleDeclarationLineRegex.Match(lines[i]);
+            if (!match.Success)
+            {
+                continue;
+            }
+
+            lines[i] =
+                match.Groups["indent"].Value +
+                match.Groups["prefix"].Value +
+                $"{QuoteIdentifier(schema)}.{QuoteIdentifier(name)}" +
+                match.Groups["suffix"].Value;
+            break;
+        }
+
+        return string.Join(Environment.NewLine, lines);
+    }
+
     private static string[]? GetReferenceDefinitionBlock(string[]? referenceLines)
     {
         var range = TryGetReferenceDefinitionRange(referenceLines);

tests/SqlChangeTracker.Tests/Sql/SqlServerScripterCompatibilityTests.cs

@@ -113,6 +113,56 @@ public void ApplyDefinitionFormatting_PreservesReferenceCreateLineIdentifierQuot
         Assert.Equal("CREATE PROCEDURE [Reporting].[Sample_Proc]", createLine);
     }
 
+    [Fact]
+    public void RewriteModuleDeclarationLine_ReplacesStaleStoredProcedureNameWithCurrentObjectName()
+    {
+        var definition = string.Join(Environment.NewLine, new[]
+        {
+            "CREATE PROCEDURE [Accounting].[LegacyProcedure] @BatchId int",
+            "AS",
+            "SELECT @BatchId"
+        });
+
+        var rewritten = SqlServerScripter.RewriteModuleDeclarationLine(
+            definition,
+            "Accounting",
+            "CurrentProcedure__1_12_3_0");
+
+        Assert.Equal(
+            string.Join(Environment.NewLine, new[]
+            {
+                "CREATE PROCEDURE [Accounting].[CurrentProcedure__1_12_3_0] @BatchId int",
+                "AS",
+                "SELECT @BatchId"
+            }),
+            rewritten);
+    }
+
+    [Fact]
+    public void RewriteModuleDeclarationLine_PreservesCreateOrAlterPrefix_WhenReplacingCurrentName()
+    {
+        var definition = string.Join(Environment.NewLine, new[]
+        {
+            "CREATE OR ALTER VIEW [Reporting].[LegacyView]",
+            "AS",
+            "SELECT 1"
+        });
+
+        var rewritten = SqlServerScripter.RewriteModuleDeclarationLine(
+            definition,
+            "Reporting",
+            "CurrentView");
+
+        Assert.Equal(
+            string.Join(Environment.NewLine, new[]
+            {
+                "CREATE OR ALTER VIEW [Reporting].[CurrentView]",
+                "AS",
+                "SELECT 1"
+            }),
+            rewritten);
+    }
+
     [Fact]
     public void ApplyDefinitionFormatting_PreservesCompatibleClrFunctionReferenceDefinition()
     {