Merge pull request #1107 from github/feature/inline-comments-metrics

Add metrics for inline comments

Author: jcansdale

src/GitHub.Exports.Reactive/Services/IPullRequestSession.cs

@@ -46,12 +46,6 @@ public interface IPullRequestSession
         /// </remarks>
         string RepositoryOwner { get; }
 
-        /// <summary>
-        /// Adds a new comment to the session.
-        /// </summary>
-        /// <param name="comment">The comment.</param>
-        Task AddComment(IPullRequestReviewCommentModel comment);
-
         /// <summary>
         /// Gets all files touched by the pull request.
         /// </summary>
@@ -92,6 +86,24 @@ Task<IPullRequestSessionFile> GetFile(
         /// </returns>
         string GetRelativePath(string path);
 
+        /// <summary>
+        /// Posts a new PR review comment.
+        /// </summary>
+        /// <param name="body">The comment body.</param>
+        /// <param name="commitId">THe SHA of the commit to comment on.</param>
+        /// <param name="path">The relative path of the file to comment on.</param>
+        /// <param name="position">The line index in the diff to comment on.</param>
+        /// <returns>A comment model.</returns>
+        Task<IPullRequestReviewCommentModel> PostReviewComment(string body, string commitId, string path, int position);
+
+        /// <summary>
+        /// Posts a PR review comment reply.
+        /// </summary>
+        /// <param name="body">The comment body.</param>
+        /// <param name="inReplyTo">The comment ID to reply to.</param>
+        /// <returns></returns>
+        Task<IPullRequestReviewCommentModel> PostReviewComment(string body, int inReplyTo);
+
         /// <summary>
         /// Updates the pull request session with a new pull request model in response to a refresh
         /// from the server.

src/GitHub.Exports/Models/UsageModel.cs

@@ -30,6 +30,12 @@ public class UsageModel
         public int NumberOfWelcomeDocsClicks { get; set; }
         public int NumberOfWelcomeTrainingClicks { get; set; }
         public int NumberOfGitHubPaneHelpClicks { get; set; }
+        public int NumberOfPRDetailsViewChanges { get; set; }
+        public int NumberOfPRDetailsViewFile { get; set; }
+        public int NumberOfPRDetailsCompareWithSolution { get; set; }
+        public int NumberOfPRDetailsOpenFileInSolution { get; set; }
+        public int NumberOfPRReviewDiffViewInlineCommentOpen { get; set; }
+        public int NumberOfPRReviewDiffViewInlineCommentPost { get; set; }
 
         public UsageModel Clone(bool includeWeekly, bool includeMonthly)
         {
@@ -61,6 +67,12 @@ public UsageModel Clone(bool includeWeekly, bool includeMonthly)
                 NumberOfWelcomeDocsClicks = NumberOfWelcomeDocsClicks,
                 NumberOfWelcomeTrainingClicks = NumberOfWelcomeTrainingClicks,
                 NumberOfGitHubPaneHelpClicks = NumberOfGitHubPaneHelpClicks,
+                NumberOfPRDetailsViewChanges = NumberOfPRDetailsViewChanges,
+                NumberOfPRDetailsViewFile = NumberOfPRDetailsViewFile,
+                NumberOfPRDetailsCompareWithSolution = NumberOfPRDetailsCompareWithSolution,
+                NumberOfPRDetailsOpenFileInSolution = NumberOfPRDetailsOpenFileInSolution,
+                NumberOfPRReviewDiffViewInlineCommentOpen = NumberOfPRReviewDiffViewInlineCommentOpen,
+                NumberOfPRReviewDiffViewInlineCommentPost = NumberOfPRReviewDiffViewInlineCommentPost,
             };
         }
     }

src/GitHub.Exports/Services/IUsageTracker.cs

@@ -23,5 +23,11 @@ public interface IUsageTracker
         Task IncrementWelcomeDocsClicks();
         Task IncrementWelcomeTrainingClicks();
         Task IncrementGitHubPaneHelpClicks();
