Merge pull request #2128 from BertanAygun/StaticReviewFileMap

Static review file map contract implementation

Author: grokys

src/GitHub.App/GitHub.App.csproj

@@ -46,10 +46,18 @@
     <PackageReference Include="LibGit2Sharp.NativeBinaries" Version="1.0.164" />
     <PackageReference Include="Madskristensen.VisualStudio.SDK" Version="14.3.75-pre" />
     <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.1" />
+    <PackageReference Include="Microsoft.VisualStudio.StaticReviews.Embeddable" Version="0.1.14-alpha" />
     <PackageReference Include="Newtonsoft.Json" Version="9.0.1" />
     <PackageReference Include="Rothko" Version="0.0.3-ghfvs" />
     <PackageReference Include="Serilog" Version="2.5.0" />
     <PackageReference Include="SerilogAnalyzer" Version="0.12.0.0" />
     <PackageReference Include="Stateless" Version="2.5.56.0" targetFramework="net45" />
   </ItemGroup>
-</Project>
+  <Target Name="LinkStaticReviewsEmbeddableAssemblies" AfterTargets="ResolveReferences" BeforeTargets="FindReferenceAssembliesForReferences">
+    <ItemGroup>
+      <ReferencePath Condition="'%(FileName)' == 'Microsoft.VisualStudio.StaticReviews.Embeddable'">
+        <EmbedInteropTypes>true</EmbedInteropTypes>
+      </ReferencePath>
+    </ItemGroup>
+  </Target>
+</Project>

src/GitHub.App/Services/PullRequestService.cs

@@ -8,8 +8,10 @@
 using System.Reactive;
 using System.Reactive.Linq;
 using System.Reactive.Threading.Tasks;
+using System.Runtime.InteropServices;
 using System.Text;
 using System.Text.RegularExpressions;
+using System.Threading;
 using System.Threading.Tasks;
 using System.Windows.Forms;
 using GitHub.Api;
@@ -19,6 +21,7 @@
 using GitHub.Models;
 using GitHub.Primitives;
 using LibGit2Sharp;
+using Microsoft.VisualStudio.StaticReviews.Contracts;
 using Octokit.GraphQL;
 using Octokit.GraphQL.Model;
 using Rothko;
@@ -32,7 +35,7 @@ namespace GitHub.Services
 {
     [Export(typeof(IPullRequestService))]
     [PartCreationPolicy(CreationPolicy.Shared)]
-    public class PullRequestService : IPullRequestService
+    public class PullRequestService : IPullRequestService, IStaticReviewFileMap
     {
         const string SettingCreatedByGHfVS = "created-by-ghfvs";
         const string SettingGHfVSPullRequest = "ghfvs-pr-owner-number";
@@ -58,6 +61,8 @@ public class PullRequestService : IPullRequestService
         readonly IOperatingSystem os;
         readonly IUsageTracker usageTracker;
 
+        readonly IDictionary<string, (string commitId, string repoPath)> tempFileMappings;
+   
         [ImportingConstructor]
         public PullRequestService(
             IGitClient gitClient,
@@ -73,6 +78,7 @@ public PullRequestService(
             this.graphqlFactory = graphqlFactory;
             this.os = os;
             this.usageTracker = usageTracker;
+            this.tempFileMappings = new Dictionary<string, (string commitId, string repoPath)>(StringComparer.OrdinalIgnoreCase);
         }
 
         public async Task<Page<PullRequestListItemModel>> ReadPullRequests(
@@ -755,6 +761,12 @@ public async Task<string> ExtractToTempFile(
                 }
             }
 
+            lock (this.tempFileMappings)
+            {
+                string gitRelativePath = relativePath.TrimStart('/').Replace('\\', '/');
+                this.tempFileMappings[CanonicalizeLocalFilePath(tempFilePath)] = (commitSha, gitRelativePath);
+            }
+
             return tempFilePath;
         }
 
@@ -827,6 +839,28 @@ public bool ConfirmCancelPendingReview()
                        MessageBoxIcon.Question) == DialogResult.Yes;
         }
 
+        /// <inheritdoc />
+        public Task<string> GetObjectishFromLocalPathAsync(string localPath, CancellationToken cancellationToken)
+        {
+            lock (this.tempFileMappings)
+            {
+                var canonicalizedPath = CanonicalizeLocalFilePath(localPath);
+                if (this.tempFileMappings.TryGetValue(canonicalizedPath, out (string commitId, string repoPath) result))
+                {
+                    return Task.FromResult($"{result.commitId}:{result.repoPath}");
+                }
+            }
+
+            return Task.FromResult<string>(null);
+        }
+
+        /// <inheritdoc />
+        public Task<string> GetLocalPathFromObjectishAsync(string objectish, CancellationToken cancellationToken)
+        {
+            throw new NotImplementedException();
+        }
+
+
         async Task<string> CreateRemote(IRepository repo, UriString cloneUri)
         {
             foreach (var remote in repo.Network.Remotes)
@@ -1006,6 +1040,12 @@ static string BuildGHfVSConfigKeyValue(string owner, int number)
             return default;
         }
 
