Explicitly match CommitSha in blob URLs

Author: jcansdale

src/GitHub.App/Services/GitHubContext.cs

@@ -7,7 +7,8 @@ public class GitHubContext
         public string Owner { get; set; }
         public string RepositoryName { get; set; }
         public string Host { get; set; }
-        public string Branch { get; set; }
+        public string BranchName { get; set; }
+        public string CommitSha { get; set; }
         public int? PullRequest { get; set; }
         public int? Issue { get; set; }
         public string Path { get; set; }

src/GitHub.App/Services/GitHubContextService.cs

@@ -43,6 +43,8 @@ public class GitHubContextService
         static readonly Regex windowTitleBranchesRegex = new Regex($"Branches · {owner}/{repo}( · GitHub)? - ", RegexOptions.Compiled);
 
         static readonly Regex urlLineRegex = new Regex($"#L(?<line>[0-9]+)(-L(?<lineEnd>[0-9]+))?$", RegexOptions.Compiled);
+        static readonly Regex urlBlobCommitRegex = new Regex($"blob/(?<commit>[a-z0-9]{{40}})/(?<path>[^#]*)", RegexOptions.Compiled);
+        static readonly Regex urlBlobBranchRegex = new Regex($"blob/(?<branch>master)/(?<path>[^#]*)", RegexOptions.Compiled);
 
         [ImportingConstructor]
         public GitHubContextService([Import(typeof(SVsServiceProvider))] IServiceProvider serviceProvider)
@@ -63,17 +65,42 @@ public GitHubContext FindContextFromUrl(string url)
                 return null;
             }
 
-            var (line, lineEnd) = FindLine(uri);
-            return new GitHubContext
+            var context = new GitHubContext
             {
                 Host = uri.Host,
                 Owner = uri.Owner,
                 RepositoryName = uri.RepositoryName,
-                Path = FindPath(uri),
-                PullRequest = FindPullRequest(uri),
-                Line = line,
-                LineEnd = lineEnd
             };
+
+            var repositoryPrefix = uri.ToRepositoryUrl().ToString() + "/";
+            if (!url.StartsWith(repositoryPrefix, StringComparison.OrdinalIgnoreCase))
+            {
+                return context;
+            }
+
+            var subpath = url.Substring(repositoryPrefix.Length);
+
+            (context.Line, context.LineEnd) = FindLine(subpath);
+
+            context.PullRequest = FindPullRequest(url);
+
+            var match = urlBlobCommitRegex.Match(subpath);
+            if (match.Success)
+            {
+                context.CommitSha = match.Groups["commit"].Value;
+                context.Path = match.Groups["path"].Value;
+                return context;
+            }
+
+            match = urlBlobBranchRegex.Match(subpath);
+            if (match.Success)
+            {
+                context.BranchName = match.Groups["branch"].Value;
+                context.Path = match.Groups["path"].Value;
+                return context;
+            }
+
+            return context;
         }
 
         public GitHubContext FindContextFromBrowser()
@@ -119,7 +146,7 @@ public GitHubContext FindContextFromWindowTitle(string windowTitle)
                 {
                     Owner = match.Groups["owner"].Value,
                     RepositoryName = match.Groups["repo"].Value,
-                    Branch = match.Groups["branch"].Value,
+                    BranchName = match.Groups["branch"].Value,
                     Path = match.Groups["path"].Value
                 };
             }
@@ -141,7 +168,7 @@ public GitHubContext FindContextFromWindowTitle(string windowTitle)
                 {
                     Owner = match.Groups["owner"].Value,
                     RepositoryName = match.Groups["repo"].Value,
-                    Branch = match.Groups["branch"].Value,
+                    BranchName = match.Groups["branch"].Value,
                 };
             }
 
@@ -256,23 +283,6 @@ IVsTextView OpenDocument(string fullPath)
             return (null, null);
         }
 
-        string FindPath(UriString uri)
-        {
-            var blob = FindSubPath(uri, "/blob/");
-            if (blob == null)
-            {
-                return null;
-            }
-
-            var pathIndex = blob.IndexOf('/');
-            if (pathIndex == -1)
-            {
-                return null;
-            }
-
-            return blob.Substring(pathIndex + 1);
-        }
-
         static int? FindPullRequest(UriString gitHubUrl)
         {
             var pullRequest = FindSubPath(gitHubUrl, "/pull/")?.Split('/').First();

test/GitHub.App.UnitTests/Services/GitHubContextServiceTests.cs

@@ -63,6 +63,22 @@ public void PullRequest(string url, int? expectPullRequest)
             Assert.That(context?.PullRequest, Is.EqualTo(expectPullRequest));
         }
 
+        [TestCase("https://github.com/github/VisualStudio/blob/master", null, null, null)]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/foo.cs", "master", null, "foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/path/foo.cs", "master", null, "path/foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/ee863ce265fc6217f589e66766125fed1b5b8256/path/foo.cs", null, "ee863ce265fc6217f589e66766125fed1b5b8256", "path/foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/not_master/foo.cs", null, null, null, Description = "We currently only match SHA and master")]
+        public void Blob(string url, string expectBranch, string expectCommitSha, string expectPath)
+        {
+            var target = CreateGitHubContextService();
+
+            var context = target.FindContextFromUrl(url);
+
+            Assert.That(context.BranchName, Is.EqualTo(expectBranch));
+            Assert.That(context.CommitSha, Is.EqualTo(expectCommitSha));
+            Assert.That(context.Path, Is.EqualTo(expectPath));
+        }
+
         [TestCase("https://github.com", null)]
         [TestCase("https://github.com/github", null)]
         [TestCase("https://github.com/github/VisualStudio", null)]
@@ -222,7 +238,7 @@ public void Branch(string branch, string expectBranch)
 
             var context = target.FindContextFromWindowTitle(windowTitle);
 
-            Assert.That(context?.Branch, Is.EqualTo(expectBranch));
+            Assert.That(context?.BranchName, Is.EqualTo(expectBranch));
         }
 
         [TestCase("github/VisualStudio: GitHub Extension for Visual Studio - Google Chrome", "github", "VisualStudio", null)]
@@ -241,7 +257,7 @@ public void OwnerRepositoryBranch(string windowTitle, string expectOwner, string
 
             Assert.That(context.Owner, Is.EqualTo(expectOwner));
             Assert.That(context.RepositoryName, Is.EqualTo(expectRepositoryName));
-            Assert.That(context.Branch, Is.EqualTo(expectBranch));
+            Assert.That(context.BranchName, Is.EqualTo(expectBranch));
         }
 
         [TestCase("github/VisualStudio at build/appveyor-fixes - Google Chrome", "github", "VisualStudio", "build/appveyor-fixes", Description = "Chrome")]
@@ -254,7 +270,7 @@ public void TreeBranch(string windowTitle, string expectOwner, string expectRepo
 
             Assert.That(context.Owner, Is.EqualTo(expectOwner));
             Assert.That(context.RepositoryName, Is.EqualTo(expectRepositoryName));
-            Assert.That(context.Branch, Is.EqualTo(expectBranch));
+            Assert.That(context.BranchName, Is.EqualTo(expectBranch));
         }
 
         [TestCase("Branches · github/VisualStudio - Google Chrome", "github", "VisualStudio", Description = "Chrome")]