Support syncing the file open in topmost browser

jcansdale · jcansdale · commit c4cac4dac3aa · 2018-06-27T16:38:29.000+01:00
When browser is in the context of a file, open a file with the same
name after repository is opened.
diff --git a/src/GitHub.App/Services/GitHubContext.cs b/src/GitHub.App/Services/GitHubContext.cs
@@ -8,5 +8,6 @@ public class GitHubContext
         public string Branch { get; set; }
         public int? PullRequest { get; set; }
         public int? Issue { get; set; }
+        public string Path { get; set; }
     }
 }
diff --git a/src/GitHub.App/Services/GitHubContextService.cs b/src/GitHub.App/Services/GitHubContextService.cs
@@ -26,11 +26,13 @@ public class GitHubContextService
 
         const string issue = "(?<issue>[0-9]+)";
 
+        static readonly string path = $"^{repo}/(?<path>[^ ]+)";
+
         static readonly Regex windowTitleRepositoryRegex = new Regex($"^{owner}/{repo}: ", RegexOptions.Compiled);
         static readonly Regex windowTitleBranchRegex = new Regex($"^{owner}/{repo} at {branch} ", RegexOptions.Compiled);
         static readonly Regex windowTitlePullRequestRegex = new Regex($" · Pull Request #{pull} · {owner}/{repo} - ", RegexOptions.Compiled);
         static readonly Regex windowTitleIssueRegex = new Regex($" · Issue #{issue} · {owner}/{repo} - ", RegexOptions.Compiled);
-        static readonly Regex windowTitlePathRegex = new Regex($" at {branch} · {owner}/{repo} - ", RegexOptions.Compiled);
+        static readonly Regex windowTitlePathRegex = new Regex($"{path} at {branch} · {owner}/{repo} - ", RegexOptions.Compiled);
         static readonly Regex windowTitleBranchesRegex = new Regex($"Branches · {owner}/{repo} - ", RegexOptions.Compiled);
 
         public GitHubContext FindContextFromUrl(UriString url)
@@ -68,7 +70,7 @@ public IEnumerable<string> FindWindowTitlesForClass(string className = "Chrome_W
 
         public GitHubContext FindContextFromWindowTitle(string windowTitle)
         {
-            var (success, owner, repo, branch, pullRequest, issue) = MatchWindowTitle(windowTitle);
+            var (success, owner, repo, branch, pullRequest, issue, path) = MatchWindowTitle(windowTitle);
             if (!success)
             {
                 return null;
@@ -80,51 +82,52 @@ public GitHubContext FindContextFromWindowTitle(string windowTitle)
                 RepositoryName = repo,
                 Branch = branch,
                 PullRequest = pullRequest,
-                Issue = issue
+                Issue = issue,
+                Path = path
             };
         }
 
-        static (bool success, string owner, string repo, string branch, int? pullRequest, int? issue) MatchWindowTitle(string windowTitle)
+        static (bool success, string owner, string repo, string branch, int? pullRequest, int? issue, string path) MatchWindowTitle(string windowTitle)
         {
             var match = windowTitlePathRegex.Match(windowTitle);
             if (match.Success)
             {
-                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null);
+                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null, match.Groups["path"].Value);
             }
 
             match = windowTitleRepositoryRegex.Match(windowTitle);
             if (match.Success)
             {
-                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null);
+                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null, null);
             }
 
             match = windowTitleBranchRegex.Match(windowTitle);
             if (match.Success)
             {
-                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null);
+                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null, null);
             }
 
             match = windowTitleBranchesRegex.Match(windowTitle);
             if (match.Success)
             {
-                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null);
+                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null, null);
             }
 
             match = windowTitlePullRequestRegex.Match(windowTitle);
             if (match.Success)
             {
                 int.TryParse(match.Groups["pull"].Value, out int pullRequest);
-                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, pullRequest, null);
+                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, pullRequest, null, null);
             }
 
             match = windowTitleIssueRegex.Match(windowTitle);
             if (match.Success)
             {
                 int.TryParse(match.Groups["issue"].Value, out int issue);
-                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, issue);
+                return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, issue, null);
             }
 
-            return (match.Success, null, null, null, null, null);
+            return (match.Success, null, null, null, null, null, null);
         }
 
         static class User32
