Fix cloning using Open From GitHub on Visual Studio 2015 #1982

jcansdale · 2018-10-09T11:37:38Z

This PR targets release/2.5.8

The aim of this PR is to make VSGitServices.Clone work as consistently as possible on Visual Studio 2015 and 2017. The clone operation should do the following on both versions:

Start the clone operation
Show clone progress bar on Team Explorer - Home
Change context to the cloned repository

On Visual Studio 2017 the cloned repository will be opened as a Folder in Solution Explorer. This happens automatically when a repository is cloned and is equivalent to using the new File > Open > Folder...) command.

On Visual Studio 2015 the Team Explorer context is changed (using VSService.TryOpenRepository), but the Folder view doesn't exist on Visual Studio 2015.

What this PR does

Make sure the IGitRepositoriesExt service can always be found
Always show progress bar on Team Explorer - Home while cloning
Consistently detect clone completion on Visual Studio 2015 when progress bar is hidden
Don't attempt to open repository if clone fails (no .git folder)
Use Throttle to avoid false positives if progress bar glitches hidden
Use StartWith(false) so clone doesn't wait forever if progress section never appears

How to test

The following should work on Visual Studio 2015 and 2017

Open Clone dialog using File > Open > Open from GitHub...
Select a repository to clone (e.g. type dotnet/BenchmarkDotNet on URL tab)
Click Clone button
Expect progress bar to appear on Team Explorer - Home
Expect repository context to chance when clone completes (not before)

When a clone operation fails

Open any solution in Visual Studio 2015
Open Clone dialog using File > Open > Open from GitHub...
Select a repository that doesn't exist (e.g. type foo/bar on URL tab)
Click Clone button
Expect Failed to clone... notification to appear
Click the Cancel button
Expect original solution/repository to remain and notification to disappear

On Visual Studio 2015, clone completion will only be detected when Team Explorer - Home is the topmost page in Team Explorer. You can confirm this by doing the following:

Open Clone dialog using File > Open > Open from GitHub...
Select a repository to clone (e.g. type dotnet/BenchmarkDotNet on URL tab)
Click Clone button
Click Manage Connections, which will navigate to Team Explorer - Connect.
Wait for the clone to complete (you should find a clone progress further down on this page)
Click Home, which will navigate to Team Explorer - Home
Expect the repository context to chance as soon as Team Explorer - Home is visible

I tested some of the Rx logic using the following test:

        [TestCase("", "", true)]
        [TestCase("x", "", true)]
        [TestCase("", "x", true)]
        [TestCase("", "xox", true)]
        [TestCase("", "xo", false)]
        public async Task SwitchTest(string a, string b, bool expect)
        {
            var observable = new[] { a, b }.ToObservable();

            var result = await observable
                .Select(w => w.ToCharArray().ToObservable())
                .Switch()
                .StartWith('x')
                .Throttle(TimeSpan.FromSeconds(1))
                .Any(c => c == 'x');

            Assert.That(result, Is.EqualTo(expect));
        }

Fixes #1981, Fixes #1982

codecov · 2018-10-09T11:50:23Z

Codecov Report

❗ No coverage uploaded for pull request base (release/2.5.8@b2385e6). Click here to learn what that means.
The diff coverage is 0%.

@@               Coverage Diff                @@
##             release/2.5.8    #1982   +/-   ##
================================================
  Coverage                 ?   41.04%           
================================================
  Files                    ?      403           
  Lines                    ?    17167           
  Branches                 ?     2381           
================================================
  Hits                     ?     7047           
  Misses                   ?     9568           
  Partials                 ?      552

Impacted Files	Coverage Δ
src/GitHub.VisualStudio.UI/Views/ViewLocator.cs	`0% <ø> (ø)`
src/GitHub.App/ViewModels/CommentViewModel.cs	`65.59% <ø> (ø)`
...rc/GitHub.App/ViewModels/CommentThreadViewModel.cs	`90.9% <ø> (ø)`
src/GitHub.App/Services/CommentService.cs	`0% <ø> (ø)`
src/GitHub.App/Services/RepositoryCloneService.cs	`48.95% <ø> (ø)`
src/GitHub.VisualStudio.UI/Views/ContentView.cs	`0% <ø> (ø)`
...rc/GitHub.VisualStudio.UI/Views/ActorAvatarView.cs	`0% <ø> (ø)`
...iews/GitHubPane/FileNameToImageMonikerConverter.cs	`0% <ø> (ø)`
...neReviews/ViewModels/InlineCommentPeekViewModel.cs	`76.85% <ø> (ø)`
...Pane/DirectoryIsExpandedToImageMonikerConverter.cs	`0% <ø> (ø)`
... and 1 more

Stop relying on the state of IGitHubServiceProvider to locate IGitRepositoriesExt.

There's no more need to explicitly show the Team Explorer - Connect page when the Start Page GitHub button is clicked. This will happen automatically before cloning.

A clone progress bar and option to cancel appears on Team Explorer - Home while cloning. Navigate to Team Explorer - Home, when clone operation is about to start.

