Handled hashes in file names for GitHub URLs.

Fixes #34

Author: reduckted

CHANGELOG.md

@@ -1,6 +1,12 @@
+# 2.5.2 (2021-08-09)
+
+## Bug Fixes
+
+-   🐛 GitHub links now handle hashes in file names.
+
 # 2.5.1 (2021-07-10)
 
-## Changes
+## Bug Fixes
 
 -   🐛 GitHub links now prevent markdown files from being rendered.
 -   🐛 Selections that end at the start of a new line are adjusted to end at the end of the previous line.

package-lock.json

@@ -2,7 +2,7 @@
     "name": "vscode-gitweblinks",
     "displayName": "Git Web Links for VS Code",
     "description": "Copy links to files in their online Git repositories",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "publisher": "reduckted",
     "homepage": "https://github.com/reduckted/vscode-gitweblinks",
     "repository": {

package.json

@@ -441,6 +441,6 @@
         }
     },
     "oneOf": [{ "required": ["server"] }, { "required": ["private"] }],
-    "required": ["name", "branch", "url", "selection", "reverse", "tests"],
+    "required": ["name", "branchRef", "url", "selection", "reverse", "tests"],
     "additionalProperties": false
 }

shared/handler-schema.json

@@ -3,7 +3,7 @@
     "name": "GitHub Enterprise",
     "private": "gitHubEnterprise",
     "branchRef": "abbreviated",
