Merge pull request #553 from github/fixes/343-latest-remote-commit

Generate Copy/Open link based on the latest commit

Author: shana

src/GitHub.Exports/Models/ILocalRepositoryModel.cs

@@ -1,5 +1,6 @@
 using GitHub.Primitives;
 using System.ComponentModel;
+using System.Threading.Tasks;
 
 namespace GitHub.Models
 {
@@ -31,6 +32,6 @@ public interface ILocalRepositoryModel : IRepositoryModel, INotifyPropertyChange
         /// <param name="startLine">A specific line, or (if specifying the <paramref name="endLine"/> as well) the start of a range</param>
         /// <param name="endLine">The end of a line range on the specified file.</param>
         /// <returns>An UriString with the generated url, or null if the repository has no remote server configured or if it can't be found locally</returns>
-        UriString GenerateUrl(string path = null, int startLine = -1, int endLine = -1);
+        Task<UriString> GenerateUrl(string path = null, int startLine = -1, int endLine = -1);
     }
 }

src/GitHub.Exports/Models/LocalRepositoryModel.cs

@@ -7,6 +7,7 @@
 using GitHub.UI;
 using GitHub.Services;
 using GitHub.Extensions;
+using System.Threading.Tasks;
 
 namespace GitHub.Models
 {
@@ -60,12 +61,12 @@ public void Refresh()
         /// <param name="startLine">A specific line, or (if specifying the <paramref name="endLine"/> as well) the start of a range</param>
         /// <param name="endLine">The end of a line range on the specified file.</param>
         /// <returns>An UriString with the generated url, or null if the repository has no remote server configured or if it can't be found locally</returns>
-        public UriString GenerateUrl(string path = null, int startLine = -1, int endLine = -1)
+        public async Task<UriString> GenerateUrl(string path = null, int startLine = -1, int endLine = -1)
         {
             if (CloneUrl == null)
                 return null;
 
-            var sha = HeadSha;
+            var sha = await GitService.GitServiceHelper.GetLatestPushedSha(path ?? LocalPath);
             // this also incidentally checks whether the repo has a valid LocalPath
             if (String.IsNullOrEmpty(sha))
                 return CloneUrl.ToRepositoryUrl().AbsoluteUri;

src/GitHub.Exports/Services/GitService.cs

@@ -4,6 +4,8 @@
 using System;
 using System.Threading.Tasks;
 using GitHub.Models;
+using System.Linq;
+using GitHub.Extensions;
 
 namespace GitHub.Services
 {
@@ -70,5 +72,39 @@ public UriString GetRemoteUri(IRepository repo, string remote = "origin")
         }
 
         public static IGitService GitServiceHelper => VisualStudio.Services.DefaultExportProvider.GetExportedValueOrDefault<IGitService>() ?? new GitService();
+
+        /// <summary>
+        /// Finds the latest pushed commit of a file and returns the sha of that commit. Returns null when no commits have 
+        /// been found in any remote branches or the current local branch. 
+        /// </summary>
+        /// <param name="path">The local path of a repository or a file inside a repository. This cannot be null.</param>
+        /// <returns></returns>
+        public Task<string> GetLatestPushedSha(string path)
+        {
+            Guard.ArgumentNotNull(path, nameof(path));
+            var repo = GetRepository(path);
+
+            if (repo == null)
+                return null;
+
+            if (repo.Head.IsTracking && repo.Head.Tip.Sha == repo.Head.TrackedBranch.Tip.Sha)
+            {
+                return Task.FromResult(repo.Head.Tip.Sha);
+            }
+
+            return Task.Factory.StartNew(() =>
+             {
+                 var remoteHeads = repo.Refs.Where(r => r.IsRemoteTrackingBranch).ToList();
+
+                 foreach (var c in repo.Commits)
+                 {
+                     if (repo.Refs.ReachableFrom(remoteHeads, new[] { c }).Any())
+                     {
+                         return c.Sha;
+                     }
+                 }
+                 return null;
+             });
+        }
     }
 }

src/GitHub.Exports/Services/IGitService.cs

@@ -1,3 +1,4 @@
+using System.Threading.Tasks;
 using GitHub.Models;
 using GitHub.Primitives;
 using LibGit2Sharp;
@@ -44,5 +45,13 @@ public interface IGitService
         /// <param name="repo"></param>
         /// <returns></returns>
         UriString GetRemoteUri(IRepository repo, string remote = "origin");
