feat(profiling): Add optional build profiling framework with versioned JSON output (#69)

Author: Copilot

docs/user-guide/build-profiling.md

@@ -17,15 +17,22 @@ namespace JD.Efcpt.Build.Tasks;
 /// </remarks>
 public sealed class AddSqlFileWarnings : Task
 {
+    /// <summary>
+    /// Full path to the MSBuild project file (used for profiling).
+    /// </summary>
+    public string ProjectPath { get; set; } = "";
+
     /// <summary>
     /// Directory containing SQL script files.
     /// </summary>
     [Required]
+    [ProfileInput]
     public string ScriptsDirectory { get; set; } = "";
 
     /// <summary>
     /// Database name for the warning header.
     /// </summary>
+    [ProfileInput]
     public string DatabaseName { get; set; } = "";
 
     /// <summary>
@@ -39,49 +46,42 @@ public sealed class AddSqlFileWarnings : Task
     [Output]
     public int FilesProcessed { get; set; }
 
-    /// <summary>
-    /// Executes the task.
-    /// </summary>
+    /// <inheritdoc />
     public override bool Execute()
+        => TaskExecutionDecorator.ExecuteWithProfiling(
+            this, ExecuteCore, ProfilingHelper.GetProfiler(ProjectPath));
+
+    private bool ExecuteCore(TaskExecutionContext ctx)
     {
-        var log = new BuildLog(Log, LogVerbosity);
+        var log = new BuildLog(ctx.Logger, LogVerbosity);
 
-        try
+        log.Info("Adding auto-generation warnings to SQL files...");
+
+        if (!Directory.Exists(ScriptsDirectory))
         {
-            log.Info("Adding auto-generation warnings to SQL files...");
+            log.Warn($"Scripts directory not found: {ScriptsDirectory}");
+            return true; // Not an error
+        }
 
-            if (!Directory.Exists(ScriptsDirectory))
+        // Find all SQL files
+        var sqlFiles = Directory.GetFiles(ScriptsDirectory, "*.sql", SearchOption.AllDirectories);
+
+        FilesProcessed = 0;
+        foreach (var sqlFile in sqlFiles)
+        {
+            try
             {
-                log.Warn($"Scripts directory not found: {ScriptsDirectory}");
-                return true; // Not an error
+                AddWarningHeader(sqlFile, log);
+                FilesProcessed++;
             }
-
-            // Find all SQL files
-            var sqlFiles = Directory.GetFiles(ScriptsDirectory, "*.sql", SearchOption.AllDirectories);
-
-            FilesProcessed = 0;
-            foreach (var sqlFile in sqlFiles)
+            catch (Exception ex)
             {
-                try
-                {
-                    AddWarningHeader(sqlFile, log);
-                    FilesProcessed++;
-                }
-                catch (Exception ex)
-                {
-                    log.Warn($"Failed to process {Path.GetFileName(sqlFile)}: {ex.Message}");
-                }
+                log.Warn($"Failed to process {Path.GetFileName(sqlFile)}: {ex.Message}");
             }
-
-            log.Info($"Processed {FilesProcessed} SQL files");
-            return true;
-        }
-        catch (Exception ex)
-        {
-            log.Error("JD0025", $"Failed to add SQL file warnings: {ex.Message}");
-            log.Detail($"Exception details: {ex}");
-            return false;
         }
+
+        log.Info($"Processed {FilesProcessed} SQL files");
+        return true;
     }
 
     /// <summary>

src/JD.Efcpt.Build.Tasks/AddSqlFileWarnings.cs

@@ -31,22 +31,30 @@ public sealed class ApplyConfigOverrides : Task
 {
     #region Control Properties
 
+    /// <summary>
+    /// Full path to the MSBuild project file (used for profiling).
+    /// </summary>
+    public string ProjectPath { get; set; } = "";
+
     /// <summary>
     /// Path to the staged efcpt-config.json file to modify.
     /// </summary>
     [Required]
+    [ProfileInput]
     public string StagedConfigPath { get; set; } = "";
 
     /// <summary>
     /// Whether to apply MSBuild property overrides to user-provided config files.
     /// </summary>
     /// <value>Default is "true". Set to "false" to skip overrides for user-provided configs.</value>
+    [ProfileInput]
     public string ApplyOverrides { get; set; } = "true";
 
     /// <summary>
     /// Indicates whether the config file is the library default (not user-provided).
     /// </summary>
     /// <value>When "true", overrides are always applied regardless of <see cref="ApplyOverrides"/>.</value>
+    [ProfileInput]
     public string IsUsingDefaultConfig { get; set; } = "false";
 
     /// <summary>
@@ -189,11 +197,8 @@ public sealed class ApplyConfigOverrides : Task
 
     /// <inheritdoc />
     public override bool Execute()
-    {
-        var decorator = TaskExecutionDecorator.Create(ExecuteCore);
-        var ctx = new TaskExecutionContext(Log, nameof(ApplyConfigOverrides));
-        return decorator.Execute(in ctx);
-    }
+        => TaskExecutionDecorator.ExecuteWithProfiling(
+            this, ExecuteCore, ProfilingHelper.GetProfiler(ProjectPath));
 
     private bool ExecuteCore(TaskExecutionContext ctx)
     {

src/JD.Efcpt.Build.Tasks/ApplyConfigOverrides.cs

@@ -1,6 +1,8 @@
 using System.Net.Http;
 using System.Text.Json;
+using JD.Efcpt.Build.Tasks.Decorators;
 using Microsoft.Build.Framework;
+using Task = Microsoft.Build.Utilities.Task;
 
 namespace JD.Efcpt.Build.Tasks;
 
@@ -18,22 +20,29 @@ namespace JD.Efcpt.Build.Tasks;
 /// - Cache duration: 24 hours (configurable via CacheHours)
 /// </para>
 /// </remarks>
-public class CheckSdkVersion : Microsoft.Build.Utilities.Task
+public class CheckSdkVersion : Task
 {
     private static readonly HttpClient HttpClient = new()
     {
         Timeout = TimeSpan.FromSeconds(5)
     };
 
+    /// <summary>
+    /// Full path to the MSBuild project file (used for profiling).
+    /// </summary>
+    public string ProjectPath { get; set; } = "";
+
     /// <summary>
     /// The current SDK version being used.
     /// </summary>
     [Required]
+    [ProfileInput]
     public string CurrentVersion { get; set; } = "";
 
     /// <summary>
     /// The NuGet package ID to check.
     /// </summary>
+    [ProfileInput]
     public string PackageId { get; set; } = "JD.Efcpt.Sdk";
 
     /// <summary>
@@ -66,6 +75,10 @@ public class CheckSdkVersion : Microsoft.Build.Utilities.Task
 
     /// <inheritdoc />
     public override bool Execute()
+        => TaskExecutionDecorator.ExecuteWithProfiling(
+            this, ExecuteCore, ProfilingHelper.GetProfiler(ProjectPath));
+
+    private bool ExecuteCore(TaskExecutionContext ctx)
     {
         try
         {
@@ -93,7 +106,7 @@ public override bool Execute()
         catch (Exception ex)
         {
             // Don't fail the build for version check issues - just log and continue
-            Log.LogMessage(MessageImportance.Low,
+            ctx.Logger.LogMessage(MessageImportance.Low,
                 $"EFCPT: Unable to check for SDK updates: {ex.Message}");
             return true;
         }

src/JD.Efcpt.Build.Tasks/CheckSdkVersion.cs

@@ -39,37 +39,48 @@ namespace JD.Efcpt.Build.Tasks;
 /// </remarks>
 public sealed class ComputeFingerprint : Task
 {
+    /// <summary>
+    /// Full path to the MSBuild project file (used for profiling).
+    /// </summary>
+    public string ProjectPath { get; set; } = "";
+
     /// <summary>
     /// Path to the DACPAC file to include in the fingerprint (used in .sqlproj mode).
     /// </summary>
+    [ProfileInput]
     public string DacpacPath { get; set; } = "";
 
     /// <summary>
     /// Schema fingerprint from QuerySchemaMetadata (used in connection string mode).
     /// </summary>
+    [ProfileInput]
     public string SchemaFingerprint { get; set; } = "";
 
     /// <summary>
     /// Indicates whether we're in connection string mode.
     /// </summary>
+    [ProfileInput]
     public string UseConnectionStringMode { get; set; } = "false";
 
     /// <summary>
     /// Path to the efcpt configuration JSON file to include in the fingerprint.
     /// </summary>
     [Required]
+    [ProfileInput]
     public string ConfigPath { get; set; } = "";
 
     /// <summary>
     /// Path to the efcpt renaming JSON file to include in the fingerprint.
     /// </summary>
     [Required]
+    [ProfileInput]
     public string RenamingPath { get; set; } = "";
 
     /// <summary>
     /// Root directory containing template files to include in the fingerprint.
     /// </summary>
     [Required]
+    [ProfileInput]
     public string TemplateDir { get; set; } = "";
 
     /// <summary>
@@ -86,21 +97,25 @@ public sealed class ComputeFingerprint : Task
     /// <summary>
     /// Version of the EF Core Power Tools CLI tool package being used.
     /// </summary>
+    [ProfileInput]
     public string ToolVersion { get; set; } = "";
 
     /// <summary>
     /// Directory containing generated files to optionally include in the fingerprint.
     /// </summary>
+    [ProfileInput]
     public string GeneratedDir { get; set; } = "";
 
     /// <summary>
     /// Indicates whether to detect changes to generated files (default: false to avoid overwriting manual edits).
     /// </summary>
+    [ProfileInput]
     public string DetectGeneratedFileChanges { get; set; } = "false";
 
     /// <summary>
     /// Serialized JSON string containing MSBuild config property overrides.
     /// </summary>
+    [ProfileInput]
     public string ConfigPropertyOverrides { get; set; } = "";
 
     /// <summary>
@@ -121,11 +136,8 @@ public sealed class ComputeFingerprint : Task
 
     /// <inheritdoc />
     public override bool Execute()
-    {
-        var decorator = TaskExecutionDecorator.Create(ExecuteCore);
-        var ctx = new TaskExecutionContext(Log, nameof(ComputeFingerprint));
-        return decorator.Execute(in ctx);
-    }
+        => TaskExecutionDecorator.ExecuteWithProfiling(
+            this, ExecuteCore, ProfilingHelper.GetProfiler(ProjectPath));
 
     private bool ExecuteCore(TaskExecutionContext ctx)
     {