diff --git a/src/GitHub.VisualStudio/Commands/OpenFromUrlCommand.cs b/src/GitHub.VisualStudio/Commands/OpenFromUrlCommand.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.IO;
+using System.Linq;
 using System.Windows;
 using System.Threading.Tasks;
 using System.ComponentModel.Composition;
@@ -64,10 +65,11 @@ public override async Task Execute(string url)
                 gitHubUrl = null;
             }
 
+            GitHubContext context = null;
             if (gitHubUrl == null)
             {
                 // HACK: Reconstruct a GitHub URL from the topmost browser window
-                var context = gitHubContextService.Value.FindContextFromBrowser();
+                context = gitHubContextService.Value.FindContextFromBrowser();
                 if (context != null)
                 {
                     gitHubUrl = $"https://github.com/{context.Owner}/{context.RepositoryName}";
@@ -101,7 +103,7 @@ public override async Task Execute(string url)
             }
 
             await TryOpenPullRequest(gitHubUrl);
-            TryOpenFile(gitHubUrl, repositoryDir);
+            TryOpenFile(gitHubUrl, context, repositoryDir);
         }
 
         static bool ContainsDirectory(string repositoryDir, string solutionDir)
@@ -135,9 +137,9 @@ static string FindSolutionDirectory(Solution solution)
             return null;
         }
 
