Merge branch 'mfluharty-clickable-links-in-file-view' into 'master'

Make URLs in blob viewer and blob editor into clickable links

See merge request gitlab-org/gitlab!18305

app/assets/javascripts/blob/blob_utils.js

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

app/assets/javascripts/blob/viewer/index.js

@@ -4,6 +4,10 @@ import Flash from '../../flash';
 import { handleLocationHash } from '../../lib/utils/common_utils';
 import axios from '../../lib/utils/axios_utils';
 import { __ } from '~/locale';
+import { blobLinkRegex } from '~/blob/blob_utils';
+
+const SIMPLE_VIEWER_NAME = 'simple';
+const RICH_VIEWER_NAME = 'rich';
 
 export default class BlobViewer {
   constructor() {
@@ -21,7 +25,7 @@ export default class BlobViewer {
   }
 
   static initRichViewer() {
-    const viewer = document.querySelector('.blob-viewer[data-type="rich"]');
+    const viewer = document.querySelector(`.blob-viewer[data-type="${RICH_VIEWER_NAME}"]`);
     if (!viewer || !viewer.dataset.richType) return;
 
     const initViewer = promise =>
@@ -61,8 +65,12 @@ export default class BlobViewer {
     this.switcherBtns = document.querySelectorAll('.js-blob-viewer-switch-btn');
     this.copySourceBtn = document.querySelector('.js-copy-blob-source-btn');
 
-    this.simpleViewer = this.$fileHolder[0].querySelector('.blob-viewer[data-type="simple"]');
-    this.richViewer = this.$fileHolder[0].querySelector('.blob-viewer[data-type="rich"]');
+    this.simpleViewer = this.$fileHolder[0].querySelector(
+      `.blob-viewer[data-type="${SIMPLE_VIEWER_NAME}"]`,
+    );
+    this.richViewer = this.$fileHolder[0].querySelector(
+      `.blob-viewer[data-type="${RICH_VIEWER_NAME}"]`,
+    );
 
     this.initBindings();
 
@@ -71,10 +79,10 @@ export default class BlobViewer {
 
   switchToInitialViewer() {
     const initialViewer = this.$fileHolder[0].querySelector('.blob-viewer:not(.hidden)');
-    let initialViewerName = initialViewer.getAttribute('data-type');
+    let initialViewerName = initialViewer.dataset.type;
 
     if (this.switcher && window.location.hash.indexOf('#L') === 0) {
-      initialViewerName = 'simple';
+      initialViewerName = SIMPLE_VIEWER_NAME;
     }
 
     this.switchToViewer(initialViewerName);
@@ -91,35 +99,41 @@ export default class BlobViewer {
       this.copySourceBtn.addEventListener('click', () => {
         if (this.copySourceBtn.classList.contains('disabled')) return this.copySourceBtn.blur();
 
-        return this.switchToViewer('simple');
+        return this.switchToViewer(SIMPLE_VIEWER_NAME);
       });
     }
   }
 
+  static linkifyURLs(viewer) {
+    if (viewer.dataset.linkified) return;
+
+    document.querySelectorAll('.js-blob-content .code .line').forEach(line => {
+      // eslint-disable-next-line no-param-reassign
+      line.innerHTML = line.innerHTML.replace(blobLinkRegex, '<a href="$&">$&</a>');
+    });
+
+    // eslint-disable-next-line no-param-reassign
+    viewer.dataset.linkified = true;
+  }
+
   switchViewHandler(e) {
     const target = e.currentTarget;
 
     e.preventDefault();
 
-    this.switchToViewer(target.getAttribute('data-viewer'));
+    this.switchToViewer(target.dataset.viewer);
   }
 
   toggleCopyButtonState() {
     if (!this.copySourceBtn) return;
-    if (this.simpleViewer.getAttribute('data-loaded')) {
-      this.copySourceBtn.setAttribute('title', __('Copy file contents'));
+    if (this.simpleViewer.dataset.loaded) {
+      this.copySourceBtn.dataset.title = __('Copy file contents');
       this.copySourceBtn.classList.remove('disabled');
     } else if (this.activeViewer === this.simpleViewer) {
-      this.copySourceBtn.setAttribute(
-        'title',
-        __('Wait for the file to load to copy its contents'),
-      );
+      this.copySourceBtn.dataset.title = __('Wait for the file to load to copy its contents');
       this.copySourceBtn.classList.add('disabled');
     } else {
-      this.copySourceBtn.setAttribute(
-        'title',
-        __('Switch to the source to copy the file contents'),
-      );
+      this.copySourceBtn.dataset.title = __('Switch to the source to copy the file contents');
       this.copySourceBtn.classList.add('disabled');
     }
 
@@ -159,6 +173,8 @@ export default class BlobViewer {
         this.$fileHolder.trigger('highlight:line');
         handleLocationHash();
 
+        if (name === SIMPLE_VIEWER_NAME) BlobViewer.linkifyURLs(viewer);
+
         this.toggleCopyButtonState();
       })
       .catch(() => new Flash(__('Error loading viewer')));
@@ -166,17 +182,17 @@ export default class BlobViewer {
 
   static loadViewer(viewerParam) {
     const viewer = viewerParam;
-    const url = viewer.getAttribute('data-url');
+    const { url, loaded, loading } = viewer.dataset;
 
-    if (!url || viewer.getAttribute('data-loaded') || viewer.getAttribute('data-loading')) {
+    if (!url || loaded || loading) {
       return Promise.resolve(viewer);
     }
 
-    viewer.setAttribute('data-loading', 'true');
+    viewer.dataset.loading = true;
 
     return axios.get(url).then(({ data }) => {
       viewer.innerHTML = data.html;
-      viewer.setAttribute('data-loaded', 'true');
+      viewer.dataset.loaded = true;
 
       return viewer;
     });

app/assets/javascripts/blob_edit/edit_blob.js

@@ -4,7 +4,8 @@ import $ from 'jquery';
 import axios from '~/lib/utils/axios_utils';
 import createFlash from '~/flash';
 import { __ } from '~/locale';
-import TemplateSelectorMediator from '../blob/file_template_mediator';
+import { blobLinkRegex } from '~/blob/blob_utils';
+import TemplateSelectorMediator from '~/blob/file_template_mediator';
 import getModeByFileExtension from '~/lib/utils/ace_utils';
 import { addEditorMarkdownListeners } from '~/lib/utils/text_markdown';
 
@@ -17,6 +18,7 @@ export default class EditBlob {
     this.initModePanesAndLinks();
     this.initSoftWrap();
     this.initFileSelectors();
+    this.initBlobContentLinkClickability();
   }
 
   configureAceEditor() {
@@ -89,6 +91,22 @@ export default class EditBlob {
     return this.editor.focus();
   }
 
+  initBlobContentLinkClickability() {
+    this.editor.renderer.on('afterRender', () => {
+      document.querySelectorAll('.ace_text-layer .ace_line > *').forEach(token => {
+        if (token.dataset.linkified || !token.textContent.includes('http')) return;
+
+        // eslint-disable-next-line no-param-reassign
+        token.innerHTML = token.innerHTML.replace(
+          blobLinkRegex,
+          '<a target="_blank" href="$&">$&</a>',
+        );
+        // eslint-disable-next-line no-param-reassign
+        token.dataset.linkified = true;
+      });
+    });
+  }
+
   initSoftWrap() {
     this.isSoftWrapped = false;
     this.$toggleButton = $('.soft-wrap-toggle');

app/assets/stylesheets/framework/files.scss

@@ -258,6 +258,17 @@
       }
     }
   }
+
+  .file-editor {
+    .ace_underline {
+      text-decoration: none;
+    }
+
+    .ace_line a {
+      pointer-events: auto;
+      color: inherit;
+    }
+  }
 }
 
 span.idiff {

app/assets/stylesheets/highlight/common.scss

@@ -29,3 +29,12 @@
     color: $link;
   }
 }
+
+// Links to URLs, emails, or dependencies
+.code .line a {
+  color: inherit;
+
+  &:hover {
+    text-decoration: underline;
+  }
+}

app/assets/stylesheets/highlight/themes/dark.scss

@@ -193,11 +193,6 @@ $dark-il: #de935f;
     color: $dark-highlight-color !important;
   }
 
-  // Links to URLs, emails, or dependencies
-  .line a {
-    color: $dark-na;
-  }
-
   .hll { background-color: $dark-hll-bg; }
   .c { color: $dark-c; } /* Comment */
   .err { color: $dark-err; } /* Error */

app/assets/stylesheets/highlight/themes/monokai.scss

@@ -193,11 +193,6 @@ $monokai-gi: #a6e22e;
     color: $black !important;
   }
 
-  // Links to URLs, emails, or dependencies
-  .line a {
-    color: $monokai-k;
-  }
-
   .hll { background-color: $monokai-hll; }
   .c { color: $monokai-c; } /* Comment */
   .err { color: $monokai-err-color; background-color: $monokai-err-bg; } /* Error */

app/assets/stylesheets/highlight/themes/none.scss

@@ -143,12 +143,6 @@
     background-color: $white-normal;
   }
 
-    // Links to URLs, emails, or dependencies
-  .line a {
-    color: $gl-text-color;
-    text-decoration: underline;
-  }
-
   .hll { background-color: $white-light; }
 
   .gd {

app/assets/stylesheets/highlight/themes/solarized-dark.scss

@@ -196,11 +196,6 @@ $solarized-dark-il: #2aa198;
     background-color: $solarized-dark-highlight !important;
   }
 
-  // Links to URLs, emails, or dependencies
-  .line a {
-    color: $solarized-dark-kd;
-  }
-
   /* Solarized Dark
 
   For use with Jekyll and Pygments

app/assets/stylesheets/highlight/themes/solarized-light.scss

@@ -204,11 +204,6 @@ $solarized-light-il: #2aa198;
     background-color: $solarized-light-highlight !important;
   }
 
-  // Links to URLs, emails, or dependencies
-  .line a {
-    color: $solarized-light-kd;
-  }
-
   /* Solarized Light
 
   For use with Jekyll and Pygments

app/assets/stylesheets/highlight/white_base.scss

@@ -209,11 +209,6 @@ span.highlight_word {
   background-color: $white-highlight !important;
 }
 
-// Links to URLs, emails, or dependencies
-.line a {
-  color: $white-nb;
-}
-
 .hll { background-color: $white-hll-bg; }
 
 .c { color: $white-c;

app/views/shared/_file_highlight.html.haml

@@ -10,7 +10,7 @@
         %a.diff-line-num{ href: "#{link}#L#{i}", id: "L#{i}", 'data-line-number' => i }
           = link_icon
           = i
-  .blob-content{ data: { blob_id: blob.id } }
+  .blob-content.js-blob-content{ data: { blob_id: blob.id } }
     %pre.code.highlight
       %code
         = blob.present.highlight

changelogs/unreleased/mfluharty-clickable-links-in-file-view.yml

+---
+title: Make URLs in blob viewer and blob editor into clickable links
+merge_request: 18305
+author:
+type: added

spec/features/projects/blobs/edit_spec.rb

@@ -60,6 +60,13 @@ describe 'Editing file blob', :js do
       expect(page).to have_content 'NextFeature'
     end
 
+    it 'renders a URL in the content of file as a link' do
+      project.repository.create_file(user, 'file.yml', '# go to https://gitlab.com', message: 'testing', branch_name: branch)
+      visit project_edit_blob_path(project, tree_join(branch, 'file.yml'))
+
+      expect(page).to have_selector('.ace_content .ace_line a')
+    end
+
     context 'from blob file path' do
       before do
         visit project_blob_path(project, tree_join(branch, file_path))

spec/javascripts/blob/viewer/index_spec.js

@@ -11,6 +11,13 @@ describe('Blob viewer', () => {
 
   preloadFixtures('snippets/show.html');
 
+  const asyncClick = () =>
+    new Promise(resolve => {
+      document.querySelector('.js-blob-viewer-switch-btn[data-viewer="simple"]').click();
+
+      setTimeout(resolve);
+    });
+
   beforeEach(() => {
     mock = new MockAdapter(axios);
 
@@ -66,19 +73,12 @@ describe('Blob viewer', () => {
   });
 
   it('doesnt reload file if already loaded', done => {
-    const asyncClick = () =>
-      new Promise(resolve => {
-        document.querySelector('.js-blob-viewer-switch-btn[data-viewer="simple"]').click();
-
-        setTimeout(resolve);
-      });
-
     asyncClick()
       .then(() => asyncClick())
       .then(() => {
-        expect(
-          document.querySelector('.blob-viewer[data-type="simple"]').getAttribute('data-loaded'),
-        ).toBe('true');
+        expect(document.querySelector('.blob-viewer[data-type="simple"]').dataset.loaded).toBe(
+          'true',
+        );
 
         done();
       })
@@ -100,9 +100,7 @@ describe('Blob viewer', () => {
     });
 
     it('has tooltip when disabled', () => {
-      expect(copyButton.getAttribute('data-original-title')).toBe(
-        'Switch to the source to copy the file contents',
-      );
+      expect(copyButton.dataset.title).toBe('Switch to the source to copy the file contents');
     });
 
     it('is blurred when clicked and disabled', () => {
@@ -136,7 +134,7 @@ describe('Blob viewer', () => {
       document.querySelector('.js-blob-viewer-switch-btn[data-viewer="simple"]').click();
 
       setTimeout(() => {
-        expect(copyButton.getAttribute('data-original-title')).toBe('Copy file contents');
+        expect(copyButton.dataset.title).toBe('Copy file contents');
 
         done();
       });
@@ -177,4 +175,27 @@ describe('Blob viewer', () => {
       expect(axios.get.calls.count()).toBe(1);
     });
   });
+
+  describe('a URL inside the blob content', () => {
+    beforeEach(() => {
+      mock.onGet('http://test.host/snippets/1.json?viewer=simple').reply(200, {
+        html:
+          '<div class="js-blob-content"><pre class="code"><code><span class="line" lang="yaml"><span class="c1">To install gitlab-shell you also need a Go compiler version 1.8 or newer. https://golang.org/dl/</span></span></code></pre></div>',
+      });
+    });
+
+    it('is rendered as a link in simple view', done => {
+      asyncClick()
+        .then(() => {
+          expect(document.querySelector('.blob-viewer[data-type="simple"]').innerHTML).toContain(
+            '<a href="https://golang.org/dl/">https://golang.org/dl/</a>',
+          );
+          done();
+        })
+        .catch(() => {
+          fail();
+          done();
+        });
+    });
+  });
 });