Merge branch '16568-relative-links-wiki-regression' into 'master'

Relative Links in the Wiki Are Broken

- [ ] #16568 (!4050) Relative links in wiki are broken
    - [x] Investigate issue

  
    - [x] Implementation / Fix

        - [x] Write (failing) tests for `WikiLinkFilter`
        - [x] Link to `./bar` should either get rewritten correctly or left alone
        - [x] Link to `./bar.md` should maybe get rewritten correctly (is left alone currently)
        - [x] Link to `bar.md` should get rewritten correctly


            - [x] Check if this indeed a bug

    - [x] Make sure CI is green
    - [x] Assign to endboss

    - [x] Wait for review

    - [x] Implement review feedback
    - [ ] Wait for merge


See merge request !4050

1 files changed, 85 insertions, 0 deletions

diff --git a/spec/lib/banzai/filter/wiki_link_filter_spec.rb b/spec/lib/banzai/filter/wiki_link_filter_spec.rb
new file mode 100644
index 00000000000..185abbb2108
--- /dev/null
+++ b/spec/lib/banzai/filter/wiki_link_filter_spec.rb
@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Banzai::Filter::WikiLinkFilter, lib: true do
+  include FilterSpecHelper
+
+  let(:namespace) { build_stubbed(:namespace, name: "wiki_link_ns") }
+  let(:project)   { build_stubbed(:empty_project, :public, name: "wiki_link_project", namespace: namespace) }
+  let(:user) { double }
+  let(:project_wiki) { ProjectWiki.new(project, user) }
+
+  describe "links within the wiki (relative)" do
+    describe "hierarchical links to the current directory" do
+      it "doesn't rewrite non-file links" do
+        link = "<a href='./page'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to eq('./page')
+      end
+
+      it "doesn't rewrite file links" do
+        link = "<a href='./page.md'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to eq('./page.md')
+      end
+    end
+
+    describe "hierarchical links to the parent directory" do
+      it "doesn't rewrite non-file links" do
+        link = "<a href='../page'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to eq('../page')
+      end
+
+      it "doesn't rewrite file links" do
+        link = "<a href='../page.md'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to eq('../page.md')
+      end
+    end
+
+    describe "hierarchical links to a sub-directory" do
+      it "doesn't rewrite non-file links" do
+        link = "<a href='./subdirectory/page'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to eq('./subdirectory/page')
+      end
+
+      it "doesn't rewrite file links" do
+        link = "<a href='./subdirectory/page.md'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to eq('./subdirectory/page.md')
+      end
+    end
+
+    describe "non-hierarchical links" do
+      it 'rewrites non-file links to be at the scope of the wiki root' do
+        link = "<a href='page'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to match('/wiki_link_ns/wiki_link_project/wikis/page')
+      end
+
+      it "doesn't rewrite file links" do
+        link = "<a href='page.md'>Link to Page</a>"
+        filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+        expect(filtered_link.attribute('href').value).to eq('page.md')
+      end
+    end
+  end
+
+  describe "links outside the wiki (absolute)" do
+    it "doesn't rewrite links" do
+      link = "<a href='http://example.com/page'>Link to Page</a>"
+      filtered_link = filter(link, project_wiki: project_wiki).children[0]
+
+      expect(filtered_link.attribute('href').value).to eq('http://example.com/page')
+    end
+  end
+end