Add BAR build links to dependency PR descriptions (#5227)

Copilot · premun · web-flow · commit 23cc79af3979 · 2025-09-01T11:41:44.000+02:00
Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: premun &lt;7013027+premun@users.noreply.github.com&gt;
Co-authored-by: Přemek Vysoký &lt;premek.vysoky@gmail.com&gt;
Co-authored-by: Premek Vysoky &lt;premek.vysoky@microsoft.com&gt;
diff --git a/src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs b/src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs
@@ -55,7 +55,7 @@ string GenerateCodeFlowPRTitle(
     /// <summary>
     ///    Generate the description for a code flow PR.
     /// </summary>
-    string GenerateCodeFlowPRDescription(
+    Task<string> GenerateCodeFlowPRDescription(
         SubscriptionUpdateWorkItem update,
         BuildDTO build,
         string? previousSourceCommit,
@@ -181,7 +181,7 @@ public async Task<string> CalculatePRDescriptionAndCommitUpdatesAsync(
                 itemsToUpdate,
                 message.ToString());
 
-            AppendBuildDescription(description, ref startingReferenceId, update, deps, committedFiles, build);
+            startingReferenceId = await AppendBuildDescriptionAsync(description, startingReferenceId, update, deps, committedFiles, build);
         }
 
         // If the coherency update wasn't combined, then
@@ -224,7 +224,7 @@ public string GenerateCodeFlowPRTitle(
         return GeneratePRTitle($"[{targetBranch}] Source code updates from", repoNames);
     }
 
-    public string GenerateCodeFlowPRDescription(
+    public async Task<string> GenerateCodeFlowPRDescription(
         SubscriptionUpdateWorkItem update,
         BuildDTO build,
         string? previousSourceCommit,
@@ -233,7 +233,7 @@ public string GenerateCodeFlowPRDescription(
         string? currentDescription,
         bool isForwardFlow)
     {
-        string description = GenerateCodeFlowPRDescriptionInternal(
+        string description = await GenerateCodeFlowPRDescriptionInternal(
             update,
             build,
             previousSourceCommit,
@@ -246,7 +246,7 @@ public string GenerateCodeFlowPRDescription(
         return AddOrUpdateFooterInDescription(description, upstreamRepoDiffs);
     }
 
-    private static string GenerateCodeFlowPRDescriptionInternal(
+    private async Task<string> GenerateCodeFlowPRDescriptionInternal(
         SubscriptionUpdateWorkItem update,
         BuildDTO build,
         string? previousSourceCommit,
@@ -263,7 +263,7 @@ private static string GenerateCodeFlowPRDescriptionInternal(
                 > This is a codeflow update. It may contain both source code changes from [{(isForwardFlow ? "the source repo" : "the VMR")}]({update.SourceRepo}) as well as dependency updates. Learn more [here]({CodeFlowPrFaqUri}).
 
                 This pull request brings the following source code changes
-                {GenerateCodeFlowDescriptionForSubscription(update.SubscriptionId, previousSourceCommit, build, update.SourceRepo, dependencyUpdates)}
+                {await GenerateCodeFlowDescriptionForSubscription(update.SubscriptionId, previousSourceCommit, build, update.SourceRepo, dependencyUpdates)}
                 """;
         }
         else
@@ -279,15 +279,16 @@ This pull request brings the following source code changes
                 currentDescription.Length :
                 endIndex + GetEndMarker(update.SubscriptionId).Length;
 
-            return string.Concat(
-                currentDescription.AsSpan(0, startCutoff),
-                GenerateCodeFlowDescriptionForSubscription(
-                    update.SubscriptionId,
-                    previousSourceCommit,
-                    build,
-                    update.SourceRepo,
-                    dependencyUpdates),
-                currentDescription.AsSpan(endCutoff, currentDescription.Length - endCutoff));
+            var beforeSpan = currentDescription.Substring(0, startCutoff);
+            var afterSpan = currentDescription.Substring(endCutoff, currentDescription.Length - endCutoff);
+            var generatedDescription = await GenerateCodeFlowDescriptionForSubscription(
+                update.SubscriptionId,
+                previousSourceCommit,
+                build,
+                update.SourceRepo,
+                dependencyUpdates);
+
+            return string.Concat(beforeSpan, generatedDescription, afterSpan);
         }
     }
 
@@ -336,15 +337,14 @@ private static string GenerateUpstreamRepoDiffs(IReadOnlyCollection<UpstreamRepo
         return sb.ToString();
     }
 
-    private static string GenerateCodeFlowDescriptionForSubscription(
+    private async Task<string> GenerateCodeFlowDescriptionForSubscription(
         Guid subscriptionId,
         string? previousSourceCommit,
         BuildDTO build,
         string repoUri,
         List<DependencyUpdateSummary> dependencyUpdates)
     {
         string sourceDiffText = CreateSourceDiffLink(build, previousSourceCommit);
-
         string dependencyUpdateBlock = CreateDependencyUpdateBlock(dependencyUpdates, repoUri);
         return
             $"""
@@ -353,7 +353,7 @@ private static string GenerateCodeFlowDescriptionForSubscription(
             
             ## From {build.GetRepository()}
             - **Subscription**: {GetSubscriptionLink(subscriptionId)}
-            - **Build**: [{build.AzureDevOpsBuildNumber}]({build.GetBuildLink()})
+            - **Build**: {await GetBuildLinkAsync(build, subscriptionId)}
             - **Date Produced**: {build.DateProduced.ToUniversalTime():MMMM d, yyyy h:mm:ss tt UTC}
             - **Commit**: [{build.Commit}]({GitRepoUrlUtils.GetCommitUri(build.GetRepository(), build.Commit)})
             - **Commit Diff**: {sourceDiffText}
@@ -557,9 +557,9 @@ private static string CompressRepeatedLinksInDescription(string description)
     ///     Because PRs tend to be live for short periods of time, we can put more information
     ///     in the description than the commit message without worrying that links will go stale.
     /// </remarks>
-    private void AppendBuildDescription(
+    private async Task<int> AppendBuildDescriptionAsync(
         StringBuilder description,
-        ref int startingReferenceId,
+        int startingReferenceId,
         SubscriptionUpdateWorkItem update,
         List<DependencyUpdate> deps,
         List<GitFile>? committedFiles,
@@ -577,7 +577,7 @@ private void AppendBuildDescription(
             .AppendLine(sectionStartMarker)
             .AppendLine($"## From {sourceRepository}")
             .AppendLine($"- **Subscription**: {GetSubscriptionLink(updateSubscriptionId)}")
-            .AppendLine($"- **Build**: [{build.AzureDevOpsBuildNumber}]({build.GetBuildLink()})")
+            .AppendLine($"- **Build**: {await GetBuildLinkAsync(build, update.SubscriptionId)}")
             .AppendLine($"- **Date Produced**: {build.DateProduced.ToUniversalTime():MMMM d, yyyy h:mm:ss tt UTC}")
             // This is duplicated from the files changed, but is easier to read here.
             .AppendLine($"- **Commit**: [{build.Commit}]({GitRepoUrlUtils.GetCommitUri(build.GetRepository(), build.Commit)})");
@@ -658,6 +658,7 @@ private void AppendBuildDescription(
         description.AppendLine();
 
         startingReferenceId += changesLinks.Count;
+        return startingReferenceId;
     }
 
     /// <summary>
@@ -844,4 +845,98 @@ private static string GetEndMarker(Guid subscriptionId)
 
     private static string GetSubscriptionLink(Guid subscriptionId)
         => $"[{subscriptionId}](https://maestro.dot.net/subscriptions?search={subscriptionId})";
+
+    /// <summary>
+    /// Generates a build link that to the Azure DevOps build and tries to add a BAR build link.
+    /// </summary>
+    /// <param name="build">The build object containing build information</param>
+    /// <param name="subscriptionId">The subscription ID to get channel information</param>
+    /// <returns>Enhanced build link string with BAR build details</returns>
+    private async Task<string> GetBuildLinkAsync(BuildDTO build, Guid subscriptionId)
+    {
+        var originalBuildLink = $"[{build.AzureDevOpsBuildNumber}]({build.GetBuildLink()})";
+        
+        try
+        {
+            int? channelId;
+            if (build.Channels.Count == 1)
+            {
+                channelId = build.Channels[0].Id;
+            }
+            else
+            {
+
+                // Get the subscription to retrieve the channel ID
+                var subscription = await _context.Subscriptions
+                    .Where(s => s.Id == subscriptionId)
+                    .Select(s => new { s.ChannelId })
+                    .FirstOrDefaultAsync();
+
+                if (subscription == null)
+                {
+                    // If the subscription is not found, return the original link
+                    return originalBuildLink;
+                }
+
+                channelId = subscription.ChannelId;
+            }
+            
+            // Generate repository slug for BarViz URL
+            var repoSlug = ConvertRepoUrlToSlug(build.GetRepository());
+            if (string.IsNullOrEmpty(repoSlug))
+            {
+                return originalBuildLink;
+            }
+            
+            // Create the BarViz link
+            var barBuildLink = $"https://maestro.dot.net/channel/{channelId}/{repoSlug}/build/{build.Id}";
+            return $"{originalBuildLink} ([{build.Id}]({barBuildLink}))";
+        }
+        catch (Exception ex)
+        {
+            _logger.LogWarning(ex, "Failed to generate enhanced build link for build {BuildId} and subscription {SubscriptionId}", build.Id, subscriptionId);
+            return originalBuildLink;
+        }
+    }
+
+    /// <summary>
+    /// Converts a repository URL to a slug format used by BarViz.
+    /// </summary>
+    /// <param name="repoUrl">The repository URL</param>
+    /// <returns>Repository slug in format github:org:repo or azdo:org:project:repo</returns>
+    private static string? ConvertRepoUrlToSlug(string? repoUrl)
+    {
+        if (repoUrl == null)
+        {
+            return null;
+        }
+
+        var repoType = GitRepoUrlUtils.ParseTypeFromUri(repoUrl);
+        
+        switch (repoType)
+        {
+            case GitRepoType.GitHub:
+                var (repoName, org) = GitRepoUrlUtils.GetRepoNameAndOwner(repoUrl);
+                return $"github:{org}:{repoName}";
+                
+            case GitRepoType.AzureDevOps:
+                // For Azure DevOps, we need to extract the project name from the URL
+                // Format: https://dev.azure.com/{org}/{project}/_git/{repo}
+                const string azureDevOpsPrefix = "https://dev.azure.com/";
+                if (repoUrl.StartsWith(azureDevOpsPrefix))
+                {
+                    string[] urlParts = repoUrl.Substring(azureDevOpsPrefix.Length).Split('/');
+                    if (urlParts.Length >= 4 && urlParts[2] == "_git")
+                    {
+                        string orgName = urlParts[0];
+                        string projectName = urlParts[1];
+                        string repoNamePart = urlParts[3].Split('?')[0]; // Remove query parameters
+                        return $"azdo:{orgName}:{projectName}:{repoNamePart}";
+                    }
+                }
+                break;
+        }
+
+        return null;
+    }
 }
diff --git a/src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestUpdater.cs b/src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestUpdater.cs
@@ -1216,7 +1216,7 @@ private async Task UpdateCodeFlowPullRequestAsync(
             subscription.TargetBranch,
             pullRequest.ContainedSubscriptions.Select(s => s.SourceRepo).ToList());
 
-        var description = _pullRequestBuilder.GenerateCodeFlowPRDescription(
+        var description = await _pullRequestBuilder.GenerateCodeFlowPRDescription(
             update,
             build,
             previousSourceSha,
@@ -1274,7 +1274,7 @@ private async Task<InProgressPullRequest> CreateCodeFlowPullRequestAsync(
         try
         {
             var title = _pullRequestBuilder.GenerateCodeFlowPRTitle(subscription.TargetBranch, [update.SourceRepo]);
-            var description = _pullRequestBuilder.GenerateCodeFlowPRDescription(
+            var description = await _pullRequestBuilder.GenerateCodeFlowPRDescription(
                 update,
                 build,
                 previousSourceSha,
diff --git a/test/ProductConstructionService.DependencyFlow.Tests/PullRequestBuilderTests.cs b/test/ProductConstructionService.DependencyFlow.Tests/PullRequestBuilderTests.cs
