Add ResolvePath to resolve Treeish + BlobName

Author: jcansdale

src/GitHub.App/Services/GitHubContext.cs

@@ -8,10 +8,10 @@ public class GitHubContext
         public string RepositoryName { get; set; }
         public string Host { get; set; }
         public string BranchName { get; set; }
-        public string CommitSha { get; set; }
+        public string Treeish { get; set; }
+        public string BlobName { get; set; }
         public int? PullRequest { get; set; }
         public int? Issue { get; set; }
-        public string Path { get; set; }
         public int? Line { get; set; }
         public int? LineEnd { get; set; }
     }

src/GitHub.App/Services/GitHubContextService.cs

@@ -33,18 +33,22 @@ public class GitHubContextService
 
         const string issue = "(?<issue>[0-9]+)";
 
-        static readonly string path = $"^{repo}/(?<path>[^ ]+)";
+        static readonly string tree = $"^{repo}/(?<tree>[^ ]+)";
+        static readonly string blobName = $"^{repo}/(?<blobName>[^ /]+)";
 
         static readonly Regex windowTitleRepositoryRegex = new Regex($"^(GitHub - )?{owner}/{repo}(: .*)? - ", RegexOptions.Compiled);
         static readonly Regex windowTitleBranchRegex = new Regex($"^(GitHub - )?{owner}/{repo} at {branch} ", RegexOptions.Compiled);
         static readonly Regex windowTitlePullRequestRegex = new Regex($" · Pull Request #{pull} · {owner}/{repo}( · GitHub)? - ", RegexOptions.Compiled);
         static readonly Regex windowTitleIssueRegex = new Regex($" · Issue #{issue} · {owner}/{repo}( · GitHub)? - ", RegexOptions.Compiled);
-        static readonly Regex windowTitlePathRegex = new Regex($"{path} at {branch} · {owner}/{repo}( · GitHub)? - ", RegexOptions.Compiled);
+        static readonly Regex windowTitleBlobRegex = new Regex($"{blobName} at {branch} · {owner}/{repo}( · GitHub)? - ", RegexOptions.Compiled);
+        static readonly Regex windowTitleTreeRegex = new Regex($"{tree} at {branch} · {owner}/{repo}( · GitHub)? - ", RegexOptions.Compiled);
         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);
+        static readonly Regex urlBlobRegex = new Regex($"blob/(?<treeish>[^/]+(/[^/]+)*)/(?<blobName>[^/#]+)", RegexOptions.Compiled);
+
+        static readonly Regex treeishCommitRegex = new Regex($"(?<commit>[a-z0-9]{{40}})(/(?<tree>.+))?", RegexOptions.Compiled);
+        static readonly Regex treeishBranchRegex = new Regex($"(?<branch>master)(/(?<tree>.+))?", RegexOptions.Compiled);
 
         [ImportingConstructor]
         public GitHubContextService([Import(typeof(SVsServiceProvider))] IServiceProvider serviceProvider)
@@ -84,19 +88,11 @@ public GitHubContext FindContextFromUrl(string url)
 
             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);
+            var match = urlBlobRegex.Match(subpath);
             if (match.Success)
             {
-                context.BranchName = match.Groups["branch"].Value;
-                context.Path = match.Groups["path"].Value;
+                context.Treeish = match.Groups["treeish"].Value;
+                context.BlobName = match.Groups["blobName"].Value;
                 return context;
             }
 
