Unified Clone / Open from GitHub UI #1919

jcansdale · 2018-09-13T16:41:12Z

What this PR does

Allow user to Open a repository when the target path already exists
View/open cloned repositories on Team Explorer Home (same as built in clone)
In Visual Studio 2017 open cloned repositories in Folder view (same as built in clone)
Fix GitHub button on Start Page
Add Add File / Open / Open from GitHub... button
Pre-populate Url from clipboard/command args when available
Only show warning banner when a file is in the way of the target path
Use Clone/Open dialog for existing GitHub.OpenFromUrl command

TODO

Add metrics

What this PR doesn't do

The GitHub.OpenFromUrl command will no longer attempt to navigate the the file and line number from a target Url. This was done to trim the scope of this PR to simply cloning/opening a repository.

The next step will be to incorporate functionality from the Open from clipboard command. This will be more complex to test and will be done as a separate PR.

At the moment these two commands can be combined manually:

Copy a GitHub URL to the clipboard
Use Add File / Open / Open from GitHub...
Use GitHub > Open from clipboard

How to test

Here is an example workflow

Copy a GitHub URL
Select File > Open > Open from GitHub...
URL is copied into username/repository field and path is populated with a default location
Click Open if local repository already exists or update path and Clone to create a new repository
Repository folder is loaded into Solution Explorer and Team Explorer - Home appears
Select from list of solutions

Use clone from URL as the UI for GitHub.OpenFromUrl.

Now we have a proper UI, re-enable the `File / Open / Open from GitHub...` button.

Add method for cloning or opening a repository.

Add method to open a repository and view it on Team Explorer Home.

Use VSServices.TryOpenRepository on Visual Studio 2015 where solution folders aren't available. This creates a temporary solution to make Team Explorer change its active repository.

When a directory already exists we can open the repository, so only show a path error when a file exists at the target path.

IVSServices is only used in Visual Studio 2015 so retrieve it on demand.

Be flexible about the type of Url that CloneDialogResult can return.

Convert ToRepositoryUrl inside this method.

This command is now only responsible for opening the clone and calling CloneOrOpenRepository.

meaghanlewis · 2018-09-21T23:16:16Z

This LGTM @jcansdale ✨

This reverts commit b2f0679.

jcansdale · 2018-09-24T16:55:34Z

src/GitHub.App/Services/RepositoryCloneService.cs

+                await CloneRepository(cloneUrl, repositoryPath, progress);
+            }
+
+            teamExplorerServices.OpenRepository(repositoryPath);


We don't need to do this when cloning (it happens as part of the clone). But we should still switch to Team Explorer - Home.

It appears that CloneRepository is also called when a new repository is created. Only increment the new counters during CloneOrOpenRepository.

Increment new NumberOfGitHubClones and NumberOfEnterpriseClones counters in CloneOrOpenRepository but not CloneRepository.

Expect to fail on this commit.

Increment NumberOfGitHubOpens and NumberOfEnterpriseOpens counters when CloneOrOpenRepository is called.

jcansdale · 2018-09-25T14:30:14Z

src/GitHub.App/Services/RepositoryCloneService.cs