-        bool TryOpenFile(UriString gitHubUrl, string repositoryDir)
+        bool TryOpenFile(UriString gitHubUrl, GitHubContext context, string repositoryDir)
         {
-            var path = FindSubPath(gitHubUrl, "/blob/master/");
+            var path = FindSubPath(gitHubUrl, "/blob/master/") ?? context?.Path;
             if (path == null)
             {
                 return false;
@@ -146,6 +148,13 @@ bool TryOpenFile(UriString gitHubUrl, string repositoryDir)
             var windowsPath = path.Replace('/', '\\');
             var fullPath = Path.Combine(repositoryDir, windowsPath);
             if (!File.Exists(fullPath))
+            {
+                // Search by filename only
+                var fileName = Path.GetFileName(path);
+                fullPath = Directory.EnumerateFiles(repositoryDir, fileName, SearchOption.AllDirectories).FirstOrDefault();
+            }
+
+            if (fullPath == null)
             {
                 return false;
             }
diff --git a/test/GitHub.App.UnitTests/Services/GitHubContextServiceTests.cs b/test/GitHub.App.UnitTests/Services/GitHubContextServiceTests.cs
@@ -163,5 +163,16 @@ 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")]
+        public void Path(string windowTitle, string expectPath)
+        {
+            var target = new GitHubContextService();
+
+            var context = target.FindContextFromWindowTitle(windowTitle);
+
+            Assert.That(context?.Path, Is.EqualTo(expectPath));
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@ public class GitHubContext`
`8`	`8`	`public string Branch { get; set; }`
`9`	`9`	`public int? PullRequest { get; set; }`
`10`	`10`	`public int? Issue { get; set; }`
	`11`	`+ public string Path { get; set; }`
`11`	`12`	`}`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,11 +26,13 @@ public class GitHubContextService`
`26`	`26`
`27`	`27`	`const string issue = "(?<issue>[0-9]+)";`
`28`	`28`
	`29`	`+ static readonly string path = $"^{repo}/(?<path>[^ ]+)";`
	`30`	`+`
`29`	`31`	`static readonly Regex windowTitleRepositoryRegex = new Regex($"^{owner}/{repo}: ", RegexOptions.Compiled);`
`30`	`32`	`static readonly Regex windowTitleBranchRegex = new Regex($"^{owner}/{repo} at {branch} ", RegexOptions.Compiled);`
`31`	`33`	`static readonly Regex windowTitlePullRequestRegex = new Regex($" · Pull Request #{pull} · {owner}/{repo} - ", RegexOptions.Compiled);`
`32`	`34`	`static readonly Regex windowTitleIssueRegex = new Regex($" · Issue #{issue} · {owner}/{repo} - ", RegexOptions.Compiled);`
`33`		`- static readonly Regex windowTitlePathRegex = new Regex($" at {branch} · {owner}/{repo} - ", RegexOptions.Compiled);`
	`35`	`+ static readonly Regex windowTitlePathRegex = new Regex($"{path} at {branch} · {owner}/{repo} - ", RegexOptions.Compiled);`
`34`	`36`	`static readonly Regex windowTitleBranchesRegex = new Regex($"Branches · {owner}/{repo} - ", RegexOptions.Compiled);`
`35`	`37`
`36`	`38`	`public GitHubContext FindContextFromUrl(UriString url)`
`@@ -68,7 +70,7 @@ public IEnumerable<string> FindWindowTitlesForClass(string className = "Chrome_W`
`68`	`70`
`69`	`71`	`public GitHubContext FindContextFromWindowTitle(string windowTitle)`
`70`	`72`	`{`
`71`		`- var (success, owner, repo, branch, pullRequest, issue) = MatchWindowTitle(windowTitle);`
	`73`	`+ var (success, owner, repo, branch, pullRequest, issue, path) = MatchWindowTitle(windowTitle);`
`72`	`74`	`if (!success)`
`73`	`75`	`{`
`74`	`76`	`return null;`
`@@ -80,51 +82,52 @@ public GitHubContext FindContextFromWindowTitle(string windowTitle)`
`80`	`82`	`RepositoryName = repo,`
`81`	`83`	`Branch = branch,`
`82`	`84`	`PullRequest = pullRequest,`
`83`		`- Issue = issue`
	`85`	`+ Issue = issue,`
	`86`	`+ Path = path`
`84`	`87`	`};`
`85`	`88`	`}`
`86`	`89`
`87`		`- static (bool success, string owner, string repo, string branch, int? pullRequest, int? issue) MatchWindowTitle(string windowTitle)`
	`90`	`+ static (bool success, string owner, string repo, string branch, int? pullRequest, int? issue, string path) MatchWindowTitle(string windowTitle)`
`88`	`91`	`{`
`89`	`92`	`var match = windowTitlePathRegex.Match(windowTitle);`
`90`	`93`	`if (match.Success)`
`91`	`94`	`{`
`92`		`- return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null);`
	`95`	`+ return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null, match.Groups["path"].Value);`
`93`	`96`	`}`
`94`	`97`
`95`	`98`	`match = windowTitleRepositoryRegex.Match(windowTitle);`
`96`	`99`	`if (match.Success)`
`97`	`100`	`{`
`98`		`- return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null);`
	`101`	`+ return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null, null);`
`99`	`102`	`}`
`100`	`103`
`101`	`104`	`match = windowTitleBranchRegex.Match(windowTitle);`
`102`	`105`	`if (match.Success)`
`103`	`106`	`{`
`104`		`- return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null);`
	`107`	`+ return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, match.Groups["branch"].Value, null, null, null);`
`105`	`108`	`}`
`106`	`109`
`107`	`110`	`match = windowTitleBranchesRegex.Match(windowTitle);`
`108`	`111`	`if (match.Success)`
`109`	`112`	`{`
`110`		`- return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null);`
	`113`	`+ return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, null, null);`
`111`	`114`	`}`
`112`	`115`
`113`	`116`	`match = windowTitlePullRequestRegex.Match(windowTitle);`
`114`	`117`	`if (match.Success)`
`115`	`118`	`{`
`116`	`119`	`int.TryParse(match.Groups["pull"].Value, out int pullRequest);`
`117`		`- return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, pullRequest, null);`
	`120`	`+ return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, pullRequest, null, null);`
`118`	`121`	`}`
`119`	`122`
`120`	`123`	`match = windowTitleIssueRegex.Match(windowTitle);`
`121`	`124`	`if (match.Success)`
`122`	`125`	`{`
`123`	`126`	`int.TryParse(match.Groups["issue"].Value, out int issue);`
`124`		`- return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, issue);`
	`127`	`+ return (match.Success, match.Groups["owner"].Value, match.Groups["repo"].Value, null, null, issue, null);`
`125`	`128`	`}`
`126`	`129`
`127`		`- return (match.Success, null, null, null, null, null);`
	`130`	`+ return (match.Success, null, null, null, null, null, null);`
`128`	`131`	`}`
`129`	`132`
`130`	`133`	`static class User32`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.IO;`
	`3`	`+using System.Linq;`
`3`	`4`	`using System.Windows;`
`4`	`5`	`using System.Threading.Tasks;`
`5`	`6`	`using System.ComponentModel.Composition;`
`@@ -64,10 +65,11 @@ public override async Task Execute(string url)`
`64`	`65`	`gitHubUrl = null;`
`65`	`66`	`}`
`66`	`67`
	`68`	`+ GitHubContext context = null;`
`67`	`69`	`if (gitHubUrl == null)`
`68`	`70`	`{`
`69`	`71`	`// HACK: Reconstruct a GitHub URL from the topmost browser window`
`70`		`- var context = gitHubContextService.Value.FindContextFromBrowser();`
	`72`	`+ context = gitHubContextService.Value.FindContextFromBrowser();`
`71`	`73`	`if (context != null)`
`72`	`74`	`{`
`73`	`75`	`gitHubUrl = $"https://github.com/{context.Owner}/{context.RepositoryName}";`
`@@ -101,7 +103,7 @@ public override async Task Execute(string url)`
`101`	`103`	`}`
`102`	`104`
`103`	`105`	`await TryOpenPullRequest(gitHubUrl);`
`104`		`- TryOpenFile(gitHubUrl, repositoryDir);`
	`106`	`+ TryOpenFile(gitHubUrl, context, repositoryDir);`
`105`	`107`	`}`
`106`	`108`
`107`	`109`	`static bool ContainsDirectory(string repositoryDir, string solutionDir)`
`@@ -135,9 +137,9 @@ static string FindSolutionDirectory(Solution solution)`
`135`	`137`	`return null;`
`136`	`138`	`}`
`137`	`139`
`138`		`- bool TryOpenFile(UriString gitHubUrl, string repositoryDir)`
	`140`	`+ bool TryOpenFile(UriString gitHubUrl, GitHubContext context, string repositoryDir)`
`139`	`141`	`{`
`140`		`- var path = FindSubPath(gitHubUrl, "/blob/master/");`
	`142`	`+ var path = FindSubPath(gitHubUrl, "/blob/master/") ?? context?.Path;`
`141`	`143`	`if (path == null)`
`142`	`144`	`{`
`143`	`145`	`return false;`
`@@ -146,6 +148,13 @@ bool TryOpenFile(UriString gitHubUrl, string repositoryDir)`
`146`	`148`	`var windowsPath = path.Replace('/', '\\');`
`147`	`149`	`var fullPath = Path.Combine(repositoryDir, windowsPath);`
`148`	`150`	`if (!File.Exists(fullPath))`
	`151`	`+ {`
	`152`	`+ // Search by filename only`
	`153`	`+ var fileName = Path.GetFileName(path);`
	`154`	`+ fullPath = Directory.EnumerateFiles(repositoryDir, fileName, SearchOption.AllDirectories).FirstOrDefault();`
	`155`	`+ }`
	`156`	`+`
	`157`	`+ if (fullPath == null)`
`149`	`158`	`{`
`150`	`159`	`return false;`
`151`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -163,5 +163,16 @@ public void Issue(string windowTitle, int expectIssue)`
`163`	`163`
`164`	`164`	`Assert.That(context.Issue, Is.EqualTo(expectIssue));`
`165`	`165`	`}`
	`166`	`+`
	`167`	`+ [TestCase("VisualStudio/mark_github.xaml at master · github/VisualStudio - Google Chrome", "mark_github.xaml")]`
	`168`	`+ [TestCase("VisualStudio/src/GitHub.VisualStudio/Resources/icons at master · github/VisualStudio - Google Chrome", "src/GitHub.VisualStudio/Resources/icons")]`
	`169`	`+ public void Path(string windowTitle, string expectPath)`
	`170`	`+ {`
	`171`	`+ var target = new GitHubContextService();`
	`172`	`+`
	`173`	`+ var context = target.FindContextFromWindowTitle(windowTitle);`
	`174`	`+`
	`175`	`+ Assert.That(context?.Path, Is.EqualTo(expectPath));`
	`176`	`+ }`
`166`	`177`	`}`
`167`	`178`	`}`