@@ -139,15 +135,27 @@ public Uri ToRepositoryUrl(GitHubContext context)
 
         public GitHubContext FindContextFromWindowTitle(string windowTitle)
         {
-            var match = windowTitlePathRegex.Match(windowTitle);
+            var match = windowTitleBlobRegex.Match(windowTitle);
             if (match.Success)
             {
                 return new GitHubContext
                 {
                     Owner = match.Groups["owner"].Value,
                     RepositoryName = match.Groups["repo"].Value,
                     BranchName = match.Groups["branch"].Value,
-                    Path = match.Groups["path"].Value
+                    BlobName = match.Groups["blobName"].Value
+                };
+            }
+
+            match = windowTitleTreeRegex.Match(windowTitle);
+            if (match.Success)
+            {
+                return new GitHubContext
+                {
+                    Owner = match.Groups["owner"].Value,
+                    RepositoryName = match.Groups["repo"].Value,
+                    BranchName = match.Groups["branch"].Value,
+                    Treeish = $"{match.Groups["branch"].Value}/{match.Groups["tree"].Value}"
                 };
             }
 
@@ -213,24 +221,30 @@ public GitHubContext FindContextFromWindowTitle(string windowTitle)
 
         public bool TryOpenFile(GitHubContext context, string repositoryDir)
         {
-            var path = context.Path;
-            if (path == null)
+            var fileName = context.BlobName;
+            if (fileName == null)
             {
                 return false;
             }
 
-            var windowsPath = path.Replace('/', '\\');
-            var fullPath = Path.Combine(repositoryDir, windowsPath);
-            if (!File.Exists(fullPath))
+            string fullPath;
+            var resolvedPath = ResolvePath(context);
+            if (resolvedPath != null)
             {
-                // Search by filename only
-                var fileName = Path.GetFileName(path);
-                fullPath = Directory.EnumerateFiles(repositoryDir, fileName, SearchOption.AllDirectories).FirstOrDefault();
+                fullPath = Path.Combine(repositoryDir, resolvedPath);
+                if (!File.Exists(fullPath))
+                {
+                    return false;
+                }
             }
-
-            if (fullPath == null)
+            else
             {
-                return false;
+                // Search by filename only
+                fullPath = Directory.EnumerateFiles(repositoryDir, fileName, SearchOption.AllDirectories).FirstOrDefault();
+                if (fullPath == null)
+                {
+                    return false;
+                }
             }
 
             var textView = OpenDocument(fullPath);
@@ -250,6 +264,37 @@ public bool TryOpenFile(GitHubContext context, string repositoryDir)
             return true;
         }
 
+        public string ResolvePath(GitHubContext context)
+        {
+            var treeish = context.Treeish;
+            if (treeish == null)
+            {
+                return null;
+            }
+
+            var blobName = context.BlobName;
+            if (blobName == null)
+            {
+                return null;
+            }
+
+            var match = treeishCommitRegex.Match(treeish);
+            if (match.Success)
+            {
+                var tree = match.Groups["tree"].Value.Replace('/', '\\');
+                return Path.Combine(tree, blobName);
+            }
+
+            match = treeishBranchRegex.Match(treeish);
+            if (match.Success)
+            {
+                var tree = match.Groups["tree"].Value.Replace('/', '\\');
+                return Path.Combine(tree, blobName);
+            }
+
+            return null;
+        }
+
         IVsTextView OpenDocument(string fullPath)
         {
             var logicalView = VSConstants.LOGVIEWID.TextView_guid;

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

@@ -63,46 +63,20 @@ 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)
+        [TestCase("https://github.com/github/VisualStudio/blob/master", null, null)]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/foo.cs", "master", "foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/path/foo.cs", "master/path", "foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/ee863ce265fc6217f589e66766125fed1b5b8256/foo.cs", "ee863ce265fc6217f589e66766125fed1b5b8256", "foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/ee863ce265fc6217f589e66766125fed1b5b8256/path/foo.cs", "ee863ce265fc6217f589e66766125fed1b5b8256/path", "foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/bar.cs#stuff", "master", "bar.cs")]
+        public void Blob(string url, string expectTreeish, string expectBlobName)
         {
             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)]
-        [TestCase("https://github.com/github/VisualStudio/blob/master/README.md", "README.md")]
-        [TestCase("https://github.com/github/VisualStudio/blob/master/README.md#notices", "README.md")]
-        [TestCase("https://github.com/github/VisualStudio/blob/0d264d50c57d701fa62d202f481075a6c6dbdce8/src/Code.cs#L86", "src/Code.cs")]
-        public void Path(string url, string expectPath)
-        {
-            var target = CreateGitHubContextService();
-
-            var context = target.FindContextFromUrl(url);
-
-            Assert.That(context.Path, Is.EqualTo(expectPath));
-        }
-
-        // HACK: We're assuming that branches don't contain a '/' (sic)
-        [TestCase("https://github.com/github/VisualStudio/blob/fixes/branch/buggy.cs", "branch/buggy.cs")]
-        public void ProblemPath(string url, string expectPath)
-        {
-            var target = CreateGitHubContextService();
-
-            var context = target.FindContextFromUrl(url);
-
-            Assert.That(context.Path, Is.EqualTo(expectPath));
+            Assert.That(context.Treeish, Is.EqualTo(expectTreeish));
+            Assert.That(context.BlobName, Is.EqualTo(expectBlobName));
         }
 
         [TestCase("https://github.com", null)]
