Merge pull request #2512 from davidwengier/FixDiffCaptions

Prevent error when filenames have braces in them
github · Jun 9, 2020 · bb629da · bb629da
2 parents c56f7f2 + a1dc901
commit bb629da
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/src/GitHub.App/Services/PullRequestEditorService.cs b/src/GitHub.App/Services/PullRequestEditorService.cs
@@ -219,10 +219,10 @@ await pullRequestService.ExtractToTempFile(
                     frame = VisualStudio.Services.DifferenceService.OpenComparisonWindow2(
                         leftFile,
                         rightFile,
-                        caption,
-                        tooltip,
-                        leftLabel,
-                        rightLabel,
+                        SanitizeForDisplay(caption),
+                        SanitizeForDisplay(tooltip),
+                        SanitizeForDisplay(leftLabel),
+                        SanitizeForDisplay(rightLabel),
                         string.Empty,
                         string.Empty,
                         (uint)options);
@@ -284,6 +284,13 @@ await pullRequestService.ExtractToTempFile(
             }
         }
 
+        private static string SanitizeForDisplay(string caption)
+        {
+            // The diff window passes captions and tooltips through string.Format, with {0} and {1} being the left and right file respectively, but we already
+            // nicely format the file names with extra info we know, so we have to escape braces to prevent unwanted formatting, or invalid format errors.
+            return caption.Replace("{", "{{").Replace("}", "}}");
+        }
+
         /// <inheritdoc/>
         public Task<IDifferenceViewer> OpenDiff(
             IPullRequestSession session,