Merge pull request #1900 from github/features/check-suite-annotations-inline

Check Run Annotations Inline

Author: grokys

src/GitHub.App/SampleData/CommentThreadViewModelDesigner.cs

@@ -1,5 +1,7 @@
-using System.Diagnostics.CodeAnalysis;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
+using GitHub.Models;
 using GitHub.ViewModels;
 using ReactiveUI;
 
@@ -8,6 +10,16 @@ namespace GitHub.SampleData
     [SuppressMessage("Microsoft.Performance", "CA1812:AvoidUninstantiatedInternalClasses")]
     public class CommentThreadViewModelDesigner : ViewModelBase, ICommentThreadViewModel
     {
+        public CommentThreadViewModelDesigner()
+        {
+            Comments = new ReactiveList<ICommentViewModel>(){new CommentViewModelDesigner()
+            {
+                Author = new ActorViewModel{ Login = "shana"},
+                Body = "You can use a `CompositeDisposable` type here, it's designed to handle disposables in an optimal way (you can just call `Dispose()` on it and it will handle disposing everything it holds)."
+            }};
+
+        }
+
         public IReadOnlyReactiveList<ICommentViewModel> Comments { get; }
             = new ReactiveList<ICommentViewModel>();
 

src/GitHub.App/SampleData/InlineAnnotationViewModelDesigner.cs

@@ -0,0 +1,40 @@
+using System.Collections.Generic;
+using GitHub.Models;
+using GitHub.ViewModels;
+
+namespace GitHub.SampleData
+{
+    public class InlineAnnotationViewModelDesigner : IInlineAnnotationViewModel
+    {
+        public InlineAnnotationViewModelDesigner()
+        {
+            var checkRunAnnotationModel = new CheckRunAnnotationModel
+            {
+                AnnotationLevel = CheckAnnotationLevel.Failure,
+                Path = "SomeFile.cs",
+                EndLine = 12,
+                StartLine = 12,
+                Message = "Some Error Message",
+                Title = "CS12345"
+            };
+
+            var checkRunModel =
+                new CheckRunModel
+                {
+                    Annotations = new List<CheckRunAnnotationModel> {checkRunAnnotationModel},
+                    Name = "Fake Check Run"
+                };
+
+            var checkSuiteModel = new CheckSuiteModel()
+            {
+                ApplicationName = "Fake Check Suite",
+                HeadSha = "ed6198c37b13638e902716252b0a17d54bd59e4a",
+                CheckRuns = new List<CheckRunModel> { checkRunModel}
+            };
+
+            Model= new InlineAnnotationModel(checkSuiteModel, checkRunModel, checkRunAnnotationModel);
+        }
+
+        public InlineAnnotationModel Model { get; }
+    }
+}

src/GitHub.App/SampleData/PullRequestAnnotationItemViewModelDesigner.cs

@@ -12,7 +12,7 @@ public sealed class PullRequestAnnotationItemViewModelDesigner : IPullRequestAnn
         public CheckRunAnnotationModel Annotation { get; set; }
         public bool IsExpanded { get; set; }
         public string LineDescription => $"{Annotation.StartLine}:{Annotation.EndLine}";
-        public bool IsFileInPullRequest { get; }
+        public bool IsFileInPullRequest { get; set;  }
         public ReactiveCommand<Unit, Unit> OpenAnnotation { get; }
     }
 }

src/GitHub.App/SampleData/PullRequestAnnotationsViewModelDesigner.cs

@@ -40,6 +40,7 @@ public sealed class PullRequestAnnotationsViewModelDesigner : PanePageViewModelB
                                 Title = "CS 12345"
                             },
                             IsExpanded = true,
+                            IsFileInPullRequest = true
                         },
                         new PullRequestAnnotationItemViewModelDesigner
                         {
@@ -53,6 +54,7 @@ public sealed class PullRequestAnnotationsViewModelDesigner : PanePageViewModelB
                                 Title = "CS 12345"
                             },
                             IsExpanded = true,
+                            IsFileInPullRequest = true
                         },
                     }
                 },

src/GitHub.App/SampleData/PullRequestCheckViewModelDesigner.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Reactive;
-using System.Windows.Media.Imaging;
 using GitHub.Models;
 using GitHub.ViewModels;
 using GitHub.ViewModels.GitHubPane;

src/GitHub.App/SampleData/PullRequestFilesViewModelDesigner.cs

@@ -36,6 +36,9 @@ public PullRequestFilesViewModelDesigner()
         public ReactiveCommand<IPullRequestFileNode, Unit> DiffFileWithWorkingDirectory { get; }
         public ReactiveCommand<IPullRequestFileNode, Unit> OpenFileInWorkingDirectory { get; }
         public ReactiveCommand<IPullRequestFileNode, Unit> OpenFirstComment { get; }
