Merge pull request #1230 from github/refactor/pr-sessions-2

Refactoring Pull Request Sessions (again)

Author: jcansdale

src/GitHub.Exports.Reactive/GitHub.Exports.Reactive.csproj

@@ -54,6 +54,14 @@
       <HintPath>..\..\packages\Microsoft.VisualStudio.Text.Data.14.3.25407\lib\net45\Microsoft.VisualStudio.Text.Data.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="Microsoft.VisualStudio.Text.Logic, Version=14.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.VisualStudio.Text.Logic.14.3.25407\lib\net45\Microsoft.VisualStudio.Text.Logic.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="Microsoft.VisualStudio.Text.UI, Version=14.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.VisualStudio.Text.UI.14.3.25407\lib\net45\Microsoft.VisualStudio.Text.UI.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="PresentationCore" />
     <Reference Include="System" />
     <Reference Include="System.ComponentModel.Composition" />
@@ -95,8 +103,8 @@
     <Compile Include="GlobalSuppressions.cs" />
     <Compile Include="Models\IAvatarContainer.cs" />
     <Compile Include="Models\IConnectionRepositoryHostMap.cs" />
-    <Compile Include="Models\IEditorContentSource.cs" />
     <Compile Include="Models\IInlineCommentThreadModel.cs" />
+    <Compile Include="Models\IPullRequestSessionLiveFile.cs" />
     <Compile Include="Models\IPullRequestSessionFile.cs" />
     <Compile Include="Models\IRepositoryHosts.cs" />
     <Compile Include="Models\PullRequestTextBufferInfo.cs" />

src/GitHub.Exports.Reactive/Models/IEditorContentSource.cs