+
+        /// <summary>
+        /// Finds the latest pushed commit of a file and returns the sha of that commit. Returns null when no commits have 
+        /// been found in any remote branches or the current local branch. 
+        /// </summary>
+        /// <param name="path">The local path of a repository or a file inside a repository. This cannot be null.</param>
+        /// <returns></returns>
+        Task<string> GetLatestPushedSha(string path);
     }
 }

src/GitHub.VisualStudio/Menus/CopyLink.cs

@@ -33,7 +33,7 @@ public async void Activate([AllowNull]object data = null)
             if (!isgithub)
                 return;
 
-            var link = GenerateLink();
+            var link = await GenerateLink();
             if (link == null)
                 return;
             try

src/GitHub.VisualStudio/Menus/LinkMenuBase.cs

@@ -2,6 +2,7 @@
 using GitHub.Extensions;
 using GitHub.Primitives;
 using System;
+using System.Threading.Tasks;
 
 namespace GitHub.VisualStudio.Menus
 {
@@ -12,7 +13,7 @@ public LinkMenuBase(IServiceProvider serviceProvider, ISimpleApiClientFactory ap
         {
         }
 
-        protected UriString GenerateLink()
+        protected Task<UriString> GenerateLink()
         {
             var repo = ActiveRepo;
             var activeDocument = ServiceProvider.GetExportedValue<IActiveDocumentSnapshot>();

src/GitHub.VisualStudio/Menus/OpenLink.cs

@@ -31,7 +31,7 @@ public async void Activate([AllowNull]object data = null)
             if (!isgithub)
                 return;
 
-            var link = GenerateLink();
+            var link = await GenerateLink();
             if (link == null)
                 return;
             var browser = ServiceProvider.GetExportedValue<IVisualStudioBrowser>();

src/UnitTests/GitHub.Exports/LocalRepositoryModelTests.cs

@@ -7,6 +7,8 @@
 using Xunit;
 using GitHub.Primitives;
 using Xunit.Abstractions;
+using System.Collections.Generic;
+using System.Threading.Tasks;
 
 [Collection("PackageServiceProvider global data tests")]
 public class LocalRepositoryModelTests : TestBaseClass
@@ -24,8 +26,13 @@ static void SetupRepository(string sha)
         var gitservice = provider.GetGitService();
         var repo = Substitute.For<IRepository>();
         gitservice.GetRepository(Args.String).Returns(repo);
+        gitservice.GetLatestPushedSha(Args.String).Returns(Task.FromResult(sha));
         if (!String.IsNullOrEmpty(sha))
         {
+            var refs = Substitute.For<ReferenceCollection>();
+            var refrence = Substitute.For<Reference>();
+            refs.ReachableFrom(Arg.Any<IEnumerable<Reference>>(), Arg.Any<IEnumerable<Commit>>()).Returns(new Reference[] { refrence });
+            repo.Refs.Returns(refs);
             var commit = Substitute.For<Commit>();
             commit.Sha.Returns(sha);
             repo.Commits.Returns(new FakeCommitLog { commit });
@@ -54,7 +61,7 @@ static void SetupRepository(string sha)
     [InlineData(19, false, "[email protected]/foo/bar", "123123", @"src\dir\file1.cs", -1, -1, "https://github.com/foo/bar/blob/123123/src/dir/file1.cs")]
     [InlineData(20, false, "[email protected]/foo/bar", "123123", @"src\dir\File1.cs", -1, -1, "https://github.com/foo/bar/blob/123123/src/dir/File1.cs")]
     [InlineData(21, false, "[email protected]/foo/bar", "123123", @"src\dir\ThisIsFile1.cs", -1, -1, "https://github.com/foo/bar/blob/123123/src/dir/ThisIsFile1.cs")]
-    public void GenerateUrl(int testid, bool createRootedPath, string baseUrl, string sha, string path, int startLine, int endLine, string expected)
+    public async void GenerateUrl(int testid, bool createRootedPath, string baseUrl, string sha, string path, int startLine, int endLine, string expected)
     {
         using (var temp = new TempDirectory())
         {
@@ -68,7 +75,7 @@ public void GenerateUrl(int testid, bool createRootedPath, string baseUrl, strin
                 model = new LocalRepositoryModel("bar", new UriString(baseUrl), basePath.FullName);
             else
                 model = new LocalRepositoryModel(basePath.FullName);
-            var result = model.GenerateUrl(path, startLine, endLine);
+            var result = await model.GenerateUrl(path, startLine, endLine);
             Assert.Equal(expected, result?.ToString());
         }
     }