+        Task IncrementPRDetailsViewChanges();
+        Task IncrementPRDetailsViewFile();
+        Task IncrementPRDetailsCompareWithSolution();
+        Task IncrementPRDetailsOpenFileInSolution();
+        Task IncrementPRReviewDiffViewInlineCommentOpen();
+        Task IncrementPRReviewDiffViewInlineCommentPost();
     }
 }

src/GitHub.InlineReviews/Services/IPullRequestSessionService.cs

@@ -81,5 +81,41 @@ Task<byte[]> ExtractFileFromGit(
         /// The merge base SHA for the PR.
         /// </returns>
         Task<string> GetPullRequestMergeBase(ILocalRepositoryModel repository, IPullRequestModel pullRequest);
+
+        /// <summary>
+        /// Posts a new PR review comment.
+        /// </summary>
+        /// <param name="repository">The repository.</param>
+        /// <param name="user">The user posting the comment.</param>
+        /// <param name="number">The pull request number.</param>
+        /// <param name="body">The comment body.</param>
+        /// <param name="commitId">THe SHA of the commit to comment on.</param>
+        /// <param name="path">The relative path of the file to comment on.</param>
+        /// <param name="position">The line index in the diff to comment on.</param>
+        /// <returns>A model representing the posted comment.</returns>
+        Task<IPullRequestReviewCommentModel> PostReviewComment(
+            ILocalRepositoryModel repository,
+            IAccount user,
+            int number,
+            string body,
+            string commitId,
+            string path,
+            int position);
+
+        /// <summary>
+        /// Posts a PR review comment reply.
+        /// </summary>
+        /// <param name="repository">The repository.</param>
+        /// <param name="user">The user posting the comment.</param>
+        /// <param name="number">The pull request number.</param>
+        /// <param name="body">The comment body.</param>
+        /// <param name="inReplyTo">The comment ID to reply to.</param>
+        /// <returns>A model representing the posted comment.</returns>
+        Task<IPullRequestReviewCommentModel> PostReviewComment(
+            ILocalRepositoryModel repository,
+            IAccount user,
+            int number,
+            string body,
+            int inReplyTo);
     }
 }

src/GitHub.InlineReviews/Services/InlineCommentPeekService.cs

@@ -10,6 +10,7 @@
 using GitHub.InlineReviews.Tags;
 using GitHub.Models;
 using GitHub.Primitives;
+using GitHub.Services;
 using Microsoft.VisualStudio.Language.Intellisense;
 using Microsoft.VisualStudio.Text;
 using Microsoft.VisualStudio.Text.Differencing;
@@ -28,16 +29,19 @@ class InlineCommentPeekService : IInlineCommentPeekService
         readonly IApiClientFactory apiClientFactory;
         readonly IOutliningManagerService outliningService;
         readonly IPeekBroker peekBroker;
+        readonly IUsageTracker usageTracker;
 
         [ImportingConstructor]
         public InlineCommentPeekService(
             IApiClientFactory apiClientFactory,
             IOutliningManagerService outliningManager,
-            IPeekBroker peekBroker)
+            IPeekBroker peekBroker,
+            IUsageTracker usageTracker)
         {
             this.apiClientFactory = apiClientFactory;
             this.outliningService = outliningManager;
             this.peekBroker = peekBroker;
+            this.usageTracker = usageTracker;
         }
 
         /// <inheritdoc/>
@@ -152,6 +156,12 @@ Tuple<ITextSnapshotLine, ITrackingPoint> GetLineAndTrackingPoint(ITextView textV
 
             var line = snapshot.GetLineFromLineNumber(tag.LineNumber);
             var trackingPoint = snapshot.CreateTrackingPoint(line.Start.Position, PointTrackingMode.Positive);
+
+            ExpandCollapsedRegions(textView, line.Extent);
+            peekBroker.TriggerPeekSession(textView, trackingPoint, InlineCommentPeekRelationship.Instance.Name);
+
+            usageTracker.IncrementPRReviewDiffViewInlineCommentOpen().Forget();
+
             return Tuple.Create(line, trackingPoint);
         }
 

