Display most recent draft when diff opened.

grokys · grokys · commit 8bddb0ddc1bb · 2018-10-15T16:42:39.000+02:00
diff --git a/src/GitHub.App/Models/Drafts/CommentDraft.cs b/src/GitHub.App/Models/Drafts/CommentDraft.cs
@@ -1,7 +1,15 @@
-﻿namespace GitHub.App.Models.Drafts
+﻿using GitHub.ViewModels;
+
+namespace GitHub.Models.Drafts
 {
+    /// <summary>
+    /// Stores a draft for a <see cref="CommentViewModel"/>
+    /// </summary>
     public class CommentDraft
     {
+        /// <summary>
+        /// Gets or sets the draft comment body.
+        /// </summary>
         public string Body { get; set; }
     }
 }
diff --git a/src/GitHub.App/Models/Drafts/PullRequestReviewCommentDraft.cs b/src/GitHub.App/Models/Drafts/PullRequestReviewCommentDraft.cs
@@ -0,0 +1,21 @@
+﻿using System;
+using GitHub.ViewModels;
+
+namespace GitHub.Models.Drafts
+{
+    /// <summary>
+    /// Stores a draft for a <see cref="PullRequestReviewCommentViewModel"/>
+    /// </summary>
+    public class PullRequestReviewCommentDraft : CommentDraft
+    {
+        /// <summary>
+        /// Gets or sets the side of the diff that the draft comment was left on.
+        /// </summary>
+        public DiffSide Side { get; set; }
+
+        /// <summary>
+        /// Gets or sets the time that the draft was last updated.
+        /// </summary>
+        public DateTimeOffset UpdatedAt { get; set; }
+    }
+}
diff --git a/src/GitHub.App/Services/PullRequestEditorService.cs b/src/GitHub.App/Services/PullRequestEditorService.cs
@@ -5,9 +5,12 @@
 using System.Linq;
 using System.Reactive.Linq;
 using System.Threading.Tasks;
+using EnvDTE;
 using GitHub.Commands;
 using GitHub.Extensions;
 using GitHub.Models;
+using GitHub.Models.Drafts;
+using GitHub.ViewModels;
 using GitHub.VisualStudio;
 using Microsoft.VisualStudio;
 using Microsoft.VisualStudio.Editor;
@@ -18,7 +21,6 @@
 using Microsoft.VisualStudio.Text.Editor;
 using Microsoft.VisualStudio.Text.Projection;
 using Microsoft.VisualStudio.TextManager.Interop;
-using EnvDTE;
 using Task = System.Threading.Tasks.Task;
 
 namespace GitHub.Services
@@ -39,6 +41,8 @@ public class PullRequestEditorService : IPullRequestEditorService
         readonly IStatusBarNotificationService statusBar;
         readonly IGoToSolutionOrPullRequestFileCommand goToSolutionOrPullRequestFileCommand;
         readonly IEditorOptionsFactoryService editorOptionsFactoryService;
+        readonly IMessageDraftStore draftStore;
+        readonly IInlineCommentPeekService peekService;
         readonly IUsageTracker usageTracker;
 
         [ImportingConstructor]