@@ -1,22 +1,26 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
-using GitHub.Services;
 
 namespace GitHub.Models
 {
     /// <summary>
-    /// A file in a pull request session.
+    /// Represents a file in a pull request.
     /// </summary>
     /// <remarks>
-    /// A pull request session file represents the real-time state of a file in a pull request in
-    /// the IDE. If the pull request branch is checked out, it represents the state of a file from
-    /// the pull request model updated to the current state of the code on disk and in the editor.
+    /// A <see cref="IPullRequestSessionFile"/> holds the review comments for a file in a pull
+    /// request together with associated information such as the commit SHA of the file and the
+    /// diff with the file's merge base.
     /// </remarks>
     /// <seealso cref="IPullRequestSession"/>
     /// <seealso cref="IPullRequestSessionManager"/>
     public interface IPullRequestSessionFile : INotifyPropertyChanged
     {
+        /// <summary>
+        /// Gets the SHA of the base commit of the file in the pull request.
+        /// </summary>
+        string BaseSha { get; }
+
         /// <summary>
         /// Gets the SHA of the current commit of the file, or null if the file has uncommitted
         /// changes.
@@ -31,12 +35,7 @@ public interface IPullRequestSessionFile : INotifyPropertyChanged
         /// <summary>
         /// Gets the diff between the PR merge base and the current state of the file.
         /// </summary>
-        IList<DiffChunk> Diff { get; }
-
-        /// <summary>
-        /// Gets the source for the editor contents for the file.
-        /// </summary>
-        IEditorContentSource ContentSource { get; }
+        IReadOnlyList<DiffChunk> Diff { get; }
 
         /// <summary>
         /// Gets the inline comments threads for the file.

src/GitHub.Exports.Reactive/Models/IPullRequestSessionFile.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using GitHub.Services;
+
+namespace GitHub.Models
+{
+    /// <summary>
+    /// A file in a pull request session that tracks editor content.
+    /// </summary>
+    /// <remarks>
+    /// A live session file extends <see cref="IPullRequestSessionFile"/> to update the file's
+    /// review comments in real time, based on the contents of an editor and
+    /// <see cref="IPullRequestSessionManager.CurrentSession"/>.
+    /// </remarks>
+    public interface IPullRequestSessionLiveFile : IPullRequestSessionFile
+    {
+        /// <summary>
+        /// Gets an observable that is raised with a collection of 0-based line numbers when the
+        /// review comments on the file are changed.
+        /// </summary>
+        IObservable<IReadOnlyList<int>> LinesChanged { get; }
+    }
+}

src/GitHub.Exports.Reactive/Models/IPullRequestSessionLiveFile.cs

@@ -5,25 +5,26 @@ namespace GitHub.Models
 {
     /// <summary>
     /// When attached as a property to a Visual Studio ITextBuffer, informs the inline comment
-    /// tagger that the buffer represents a buffer opened from a pull request.
+    /// tagger that the buffer represents a buffer opened from a pull request at the HEAD commit
+    /// of a pull request.
     /// </summary>
     public class PullRequestTextBufferInfo
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="PullRequestTextBufferInfo"/> class.
         /// </summary>
         /// <param name="session">The pull request session.</param>
-        /// <param name="filePath">The full path to the file.</param>
+        /// <param name="relativePath">The relative path to the file in the repository.</param>
         /// <param name="isLeftComparisonBuffer">
         /// Whether the buffer represents the left-hand-side of a comparison.
         /// </param>
         public PullRequestTextBufferInfo(
             IPullRequestSession session,
-            string filePath,
+            string relativePath,
             bool isLeftComparisonBuffer)
         {
             Session = session;
-            FilePath = filePath;
+            RelativePath = relativePath;
             IsLeftComparisonBuffer = isLeftComparisonBuffer;
         }
 
@@ -33,9 +34,9 @@ public PullRequestTextBufferInfo(
         public IPullRequestSession Session { get; }
 
         /// <summary>
-        /// Gets the full path to the file.
+        /// Gets the relative path to the file in the repository.
         /// </summary>
-        public string FilePath { get; }
+        public string RelativePath { get; }
 
         /// <summary>
         /// Gets a value indicating whether the buffer represents the left-hand-side of a comparison.

src/GitHub.Exports.Reactive/Models/PullRequestTextBufferInfo.cs

@@ -2,18 +2,12 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using GitHub.Models;
-using ReactiveUI;
 
 namespace GitHub.Services
 {
     /// <summary>
-    /// A pull request session used to display inline reviews.
+    /// A pull request session used to display inline comments.
     /// </summary>
-    /// <remarks>
-    /// A pull request session represents the real-time state of a pull request in the IDE.
-    /// It takes the pull request model and updates according to the current state of the
-    /// repository on disk and in the editor.
-    /// </remarks>
     public interface IPullRequestSession
     {
         /// <summary>
@@ -65,26 +59,10 @@ public interface IPullRequestSession
         Task<IPullRequestSessionFile> GetFile(string relativePath);
 
         /// <summary>
-        /// Gets a file touched by the pull request.
-        /// </summary>
-        /// <param name="relativePath">The relative path to the file.</param>
-        /// <param name="contentSource">The editor file content source.</param>
-        /// <returns>
-        /// A <see cref="IPullRequestSessionFile"/> object or null if the file was not touched by
-        /// the pull request.
-        /// </returns>
-        Task<IPullRequestSessionFile> GetFile(
-            string relativePath,
-            IEditorContentSource contentSource);
-
-        /// <summary>
-        /// Converts a path to a path relative to the current repository.
+        /// Gets the merge base SHA for the pull request.
         /// </summary>
-        /// <param name="path">The path.</param>
-        /// <returns>
-        /// The relative path, or null if the specified path is not in the repository.
-        /// </returns>
-        string GetRelativePath(string path);
+        /// <returns>The merge base SHA.</returns>
+        Task<string> GetMergeBase();
 
         /// <summary>
         /// Posts a new PR review comment.
@@ -111,12 +89,5 @@ Task<IPullRequestSessionFile> GetFile(
         /// <param name="pullRequest">The new pull request model.</param>
         /// <returns>A task which completes when the session has completed updating.</returns>
         Task Update(IPullRequestModel pullRequest);
-
-        /// <summary>
-        /// Notifies the session that the contents of a file in the editor have changed.
-        /// </summary>
-        /// <param name="relativePath">The relative path to the file.</param>
-        /// <returns>A task which completes when the session has completed updating.</returns>
-        Task UpdateEditorContent(string relativePath);
     }
 }

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

@@ -3,12 +3,23 @@
 using System.Threading.Tasks;
 using GitHub.Models;
 using Microsoft.VisualStudio.Text;
+using Microsoft.VisualStudio.Text.Editor;
 
 namespace GitHub.Services
 {
     /// <summary>
     /// Manages pull request sessions.
     /// </summary>
+    /// <remarks>
+    /// If the currently checked out branch represents a pull request then <see cref="CurrentSession"/>
+    /// will return an <see cref="IPullRequestSession"/> containing the details of that pull request.
+    /// A session for any other pull request can also be retrieved by calling
+    /// <see cref="GetSession(IPullRequestModel)"/>.
+    /// 
+    /// Calling <see cref="GetLiveFile(string, ITextView, ITextBuffer)"/> will return an
+    /// <see cref="IPullRequestSessionFile"/> which tracks both the contents of a text buffer and the
+    /// current session, and updates the review comments in real-time.
+    /// </remarks>
     public interface IPullRequestSessionManager : INotifyPropertyChanged
     {
         /// <summary>
@@ -20,6 +31,28 @@ public interface IPullRequestSessionManager : INotifyPropertyChanged
         /// </returns>
         IPullRequestSession CurrentSession { get; }
 
+        /// <summary>
+        /// Gets an <see cref="IPullRequestSessionFile"/> that tracks the live state of a document.
+        /// </summary>
+        /// <param name="relativePath">The relative path to the file in the repository.</param>
+        /// <param name="textView">The text view that is showing the file.</param>
+        /// <param name="textBuffer">The text buffer with the file contents.</param>
+        /// <returns>An <see cref="IPullRequestSessionLiveFile"/>.</returns>
+        Task<IPullRequestSessionLiveFile> GetLiveFile(
+            string relativePath,
+            ITextView textView,
+            ITextBuffer textBuffer);
+
+        /// <summary>
+        /// Gets the path of a document displayed in a text buffer, relative to the current
+        /// repository.
+        /// </summary>
+        /// <param name="buffer">The text buffer.</param>
+        /// <returns>
+        /// The relative path, or null if the buffer does not represent a file in the repository.
+        /// </returns>
+        string GetRelativePath(ITextBuffer buffer);
+
         /// <summary>
         /// Gets a pull request session for a pull request that may not be checked out.
         /// </summary>

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

@@ -4,6 +4,8 @@
   <package id="LibGit2Sharp.NativeBinaries" version="1.0.129" targetFramework="net461" />
   <package id="Microsoft.VisualStudio.CoreUtility" version="14.3.25407" targetFramework="net461" />
   <package id="Microsoft.VisualStudio.Text.Data" version="14.3.25407" targetFramework="net461" />
+  <package id="Microsoft.VisualStudio.Text.Logic" version="14.3.25407" targetFramework="net461" />
+  <package id="Microsoft.VisualStudio.Text.UI" version="14.3.25407" targetFramework="net461" />
   <package id="Rx-Core" version="2.2.5-custom" targetFramework="net45" />
   <package id="Rx-Interfaces" version="2.2.5-custom" targetFramework="net45" />
   <package id="Rx-Linq" version="2.2.5-custom" targetFramework="net45" />

src/GitHub.Exports.Reactive/packages.config

@@ -16,7 +16,7 @@ public static IEnumerable<DiffChunk> ParseFragment(string diff)
             {
                 string line;
                 DiffChunk chunk = null;
-                int diffLine = 0;
+                int diffLine = -1;
                 int oldLine = -1;
                 int newLine = -1;
 
@@ -31,6 +31,8 @@ public static IEnumerable<DiffChunk> ParseFragment(string diff)
                             yield return chunk;
                         }
 
+                        if (diffLine == -1) diffLine = 0;
+
                         chunk = new DiffChunk
                         {
                             OldLineNumber = oldLine = int.Parse(headerMatch.Groups[1].Value),
@@ -70,7 +72,7 @@ public static IEnumerable<DiffChunk> ParseFragment(string diff)
                         }
                     }
 
-                    ++diffLine;
+                    if (diffLine != -1) ++diffLine;
                 }
 
                 if (chunk != null)

src/GitHub.Exports/Models/DiffUtilities.cs

@@ -75,6 +75,7 @@
     <Compile Include="Glyph\IGlyphFactory.cs" />
     <Compile Include="InlineReviewsPackage.cs" />
     <Compile Include="Models\InlineCommentThreadModel.cs" />
+    <Compile Include="Models\PullRequestSessionLiveFile.cs" />
     <Compile Include="Models\PullRequestSessionFile.cs" />
     <Compile Include="Tags\MouseEnterAndLeaveEventRouter.cs" />
     <Compile Include="Peek\InlineCommentPeekableItem.cs" />