src/GitHub.InlineReviews/Services/PullRequestSession.cs

@@ -50,15 +50,6 @@ public PullRequestSession(
             RepositoryOwner = repositoryOwner;
         }
 
-        /// <inheritdoc/>
-        public async Task AddComment(IPullRequestReviewCommentModel comment)
-        {
-            PullRequest.ReviewComments = PullRequest.ReviewComments
-                .Concat(new[] { comment })
-                .ToList();
-            await Update(PullRequest);
-        }
-
         /// <inheritdoc/>
         public async Task<IReadOnlyList<IPullRequestSessionFile>> GetAllFiles()
         {
@@ -125,6 +116,34 @@ public string GetRelativePath(string path)
             return null;
         }
 
+        /// <inheritdoc/>
+        public async Task<IPullRequestReviewCommentModel> PostReviewComment(string body, string commitId, string path, int position)
+        {
+            var model = await service.PostReviewComment(
+                LocalRepository,
+                User,
+                PullRequest.Number,
+                body,
+                commitId,
+                path,
+                position);
+            await AddComment(model);
+            return model;
+        }
+
+        /// <inheritdoc/>
+        public async Task<IPullRequestReviewCommentModel> PostReviewComment(string body, int inReplyTo)
+        {
+            var model = await service.PostReviewComment(
+                LocalRepository,
+                User,
+                PullRequest.Number,
+                body,
+                inReplyTo);
+            await AddComment(model);
+            return model;
+        }
+
         /// <inheritdoc/>
         public async Task UpdateEditorContent(string relativePath)
         {
@@ -159,6 +178,14 @@ public async Task Update(IPullRequestModel pullRequest)
             }
         }
 
+        async Task AddComment(IPullRequestReviewCommentModel comment)
+        {
+            PullRequest.ReviewComments = PullRequest.ReviewComments
+                .Concat(new[] { comment })
+                .ToList();
+            await Update(PullRequest);
+        }
+
         async Task UpdateFile(PullRequestSessionFile file)
         {
             // NOTE: We must call GetPullRequestMergeBase before GetFileContent.

src/GitHub.InlineReviews/Services/PullRequestSessionService.cs

@@ -2,8 +2,11 @@
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
 using System.IO;
+using System.Reactive.Linq;
 using System.Threading.Tasks;
+using GitHub.Factories;
 using GitHub.Models;
+using GitHub.Primitives;
 using GitHub.Services;
 using LibGit2Sharp;
 
@@ -18,18 +21,24 @@ class PullRequestSessionService : IPullRequestSessionService
         readonly IGitService gitService;
         readonly IGitClient gitClient;
         readonly IDiffService diffService;
+        readonly IApiClientFactory apiClientFactory;
+        readonly IUsageTracker usageTracker;
 
         readonly IDictionary<Tuple<string, string>, string> mergeBaseCache;
 
         [ImportingConstructor]
         public PullRequestSessionService(
             IGitService gitService,
             IGitClient gitClient,
-            IDiffService diffService)
+            IDiffService diffService,
+            IApiClientFactory apiClientFactory,
+            IUsageTracker usageTracker)
         {
             this.gitService = gitService;
             this.gitClient = gitClient;
             this.diffService = diffService;
+            this.apiClientFactory = apiClientFactory;
+            this.usageTracker = usageTracker;
 
             mergeBaseCache = new Dictionary<Tuple<string, string>, string>();
         }
@@ -125,6 +134,80 @@ public async Task<string> GetPullRequestMergeBase(ILocalRepositoryModel reposito
             throw new FileNotFoundException($"Couldn't find merge base between {baseSha} and {headSha}.");
         }
 