-    "url": "{{ base }}/{{ repository }}/blob/{{ ref | encode_uri }}/{{ file | encode_uri }}?plain=1",
+    "url": "{{ base }}/{{ repository }}/blob/{{ ref | encode_uri }}/{{ file | encode_uri_component_segments }}?plain=1",
     "selection": "#L{{ startLine }}{% if startLine != endLine %}-L{{ endLine }}{% endif %}",
     "reverse": {
         "pattern": [
@@ -15,7 +15,7 @@
             "(?:\\?[^#]*)?",
             "(?:#L(?<start>\\d+)(?:-L(?<end>\\d+))?)?"
         ],
-        "file": "{{ match.groups.file | decode_uri }}",
+        "file": "{{ match.groups.file | decode_uri_component_segments }}",
         "fileMayStartWithBranch": true,
         "server": {
             "http": "{{ http }}/{{ match.groups.username }}/{{ match.groups.repository }}.git",
@@ -55,6 +55,14 @@
                 "remote": "https://local-github.server:8080/context/foo/bar.git",
                 "result": "https://local-github.server:8080/context/foo/bar/blob/{{ commit }}/src/file.txt?plain=1"
             },
+            "misc": [
+                {
+                    "name": "Hash in file name",
+                    "fileName": "test#file",
+                    "remote": "https://local-github.server:8080/context/foo/bar.git",
+                    "result": "https://local-github.server:8080/context/foo/bar/blob/master/test%23file?plain=1"
+                }
+            ],
             "selection": {
                 "remote": "https://local-github.server:8080/context/foo/bar.git",
                 "point": {

shared/handlers/github-enterprise.json

@@ -6,7 +6,7 @@
         "ssh": "[email protected]"
     },
     "branchRef": "abbreviated",
-    "url": "{{ base }}/{{ repository }}/blob/{{ ref | encode_uri }}/{{ file | encode_uri }}?plain=1",
+    "url": "{{ base }}/{{ repository }}/blob/{{ ref | encode_uri }}/{{ file | encode_uri_component_segments }}?plain=1",
     "selection": "#L{{ startLine }}{% if startLine != endLine %}-L{{ endLine }}{% endif %}",
     "reverse": {
         "pattern": [
@@ -19,7 +19,7 @@
             "(?:\\?[^#]*)?",
             "(?:#L(?<start>\\d+)(?:-L(?<end>\\d+))?)?"
         ],
-        "file": "{{ match.groups.file | decode_uri }}",
+        "file": "{{ match.groups.file | decode_uri_component_segments }}",
         "fileMayStartWithBranch": true,
         "server": {
             "http": "https://github.com/{{ match.groups.username }}/{{ match.groups.repository }}.git",
@@ -51,6 +51,14 @@
                 "remote": "https://github.com/foo/bar.git",
                 "result": "https://github.com/foo/bar/blob/{{ commit }}/src/file.txt?plain=1"
             },
+            "misc": [
+                {
+                    "name": "Hash in file name",
+                    "fileName": "test#file",
+                    "remote": "https://github.com/foo/bar.git",
+                    "result": "https://github.com/foo/bar/blob/master/test%23file?plain=1"
+                }
+            ],
             "selection": {
                 "remote": "https://github.com/foo/bar.git",
                 "point": {

shared/handlers/github.json

@@ -95,7 +95,7 @@ export class GetLinkCommand {
                         break;
 
                     case 'open':
-                        void env.openExternal(Uri.parse(link));
+                        openExternal(link);
                 }
             } catch (ex) {
                 log('Error while generating a link: %o', ex);
@@ -171,13 +171,30 @@ export class GetLinkCommand {
 
             case 'open':
                 if (link) {
-                    void env.openExternal(Uri.parse(link));
+                    openExternal(link);
                 }
                 break;
         }
     }
 }
 
+/**
+ * A wrapper around `env.openExternal()` to handle a bug in VS Code.
+ *
+ * @param link The link to open.
+ */
+function openExternal(link: string): void {
+    try {
+        // @ts-expect-error: VS Code seems to decode and re-encode the URI, which causes certain
+        // characters to be unescaped and breaks the URL. A a hack, we can try passing a string
+        // instead of a URI. If that throws an error, then we'll fall back to passing a URI.
+        // https://github.com/microsoft/vscode/issues/85930
+        void env.openExternal(link);
+    } catch {
+        void env.openExternal(Uri.parse(link));
+    }
+}
+
 /**
  * Options for controling the behaviouor of the command.
  */

src/commands/get-link-command.ts

@@ -10,8 +10,10 @@ const engine: Liquid = new Liquid({
 engine.filters.set('filename', posix.basename);
 engine.filters.set('encode_uri', encodeURI);
 engine.filters.set('encode_uri_component', encodeURIComponent);
+engine.filters.set('encode_uri_component_segments', encodeURIComponentSegments);
 engine.filters.set('decode_uri', decodeURI);
 engine.filters.set('decode_uri_component', decodeURIComponent);
+engine.filters.set('decode_uri_component_segments', decodeURIComponentSegments);
 
 /**
  * Parses the given template.
@@ -57,6 +59,29 @@ export function parseTemplate(template: Template | undefined): ParsedTemplate |
     };
 }
 
+/**
+ * A template filter that splits the value into path segments (at the '/' character)
+ * and applies `encodeURIComponent` on each segment before joining the segments back together.
+ *
+ * @param value The value to transform.
+ * @returns The transformed value.
+ */
+function encodeURIComponentSegments(value: string): string {
+    // Split the value into path segments so that
+    // `encodeURIComponent` doesn't encode the '/' character.
+    return value.split('/').map(encodeURIComponent).join('/');
+}
+
+/**
+ * A template filter that reverses `encodeURIComponentSegments`.
+ *
+ * @param value The value to transform.
+ * @returns The transformed value.
+ */
+function decodeURIComponentSegments(value: string): string {
+    return value.split('/').map(decodeURIComponent).join('/');
+}
+
 /**
  * Represents a template that has been pared and can be rendered.
  */

src/templates.ts

@@ -233,7 +233,8 @@ describe('GetLinkCommand', () => {
         command = createCommand({ linkType: 'commit', includeSelection: true, action: 'copy' });
         await command.execute(file);
 
-        expect(openExternal).to.have.been.calledWith(Uri.parse('http://example.com/foo/bar'));
+        // Should be called with a string instead of a Uri because of https://github.com/microsoft/vscode/issues/85930
+        expect(openExternal).to.have.been.calledWith('http://example.com/foo/bar');
     });
 
     it('should open the link in the browser without showing a notification when the command action is "open".', async () => {
@@ -248,7 +249,8 @@ describe('GetLinkCommand', () => {
         await command.execute(file);
 
         expect(showInformationMessage).to.have.not.been.called;
-        expect(openExternal).to.have.been.calledWith(Uri.parse('http://example.com/foo/bar'));
+        // Should be called with a string instead of a Uri because of https://github.com/microsoft/vscode/issues/85930
+        expect(openExternal).to.have.been.calledWith('http://example.com/foo/bar');
     });
 
     function createCommand(options: GetLinkCommandOptions): GetLinkCommand {

test/commands/get-link-command.test.ts

@@ -39,6 +39,12 @@ describe('templates', () => {
             expect(template.render({})).to.equal('This%20%2B%20that');
         });
 
+        it('should support encodeUriComponent() on path segments.', () => {
+            template = parseTemplate('This{{ "/a/b#c/d/" | encode_uri_component_segments }}that');
+
+            expect(template.render({})).to.equal('This/a/b%23c/d/that');
+        });
+
         it('should support decodeUri().', () => {
             template = parseTemplate('This{{ "%20+%20" | decode_uri }}that');
 
@@ -51,6 +57,12 @@ describe('templates', () => {
             expect(template.render({})).to.equal('This + that');
         });
 
+        it('should support decodeUriComponent() on path segments.', () => {
+            template = parseTemplate('This{{ "/a/b%23c/d/" | decode_uri_component_segments }}that');
+
+            expect(template.render({})).to.equal('This/a/b#c/d/that');
+        });
+
         it('should support path.basename().', () => {
             template = parseTemplate('The name is {{ "foo/bar/meep.ts" | filename }}.');