Show dialog when attempting to open non-blob URL

jcansdale · jcansdale · commit c429d7683e49 · 2018-07-12T14:55:39.000+01:00
"Couldn't open from 'https://github.com/owner/name'. Only URLs that link to repository files are currently supported."
diff --git a/src/GitHub.App/Services/GitHubContextService.cs b/src/GitHub.App/Services/GitHubContextService.cs
@@ -8,6 +8,7 @@
 using System.ComponentModel.Composition;
 using System.Text.RegularExpressions;
 using System.Runtime.InteropServices;
+using GitHub.Exports;
 using GitHub.Services;
 using GitHub.Extensions;
 using GitHub.Primitives;
@@ -90,6 +91,7 @@ public GitHubContext FindContextFromUrl(string url)
                 Host = uri.Host,
                 Owner = uri.Owner,
                 RepositoryName = uri.RepositoryName,
+                Url = uri
             };
 
             var repositoryPrefix = uri.ToRepositoryUrl().ToString() + "/";
@@ -109,6 +111,7 @@ public GitHubContext FindContextFromUrl(string url)
             {
                 context.TreeishPath = match.Groups["treeish"].Value;
                 context.BlobName = match.Groups["blobName"].Value;
+                context.LinkType = LinkType.Blob;
                 return context;
             }
 
diff --git a/src/GitHub.Exports/Exports/ExportMetadata.cs b/src/GitHub.Exports/Exports/ExportMetadata.cs
@@ -19,6 +19,7 @@ public enum MenuType
     /// </summary>
     public enum LinkType
     {
+        Unknown,
         Blob,
         Blame
     }
diff --git a/src/GitHub.Exports/Services/GitHubContext.cs b/src/GitHub.Exports/Services/GitHubContext.cs
@@ -1,4 +1,7 @@
-﻿namespace GitHub.Services
+﻿using GitHub.Exports;
+using GitHub.Primitives;
+
+namespace GitHub.Services
 {
     public class GitHubContext
     {
@@ -15,5 +18,7 @@ public class GitHubContext
         public int? Issue { get; set; }
         public int? Line { get; set; }
         public int? LineEnd { get; set; }
+        public UriString Url { get; set; }
+        public LinkType LinkType { get; set; }
     }
 }
diff --git a/src/GitHub.VisualStudio/Commands/OpenFromClipboardCommand.cs b/src/GitHub.VisualStudio/Commands/OpenFromClipboardCommand.cs
@@ -1,6 +1,7 @@
 ﻿using System;
 using System.ComponentModel.Composition;
 using GitHub.Commands;
+using GitHub.Exports;
 using GitHub.Services;
 using GitHub.Services.Vssdk.Commands;
 using Task = System.Threading.Tasks.Task;
@@ -16,6 +17,7 @@ public class OpenFromClipboardCommand : VsCommand<string>, IOpenFromClipboardCom
         public const string NoActiveRepositoryMessage = "There is no active repository to navigate";
         public const string ChangesInWorkingDirectoryMessage = "This file has changed since the permalink was created";
         public const string DifferentRepositoryMessage = "Please open the repository '{0}' and try again";
+        public const string UnknownLinkTypeMessage = "Couldn't open from '{0}'. Only URLs that link to repository files are currently supported.";
 
         readonly Lazy<IGitHubContextService> gitHubContextService;
         readonly Lazy<ITeamExplorerContext> teamExplorerContext;
@@ -55,6 +57,13 @@ public override async Task Execute(string url)
                 return;
             }
 
+            if (context.LinkType != LinkType.Blob)
+            {
+                var message = string.Format(UnknownLinkTypeMessage, context.Url);
+                vsServices.Value.ShowMessageBoxInfo(message);
+                return;
+            }
+
             var activeRepository = teamExplorerContext.Value.ActiveRepository;
             var repositoryDir = activeRepository?.LocalPath;
             if (repositoryDir == null)
diff --git a/test/GitHub.App.UnitTests/Services/GitHubContextServiceTests.cs b/test/GitHub.App.UnitTests/Services/GitHubContextServiceTests.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using GitHub.Exports;
 using GitHub.Services;
 using GitHub.App.Services;
 using NSubstitute;
@@ -121,6 +122,27 @@ public void IsNull(string url, bool expectNull)
 
             Assert.That(context, expectNull ? Is.Null : Is.Not.Null);
         }