+        public ReactiveCommand<IPullRequestFileNode, Unit> OpenFirstAnnotationNotice { get; }
+        public ReactiveCommand<IPullRequestFileNode, Unit> OpenFirstAnnotationWarning { get; }
+        public ReactiveCommand<IPullRequestFileNode, Unit> OpenFirstAnnotationFailure { get; }
 
         public Task InitializeAsync(
             IPullRequestSession session,

src/GitHub.App/Services/PullRequestEditorService.cs

@@ -285,7 +285,7 @@ await pullRequestService.ExtractToTempFile(
         }
 
         /// <inheritdoc/>
-        public async Task<IDifferenceViewer> OpenDiff(
+        public Task<IDifferenceViewer> OpenDiff(
             IPullRequestSession session,
             string relativePath,
             IInlineCommentThreadModel thread)
@@ -294,11 +294,17 @@ public async Task<IDifferenceViewer> OpenDiff(
             Guard.ArgumentNotEmptyString(relativePath, nameof(relativePath));
             Guard.ArgumentNotNull(thread, nameof(thread));
 
-            var diffViewer = await OpenDiff(session, relativePath, thread.CommitSha, scrollToFirstDraftOrDiff: false);
+            return OpenDiff(session, relativePath, thread.CommitSha, thread.LineNumber - 1);
+        }
+
+        /// <inheritdoc/>
+        public async Task<IDifferenceViewer> OpenDiff(IPullRequestSession session, string relativePath, string headSha, int fromLine)
+        {
+            var diffViewer = await OpenDiff(session, relativePath, headSha, scrollToFirstDraftOrDiff: false);
 
-            var param = (object)new InlineCommentNavigationParams
+            var param = (object) new InlineCommentNavigationParams
             {
-                FromLine = thread.LineNumber - 1,
+                FromLine = fromLine,
             };
 
             // HACK: We need to wait here for the inline comment tags to initialize so we can find the next inline comment.

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

@@ -1,5 +1,7 @@
 using System.Reactive;
+using System.Reactive.Linq;
 using GitHub.Models;
+using GitHub.Services;
 using ReactiveUI;
 
 namespace GitHub.ViewModels.GitHubPane
@@ -14,12 +16,22 @@ public class PullRequestAnnotationItemViewModel : ViewModelBase, IPullRequestAnn
         /// </summary>
         /// <param name="annotation">The check run annotation model.</param>
         /// <param name="isFileInPullRequest">A flag that denotes if the annotation is part of the pull request's changes.</param>
-        public PullRequestAnnotationItemViewModel(CheckRunAnnotationModel annotation, bool isFileInPullRequest)
+        /// <param name="checkSuite">The check suite model.</param>
+        /// <param name="session">The pull request session.</param>
+        /// <param name="editorService">The pull request editor service.</param>
+        public PullRequestAnnotationItemViewModel(
+            CheckRunAnnotationModel annotation,
+            bool isFileInPullRequest,
+            CheckSuiteModel checkSuite,
+            IPullRequestSession session,
+            IPullRequestEditorService editorService)
         {
             Annotation = annotation;
             IsFileInPullRequest = isFileInPullRequest;
 
-            OpenAnnotation = ReactiveCommand.Create(() => { });
+            OpenAnnotation = ReactiveCommand.CreateFromTask<Unit>(
+                async _ => await editorService.OpenDiff(session, annotation.Path, checkSuite.HeadSha, annotation.EndLine - 1),
+                Observable.Return(IsFileInPullRequest));
         }
 
         /// <inheritdoc />

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

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
 using System.Linq;
@@ -15,7 +15,8 @@ namespace GitHub.ViewModels.GitHubPane
     [PartCreationPolicy(CreationPolicy.NonShared)]
     public class PullRequestAnnotationsViewModel : PanePageViewModelBase, IPullRequestAnnotationsViewModel
     {
-        private readonly IPullRequestSessionManager sessionManager;
+        readonly IPullRequestSessionManager sessionManager;
+        readonly IPullRequestEditorService pullRequestEditorService;
 
         IPullRequestSession session;
         string title;
@@ -29,10 +30,12 @@ public class PullRequestAnnotationsViewModel : PanePageViewModelBase, IPullReque
         /// Initializes a new instance of the <see cref="PullRequestAnnotationsViewModel"/> class.
         /// </summary>
         /// <param name="sessionManager">The pull request session manager.</param>
+        /// <param name="pullRequestEditorService">The pull request editor service.</param>
         [ImportingConstructor]
-        public PullRequestAnnotationsViewModel(IPullRequestSessionManager sessionManager)
+        public PullRequestAnnotationsViewModel(IPullRequestSessionManager sessionManager, IPullRequestEditorService pullRequestEditorService)
         {
             this.sessionManager = sessionManager;
+            this.pullRequestEditorService = pullRequestEditorService;
             NavigateToPullRequest = ReactiveCommand.Create(() => {
                     NavigateTo(FormattableString.Invariant(
                         $"{LocalRepository.Owner}/{LocalRepository.Name}/pull/{PullRequestNumber}"));
@@ -151,7 +154,7 @@ void Load(PullRequestDetailModel pullRequest)
                     .ToDictionary(
                         path => path,
                         path => annotationsLookup[path]
-                            .Select(annotation => new PullRequestAnnotationItemViewModel(annotation, changedFiles.Contains(path)))
+                            .Select(annotation => new PullRequestAnnotationItemViewModel(annotation, changedFiles.Contains(path), checkSuiteRun.checkSuite, session, pullRequestEditorService))
                             .Cast<IPullRequestAnnotationItemViewModel>()
                             .ToArray()
                         );

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

@@ -7,6 +7,7 @@
 using GitHub.Extensions;
 using GitHub.Factories;
 using GitHub.Models;
+using GitHub.Primitives;
 using GitHub.Services;
 using ReactiveUI;
 
@@ -17,6 +18,8 @@ namespace GitHub.ViewModels.GitHubPane
     [PartCreationPolicy(CreationPolicy.NonShared)]
     public class PullRequestCheckViewModel: ViewModelBase, IPullRequestCheckViewModel
     {
+        const string DefaultAvatar = "pack://application:,,,/GitHub.App;component/Images/default_user_avatar.png";
+
         private readonly IUsageTracker usageTracker;
 
         /// <summary>
@@ -56,11 +59,14 @@ public static IEnumerable<IPullRequestCheckViewModel> Build(IViewViewModelFactor
                 return pullRequestCheckViewModel;
             }) ?? Array.Empty<PullRequestCheckViewModel>();
 
-            var checks = pullRequest.CheckSuites?.SelectMany(checkSuiteModel => checkSuiteModel.CheckRuns)
-                .Select(checkRunModel =>
+            var checks = 
+                pullRequest.CheckSuites?
+                    .SelectMany(checkSuite => checkSuite.CheckRuns
+                        .Select(checkRun => new { checkSuiteModel = checkSuite, checkRun}))
+                .Select(arg =>
                 {
                     PullRequestCheckStatus checkStatus;
-                    switch (checkRunModel.Status)
+                    switch (arg.checkRun.Status)
                     {
                         case CheckStatusState.Requested:
                         case CheckStatusState.Queued:
@@ -69,7 +75,7 @@ public static IEnumerable<IPullRequestCheckViewModel> Build(IViewViewModelFactor
                             break;
 
                         case CheckStatusState.Completed:
-                            switch (checkRunModel.Conclusion)
+                            switch (arg.checkRun.Conclusion)
                             {
                                 case CheckConclusionState.Success:
                                     checkStatus = PullRequestCheckStatus.Success;
@@ -94,13 +100,12 @@ public static IEnumerable<IPullRequestCheckViewModel> Build(IViewViewModelFactor
 
                     var pullRequestCheckViewModel = (PullRequestCheckViewModel)viewViewModelFactory.CreateViewModel<IPullRequestCheckViewModel>();
                     pullRequestCheckViewModel.CheckType = PullRequestCheckType.ChecksApi;
-                    pullRequestCheckViewModel.CheckRunId = checkRunModel.Id;
-                    pullRequestCheckViewModel.HasAnnotations = checkRunModel.Annotations?.Any() ?? false;
-                    pullRequestCheckViewModel.Title = checkRunModel.Name;
-                    pullRequestCheckViewModel.Description = checkRunModel.Summary;
+                    pullRequestCheckViewModel.CheckRunId = arg.checkRun.Id;
+                    pullRequestCheckViewModel.HasAnnotations = arg.checkRun.Annotations?.Any() ?? false;
+                    pullRequestCheckViewModel.Title = arg.checkRun.Name;
+                    pullRequestCheckViewModel.Description = arg.checkRun.Summary;
                     pullRequestCheckViewModel.Status = checkStatus;
-                    pullRequestCheckViewModel.DetailsUrl = new Uri(checkRunModel.DetailsUrl);
-
+                    pullRequestCheckViewModel.DetailsUrl = new Uri(arg.checkRun.DetailsUrl);
                     return pullRequestCheckViewModel;
                 }) ?? Array.Empty<PullRequestCheckViewModel>();