@@ -49,6 +53,8 @@ public PullRequestEditorService(
             IStatusBarNotificationService statusBar,
             IGoToSolutionOrPullRequestFileCommand goToSolutionOrPullRequestFileCommand,
             IEditorOptionsFactoryService editorOptionsFactoryService,
+            IMessageDraftStore draftStore,
+            IInlineCommentPeekService peekService,
             IUsageTracker usageTracker)
         {
             Guard.ArgumentNotNull(serviceProvider, nameof(serviceProvider));
@@ -58,13 +64,17 @@ public PullRequestEditorService(
             Guard.ArgumentNotNull(goToSolutionOrPullRequestFileCommand, nameof(goToSolutionOrPullRequestFileCommand));
             Guard.ArgumentNotNull(goToSolutionOrPullRequestFileCommand, nameof(editorOptionsFactoryService));
             Guard.ArgumentNotNull(usageTracker, nameof(usageTracker));
+            Guard.ArgumentNotNull(peekService, nameof(peekService));
+            Guard.ArgumentNotNull(draftStore, nameof(draftStore));
 
             this.serviceProvider = serviceProvider;
             this.pullRequestService = pullRequestService;
             this.vsEditorAdaptersFactory = vsEditorAdaptersFactory;
             this.statusBar = statusBar;
             this.goToSolutionOrPullRequestFileCommand = goToSolutionOrPullRequestFileCommand;
             this.editorOptionsFactoryService = editorOptionsFactoryService;
+            this.draftStore = draftStore;
+            this.peekService = peekService;
             this.usageTracker = usageTracker;
         }
 
@@ -129,7 +139,7 @@ public async Task<ITextView> OpenFile(
         }
 
         /// <inheritdoc/>
-        public async Task<IDifferenceViewer> OpenDiff(IPullRequestSession session, string relativePath, string headSha, bool scrollToFirstDiff)
+        public async Task<IDifferenceViewer> OpenDiff(IPullRequestSession session, string relativePath, string headSha, bool scrollToFirstDraftOrDiff)
         {
             Guard.ArgumentNotNull(session, nameof(session));
             Guard.ArgumentNotEmptyString(relativePath, nameof(relativePath));
@@ -168,12 +178,37 @@ await pullRequestService.ExtractToTempFile(
                 var caption = $"Diff - {Path.GetFileName(file.RelativePath)}";
                 var options = __VSDIFFSERVICEOPTIONS.VSDIFFOPT_DetectBinaryFiles |
                     __VSDIFFSERVICEOPTIONS.VSDIFFOPT_LeftFileIsTemporary;
+                var openThread = (line: -1, side: DiffSide.Left);
+                var scrollToFirstDiff = false;
 
                 if (!workingDirectory)
                 {
                     options |= __VSDIFFSERVICEOPTIONS.VSDIFFOPT_RightFileIsTemporary;
                 }
 
+                if (scrollToFirstDraftOrDiff)
+                {
+                    var (key, _) = PullRequestReviewCommentThreadViewModel.GetDraftKeys(
+                        session.LocalRepository.CloneUrl.WithOwner(session.RepositoryOwner),
+                        session.PullRequest.Number,
+                        relativePath,
+                        0);
+                    var drafts = (await draftStore.GetDrafts<PullRequestReviewCommentDraft>(key)
+                        .ConfigureAwait(true))
+                        .OrderByDescending(x => x.data.UpdatedAt)
+                        .ToList();
+
+                    if (drafts.Count > 0 && int.TryParse(drafts[0].secondaryKey, out var line))
+                    {
+                        openThread = (line, drafts[0].data.Side);
+                        scrollToFirstDiff = false;
+                    }
+                    else
+                    {
+                        scrollToFirstDiff = true;
+                    }
+                }
+
                 IVsWindowFrame frame;
                 using (OpenWithOption(DifferenceViewerOptions.ScrollToFirstDiffName, scrollToFirstDiff))
                 using (OpenInProvisionalTab())
@@ -228,6 +263,18 @@ await pullRequestService.ExtractToTempFile(
                 else
                     await usageTracker.IncrementCounter(x => x.NumberOfPRDetailsViewChanges);
 
+                if (openThread.line != -1)
+                {
+                    var view = diffViewer.ViewMode == DifferenceViewMode.Inline ?
+                        diffViewer.InlineView :
+                        openThread.side == DiffSide.Left ? diffViewer.LeftView : diffViewer.RightView;
+                    
+                    // HACK: We need to wait here for the view to initialize or the peek session won't appear.
+                    // There must be a better way of doing this.
+                    await Task.Delay(1500).ConfigureAwait(true);
+                    peekService.Show(view, openThread.side, openThread.line);
+                }
+
                 return diffViewer;
             }
             catch (Exception e)
@@ -247,7 +294,7 @@ public async Task<IDifferenceViewer> OpenDiff(
             Guard.ArgumentNotEmptyString(relativePath, nameof(relativePath));
             Guard.ArgumentNotNull(thread, nameof(thread));
 
-            var diffViewer = await OpenDiff(session, relativePath, thread.CommitSha, scrollToFirstDiff: false);
+            var diffViewer = await OpenDiff(session, relativePath, thread.CommitSha, scrollToFirstDraftOrDiff: false);
 
             var param = (object)new InlineCommentNavigationParams
             {
diff --git a/src/GitHub.App/ViewModels/CommentThreadViewModel.cs b/src/GitHub.App/ViewModels/CommentThreadViewModel.cs
@@ -5,9 +5,9 @@
 using System.Reactive.Linq;
 using System.Reactive.Subjects;
 using System.Threading.Tasks;
-using GitHub.App.Models.Drafts;
 using GitHub.Extensions;
 using GitHub.Models;
+using GitHub.Models.Drafts;
 using GitHub.Services;
 using ReactiveUI;
 
diff --git a/src/GitHub.App/ViewModels/PullRequestReviewCommentThreadViewModel.cs b/src/GitHub.App/ViewModels/PullRequestReviewCommentThreadViewModel.cs
@@ -3,10 +3,10 @@
 using System.Globalization;
 using System.Linq;
 using System.Threading.Tasks;
-using GitHub.App.Models.Drafts;
 using GitHub.Extensions;
 using GitHub.Factories;
 using GitHub.Models;
+using GitHub.Models.Drafts;
 using GitHub.Primitives;
 using GitHub.Services;
 using ReactiveUI;
@@ -133,9 +133,9 @@ public async Task InitializeNewAsync(
             Comments.Add(vm);
 
             var (key, secondaryKey) = GetDraftKeys(vm);
-            var draft = await DraftStore.GetDraft<CommentDraft>(key, secondaryKey).ConfigureAwait(true);
+            var draft = await DraftStore.GetDraft<PullRequestReviewCommentDraft>(key, secondaryKey).ConfigureAwait(true);
 
-            if (draft != null)
+            if (draft?.Side == side)
             {
                 vm.Body = draft.Body;
             }
@@ -193,13 +193,19 @@ public static (string key, string secondaryKey) GetDraftKeys(
             string relativePath,
             int lineNumber)
         {
+            relativePath = relativePath.Replace("\\", "/");
             var key = Invariant($"pr-review-comment|{cloneUri}|{pullRequestNumber}|{relativePath}");
             return (key, lineNumber.ToString(CultureInfo.InvariantCulture));
         }
 
         protected override CommentDraft BuildDraft(ICommentViewModel comment)
         {
-            return base.BuildDraft(comment);
+            return new PullRequestReviewCommentDraft
+            {
+                Body = comment.Body,
+                Side = Side,
+                UpdatedAt = DateTimeOffset.UtcNow,
+            };
         }
 
         protected override (string key, string secondaryKey) GetDraftKeys(ICommentViewModel comment)
diff --git a/test/GitHub.App.UnitTests/Services/PullRequestEditorServiceTests.cs b/test/GitHub.App.UnitTests/Services/PullRequestEditorServiceTests.cs
@@ -56,6 +56,8 @@ static PullRequestEditorService CreateNavigationService()
         var statusBar = Substitute.For<IStatusBarNotificationService>();
         var openFileInSolutionCommand = Substitute.For<IGoToSolutionOrPullRequestFileCommand>();
         var editorOptionsFactoryService = Substitute.For<IEditorOptionsFactoryService>();
+        var draftStore = Substitute.For<IMessageDraftStore>();
+        var peekService = Substitute.For<IInlineCommentPeekService>();
         var usageTracker = Substitute.For<IUsageTracker>();
         return new PullRequestEditorService(
             sp,
@@ -64,6 +66,8 @@ static PullRequestEditorService CreateNavigationService()
             statusBar,
             openFileInSolutionCommand,
             editorOptionsFactoryService,
+            draftStore,
+            peekService,
             usageTracker);
     }
 }
diff --git a/test/GitHub.App.UnitTests/ViewModels/CommentThreadViewModelTests.cs b/test/GitHub.App.UnitTests/ViewModels/CommentThreadViewModelTests.cs
@@ -1,8 +1,8 @@
 ﻿using System;
 using System.Reactive.Concurrency;
 using System.Threading.Tasks;
-using GitHub.App.Models.Drafts;
 using GitHub.Models;
+using GitHub.Models.Drafts;
 using GitHub.Services;
 using GitHub.ViewModels;
 using NSubstitute;
diff --git a/test/GitHub.App.UnitTests/ViewModels/PullRequestReviewCommentThreadViewModelTests.cs b/test/GitHub.App.UnitTests/ViewModels/PullRequestReviewCommentThreadViewModelTests.cs
@@ -1,12 +1,11 @@
-﻿using System;
-using System.Collections.Generic;
+﻿using System.Collections.Generic;
 using System.Linq;
 using System.Reactive.Concurrency;
 using System.Reactive.Linq;
 using System.Threading.Tasks;
-using GitHub.App.Models.Drafts;
 using GitHub.Factories;
 using GitHub.Models;
+using GitHub.Models.Drafts;
 using GitHub.Primitives;
 using GitHub.Services;
 using GitHub.ViewModels;

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,15 @@`
`1`		`-namespace GitHub.App.Models.Drafts`
	`1`	`+using GitHub.ViewModels;`
	`2`	`+`
	`3`	`+namespace GitHub.Models.Drafts`
`2`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// Stores a draft for a <see cref="CommentViewModel"/>`
	`7`	`+ /// </summary>`
`3`	`8`	`public class CommentDraft`
`4`	`9`	`{`
	`10`	`+ /// <summary>`
	`11`	`+ /// Gets or sets the draft comment body.`
	`12`	`+ /// </summary>`
`5`	`13`	`public string Body { get; set; }`
`6`	`14`	`}`
`7`	`15`	`}`