@@ -121,20 +172,7 @@ public async Task<ViewerRepositoriesModel> ReadViewerRepositories(HostAddress ad
            try
            {
                await vsGitServices.Clone(cloneUrl, repositoryPath, true, progress);
-
                await usageTracker.IncrementCounter(x => x.NumberOfClones);


This method is being called by CreateRepository here:

VisualStudio/src/GitHub.App/Services/RepositoryCreationService.cs

Line 40 in 8067273

.Select(repository => cloneService.CloneRepository(repository.CloneUrl, Path.Combine(directory, repository.Name)))

Change to "A file exists at the destination path."

Check the following conditions: - Local repository exists at path - Local repository has an 'origin' remote - Local repository's URL matches selected repository

There was an issue with PathError appearing at the top. When the error appeared, the repository list would move down causing a different repository to be selected. This would clause flickering between two repositories. This commit consolidates PathError into PathWarning (which appears above the path which is being validated). This avoids the flicker and puts the warning next to the text box which it applies to. The logic to block clone or open when there is a file in the way has been moved to the commands' `canExecute` observable.

This reverts commit c37522b. Fixed in #1953 instead

jcansdale · 2018-09-27T09:16:47Z

@grokys re: #1919 (comment)

Should we be checking whether the repository at this path has the same clone URL? I'm thinking of the case where e.g. the user wants to clone a fork and they already have the parent repository at this location.

I've added checks for this and also for when there is no repository at the target path or when the repository doesn't have a remote named origin.

I've moved the warning banner to above the Local path text box that it's validating. This was for a couple of reasons.

Having it appear above the tree view meant that when it appeared, it moved the tree view control that the user might have clicked on. This lead to rapid cycling between two selections.
Moving it to above the field that it's validating means the context is obvious and the warnings can be more concise (we're somewhat restricted for space).

Here are the warnings:

When there is no repository at the local path (e.g. an empty folder):
When the remote URL of the local repository is different to the URL selected:
When there is a file in the way of the local path (in this case there is a file called PReview:
When the target repository doesn't have a remote named origin and won't be recognized by GHfVS:

"You have already cloned to this location. Click 'Open' to open the local repository."

jcansdale · 2018-09-27T10:08:24Z

It will now always this this when a local clone already exists:

jcansdale · 2018-09-27T10:41:44Z

Here are the updated warning messages:

Add Open_Is_Enabled_When_Path_DirectoryExists test Fix/update some other tests

StanleyGoldman

Should the user message here change?

StanleyGoldman · 2018-09-27T12:00:06Z

src/GitHub.TeamFoundation.14/Connect/GitHubConnectSection.cs


                    usageTracker.IncrementCounter(x => x.NumberOfGitHubConnectSectionClones).Forget();
                }
                catch (Exception e)
                {
                    var teServices = ServiceProvider.TryGetService<ITeamExplorerServices>();
-                    teServices.ShowError(e.GetUserFriendlyErrorMessage(ErrorType.ClonedFailed, result.Repository.Name));
+                    teServices.ShowError(e.GetUserFriendlyErrorMessage(ErrorType.ClonedFailed, result.Url.RepositoryName));


Should the user message here change?

You're right. Commit incoming. 🚀

PathWarning_Is_Set_For_Existing_Clone_At_Destination PathWarning_Is_Set_For_Repository_With_No_Origin PathWarning_Is_Set_For_Directory_With_No_Repository PathWarning_Is_Set_For_Existing_Repository_At_Destination_With_Different_Remote

Changed ClonedFailed to CloneOrOpenFailed.

jcansdale added 17 commits September 13, 2018 15:38

Use clone dialog as OpenFromUrl UI

b2f0679

Use clone from URL as the UI for GitHub.OpenFromUrl.

Add File / Open / Open from GitHub... button

5e955d6

Now we have a proper UI, re-enable the `File / Open / Open from GitHub...` button.

WIP: Allow user to open from the clone dialog

f2ed1fd

Add RepositoryCloneService.CloneOrOpenRepository

732f9d2

Add method for cloning or opening a repository.

Add ITeamExplorerServices.OpenRepository

ba3bdfa

Add method to open a repository and view it on Team Explorer Home.

Use CloneOrOpenRepository in OpenFromUrlCommand

1726986

Open repository after cloning

5295642

Don't attempt to open folder on Visual Studio 2015

f8d0c7b

Use VSServices.TryOpenRepository on Visual Studio 2015 where solution folders aren't available. This creates a temporary solution to make Team Explorer change its active repository.

Only enable Open when a repository is selected

f10bf85

Fix failing tests

b82ac27

Only show path error when file is in way

43fd57d

When a directory already exists we can open the repository, so only show a path error when a file exists at the target path.

Prepopulate URL from clipboard/command args

2aa841d

Fix CA errors

a47cc29

IVSServices is only used in Visual Studio 2015 so retrieve it on demand.

Change dialog title to Open from GitHub

f13312e

Return Url instead of IRepositoryModel

9ec30fb

Be flexible about the type of Url that CloneDialogResult can return.

Make CloneOrOpenRepository accept URL

efcf29d

Convert ToRepositoryUrl inside this method.

Simplify OpenFromUrlCommand

b361468

This command is now only responsible for opening the clone and calling CloneOrOpenRepository.

jcansdale mentioned this pull request Sep 18, 2018

GitHub button not working on start page #1927

Closed

jcansdale changed the title ~~[spike] Unified Clone / Open from GitHub UI~~ Unified Clone / Open from GitHub UI Sep 18, 2018

jcansdale added the Ready for Review label Sep 18, 2018

jcansdale requested review from grokys and meaghanlewis September 18, 2018 19:42

jcansdale and others added 2 commits September 19, 2018 10:01

Merge branch 'master' into feature/open-from-uri-clone-ui

fff3255

Merge branch 'master' into feature/open-from-uri-clone-ui

bb181eb

Revert change to default clone/open tab

fdca558

This reverts commit b2f0679.

meaghanlewis mentioned this pull request Sep 24, 2018

Development Sprint: October 1st Release #1899

Closed

meaghanlewis added the verified label Sep 24, 2018

jcansdale commented Sep 24, 2018

View reviewed changes

Merge branch 'master' into feature/open-from-uri-clone-ui

95f8a01

jcansdale added 4 commits September 25, 2018 14:43

Only increment NumberOfClones during clone

451a5b0

It appears that CloneRepository is also called when a new repository is created. Only increment the new counters during CloneOrOpenRepository.

Increment new counters in CloneOrOpenRepository

d91c9ab

Increment new NumberOfGitHubClones and NumberOfEnterpriseClones counters in CloneOrOpenRepository but not CloneRepository.

Add tests for NumberOf*Opens counters

af55f6a

Expect to fail on this commit.

Increment NumberOf*Opens counters

8067273

Increment NumberOfGitHubOpens and NumberOfEnterpriseOpens counters when CloneOrOpenRepository is called.

jcansdale commented Sep 25, 2018

View reviewed changes

Update DestinationAlreadyExists warning

9f8757a

Change to "A file exists at the destination path."

jcansdale force-pushed the feature/open-from-uri-clone-ui branch from 430fb34 to 9f8757a Compare September 25, 2018 14:48

jcansdale and others added 7 commits September 25, 2018 16:20

Merge branch 'master' into feature/open-from-uri-clone-ui

3172217

Sanity check local repository

527b1d1

Check the following conditions: - Local repository exists at path - Local repository has an 'origin' remote - Local repository's URL matches selected repository

Fixing test

09347ae

Fixing another test

43ba772

Merge branch 'master' into feature/open-from-uri-clone-ui

6de1bbb

Revert "Don't run XliffTasks targets during NCrunch build"

f1ba0d2

This reverts commit c37522b. Fixed in #1953 instead

jcansdale added 2 commits September 27, 2018 10:19

Convert strings to resources

7344458

Show warning when local clone already exists

d789c4e

"You have already cloned to this location. Click 'Open' to open the local repository."

jcansdale added 3 commits September 27, 2018 12:03

Refined wording of local path warnings

27e13d2

Factor out magical strings

43162db

Update Clone/Open enabled tests

5f2012a

Add Open_Is_Enabled_When_Path_DirectoryExists test Fix/update some other tests

StanleyGoldman reviewed Sep 27, 2018

View reviewed changes

jcansdale added 2 commits September 27, 2018 14:20

Add unit tests for ValidatePathWarning

cfadc62

PathWarning_Is_Set_For_Existing_Clone_At_Destination PathWarning_Is_Set_For_Repository_With_No_Origin PathWarning_Is_Set_For_Directory_With_No_Repository PathWarning_Is_Set_For_Existing_Repository_At_Destination_With_Different_Remote

Update ErrorType.ClonedFailed message

ca1a215

Changed ClonedFailed to CloneOrOpenFailed.

StanleyGoldman approved these changes Sep 27, 2018

View reviewed changes

jcansdale mentioned this pull request Sep 27, 2018

Documentation updates #1943

Merged

Merge branch 'master' into feature/open-from-uri-clone-ui

37e9acf

jcansdale merged commit b582064 into master Sep 27, 2018

jcansdale deleted the feature/open-from-uri-clone-ui branch September 27, 2018 17:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Unified Clone / Open from GitHub UI #1919

Unified Clone / Open from GitHub UI #1919

Uh oh!

jcansdale commented Sep 13, 2018 •

edited

Loading

Uh oh!

meaghanlewis commented Sep 21, 2018

Uh oh!

jcansdale Sep 24, 2018 •

edited

Loading

Uh oh!

jcansdale Sep 25, 2018

Uh oh!

jcansdale commented Sep 27, 2018 •

edited

Loading

Uh oh!

jcansdale commented Sep 27, 2018

Uh oh!

jcansdale commented Sep 27, 2018 •

edited

Loading

Uh oh!

StanleyGoldman left a comment

Uh oh!

StanleyGoldman Sep 27, 2018

Uh oh!

jcansdale Sep 27, 2018

Uh oh!

Uh oh!

Unified Clone / Open from GitHub UI #1919

Unified Clone / Open from GitHub UI #1919

Uh oh!

Conversation

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

Uh oh!

What this PR does

TODO

What this PR doesn't do

How to test

Here is an example workflow

Uh oh!

meaghanlewis commented Sep 21, 2018

Uh oh!

jcansdale Sep 24, 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!

jcansdale Sep 25, 2018

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

jcansdale commented Sep 27, 2018

Uh oh!

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

Uh oh!

Uh oh!

StanleyGoldman left a comment

Choose a reason for hiding this comment

Uh oh!

StanleyGoldman Sep 27, 2018

Choose a reason for hiding this comment

Uh oh!

jcansdale Sep 27, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jcansdale commented Sep 13, 2018 •

edited

Loading

jcansdale Sep 24, 2018 •

edited

Loading

jcansdale commented Sep 27, 2018 •

edited

Loading

jcansdale commented Sep 27, 2018 •

edited

Loading