Display connection errors in GitHub pane.

grokys · grokys · commit 678745bb4453 · 2018-08-10T13:40:08.000+02:00
diff --git a/src/GitHub.App/GitHub.App.csproj b/src/GitHub.App/GitHub.App.csproj
@@ -258,6 +258,7 @@
     <Compile Include="ViewModels\GitHubPane\NavigationViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\GitHubPaneViewModel.cs" />
     <Compile Include="SampleData\PullRequestCheckViewModelDesigner.cs" />
+    <Compile Include="ViewModels\GitHubPane\LoginFailedViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\PullRequestFilesViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\PullRequestListItemViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\PullRequestListViewModel.cs" />
diff --git a/src/GitHub.App/Services/StandardUserErrors.cs b/src/GitHub.App/Services/StandardUserErrors.cs
@@ -209,7 +209,7 @@ static IObservable<RecoveryOptionResult> DisplayErrorMessage(this Exception exce
             return userError.Throw();
         }
 
-        static UserError GetUserFriendlyError(this Exception exception, ErrorType errorType, params object[] messageArgs)
+        public static UserError GetUserFriendlyError(this Exception exception, ErrorType errorType, params object[] messageArgs)
         {
             return Translator.Value.GetUserError(errorType, exception, messageArgs);
         }
diff --git a/src/GitHub.App/ViewModels/GitHubPane/GitHubPaneViewModel.cs b/src/GitHub.App/ViewModels/GitHubPane/GitHubPaneViewModel.cs
@@ -44,6 +44,7 @@ public sealed class GitHubPaneViewModel : ViewModelBase, IGitHubPaneViewModel, I
         readonly ILoggedOutViewModel loggedOut;
         readonly INotAGitHubRepositoryViewModel notAGitHubRepository;
         readonly INotAGitRepositoryViewModel notAGitRepository;
+        readonly ILoginFailedViewModel loginFailed;
         readonly SemaphoreSlim navigating = new SemaphoreSlim(1);
         readonly ObservableAsPropertyHelper<ContentOverride> contentOverride;
         readonly ObservableAsPropertyHelper<bool> isSearchEnabled;
@@ -52,6 +53,7 @@ public sealed class GitHubPaneViewModel : ViewModelBase, IGitHubPaneViewModel, I
         readonly ReactiveCommand<Unit> showPullRequests;
         readonly ReactiveCommand<object> openInBrowser;
         readonly ReactiveCommand<object> help;
+        IDisposable connectionSubscription;
         Task initializeTask;
         IViewModel content;
         ILocalRepositoryModel localRepository;