+        static string CanonicalizeLocalFilePath(string localPath)
+        {
+            localPath = localPath.Replace("\\\\", "\\");
+            return Path.GetFullPath(localPath);
+        }
+
         class ListItemAdapter : PullRequestListItemModel
         {
             public IList<ReviewAdapter> Reviews { get; set; }

src/GitHub.App/ViewModels/GitHubPane/PullRequestDetailViewModel.cs

@@ -7,6 +7,7 @@
 using System.Reactive;
 using System.Reactive.Linq;
 using System.Reactive.Threading.Tasks;
+using System.Threading;
 using System.Threading.Tasks;
 using GitHub.App;
 using GitHub.Commands;
@@ -17,6 +18,7 @@
 using GitHub.Models;
 using GitHub.Services;
 using LibGit2Sharp;
+using Microsoft.VisualStudio.StaticReviews.Contracts;
 using ReactiveUI;
 using ReactiveUI.Legacy;
 using Serilog;
@@ -28,7 +30,7 @@ namespace GitHub.ViewModels.GitHubPane
     /// <inheritdoc cref="IPullRequestDetailViewModel"/>
     [Export(typeof(IPullRequestDetailViewModel))]
     [PartCreationPolicy(CreationPolicy.NonShared)]
-    public sealed class PullRequestDetailViewModel : PanePageViewModelBase, IPullRequestDetailViewModel
+    public sealed class PullRequestDetailViewModel : PanePageViewModelBase, IPullRequestDetailViewModel, IStaticReviewFileMap
     {
         static readonly ILogger log = LogManager.ForContext<PullRequestDetailViewModel>();
 
@@ -40,6 +42,7 @@ public sealed class PullRequestDetailViewModel : PanePageViewModelBase, IPullReq
         readonly ISyncSubmodulesCommand syncSubmodulesCommand;
         readonly IViewViewModelFactory viewViewModelFactory;
         readonly IGitService gitService;
+
         IModelService modelService;
         PullRequestDetailModel model;
         IActorViewModel author;
@@ -98,6 +101,7 @@ public PullRequestDetailViewModel(
             this.syncSubmodulesCommand = syncSubmodulesCommand;
             this.viewViewModelFactory = viewViewModelFactory;
             this.gitService = gitService;
+
             Files = files;
 
             Checkout = ReactiveCommand.CreateFromObservable(
@@ -137,6 +141,9 @@ public PullRequestDetailViewModel(
             ShowAnnotations = ReactiveCommand.Create<IPullRequestCheckViewModel>(DoShowAnnotations);
         }
 
+        [Import(AllowDefault = true)]
+        private IStaticReviewFileMapManager StaticReviewFileMapManager { get; set; }
+
         private void DoOpenDetailsUrl()
         {
             usageTracker.IncrementCounter(measuresModel => measuresModel.NumberOfPRDetailsOpenInGitHub).Forget();
@@ -490,6 +497,7 @@ public string GetLocalFilePath(IPullRequestFileNode file)
         public override void Activated()
         {
             active = true;
+            this.StaticReviewFileMapManager?.RegisterStaticReviewFileMap(this);
 
             if (refreshOnActivate)
             {
@@ -499,7 +507,43 @@ public override void Activated()
         }
 
         /// <inheritdoc/>
-        public override void Deactivated() => active = false;
+        public override void Deactivated()
+        {
+            this.StaticReviewFileMapManager?.UnregisterStaticReviewFileMap(this);
+            active = false;
+        }
+
+        /// <inheritdoc/>
+        public Task<string> GetLocalPathFromObjectishAsync(string objectish, CancellationToken cancellationToken)
+        {
+            if (this.pullRequestsService != null)
+            {
+                string commitId = objectish.Substring(0, objectish.IndexOf(':'));
+                string relativePath = objectish.Substring(objectish.IndexOf(':')+1).TrimStart('/');
+
+                return this.pullRequestsService.ExtractToTempFile(
+                    this.Session.LocalRepository,
+                    this.Session.PullRequest,
+                    relativePath,
+                    commitId,
+                    this.pullRequestsService.GetEncoding(this.Session.LocalRepository, relativePath));
+            }
+
+            return Task.FromResult<string>(null);
+        }
+
+        /// <inheritdoc/>
+        public Task<string> GetObjectishFromLocalPathAsync(string localPath, CancellationToken cancellationToken)
+        {
+            // We rely on pull request service's global map here instead of trying to get it from IPullRequestSessionManager via ITextBuffer
+            // because it is possible that the file queried wasn't opened by GitHub extension and instead was opened by LSP
+            if (this.pullRequestsService is IStaticReviewFileMap staticReviewFileMap)
+            {
+                return staticReviewFileMap.GetObjectishFromLocalPathAsync(localPath, cancellationToken);
+            }
+
+            return Task.FromResult<string>(null);
+        }
 
         /// <inheritdoc/>
         protected override void Dispose(bool disposing)