We want the Clone behavior to be as similar as possible on Visual Studio 2015 and 2017.

This gives user an opportunity to choose a solution.

If the user navigates away from the Connect page, the CanClone property will stop updating and the Clone method won't return. Point Team Explorer at the target folder when clone starts incase this happens.

Detect when a clone completes by waiting for the clone progress bar on the Team Explorer Home page to be hidden.

Look for clone progress bar on any Team Explorer Home page that the user navigates to. The Home page will need to be the topmost page on Team Explorer for the clone to complete.

- Be consistent between 2015 and 2017 by navigating to Home page after clone starts. - There's no need to use JoinableTaskFactory.RunAsync when a task is being awaited.

Move NavigateToHomePage out of WaitForCloneOnHomePageAsync to show the stages more clearly.

drguthals · 2018-10-11T02:51:37Z

I just confirmed that this worked on VS2015 Community 👍

Looks like there is still a build failing though.

drguthals

LGTM other than the build that's failing ✨

drguthals · 2018-10-11T02:52:42Z

src/GitHub.StartPage/StartPagePackage.cs

@@ -59,7 +57,6 @@ async Task<CodeContainer> RunAcquisition(IProgress<ServiceProgressData> download
            try
            {
                var uiProvider = await Task.Run(() => Package.GetGlobalService(typeof(IGitHubServiceProvider)) as IGitHubServiceProvider);
-                await ShowTeamExplorerPage(uiProvider);


So this was the piece that was waiting for the Team Explorer to let us know that the clone had completed?

This was a hack to make the IGitRepositoriesExt service available later on when the Clone method attempts to retrieve it from IGitHubServiceProvider.

The problem was that it required two pieces to be in place before it wold work.

The Team Explorer - Connext page must be visible

Something must have set the GitServiceProvider on IGitHubServiceProvider

This was way too fragile and the reason the bug crept in.

drguthals · 2018-10-11T02:54:12Z

src/GitHub.TeamFoundation.14/Services/VSGitServices.cs

@@ -39,6 +36,8 @@ public class VSGitServices : IVSGitServices

        [SuppressMessage("Microsoft.Performance", "CA1823:AvoidUnusedPrivateFields", Justification = "Used in VS2017")]
        readonly Lazy<IStatusBarNotificationService> statusBar;
+        [SuppressMessage("Microsoft.Performance", "CA1823:AvoidUnusedPrivateFields", Justification = "Used in VS2015")]
+        readonly Lazy<IVSServices> vsServices;


Can you quickly explain this bit for my edification?

There is a TryOpenRepository method on IVSServices that we only need to call when running on Visual Studio 2015. On Visual Studio 2017, the cloned repository automatically opens in folder view (which is new in Visual Studio 2017).

If we didn't call TryOpenRepository, you wouldn't see the URL change on Team Explorer - Home and there'd be no option to open a solution. You'd need to manually find and open a solution in the cloned folder.

drguthals · 2018-10-11T02:55:59Z

src/GitHub.TeamFoundation.14/Services/VSGitServices.cs

-            // The operation will have completed when CanClone goes false and then true again.
-            await gitExt.WhenAnyValue(x => x.CanClone).Where(x => !x).Take(1);
-            await gitExt.WhenAnyValue(x => x.CanClone).Where(x => x).Take(1);
+#if TEAMEXPLORER14


So this is the new bit right? So instead of waiting for the response from TE, we're starting the clone and immediately navigating to the TE Home page and then the user will see the TE change as a result of the clone completing but TE is handling that. And we can identify that change (instead of actually waiting for an update from TE)

We can infer that the clone operation has completed when the progress bar is hidden and automatically change context to the newly cloned repository. If we didn't change repository context at this point, the user would know the clone had completed, but they'd be left to find and open a solution from the newly cloned folder (not a nice experience).

drguthals · 2018-10-11T02:56:30Z

src/GitHub.TeamFoundation.14/Services/VSGitServices.cs

+        static async Task WaitForCloneOnHomePageAsync(ITeamExplorer teamExplorer)
+        {
+            // The clone progress bar appears on the GettingStartedSection of the Home page,
+            // so we wait for this to be hidden before continuing.


If no events arrive default to invisible. Watch the topmost section.

We don't want to change context when a clone operation has failed.

src/GitHub.TeamFoundation.14/Services/VSGitServices.cs

jcansdale force-pushed the fixes/1981-open-from-github-clone-2015 branch from f4f3ddd to d877773 Compare October 9, 2018 11:55

jcansdale changed the title ~~[wip] Fix cloning using Open From GitHub on Visual Studio 2015~~ Fix cloning using Open From GitHub on Visual Studio 2015 Oct 10, 2018

jcansdale requested a review from grokys October 10, 2018 14:11

jcansdale added the Ready for Review label Oct 10, 2018

jcansdale added 11 commits October 10, 2018 15:56

Add method to find IGitRepositoriesExt

1db61f0

Stop relying on the state of IGitHubServiceProvider to locate IGitRepositoriesExt.

Don't show Connect when Start Page button clicked

b1a0171

There's no more need to explicitly show the Team Explorer - Connect page when the Start Page GitHub button is clicked. This will happen automatically before cloning.

Show clone progress on Team Explorer - Home

a5a2b1a

A clone progress bar and option to cancel appears on Team Explorer - Home while cloning. Navigate to Team Explorer - Home, when clone operation is about to start.

TryOpenRepository when clone completes on VS 2015

8952f96

We want the Clone behavior to be as similar as possible on Visual Studio 2015 and 2017.

Show Team Explorer - Home after clone

43b504e

This gives user an opportunity to choose a solution.

TryOpenRepository on empty target folder

4ce6852

If the user navigates away from the Connect page, the CanClone property will stop updating and the Clone method won't return. Point Team Explorer at the target folder when clone starts incase this happens.

Detect completion using visibility of progress bar

c793d90

Detect when a clone completes by waiting for the clone progress bar on the Team Explorer Home page to be hidden.

Look for progress bar on any Home page

38a754a

Look for clone progress bar on any Team Explorer Home page that the user navigates to. The Home page will need to be the topmost page on Team Explorer for the clone to complete.

Navigate to Home after clone starts on 2017

fc2d2c1

- Be consistent between 2015 and 2017 by navigating to Home page after clone starts. - There's no need to use JoinableTaskFactory.RunAsync when a task is being awaited.

Suppress CA1823 for IVSServices used in VS2015

4f527e7

Move StartClonenOnConnectPageAsync into Clone

567d490

Move NavigateToHomePage out of WaitForCloneOnHomePageAsync to show the stages more clearly.

jcansdale force-pushed the fixes/1981-open-from-github-clone-2015 branch from 10c038a to 567d490 Compare October 10, 2018 15:05

jcansdale changed the base branch from master to release/2.5.8 October 10, 2018 15:07

jcansdale mentioned this pull request Oct 10, 2018

Show Team Explorer Home before starting to clone #1978

Closed

drguthals approved these changes Oct 11, 2018

View reviewed changes

jcansdale added 2 commits October 11, 2018 11:43

Ignore glitch where section starts invisible

9885bad

If no events arrive default to invisible. Watch the topmost section.

Only open repository when .git directory exists

dd94727

We don't want to change context when a clone operation has failed.

grokys reviewed Oct 11, 2018

View reviewed changes

src/GitHub.TeamFoundation.14/Services/VSGitServices.cs Show resolved Hide resolved

src/GitHub.TeamFoundation.14/Services/VSGitServices.cs Show resolved Hide resolved

grokys approved these changes Oct 11, 2018

View reviewed changes

jcansdale merged commit c38cd21 into release/2.5.8 Oct 11, 2018

jcansdale deleted the fixes/1981-open-from-github-clone-2015 branch October 11, 2018 13:21

This was referenced Oct 12, 2018

File > Open > Open from GitHub silently fails in Visual Studio 2015 #1981

Closed

Progress bar not displayed until Clone completes #1977

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix cloning using Open From GitHub on Visual Studio 2015 #1982

Fix cloning using Open From GitHub on Visual Studio 2015 #1982

Uh oh!

jcansdale commented Oct 9, 2018 •

edited

Loading

Uh oh!

codecov bot commented Oct 9, 2018 •

edited

Loading

Uh oh!

drguthals commented Oct 11, 2018

Uh oh!

drguthals left a comment

Uh oh!

drguthals Oct 11, 2018

Uh oh!

jcansdale Oct 11, 2018

Uh oh!

drguthals Oct 11, 2018

Uh oh!

jcansdale Oct 11, 2018 •

edited

Loading

Uh oh!

drguthals Oct 11, 2018

Uh oh!

jcansdale Oct 11, 2018

Uh oh!

drguthals Oct 11, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fix cloning using Open From GitHub on Visual Studio 2015 #1982

Fix cloning using Open From GitHub on Visual Studio 2015 #1982

Uh oh!

Conversation

jcansdale commented Oct 9, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does

How to test

Uh oh!

codecov bot commented Oct 9, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

drguthals commented Oct 11, 2018

Uh oh!

drguthals left a comment

Choose a reason for hiding this comment

Uh oh!

drguthals Oct 11, 2018

Choose a reason for hiding this comment

Uh oh!

jcansdale Oct 11, 2018

Choose a reason for hiding this comment

Uh oh!

drguthals Oct 11, 2018

Choose a reason for hiding this comment

Uh oh!

jcansdale Oct 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

drguthals Oct 11, 2018

Choose a reason for hiding this comment

Uh oh!

jcansdale Oct 11, 2018

Choose a reason for hiding this comment

Uh oh!

drguthals Oct 11, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jcansdale commented Oct 9, 2018 •

edited

Loading

codecov bot commented Oct 9, 2018 •

edited

Loading

jcansdale Oct 11, 2018 •

edited

Loading