+
+        [TestCase("https://github.com/github/VisualStudio/blob/master/README.md", "https://github.com/github/VisualStudio/blob/master/README.md")]
+        public void Url_EqualTo(string url, string expectUrl)
+        {
+            var target = CreateGitHubContextService();
+
+            var context = target.FindContextFromUrl(url);
+
+            Assert.That(context.Url?.ToString(), Is.EqualTo(expectUrl));
+        }
+
+        [TestCase("https://github.com/github/VisualStudio/blob/master/README.md", LinkType.Blob)]
+        [TestCase("https://github.com/github/VisualStudio/unknown/master/README.md", LinkType.Unknown)]
+        public void LinkType_EqualTo(string url, LinkType expectLinkType)
+        {
+            var target = CreateGitHubContextService();
+
+            var context = target.FindContextFromUrl(url);
+
+            Assert.That(context.LinkType, Is.EqualTo(expectLinkType));
+        }
     }
 
     public class TheToMethod
diff --git a/test/GitHub.VisualStudio.UnitTests/Commands/OpenFromClipboardCommandTests.cs b/test/GitHub.VisualStudio.UnitTests/Commands/OpenFromClipboardCommandTests.cs
@@ -1,5 +1,8 @@
 ﻿using System;
 using System.Threading.Tasks;
+using GitHub.Exports;
+using GitHub.Primitives;
+using GitHub.App.Services;
 using GitHub.Services;
 using GitHub.VisualStudio.Commands;
 using Microsoft.VisualStudio;
@@ -25,7 +28,7 @@ public async Task NothingInClipboard()
         [Test]
         public async Task NoLocalRepository()
         {
-            var context = new GitHubContext();
+            var context = CreateGitHubContext();
             var repositoryDir = null as string;
             var vsServices = Substitute.For<IVSServices>();
             var target = CreateOpenFromClipboardCommand(vsServices: vsServices, contextFromClipboard: context, repositoryDir: repositoryDir);
@@ -35,13 +38,27 @@ public async Task NoLocalRepository()
             vsServices.Received(1).ShowMessageBoxInfo(OpenFromClipboardCommand.NoActiveRepositoryMessage);
         }
 