+        /// <inheritdoc/>
+        public async Task<IPullRequestReviewCommentModel> PostReviewComment(
+            ILocalRepositoryModel repository,
+            IAccount user,
+            int number,
+            string body,
+            string commitId,
+            string path,
+            int position)
+        {
+            var address = HostAddress.Create(repository.CloneUrl.Host);
+            var apiClient = await apiClientFactory.Create(address);
+
+            var result = await apiClient.CreatePullRequestReviewComment(
+                repository.Owner,
+                repository.Name,
+                number,
+                body,
+                commitId,
+                path,
+                position);
+
+            await usageTracker.IncrementPRReviewDiffViewInlineCommentPost();
+
+            return new PullRequestReviewCommentModel
+            {
+                Body = result.Body,
+                CommitId = result.CommitId,
+                DiffHunk = result.DiffHunk,
+                Id = result.Id,
+                OriginalCommitId = result.OriginalCommitId,
+                OriginalPosition = result.OriginalPosition,
+                Path = result.Path,
+                Position = result.Position,
+                CreatedAt = result.CreatedAt,
+                User = user,
+            };
+        }
+
+        /// <inheritdoc/>
+        public async Task<IPullRequestReviewCommentModel> PostReviewComment(
+            ILocalRepositoryModel repository,
+            IAccount user,
+            int number,
+            string body,
+            int inReplyTo)
+        {
+            var address = HostAddress.Create(repository.CloneUrl.Host);
+            var apiClient = await apiClientFactory.Create(address);
+
+            var result = await apiClient.CreatePullRequestReviewComment(
+                repository.Owner,
+                repository.Name,
+                number,
+                body,
+                inReplyTo);
+
+            await usageTracker.IncrementPRReviewDiffViewInlineCommentPost();
+
+            return new PullRequestReviewCommentModel
+            {
+                Body = result.Body,
+                CommitId = result.CommitId,
+                DiffHunk = result.DiffHunk,
+                Id = result.Id,
+                OriginalCommitId = result.OriginalCommitId,
+                OriginalPosition = result.OriginalPosition,
+                Path = result.Path,
+                Position = result.Position,
+                CreatedAt = result.CreatedAt,
+                User = user,
+            };
+        }
+
         Task<IRepository> GetRepository(ILocalRepositoryModel repository)
         {
             return Task.Factory.StartNew(() => gitService.GetRepository(repository.LocalPath));

src/GitHub.InlineReviews/ViewModels/InlineCommentPeekViewModel.cs

@@ -137,18 +137,17 @@ async Task UpdateThread()
             var lineAndLeftBuffer = peekService.GetLineNumber(peekSession, triggerPoint);
             var lineNumber = lineAndLeftBuffer.Item1;
             var leftBuffer = lineAndLeftBuffer.Item2;
-            var thread = file.InlineCommentThreads.FirstOrDefault(x => 
+            var thread = file.InlineCommentThreads.FirstOrDefault(x =>
                 x.LineNumber == lineNumber &&
                 ((leftBuffer && x.DiffLineType == DiffChangeType.Delete) || (!leftBuffer && x.DiffLineType != DiffChangeType.Delete)));
-            var apiClient = await CreateApiClient(session.LocalRepository);
 
             if (thread != null)
             {
-                Thread = new InlineCommentThreadViewModel(apiClient, session, thread.Comments);
+                Thread = new InlineCommentThreadViewModel(session, thread.Comments);
             }
             else
             {
-                var newThread = new NewInlineCommentThreadViewModel(apiClient, session, file, lineNumber, leftBuffer);
+                var newThread = new NewInlineCommentThreadViewModel(session, file, lineNumber, leftBuffer);
                 threadSubscription = newThread.Finished.Subscribe(_ => UpdateThread().Forget());
                 Thread = newThread;
             }
@@ -182,12 +181,6 @@ async Task SessionChanged(IPullRequestSession session)
             fileSubscription = file.WhenAnyValue(x => x.InlineCommentThreads).Subscribe(_ => UpdateThread().Forget());
         }
 
-        Task<IApiClient> CreateApiClient(ILocalRepositoryModel repository)
-        {
-            var hostAddress = HostAddress.Create(repository.CloneUrl.Host);
-            return apiClientFactory.Create(hostAddress);
-        }
-
         async Task<string> GetPlaceholderBodyToPreserve()
         {
             var lastComment = Thread?.Comments.LastOrDefault();