Merge branch '31662-fix-excessive-find-file-escaping' into 'master'

Resolve "Too-eager urlencoding for find files links"

See merge request gitlab-org/gitlab!21861

app/assets/javascripts/project_find_file.js

@@ -4,6 +4,7 @@ import $ from 'jquery';
 import fuzzaldrinPlus from 'fuzzaldrin-plus';
 import sanitize from 'sanitize-html';
 import axios from '~/lib/utils/axios_utils';
+import { joinPaths, escapeFileUrl } from '~/lib/utils/url_utility';
 import flash from '~/flash';
 import { __ } from '~/locale';
 
@@ -116,7 +117,7 @@ export default class ProjectFindFile {
       if (searchText) {
         matches = fuzzaldrinPlus.match(filePath, searchText);
       }
-      const blobItemUrl = `${this.options.blobUrlTemplate}/${encodeURIComponent(filePath)}`;
+      const blobItemUrl = joinPaths(this.options.blobUrlTemplate, escapeFileUrl(filePath));
       const html = ProjectFindFile.makeHtml(filePath, matches, blobItemUrl);
       results.push(this.element.find('.tree-table > tbody').append(html));
     }

changelogs/unreleased/31662-fix-excessive-find-file-escaping.yml

+---
+title: Fix project file finder url encoding file path separators
+merge_request: 21861
+author:
+type: fixed

spec/frontend/project_find_file_spec.js

@@ -42,21 +42,23 @@ describe('ProjectFindFile', () => {
       }));
 
   const files = [
-    'fileA.txt',
-    'fileB.txt',
-    'fi#leC.txt',
-    'folderA/fileD.txt',
-    'folder#B/fileE.txt',
-    'folde?rC/fil#F.txt',
+    { path: 'fileA.txt', escaped: 'fileA.txt' },
+    { path: 'fileB.txt', escaped: 'fileB.txt' },
+    { path: 'fi#leC.txt', escaped: 'fi%23leC.txt' },
+    { path: 'folderA/fileD.txt', escaped: 'folderA/fileD.txt' },
+    { path: 'folder#B/fileE.txt', escaped: 'folder%23B/fileE.txt' },
+    { path: 'folde?rC/fil#F.txt', escaped: 'folde%3FrC/fil%23F.txt' },
   ];
 
-  beforeEach(() => {
+  beforeEach(done => {
     // Create a mock adapter for stubbing axios API requests
     mock = new MockAdapter(axios);
 
     element = $(TEMPLATE);
-    mock.onGet(FILE_FIND_URL).replyOnce(200, files);
+    mock.onGet(FILE_FIND_URL).replyOnce(200, files.map(x => x.path));
     getProjectFindFileInstance(); // This triggers a load / axios call + subsequent render in the constructor
+
+    setImmediate(done);
   });
 
   afterEach(() => {
@@ -65,26 +67,19 @@ describe('ProjectFindFile', () => {
     sanitize.mockClear();
   });
 
-  it('loads and renders elements from remote server', done => {
-    setImmediate(() => {
+  it('loads and renders elements from remote server', () => {
     expect(findFiles()).toEqual(
-        files.map(text => ({
-          text,
-          href: `${BLOB_URL_TEMPLATE}/${encodeURIComponent(text)}`,
+      files.map(({ path, escaped }) => ({
+        text: path,
+        href: `${BLOB_URL_TEMPLATE}/${escaped}`,
       })),
     );
-
-      done();
-    });
   });
 
-  it('sanitizes search text', done => {
+  it('sanitizes search text', () => {
     const searchText = element.find('.file-finder-input').val();
 
-    setImmediate(() => {
     expect(sanitize).toHaveBeenCalledTimes(1);
     expect(sanitize).toHaveBeenCalledWith(searchText);
-      done();
-    });
   });
 });