Merge branch 'master' into refactor/new-metrics-format

# Conflicts:
#	src/GitHub.Exports/Models/UsageModel.cs
#	src/GitHub.Exports/Services/IUsageService.cs
#	src/GitHub.VisualStudio/Services/UsageService.cs
#	src/GitHub.VisualStudio/Services/UsageTracker.cs

Author: StanleyGoldman

appveyor.yml

@@ -1,4 +1,4 @@
-version: '2.4.3.{build}'
+version: '2.4.4.{build}'
 skip_tags: true
 install:
 - ps: |

docs/getting-started/authenticating-to-github.md

@@ -7,7 +7,19 @@ Before you authenticate, you must already have a GitHub or GitHub Enterprise acc
 - For more information on creating a GitHub account, see "[Signing up for a new GitHub account](https://help.github.com/articles/signing-up-for-a-new-github-account/)".
 - For a GitHub Enterprise account, contact your GitHub Enterprise site administrator.
 
-> **Note:** If your organization is on the [Business plan](https://help.github.com/articles/organization-billing-plans) and has enabled SAML single sign-on, you must create and authorize a personal access token to access protected content. For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)."
+**Note:** If your organization is on the [Business plan](https://help.github.com/articles/organization-billing-plans) and has not enabled SAML single sign-on or login with username and password, you must create and authorize a personal access token to access protected content. In addition, SAML single sign-on is not available for GitHub enterprise versions less than 2.12.2.
+
+### Scopes for personal access tokens
+
+The scopes for the personal access token are: `user`, `repo`, `gist`, and `write:public_key`. 
+- *user* scope: Grants access to the user profile data. We currently use this to display your avatar and check whether your plans lets you publish private repositories.
+- *repo* scope: Grants read/write access to code, commit statuses, invitations, collaborators, adding team memberships, and deployment statuses for public and private repositories and organizations. This is needed for all git network operations (push, pull, fetch), and for getting information about the repository you're currently working on.
+- *gist* scope: Grants write access to gists. We use this in our gist feature, so you can highlight code and create gists directly from Visual Studio
+- *write:public_key* scope: Grants access to creating, listing, and viewing details for public keys. This will allows us to add ssh support to your repositories, if you are unable to go through https (this feature is not available yet, this scope is optional)
+
+For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). 
+
+For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)."
 
 1. In Visual Studio, select **Team Explorer** from the **View** menu.
 ![Team Explorer in the view menu](images/view_team_explorer.png)
@@ -16,4 +28,13 @@ Before you authenticate, you must already have a GitHub or GitHub Enterprise acc
 3. Click the **Connect** link in the GitHub section. If you are already connected to a GitHub instance and want to connect to another, this link will not be visible; instead click **Manage Connections** and then **Connect to GitHub**.
 ![Connect to GitHub in the manage connections dropdown in the Team Explorer pane](images/connect_to_github.png)
 4. In the **Connect to GitHub dialog** choose **GitHub** or **GitHub Enterprise**, depending on which product you're using.
-5. Type your credentials, then click **Sign In**.
+
+**GitHub option**:  
+![Connect to GitHub dialog view](images/connect-to-github-dialog.png)
+- To sign in with credentials, enter either username or email and password.
+- To sign in with SSO, select `Sign in with your browser`.
+
+**GitHub Enterprise option**:  
+![Connect to GitHub Enterprise dialog view](images/connect-to-github-enterprise-dialog.png)
+- To sign in with credentials, first enter GitHub Enterprise server address. Once a valid server address is entered, a `Token` field appears and a valid token can be entered to sign in.
+  - To sign in with SSO, first enter the GitHub Enterprise server address. Once a valid server address is entered, select `Sign in with your browser`. Follow the steps to authenticate with your SSO provider.

docs/getting-started/images/connect-to-github-dialog.png

@@ -58,7 +58,7 @@ public PullRequestListViewModelDesigner()
 
         public IReadOnlyList<IRemoteRepositoryModel> Repositories { get; }
         public IRemoteRepositoryModel SelectedRepository { get; set; }
-
+        public IPullRequestModel CheckedOutPullRequest { get; set; }
         public ITrackingCollection<IPullRequestModel> PullRequests { get; set; }
         public IPullRequestModel SelectedPullRequest { get; set; }
 

docs/getting-started/images/connect-to-github-enterprise-dialog.png

@@ -76,7 +76,7 @@ void Refresh()
 
                     if (newRepositoryPath != repositoryPath)
                     {
-                        log.Debug("Fire PropertyChanged event for ActiveRepository");
+                        log.Debug("ActiveRepository changed to {CloneUrl} @ {Path}", repo?.CloneUrl, newRepositoryPath);
                         ActiveRepository = repo;
                     }
                     else if (newBranchName != branchName)

src/GitHub.App/SampleData/PullRequestListViewModelDesigner.cs

@@ -11,11 +11,13 @@
 using GitHub.Extensions;
 using GitHub.Factories;
 using GitHub.Info;
