remove package with vulnerability and add new logic to handle checkin…

…g for issue keys in reference links (atlassian#422)

Co-authored-by: Rachelle Rathbone <[email protected]>

lib/jira/util/index.js

@@ -1,6 +1,30 @@
-const { markdown } = require('markdown');
-
 module.exports = function (jiraClient) {
+  const containsReferenceLink = (line) => {
+    // reference text links should have 2 parts only
+    if (line.split(' ').length === 2) {
+      const hasSquareBrackets = line.charAt(0) === '[' && line.includes(']:');
+      const hasUrl = line.includes('http://') || line.includes('https://');
+
+      return hasSquareBrackets && hasUrl;
+    }
+
+    return false;
+  };
+
+  // Parse our existing issue text, pulling out any existing reference links.
+  // if reference links exist, returns array of issue keys. For example, the following
+  // reference links would return [ 'TEST-2019', 'TEST-2020' ]
+  // [TEST-2019]: http://example.com/browse/TEST-2019
+  // [TEST-2020]: https://example.com/browse/TEST-2020
+  // if no issue keys exist, return []
+  const checkForReferenceText = (text) => {
+    const splitTextByNewLine = text.split('\n');
+
+    return splitTextByNewLine
+      .filter((line) => containsReferenceLink(line))
+      .map((referenceLink) => referenceLink.slice(1, referenceLink.indexOf(']')));
+  };
+
   function addJiraIssueLinks(text, issues) {
     const referenceRegex = /\[([A-Z]+-[0-9]+)\](?!\()/g;
     const issueMap = issues.reduce((issueMap, issue) => ({
@@ -9,10 +33,7 @@ module.exports = function (jiraClient) {
     }), {});
 
     const links = [];
-
-    // Attempt to parse our existing issue text, pulling out any existing reference links.
-    const [, { references }] = markdown.parse(text);
-    const keys = references ? Object.keys(references) : [];
+    const keys = checkForReferenceText(text);
 
     // Parse the text up to a maximum amount of characters.
     while (referenceRegex.lastIndex < 1000) {
@@ -23,9 +44,8 @@ module.exports = function (jiraClient) {
       }
 
       const [, key] = match;
-
       // If we already have a reference link, or the issue is not valid, skip it.
-      if (keys.includes(key.toLowerCase()) || !issueMap[key]) {
+      if (keys.includes(key) || !issueMap[key]) {
         continue;
       }
 

package.json

@@ -35,7 +35,6 @@
     "helmet": "^3.21.2",
     "hot-shots": "^7.4.1",
     "ioredis": "^4.16.3",
-    "markdown": "^0.5.0",
     "moment": "^2.24.0",
     "moo": "^0.5.0",
     "newrelic": "^6.2.0",

test/fixtures/text/find-existing-references.rendered.md

@@ -0,0 +1,8 @@
+#### [TEST-2019]
+
+[TEST-2019]: https://example.com/browse/TEST-2019 This issue is related to [TEST-2020] and [TEST-2021] and this is [TEST-2020]: https://example.com/browse/TEST-2020 is randomly placed in the text.
+
+[TEST-2019]: http://example.com/browse/TEST-2019
+[TEST-2020]: https://example.com/browse/TEST-2020
+
+[TEST-2021]: http://example.com/browse/TEST-2021

test/fixtures/text/find-existing-references.source.md

@@ -0,0 +1,6 @@
+#### [TEST-2019]
+
+[TEST-2019]: https://example.com/browse/TEST-2019 This issue is related to [TEST-2020] and [TEST-2021] and this is [TEST-2020]: https://example.com/browse/TEST-2020 is randomly placed in the text.
+
+[TEST-2019]: http://example.com/browse/TEST-2019
+[TEST-2020]: https://example.com/browse/TEST-2020

test/unit/jira/util.test.js

@@ -24,7 +24,7 @@ describe('Jira util', () => {
       util = getJiraUtil(jiraClient);
     });
 
-    test('it should handle multiple Jira references appropriately', () => {
+    it('it should handle multiple Jira references appropriately', () => {
       const { source, rendered } = loadFixture('multiple-links');
       const issues = [
         {
@@ -76,7 +76,6 @@ describe('Jira util', () => {
           },
         },
       ];
-
       const result = util.addJiraIssueLinks(source, issues);
       expect(result).toBe(rendered);
     });
@@ -104,6 +103,34 @@ describe('Jira util', () => {
       const result = util.addJiraIssueLinks(source, issues);
       expect(result).toBe(rendered);
     });
+
+    it('should only pull issue keys from reference links', () => {
+      const { source, rendered } = loadFixture('find-existing-references');
+      const issues = [
+        {
+          key: 'TEST-2019',
+          fields: {
+            summary: 'First Issue',
+          },
+        },
+        {
+          key: 'TEST-2020',
+          fields: {
+            summary: 'Second Issue',
+          },
+        },
+        {
+          key: 'TEST-2021',
+          fields: {
+            summary: 'Third Issue',
+          },
+        },
+      ];
+
+      const result = util.addJiraIssueLinks(source, issues);
+
+      expect(result).toBe(rendered);
+    });
   });
 
   describe('#getJiraId', () => {