refactor: enhance github url regex (#88)

target · Oct 26, 2020 · 4713d9e · 4713d9e
1 parent 87ce12b
commit 4713d9e
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 3 deletions.
diff --git a/src/utils/ticketFinder/finders/github/__tests__/githubFinder.test.js b/src/utils/ticketFinder/finders/github/__tests__/githubFinder.test.js
@@ -15,7 +15,9 @@ resolved super/duper/#11
 
 https://github.com/example_user/example_project/issues/3
 https://github.com/example_user/example_project/issues/4
+https://github.com/example_user/example_project/issues/5#some-hash
 https://git.myenterprise.com/example_user/example_project/issues/5
+https://git.subdomain.myenterprise.com/example_user/example_project/issues/5
 https://www.github.com/example_user/example_project/issues/6
 https://github.com/example_user/example_project/issues/7
 https://github.com/example_user/example_project/issues/8
@@ -38,12 +40,24 @@ describe('github finder', () => {
           issueNumber: '4',
           name: '4',
         },
+        {
+          fullLinkedUrl: 'https://github.com/example_user/example_project/issues/5',
+          project: 'example_user/example_project',
+          issueNumber: '5',
+          name: '5',
+        },
         {
           fullLinkedUrl: 'https://git.myenterprise.com/example_user/example_project/issues/5',
           project: 'example_user/example_project',
           issueNumber: '5',
           name: '5',
         },
+        {
+          fullLinkedUrl: 'https://git.subdomain.myenterprise.com/example_user/example_project/issues/5',
+          project: 'example_user/example_project',
+          issueNumber: '5',
+          name: '5',
+        },
         {
           fullLinkedUrl: 'https://www.github.com/example_user/example_project/issues/6',
           project: 'example_user/example_project',
@@ -128,12 +142,39 @@ describe('github finder', () => {
     expect(githubFinder({ body })).toEqual(expectation);
   });
 
+  it('should find ticket with period at end of URL', () => {
+    const PRBody = `
+      ## Summary
+
+
+      https://git.you.com/wow/woohoo/issues/27158.
+
+      ### Addresses issue
+
+      prod issue
+      ### Steps to reproduce & screenshots/GIFs
+    `;
+    const expectation = {
+      tickets: [
+        {
+          fullLinkedUrl: 'https://git.you.com/wow/woohoo/issues/27158',
+          project: 'wow/woohoo',
+          issueNumber: '27158',
+          name: '27158',
+        },
+      ],
+      name: 'github',
+    };
+
+    expect(githubFinder({ body: PRBody })).toEqual(expectation);
+  });
+
   it('should return 2 tickets, not one, if they grouped together by only words or whitespace', () => {
     const PRBody = `
       ## Summary
 
 
-      https://git.you.com/wow/woohoo/issues/27158 and https://git.you.com/wow/woohoo/issue/27166
+      https://git.you.com/wow/woohoo/issues/27158 and https://git.you.com/wow/woohoo/issues/27166
 
       ### Addresses issue
 
@@ -149,7 +190,7 @@ describe('github finder', () => {
           name: '27158',
         },
         {
-          fullLinkedUrl: 'https://git.you.com/wow/woohoo/issue/27166',
+          fullLinkedUrl: 'https://git.you.com/wow/woohoo/issues/27166',
           project: 'wow/woohoo',
           issueNumber: '27166',
           name: '27166',
@@ -179,6 +220,26 @@ describe('github finder', () => {
     expect(githubFinder({ body: PRBody })).toEqual(expectation);
   });
 
+  it('should not think other GitHub URL is a ticket', () => {
+    const PRBody = `
+      ## Summary
+
+
+      https://git.you.com/wow/woohoo/tree/main/config/123
+
+      ### Addresses issue
+
+      prod issue
+      ### Steps to reproduce & screenshots/GIFs
+    `;
+    const expectation = {
+      tickets: [],
+      name: 'github',
+    };
+
+    expect(githubFinder({ body: PRBody })).toEqual(expectation);
+  });
+
   it('should return no tickets if there are no ticket types', () => {
     const expectation = {
       tickets: [],

diff --git a/src/utils/ticketFinder/finders/github/index.js b/src/utils/ticketFinder/finders/github/index.js
@@ -7,7 +7,7 @@ const githubDomain = config.get('github:domain') || 'https://github.com';
 const owner = config.get('github:owner');
 const repo = config.get('github:repo');
 
-const GITHUB_QUALIFIED_URL = /(https:\/\/(?:www.git|git)(?:\.\w+|\w+)\.com\/[a-zA-Z0-9_-]+\/[a-zA-Z0-9_-]+\/[^pull]+\w+\/\d+)/;
+const GITHUB_QUALIFIED_URL = /(https:\/\/(?:www.git|git)[^\s]*(\.[^\s]+)+\/[^\s]+\/[^\s]+\/issues\/\d+)/;
 const GITHUB_QUALIFIED_NUMBER_URL = /https:\/\/(?:www.git|git).*\..+\/(\d+)/;
 const CLOSE_ISSUE_SYNTAX = /(?:close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved)\s(\S.*\/\S.*#\d+|#\d+)/;
 const CLOSE_SYNTAX_NUMBER = /#(\d+)/;