+using GitHub.Logging;
 using GitHub.Models;
 using GitHub.Primitives;
 using GitHub.Services;
 using GitHub.VisualStudio;
 using ReactiveUI;
+using Serilog;
 using OleMenuCommand = Microsoft.VisualStudio.Shell.OleMenuCommand;
 
 namespace GitHub.ViewModels.GitHubPane
@@ -27,6 +29,7 @@ namespace GitHub.ViewModels.GitHubPane
     [PartCreationPolicy(CreationPolicy.NonShared)]
     public sealed class GitHubPaneViewModel : ViewModelBase, IGitHubPaneViewModel, IDisposable
     {
+        static readonly ILogger log = LogManager.ForContext<GitHubPaneViewModel>();
         static readonly Regex pullUri = CreateRoute("/:owner/:repo/pull/:number");
 
         readonly IViewViewModelFactory viewModelFactory;
@@ -46,8 +49,7 @@ public sealed class GitHubPaneViewModel : ViewModelBase, IGitHubPaneViewModel, I
         readonly ReactiveCommand<Unit> refresh;
         readonly ReactiveCommand<Unit> showPullRequests;
         readonly ReactiveCommand<object> openInBrowser;
-        readonly SemaphoreSlim initializing = new SemaphoreSlim(1);
-        bool initialized;
+        Task initializeTask;
         IViewModel content;
         ILocalRepositoryModel localRepository;
         string searchQuery;
@@ -198,39 +200,9 @@ public void Dispose()
         }
 
         /// <inheritdoc/>
-        public async Task InitializeAsync(IServiceProvider paneServiceProvider)
+        public Task InitializeAsync(IServiceProvider paneServiceProvider)
         {
-            await initializing.WaitAsync();
-            if (initialized) return;
-
-            try
-            {
-                await UpdateContent(teamExplorerContext.ActiveRepository);
-                teamExplorerContext.WhenAnyValue(x => x.ActiveRepository)
-                   .Skip(1)
-                   .ObserveOn(RxApp.MainThreadScheduler)
-                   .Subscribe(x => UpdateContent(x).Forget());
-
-                connectionManager.Connections.CollectionChanged += (_, __) => UpdateContent(LocalRepository).Forget();
-
-                BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.pullRequestCommand, showPullRequests);
-                BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.backCommand, navigator.NavigateBack);
-                BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.forwardCommand, navigator.NavigateForward);
-                BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.refreshCommand, refresh);
-                BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.githubCommand, openInBrowser);
-
-                paneServiceProvider.AddCommandHandler(Guids.guidGitHubToolbarCmdSet, PkgCmdIDList.helpCommand,
-                     (_, __) =>
-                     {
-                         browser.OpenUrl(new Uri(GitHubUrls.Documentation));
-                         usageTracker.IncrementCounter(x => x.NumberOfGitHubPaneHelpClicks).Forget();
-                     });
-            }
-            finally
-            {
-                initialized = true;
-                initializing.Release();
-            }
+            return initializeTask = initializeTask ?? CreateInitializeTask(paneServiceProvider);
         }
 
         /// <inheritdoc/>
@@ -304,6 +276,30 @@ public Task ShowPullRequest(string owner, string repo, int number)
                 x => x.RemoteRepositoryOwner == owner && x.LocalRepository.Name == repo && x.Number == number);
         }
 