@@ -68,7 +70,8 @@ public GitHubPaneViewModel(
             INavigationViewModel navigator,
             ILoggedOutViewModel loggedOut,
             INotAGitHubRepositoryViewModel notAGitHubRepository,
-            INotAGitRepositoryViewModel notAGitRepository)
+            INotAGitRepositoryViewModel notAGitRepository,
+            ILoginFailedViewModel loginFailed)
         {
             Guard.ArgumentNotNull(viewModelFactory, nameof(viewModelFactory));
             Guard.ArgumentNotNull(apiClientFactory, nameof(apiClientFactory));
@@ -80,6 +83,7 @@ public GitHubPaneViewModel(
             Guard.ArgumentNotNull(loggedOut, nameof(loggedOut));
             Guard.ArgumentNotNull(notAGitHubRepository, nameof(notAGitHubRepository));
             Guard.ArgumentNotNull(notAGitRepository, nameof(notAGitRepository));
+            Guard.ArgumentNotNull(loginFailed, nameof(loginFailed));
 
             this.viewModelFactory = viewModelFactory;
             this.apiClientFactory = apiClientFactory;
@@ -89,6 +93,7 @@ public GitHubPaneViewModel(
             this.loggedOut = loggedOut;
             this.notAGitHubRepository = notAGitHubRepository;
             this.notAGitRepository = notAGitRepository;
+            this.loginFailed = loginFailed;
 
             var contentAndNavigatorContent = Observable.CombineLatest(
                 this.WhenAnyValue(x => x.Content),
@@ -389,6 +394,8 @@ async Task UpdateContent(ILocalRepositoryModel repository)
             log.Debug("UpdateContent called with {CloneUrl}", repository?.CloneUrl);
 
             LocalRepository = repository;
+            connectionSubscription?.Dispose();
+            connectionSubscription = null;
             Connection = null;
             Content = null;
             navigator.Clear();
@@ -410,26 +417,56 @@ async Task UpdateContent(ILocalRepositoryModel repository)
             var isDotCom = HostAddress.IsGitHubDotComUri(repositoryUrl);
             var client = await apiClientFactory.Create(repository.CloneUrl);
             var isEnterprise = isDotCom ? false : await client.IsEnterprise();
+            var notGitHubRepo = true;
 
-            if ((isDotCom || isEnterprise) && await IsValidRepository(client))
+            if (isDotCom || isEnterprise)
             {
                 var hostAddress = HostAddress.Create(repository.CloneUrl);
 
+                notGitHubRepo = false;
+
                 Connection = await connectionManager.GetConnection(hostAddress);
+                Connection?.WhenAnyValue(
+                    x => x.IsLoggedIn,
+                    x => x.IsLoggingIn,
+                    (_, __) => Unit.Default)
+                    .Skip(1)
+                    .Throttle(TimeSpan.FromMilliseconds(100))
+                    .ObserveOn(RxApp.MainThreadScheduler)
+                    .Subscribe(_ => UpdateContent(LocalRepository).Forget());
 
                 if (Connection?.IsLoggedIn == true)
                 {
-                    log.Debug("Found a GitHub repository: {CloneUrl}", repository?.CloneUrl);
-                    Content = navigator;
-                    await ShowDefaultPage();
+                    if (await IsValidRepository(client) == true)
+                    {
+                        log.Debug("Found a GitHub repository: {CloneUrl}", repository?.CloneUrl);
+                        Content = navigator;
+                        await ShowDefaultPage();
+                    }
+                    else
+                    {
+                        notGitHubRepo = true;
+                    }
+                }
+                else if (Connection?.IsLoggingIn == true)
+                {
+                    log.Debug("Found a GitHub repository: {CloneUrl} and logging in", repository?.CloneUrl);
+                    Content = null;
+                }
+                else if (Connection?.ConnectionError != null)
+                {
+                    log.Debug("Found a GitHub repository: {CloneUrl} with login error", repository?.CloneUrl);
+                    loginFailed.Initialize(Connection.ConnectionError.GetUserFriendlyError(ErrorType.LoginFailed));
+                    Content = loginFailed;
                 }
                 else
                 {
                     log.Debug("Found a a GitHub repository but not logged in: {CloneUrl}", repository?.CloneUrl);
                     Content = loggedOut;
                 }
             }
-            else
+            
+            if (notGitHubRepo)
             {
                 log.Debug("Not a GitHub repository: {CloneUrl}", repository?.CloneUrl);
                 Content = notAGitHubRepository;
diff --git a/src/GitHub.App/ViewModels/GitHubPane/LoginFailedViewModel.cs b/src/GitHub.App/ViewModels/GitHubPane/LoginFailedViewModel.cs
@@ -0,0 +1,45 @@
+using System;
+using System.ComponentModel.Composition;
+using GitHub.Services;
+using ReactiveUI;
+
+namespace GitHub.ViewModels.GitHubPane
+{
+    /// <summary>
+    /// The view model for the "Login Failed" view in the GitHub pane.
+    /// </summary>
+    [Export(typeof(ILoginFailedViewModel))]
+    [PartCreationPolicy(CreationPolicy.NonShared)]
+    public class LoginFailedViewModel : PanePageViewModelBase, ILoginFailedViewModel
+    {
+        readonly ITeamExplorerServices teServices;
+        UserError loginError;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LoginFailedViewModel"/> class.
+        /// </summary>
+        [ImportingConstructor]
+        public LoginFailedViewModel(ITeamExplorerServices teServices)
+        {
+            this.teServices = teServices;
+            OpenTeamExplorer = ReactiveCommand.Create().OnExecuteCompleted(_ => DoOpenTeamExplorer());
+        }
+
+        /// <inheritdoc/>
+        public UserError LoginError
+        {
+            get => loginError;
+            private set => this.RaiseAndSetIfChanged(ref loginError, value);
+        }
+
+        /// <inheritdoc/>
+        public ReactiveCommand<object> OpenTeamExplorer { get; }
+
+        public void Initialize(UserError error)
+        {
+            LoginError = error;
+        }
+
+        void DoOpenTeamExplorer() => teServices.ShowConnectPage();
+    }
+}
diff --git a/src/GitHub.Exports.Reactive/GitHub.Exports.Reactive.csproj b/src/GitHub.Exports.Reactive/GitHub.Exports.Reactive.csproj
@@ -203,6 +203,7 @@
     <Compile Include="ViewModels\GitHubPane\IIssueListViewModelBase.cs" />
     <Compile Include="ViewModels\GitHubPane\ILoggedOutViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\INavigationViewModel.cs" />
+    <Compile Include="ViewModels\GitHubPane\ILoginFailedViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\IPanePageViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\IPullRequestCheckViewModel.cs" />
     <Compile Include="ViewModels\GitHubPane\IPullRequestFilesViewModel.cs" />
diff --git a/src/GitHub.Exports.Reactive/ViewModels/GitHubPane/ILoginFailedViewModel.cs b/src/GitHub.Exports.Reactive/ViewModels/GitHubPane/ILoginFailedViewModel.cs
@@ -0,0 +1,26 @@
+﻿using ReactiveUI;
+
+namespace GitHub.ViewModels.GitHubPane
+{
+    /// <summary>
+    /// Defines the view model for the "Login Failed" view in the GitHub pane.
+    /// </summary>
+    public interface ILoginFailedViewModel : IPanePageViewModel
+    {
+        /// <summary>
+        /// Gets a description of the login failure.
+        /// </summary>
+        UserError LoginError { get; }
+
+        /// <summary>
+        /// Gets a command which opens the Team Explorer Connect page.
+        /// </summary>
+        ReactiveCommand<object> OpenTeamExplorer { get; }
+
+        /// <summary>
+        /// Initializes the view model with an error.
+        /// </summary>
+        /// <param name="error">The error.</param>
+        void Initialize(UserError error);
+    }
+}
diff --git a/src/GitHub.Exports/Services/ITeamExplorerServices.cs b/src/GitHub.Exports/Services/ITeamExplorerServices.cs
@@ -4,6 +4,7 @@ namespace GitHub.Services
 {
     public interface ITeamExplorerServices : INotificationService
     {
+        void ShowConnectPage();
         void ShowPublishSection();
         void ClearNotifications();
     }
diff --git a/src/GitHub.TeamFoundation.14/Services/TeamExplorerServices.cs b/src/GitHub.TeamFoundation.14/Services/TeamExplorerServices.cs
@@ -28,6 +28,12 @@ public TeamExplorerServices(IGitHubServiceProvider serviceProvider)
             this.serviceProvider = serviceProvider;
         }
 
+        public void ShowConnectPage()
+        {
+            var te = serviceProvider.TryGetService<ITeamExplorer>();
+            var foo = te.NavigateToPage(new Guid(TeamExplorerPageIds.Connect), null);
+        }
+
         public void ShowPublishSection()
         {
             var te = serviceProvider.TryGetService<ITeamExplorer>();
diff --git a/src/GitHub.VisualStudio/GitHub.VisualStudio.csproj b/src/GitHub.VisualStudio/GitHub.VisualStudio.csproj
@@ -409,6 +409,9 @@
     <Compile Include="Views\GitHubPane\GitHubPaneView.xaml.cs">
       <DependentUpon>GitHubPaneView.xaml</DependentUpon>
     </Compile>
+    <Compile Include="Views\GitHubPane\LoginFailedView.xaml.cs">
+      <DependentUpon>LoginFailedView.xaml</DependentUpon>
+    </Compile>
     <Compile Include="Views\GitHubPane\PullRequestFileCommentsView.xaml.cs">
       <DependentUpon>PullRequestFileCommentsView.xaml</DependentUpon>
     </Compile>
@@ -593,6 +596,9 @@
       <SubType>Designer</SubType>
       <Generator>MSBuild:Compile</Generator>
     </Page>
+    <Page Include="Views\GitHubPane\LoginFailedView.xaml">
+      <Generator>MSBuild:Compile</Generator>
+    </Page>
     <Page Include="Views\GitHubPane\PullRequestFileCommentsView.xaml">
       <Generator>MSBuild:Compile</Generator>
       <SubType>Designer</SubType>
diff --git a/src/GitHub.VisualStudio/Views/GitHubPane/LoginFailedView.xaml b/src/GitHub.VisualStudio/Views/GitHubPane/LoginFailedView.xaml
@@ -0,0 +1,31 @@
+﻿<UserControl x:Class="GitHub.VisualStudio.Views.GitHubPane.LoginFailedView"
+             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
+             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
+             xmlns:ghfvs="https://github.com/github/VisualStudio"
+             mc:Ignorable="d" d:DesignHeight="300" d:DesignWidth="300">
+  
+  <Control.Resources>
+    <ResourceDictionary>
+      <ResourceDictionary.MergedDictionaries>
+        <ghfvs:SharedDictionaryManager Source="pack://application:,,,/GitHub.VisualStudio.UI;component/SharedDictionary.xaml" />
+        <ghfvs:SharedDictionaryManager Source="pack://application:,,,/GitHub.UI;component/SharedDictionary.xaml" />
+      </ResourceDictionary.MergedDictionaries>
+    </ResourceDictionary>
+  </Control.Resources>
+
+  <StackPanel Margin="10" Orientation="Vertical">
+    <ghfvs:OcticonImage Icon="mark_github" Margin="0,5" Width="48" Height="48" />
+    <Label FontSize="16"
+           HorizontalAlignment="Center"
+           Content="{Binding LoginError.ErrorMessage}"/>
+    <TextBlock Text="{Binding LoginError.ErrorCauseOrResolution}"
+               TextAlignment="Center"
+               TextWrapping="Wrap"/>
+    <ghfvs:GitHubActionLink Command="{Binding OpenTeamExplorer}"
+                            Content="Open Team Explorer"
+                            HorizontalAlignment="Center"
+                            Margin="0,15"/>
+  </StackPanel>
+</UserControl>
diff --git a/src/GitHub.VisualStudio/Views/GitHubPane/LoginFailedView.xaml.cs b/src/GitHub.VisualStudio/Views/GitHubPane/LoginFailedView.xaml.cs
@@ -0,0 +1,17 @@
+﻿using System.ComponentModel.Composition;
+using System.Windows.Controls;
+using GitHub.Exports;
+using GitHub.ViewModels.GitHubPane;
+
+namespace GitHub.VisualStudio.Views.GitHubPane
+{
+    [ExportViewFor(typeof(ILoginFailedViewModel))]
+    [PartCreationPolicy(CreationPolicy.NonShared)]
+    public partial class LoginFailedView : UserControl
+    {
+        public LoginFailedView()
+        {
+            InitializeComponent();
+        }
+    }
+}
diff --git a/test/GitHub.App.UnitTests/ViewModels/GitHubPane/GitHubPaneViewModelTests.cs b/test/GitHub.App.UnitTests/ViewModels/GitHubPane/GitHubPaneViewModelTests.cs
@@ -58,7 +58,8 @@ public async Task NotAGitHubRepositoryShownWhenRepositoryIsNotAGitHubInstanceAsy
         public async Task NotAGitHubRepositoryShownWhenRepositoryIsADeletedGitHubRepoAsync()
         {
             var te = CreateTeamExplorerContext("https://github.com/invalid/repo");
-            var target = CreateTarget(teamExplorerContext: te);
+            var cm = CreateConnectionManager("https://github.com");
+            var target = CreateTarget(teamExplorerContext: te, connectionManager: cm);
 
             await InitializeAsync(target);
 
@@ -77,6 +78,19 @@ public async Task LoggedOutShownWhenNotLoggedInToGitHubAsync()
             Assert.That(target.Content, Is.InstanceOf<ILoggedOutViewModel>());
         }
 
+        [Test]
+        public async Task LoginFailedShownWhenConnectionHasError()
+        {
+            var te = CreateTeamExplorerContext(ValidGitHubRepo);
+            var exception = new Exception();
+            var cm = CreateConnectionManager(exception, "https://github.com");
+            var target = CreateTarget(teamExplorerContext: te, connectionManager: cm);
+
+            await InitializeAsync(target);
+
+            Assert.That(target.Content, Is.InstanceOf<ILoginFailedViewModel>());
+        }
+
         [Test]
         public async Task LoggedOutShownWhenNotLoggedInToEnterpriseAsync()
         {
@@ -175,7 +189,8 @@ static GitHubPaneViewModel CreateTarget(
         INavigationViewModel navigator = null,
         ILoggedOutViewModel loggedOut = null,
         INotAGitHubRepositoryViewModel notAGitHubRepository = null,
-        INotAGitRepositoryViewModel notAGitRepository = null)
+        INotAGitRepositoryViewModel notAGitRepository = null,
+        ILoginFailedViewModel loginFailed = null)
     {
         viewModelFactory = viewModelFactory ?? Substitute.For<IViewViewModelFactory>();
         connectionManager = connectionManager ?? Substitute.For<IConnectionManager>();
@@ -185,6 +200,7 @@ static GitHubPaneViewModel CreateTarget(
         loggedOut = loggedOut ?? Substitute.For<ILoggedOutViewModel>();
         notAGitHubRepository = notAGitHubRepository ?? Substitute.For<INotAGitHubRepositoryViewModel>();
         notAGitRepository = notAGitRepository ?? Substitute.For<INotAGitRepositoryViewModel>();
+        loginFailed = loginFailed ?? Substitute.For<ILoginFailedViewModel>();
 
         if (navigator == null)
         {
@@ -218,10 +234,16 @@ static GitHubPaneViewModel CreateTarget(
             navigator,
             loggedOut,
             notAGitHubRepository,
-            notAGitRepository);
+            notAGitRepository,
+            loginFailed);
     }
 
     static IConnectionManager CreateConnectionManager(params string[] addresses)
+    {
+        return CreateConnectionManager(null, addresses);
+    }
+
+    static IConnectionManager CreateConnectionManager(Exception loginError, params string[] addresses)
     {
         var result = Substitute.For<IConnectionManager>();
         var connections = new ObservableCollectionEx<IConnection>();
@@ -232,19 +254,20 @@ static IConnectionManager CreateConnectionManager(params string[] addresses)
 
         foreach (var address in addresses)
         {
-            AddConnection(result, address);
+            AddConnection(result, address, loginError);
         }
 
         return result;
     }
 
-    static void AddConnection(IConnectionManager connectionManager, string address)
+    static void AddConnection(IConnectionManager connectionManager, string address, Exception loginError = null)
     {
         var connection = Substitute.For<IConnection>();
         var hostAddress = HostAddress.Create(address);
         var connections = (ObservableCollectionEx<IConnection>)connectionManager.Connections;
         connection.HostAddress.Returns(hostAddress);
-        connection.IsLoggedIn.Returns(true);
+        connection.IsLoggedIn.Returns(loginError == null);
+        connection.ConnectionError.Returns(loginError);
         connectionManager.GetConnection(hostAddress).Returns(connection);
         connections.Add(connection);
     }

Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,7 @@ static IObservable<RecoveryOptionResult> DisplayErrorMessage(this Exception exce`
`209`	`209`	`return userError.Throw();`
`210`	`210`	`}`
`211`	`211`
`212`		`- static UserError GetUserFriendlyError(this Exception exception, ErrorType errorType, params object[] messageArgs)`
	`212`	`+ public static UserError GetUserFriendlyError(this Exception exception, ErrorType errorType, params object[] messageArgs)`
`213`	`213`	`{`
`214`	`214`	`return Translator.Value.GetUserError(errorType, exception, messageArgs);`
`215`	`215`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ namespace GitHub.Services`
`4`	`4`	`{`
`5`	`5`	`public interface ITeamExplorerServices : INotificationService`
`6`	`6`	`{`
	`7`	`+ void ShowConnectPage();`
`7`	`8`	`void ShowPublishSection();`
`8`	`9`	`void ClearNotifications();`
`9`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,12 @@ public TeamExplorerServices(IGitHubServiceProvider serviceProvider)`
`28`	`28`	`this.serviceProvider = serviceProvider;`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ public void ShowConnectPage()`
	`32`	`+ {`
	`33`	`+ var te = serviceProvider.TryGetService<ITeamExplorer>();`
	`34`	`+ var foo = te.NavigateToPage(new Guid(TeamExplorerPageIds.Connect), null);`
	`35`	`+ }`
	`36`	`+`
`31`	`37`	`public void ShowPublishSection()`
`32`	`38`	`{`
`33`	`39`	`var te = serviceProvider.TryGetService<ITeamExplorer>();`