+        [Test]
+        public async Task UnknownLinkType()
+        {
+            var context = new GitHubContext { LinkType = LinkType.Unknown };
+            var expectMessage = string.Format(OpenFromClipboardCommand.UnknownLinkTypeMessage, context.Url);
+            var activeRepositoryDir = "activeRepositoryDir";
+            var vsServices = Substitute.For<IVSServices>();
+            var target = CreateOpenFromClipboardCommand(vsServices: vsServices, contextFromClipboard: context, repositoryDir: activeRepositoryDir);
+
+            await target.Execute(null);
+
+            vsServices.Received(1).ShowMessageBoxInfo(expectMessage);
+        }
+
         [TestCase("targetRepositoryName", "activeRepositoryName", OpenFromClipboardCommand.DifferentRepositoryMessage)]
         [TestCase("SameRepositoryName", "SameRepositoryName", null)]
         [TestCase("same_repository_name", "SAME_REPOSITORY_NAME", null)]
         public async Task DifferentLocalRepository(string targetRepositoryName, string activeRepositoryName, string expectMessage)
         {
             var activeRepositoryDir = "activeRepositoryDir";
-            var context = new GitHubContext { RepositoryName = targetRepositoryName };
+            var context = CreateGitHubContext(repositoryName: targetRepositoryName);
             var resolveBlobResult = ("commitish", "path", "SHA");
             var vsServices = Substitute.For<IVSServices>();
             var target = CreateOpenFromClipboardCommand(vsServices: vsServices,
@@ -64,12 +81,13 @@ public async Task DifferentLocalRepository(string targetRepositoryName, string a
         [TestCase("sameowner", "SAMEOWNER", OpenFromClipboardCommand.NoResolveSameOwnerMessage)]
         public async Task CouldNotResolve(string targetOwner, string currentOwner, string expectMessage)
         {
-            var context = new GitHubContext { Owner = targetOwner };
             var repositoryDir = "repositoryDir";
+            var repositoryName = "repositoryName";
+            var context = CreateGitHubContext(repositoryName: repositoryName, owner: targetOwner);
             (string, string, string)? resolveBlobResult = null;
             var vsServices = Substitute.For<IVSServices>();
             var target = CreateOpenFromClipboardCommand(vsServices: vsServices,
-                contextFromClipboard: context, repositoryDir: repositoryDir, repositoryOwner: currentOwner, resolveBlobResult: resolveBlobResult);
+                contextFromClipboard: context, repositoryDir: repositoryDir, repositoryOwner: currentOwner, repositoryName: repositoryName, resolveBlobResult: resolveBlobResult);
 
             await target.Execute(null);
 
@@ -79,12 +97,13 @@ public async Task CouldNotResolve(string targetOwner, string currentOwner, strin
         [Test]
         public async Task CouldResolve()
         {
-            var context = new GitHubContext();
+            var repositoryName = "repositoryName";
+            var context = CreateGitHubContext(repositoryName: repositoryName);
             var repositoryDir = "repositoryDir";
             var resolveBlobResult = ("master", "foo.cs", "");
             var vsServices = Substitute.For<IVSServices>();
             var target = CreateOpenFromClipboardCommand(vsServices: vsServices,
-                contextFromClipboard: context, repositoryDir: repositoryDir, resolveBlobResult: resolveBlobResult);
+                contextFromClipboard: context, repositoryDir: repositoryDir, repositoryName: repositoryName, resolveBlobResult: resolveBlobResult);
 
             await target.Execute(null);
 
@@ -94,13 +113,14 @@ public async Task CouldResolve()
         [Test]
         public async Task NoChangesInWorkingDirectory()
         {
-            var gitHubContextService = Substitute.For<IGitHubContextService>();
-            var context = new GitHubContext();
             var repositoryDir = "repositoryDir";
+            var repositoryName = "repositoryName";
+            var context = CreateGitHubContext(repositoryName: repositoryName);
+            var gitHubContextService = Substitute.For<IGitHubContextService>();
             var resolveBlobResult = ("master", "foo.cs", "");
             var vsServices = Substitute.For<IVSServices>();
             var target = CreateOpenFromClipboardCommand(gitHubContextService: gitHubContextService, vsServices: vsServices,
-                contextFromClipboard: context, repositoryDir: repositoryDir, resolveBlobResult: resolveBlobResult, hasChanges: false);
+                contextFromClipboard: context, repositoryDir: repositoryDir, repositoryName: repositoryName, resolveBlobResult: resolveBlobResult, hasChanges: false);
 
             await target.Execute(null);
 
@@ -113,15 +133,17 @@ public async Task NoChangesInWorkingDirectory()
         public async Task HasChangesInWorkingDirectory(bool annotateFileSupported, string message,
             int receivedTryAnnotateFile, int receivedTryOpenFile)
         {
+            var repositoryDir = "repositoryDir";
+            var repositoryName = "repositoryName";
+            var targetBranch = "targetBranch";
+            var context = CreateGitHubContext(repositoryName: repositoryName, branch: targetBranch);
             var gitHubContextService = Substitute.For<IGitHubContextService>();
             gitHubContextService.TryAnnotateFile(null, null, null).ReturnsForAnyArgs(annotateFileSupported);
-            var context = new GitHubContext();
-            var repositoryDir = "repositoryDir";
             var currentBranch = "currentBranch";
-            var resolveBlobResult = ("master", "foo.cs", "");
+            var resolveBlobResult = (targetBranch, "foo.cs", "");
             var vsServices = Substitute.For<IVSServices>();
             var target = CreateOpenFromClipboardCommand(gitHubContextService: gitHubContextService, vsServices: vsServices,
-                contextFromClipboard: context, repositoryDir: repositoryDir, currentBranch: currentBranch, resolveBlobResult: resolveBlobResult, hasChanges: true);
+                contextFromClipboard: context, repositoryDir: repositoryDir, repositoryName: repositoryName, currentBranch: currentBranch, resolveBlobResult: resolveBlobResult, hasChanges: true);
 
             await target.Execute(null);
 
@@ -138,6 +160,14 @@ public async Task HasChangesInWorkingDirectory(bool annotateFileSupported, strin
             gitHubContextService.Received(receivedTryOpenFile).TryOpenFile(repositoryDir, context);
         }
 
+        static GitHubContext CreateGitHubContext(UriString uri = null, string owner = "github", string repositoryName = "VisualStudio"
+            string branch = "master")
+        {
+            uri = uri ?? new UriString($"https://github.com/{owner}/{repositoryName}/blob/{branch}/README.md");
+
+            return new GitHubContextService(null, null).FindContextFromUrl(uri);
+        }
+
         static OpenFromClipboardCommand CreateOpenFromClipboardCommand(
             IGitHubContextService gitHubContextService = null,
             ITeamExplorerContext teamExplorerContext = null,

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ public enum MenuType`
`19`	`19`	`/// </summary>`
`20`	`20`	`public enum LinkType`
`21`	`21`	`{`
	`22`	`+ Unknown,`
`22`	`23`	`Blob,`
`23`	`24`	`Blame`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,7 @@`
`1`		`-namespace GitHub.Services`
	`1`	`+using GitHub.Exports;`
	`2`	`+using GitHub.Primitives;`
	`3`	`+`
	`4`	`+namespace GitHub.Services`
`2`	`5`	`{`
`3`	`6`	`public class GitHubContext`
`4`	`7`	`{`
`@@ -15,5 +18,7 @@ public class GitHubContext`
`15`	`18`	`public int? Issue { get; set; }`
`16`	`19`	`public int? Line { get; set; }`
`17`	`20`	`public int? LineEnd { get; set; }`
	`21`	`+ public UriString Url { get; set; }`
	`22`	`+ public LinkType LinkType { get; set; }`
`18`	`23`	`}`
`19`	`24`	`}`