Merge branch '18324-recognise-links-to-urls-and-repository-files-in-job-logs' into 'master'

Make URLs in logs lines into clickable links

See merge request gitlab-org/gitlab!47532

app/assets/javascripts/jobs/components/log/line.vue

 <script>
+import { linkRegex } from '../../utils';
+
 import LineNumber from './line_number.vue';
 
 export default {
@@ -16,15 +18,45 @@ export default {
   render(h, { props }) {
     const { line, path } = props;
 
-    const chars = line.content.map(content => {
-      return h(
-        'span',
-        {
-          class: ['gl-white-space-pre-wrap', content.style],
-        },
-        content.text,
-      );
-    });
+    let chars;
+    if (gon?.features?.ciJobLineLinks) {
+      chars = line.content.map(content => {
+        return h(
+          'span',
+          {
+            class: ['gl-white-space-pre-wrap', content.style],
+          },
+          // Simple "tokenization": Split text in chunks of text
+          // which alternate between text and urls.
+          content.text.split(linkRegex).map(chunk => {
+            // Return normal string for non-links
+            if (!chunk.match(linkRegex)) {
+              return chunk;
+            }
+            return h(
+              'a',
+              {
+                attrs: {
+                  href: chunk,
+                  rel: 'nofollow noopener noreferrer', // eslint-disable-line @gitlab/require-i18n-strings
+                },
+              },
+              chunk,
+            );
+          }),
+        );
+      });
+    } else {
+      chars = line.content.map(content => {
+        return h(
+          'span',
+          {
+            class: ['gl-white-space-pre-wrap', content.style],
+          },
+          content.text,
+        );
+      });
+    }
 
     return h('div', { class: 'js-line log-line' }, [
       h(LineNumber, {

app/assets/javascripts/jobs/utils.js

+// capture anything starting with http:// or https://
+// up until a disallowed character or whitespace
+export const linkRegex = /(https?:\/\/[^"<>\\^`{|}\s]+)/g;
+export default { linkRegex };

app/controllers/projects/jobs_controller.rb

@@ -14,6 +14,9 @@ class Projects::JobsController < Projects::ApplicationController
   before_action :verify_api_request!, only: :terminal_websocket_authorize
   before_action :authorize_create_proxy_build!, only: :proxy_websocket_authorize
   before_action :verify_proxy_request!, only: :proxy_websocket_authorize
+  before_action do
+    push_frontend_feature_flag(:ci_job_line_links, @project)
+  end
 
   layout 'project'
 

config/feature_flags/development/ci_job_line_links.yml

+---
+name: ci_job_line_links
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47532
+rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/281727
+milestone: '13.6'
+type: development
+group: group::continuous integration
+default_enabled: false

spec/frontend/jobs/components/log/line_spec.js

@@ -2,21 +2,26 @@ import { shallowMount } from '@vue/test-utils';
 import Line from '~/jobs/components/log/line.vue';
 import LineNumber from '~/jobs/components/log/line_number.vue';
 
+const httpUrl = 'http://example.com';
+const httpsUrl = 'https://example.com';
+
+const mockProps = ({ text = 'Running with gitlab-runner 12.1.0 (de7731dd)' } = {}) => ({
+  line: {
+    content: [
+      {
+        text,
+        style: 'term-fg-l-green',
+      },
+    ],
+    lineNumber: 0,
+  },
+  path: '/jashkenas/underscore/-/jobs/335',
+});
+
 describe('Job Log Line', () => {
   let wrapper;
-
-  const data = {
-    line: {
-      content: [
-        {
-          text: 'Running with gitlab-runner 12.1.0 (de7731dd)',
-          style: 'term-fg-l-green',
-        },
-      ],
-      lineNumber: 0,
-    },
-    path: '/jashkenas/underscore/-/jobs/335',
-  };
+  let data;
+  let originalGon;
 
   const createComponent = (props = {}) => {
     wrapper = shallowMount(Line, {
@@ -26,12 +31,25 @@ describe('Job Log Line', () => {
     });
   };
 
+  const findLine = () => wrapper.find('span');
+  const findLink = () => findLine().find('a');
+  const findLinksAt = i =>
+    findLine()
+      .findAll('a')
+      .at(i);
+
   beforeEach(() => {
+    originalGon = window.gon;
+    window.gon.features = {
+      ciJobLineLinks: false,
+    };
+
+    data = mockProps();
     createComponent(data);
   });
 
   afterEach(() => {
-    wrapper.destroy();
+    window.gon = originalGon;
   });
 
   it('renders the line number component', () => {
@@ -39,10 +57,103 @@ describe('Job Log Line', () => {
   });
 
   it('renders a span the provided text', () => {
-    expect(wrapper.find('span').text()).toBe(data.line.content[0].text);
+    expect(findLine().text()).toBe(data.line.content[0].text);
   });
 
   it('renders the provided style as a class attribute', () => {
-    expect(wrapper.find('span').classes()).toContain(data.line.content[0].style);
+    expect(findLine().classes()).toContain(data.line.content[0].style);
+  });
+
+  describe.each([true, false])('when feature ci_job_line_links enabled = %p', ciJobLineLinks => {
+    beforeEach(() => {
+      window.gon.features = {
+        ciJobLineLinks,
+      };
+    });
+
+    it('renders text with symbols', () => {
+      const text = 'apt-get update < /dev/null > /dev/null';
+      createComponent(mockProps({ text }));
+
+      expect(findLine().text()).toBe(text);
+    });
+
+    it.each`
+      tag         | text
+      ${'a'}      | ${'<a href="#">linked</a>'}
+      ${'script'} | ${'<script>doEvil();</script>'}
+      ${'strong'} | ${'<strong>highlighted</strong>'}
+    `('escapes `<$tag>` tags in text', ({ tag, text }) => {
+      createComponent(mockProps({ text }));
+
+      expect(
+        findLine()
+          .find(tag)
+          .exists(),
+      ).toBe(false);
+      expect(findLine().text()).toBe(text);
+    });
+  });
+
+  describe('when ci_job_line_links is enabled', () => {
+    beforeEach(() => {
+      window.gon.features = {
+        ciJobLineLinks: true,
+      };
+    });
+
+    it('renders an http link', () => {
+      createComponent(mockProps({ text: httpUrl }));
+
+      expect(findLink().text()).toBe(httpUrl);
+      expect(findLink().attributes().href).toBe(httpUrl);
+    });
+
+    it('renders an https link', () => {
+      createComponent(mockProps({ text: httpsUrl }));
+
+      expect(findLink().text()).toBe(httpsUrl);
+      expect(findLink().attributes().href).toBe(httpsUrl);
+    });
+
+    it('renders a multiple links surrounded by text', () => {
+      createComponent(mockProps({ text: `My HTTP url: ${httpUrl} and my HTTPS url: ${httpsUrl}` }));
+      expect(findLine().text()).toBe(
+        'My HTTP url: http://example.com and my HTTPS url: https://example.com',
+      );
+      expect(findLinksAt(0).attributes().href).toBe(httpUrl);
+      expect(findLinksAt(1).attributes().href).toBe(httpsUrl);
+    });
+
+    it('renders a link with rel nofollow and noopener', () => {
+      createComponent(mockProps({ text: httpsUrl }));
+
+      expect(findLink().attributes().rel).toBe('nofollow noopener noreferrer');
+    });
+
+    it('render links surrounded by text', () => {
+      createComponent(
+        mockProps({ text: `My HTTP url: ${httpUrl} and my HTTPS url: ${httpsUrl} are here.` }),
+      );
+      expect(findLine().text()).toBe(
+        'My HTTP url: http://example.com and my HTTPS url: https://example.com are here.',
+      );
+      expect(findLinksAt(0).attributes().href).toBe(httpUrl);
+      expect(findLinksAt(1).attributes().href).toBe(httpsUrl);
+    });
+
+    const jshref = 'javascript:doEvil();'; // eslint-disable-line no-script-url
+
+    test.each`
+      type           | text
+      ${'js'}        | ${jshref}
+      ${'file'}      | ${'file:///a-file'}
+      ${'ftp'}       | ${'ftp://example.com/file'}
+      ${'email'}     | ${'email@example.com'}
+      ${'no scheme'} | ${'example.com/page'}
+    `('does not render a $type link', ({ text }) => {
+      createComponent(mockProps({ text }));
+      expect(findLink().exists()).toBe(false);
+    });
   });
 });