+        async Task CreateInitializeTask(IServiceProvider paneServiceProvider)
+        {
+            await UpdateContent(teamExplorerContext.ActiveRepository);
+            teamExplorerContext.WhenAnyValue(x => x.ActiveRepository)
+                .Skip(1)
+                .ObserveOn(RxApp.MainThreadScheduler)
+                .Subscribe(x => UpdateContent(x).Forget());
+
+            connectionManager.Connections.CollectionChanged += (_, __) => UpdateContent(LocalRepository).Forget();
+
+            BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.pullRequestCommand, showPullRequests);
+            BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.backCommand, navigator.NavigateBack);
+            BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.forwardCommand, navigator.NavigateForward);
+            BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.refreshCommand, refresh);
+            BindNavigatorCommand(paneServiceProvider, PkgCmdIDList.githubCommand, openInBrowser);
+
+            paneServiceProvider.AddCommandHandler(Guids.guidGitHubToolbarCmdSet, PkgCmdIDList.helpCommand,
+                    (_, __) =>
+                    {
+                        browser.OpenUrl(new Uri(GitHubUrls.Documentation));
+                        usageTracker.IncrementCounter(x => x.NumberOfGitHubPaneHelpClicks).Forget();
+                    });
+        }
+
         OleMenuCommand BindNavigatorCommand<T>(IServiceProvider paneServiceProvider, int commandId, ReactiveCommand<T> command)
         {
             Guard.ArgumentNotNull(paneServiceProvider, nameof(paneServiceProvider));
@@ -360,18 +356,22 @@ async Task NavigateTo<TViewModel>(Func<TViewModel, Task> initialize, Func<TViewM
 
         async Task UpdateContent(ILocalRepositoryModel repository)
         {
+            log.Debug("UpdateContent called with {CloneUrl}", repository?.CloneUrl);
+
             LocalRepository = repository;
             Connection = null;
             Content = null;
             navigator.Clear();
 
             if (repository == null)
             {
+                log.Debug("Not a git repository: {CloneUrl}", repository?.CloneUrl);
                 Content = notAGitRepository;
                 return;
             }
             else if (string.IsNullOrWhiteSpace(repository.CloneUrl))
             {
+                log.Debug("Not a GitHub repository: {CloneUrl}", repository?.CloneUrl);
                 Content = notAGitHubRepository;
                 return;
             }
@@ -389,16 +389,19 @@ async Task UpdateContent(ILocalRepositoryModel repository)
 
                 if (Connection?.IsLoggedIn == true)
                 {
+                    log.Debug("Found a GitHub repository: {CloneUrl}", repository?.CloneUrl);
                     Content = navigator;
                     await ShowDefaultPage();
                 }
                 else
                 {
+                    log.Debug("Found a a GitHub repository but not logged in: {CloneUrl}", repository?.CloneUrl);
                     Content = loggedOut;
                 }
             }
             else
             {
+                log.Debug("Not a GitHub repository: {CloneUrl}", repository?.CloneUrl);
                 Content = notAGitHubRepository;
             }
         }

src/GitHub.App/Services/TeamExplorerContext.cs

@@ -41,10 +41,12 @@ public class PullRequestListViewModel : PanePageViewModelBase, IPullRequestListV
         public PullRequestListViewModel(
             IModelServiceFactory modelServiceFactory,
             IPackageSettings settings,
+            IPullRequestSessionManager sessionManager,
             IVisualStudioBrowser visualStudioBrowser)
         {
             Guard.ArgumentNotNull(modelServiceFactory, nameof(modelServiceFactory));
             Guard.ArgumentNotNull(settings, nameof(settings));
+            Guard.ArgumentNotNull(sessionManager, nameof(sessionManager));
             Guard.ArgumentNotNull(visualStudioBrowser, nameof(visualStudioBrowser));
 
             constructing = true;
@@ -100,6 +102,19 @@ public PullRequestListViewModel(
             OpenPullRequestOnGitHub = ReactiveCommand.Create();
             OpenPullRequestOnGitHub.Subscribe(x => DoOpenPullRequestOnGitHub((int)x));
 
+            // Get the current pull request session and the selected repository. When the session's
+            // repository is the same as our selected repository set CheckedOutPullRequest to the
+            // current session's model, so that the checked out PR can be highlighted.
+            Observable.CombineLatest(
+                sessionManager.WhenAnyValue(x => x.CurrentSession),
+                this.WhenAnyValue(x => x.SelectedRepository),
+                (s, r) => new { Session = s, Repository = r })
+                .Subscribe(x =>
+                {
+                    CheckedOutPullRequest = x.Session?.RepositoryOwner == x.Repository?.Owner ?
+                        x.Session?.PullRequest : null;
+                });
+
             constructing = false;
         }
 
@@ -245,6 +260,13 @@ public IPullRequestModel SelectedPullRequest
             set { this.RaiseAndSetIfChanged(ref selectedPullRequest, value); }
         }
 
+        IPullRequestModel checkedOutPullRequest;
+        public IPullRequestModel CheckedOutPullRequest
+        {
+            get { return checkedOutPullRequest; }
+            set { this.RaiseAndSetIfChanged(ref checkedOutPullRequest, value); }
+        }
+
         IReadOnlyList<PullRequestState> states;
         public IReadOnlyList<PullRequestState> States
         {

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

@@ -33,6 +33,7 @@ public interface IPullRequestListViewModel : ISearchablePageViewModel, IOpenInBr
         IRemoteRepositoryModel SelectedRepository { get; set; }
         ITrackingCollection<IPullRequestModel> PullRequests { get; }
         IPullRequestModel SelectedPullRequest { get; }
+        IPullRequestModel CheckedOutPullRequest { get; }
         IReadOnlyList<PullRequestState> States { get; set; }
         PullRequestState SelectedState { get; set; }
         ObservableCollection<IAccount> Authors { get; }

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

@@ -24,7 +24,7 @@ public interface IAwaiter : INotifyCompletion
 
     public static class ThreadingHelper
     {
-        public static bool InUIThread => (!Guard.InUnitTestRunner && Application.Current.Dispatcher.CheckAccess()) || !(Guard.InUnitTestRunner);
+        public static bool InUIThread => Guard.InUnitTestRunner ? true : Application.Current.Dispatcher.CheckAccess();
 
         /// <summary>
         /// Gets the Dispatcher for the main thread.
@@ -88,7 +88,7 @@ public AwaiterWrapper()
             {
                 isCompleted = () => true;
                 onCompleted = c => c();
-                getResult = () => {};
+                getResult = () => { };
             }
 
             public AwaiterWrapper(MainThreadAwaiter awaiter)