@@ -307,16 +281,29 @@ public void Issue(string windowTitle, int expectIssue)
             Assert.That(context.Issue, Is.EqualTo(expectIssue));
         }
 
-        [TestCase("VisualStudio/mark_github.xaml at master · github/VisualStudio - Google Chrome", "mark_github.xaml")]
-        [TestCase("VisualStudio/src/GitHub.VisualStudio/Resources/icons at master · github/VisualStudio - Google Chrome", "src/GitHub.VisualStudio/Resources/icons")]
-        [TestCase("VisualStudio/README.md at master · jcansdale/VisualStudio · GitHub - Mozilla Firefox", "README.md", Description = "Firefox")]
-        public void Path(string windowTitle, string expectPath)
+        [TestCase("VisualStudio/mark_github.xaml at master · github/VisualStudio - Google Chrome", "mark_github.xaml", "master")]
+        [TestCase("VisualStudio/src/GitHub.VisualStudio/Resources/icons at master · github/VisualStudio - Google Chrome", null, "master")]
+        [TestCase("VisualStudio/src at master · github/VisualStudio - Google Chrome", "src", "master", Description = "Can't differentiate between single level tree and blob")]
+        [TestCase("VisualStudio/README.md at master · jcansdale/VisualStudio · GitHub - Mozilla Firefox", "README.md", "master", Description = "Firefox")]
+        public void Blob(string windowTitle, string expectBlobName, string expectBranchName)
         {
             var target = CreateGitHubContextService();
 
             var context = target.FindContextFromWindowTitle(windowTitle);
 
-            Assert.That(context?.Path, Is.EqualTo(expectPath));
+            Assert.That(context?.BlobName, Is.EqualTo(expectBlobName));
+            Assert.That(context?.BranchName, Is.EqualTo(expectBranchName));
+        }
+
+        [TestCase("VisualStudio/src/GitHub.VisualStudio/Resources/icons at master · github/VisualStudio - Google Chrome", "master/src/GitHub.VisualStudio/Resources/icons", "master")]
+        public void Tree(string windowTitle, string expectTreeish, string expectBranch)
+        {
+            var target = CreateGitHubContextService();
+
+            var context = target.FindContextFromWindowTitle(windowTitle);
+
+            Assert.That(context?.Treeish, Is.EqualTo(expectTreeish));
+            Assert.That(context?.BranchName, Is.EqualTo(expectBranch));
         }
 
         [TestCase("jcansdale/VisualStudio: GitHub Extension for Visual Studio - Google Chrome", "jcansdale", "VisualStudio", Description = "Chrome")]
@@ -334,6 +321,27 @@ public void RepositoryHome(string windowTitle, string expectOwner, string expect
         }
     }
 
+    public class TheResolvePathMethod
+    {
+        [TestCase("https://github.com/github/VisualStudio/blob/ee863ce265fc6217f589e66766125fed1b5b8256/foo.cs", "foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/ee863ce265fc6217f589e66766125fed1b5b8256/dir/foo.cs", @"dir\foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/ee863ce265fc6217f589e66766125fed1b5b8256/dir/subdir/foo.cs", @"dir\subdir\foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/foo.cs", "foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/dir/foo.cs", @"dir\foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/master/dir/subdir/foo.cs", @"dir\subdir\foo.cs")]
+        [TestCase("https://github.com/github/VisualStudio/blob/unknown-branch/dir/subdir/foo.cs", null)]
+        [TestCase("https://github.com/github/VisualStudio/blob/unknown/branch/dir/subdir/foo.cs", null)]
+        public void ResolvePath(string url, string expectPath)
+        {
+            var target = CreateGitHubContextService();
+            var context = target.FindContextFromUrl(url);
+
+            var path = target.ResolvePath(context);
+
+            Assert.That(path, Is.EqualTo(expectPath));
+        }
+    }
+
     static GitHubContextService CreateGitHubContextService()
     {
         var sp = Substitute.For<IServiceProvider>();