Merge branch '336792-fj-add-render-capabilities-to-wiki-api' into 'master'

Add wiki page render option to wiki API

See merge request gitlab-org/gitlab!81134

app/helpers/markup_helper.rb

@@ -127,7 +127,7 @@ module MarkupHelper
     text = wiki_page.content
     return '' unless text.present?
 
-    context = render_wiki_content_context(@wiki, wiki_page, context)
+    context = render_wiki_content_context(wiki_page.wiki, wiki_page, context)
     html = markup_unsafe(wiki_page.path, text, context)
 
     prepare_for_rendering(html, context)

doc/api/group_wikis.md

@@ -9,6 +9,7 @@ type: reference, api
 
 > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212199) in GitLab 13.5.
 > - The `encoding` field was [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81150) in GitLab 14.9.
+> - The `render_html` attribute was [added](https://gitlab.com/gitlab-org/gitlab/-/issues/336792) in GitLab 14.9.
 
 The [group wikis](../user/project/wiki/group.md) API is available only in APIv4.
 An API for [project wikis](wikis.md) is also available.
@@ -69,6 +70,7 @@ GET /groups/:id/wikis/:slug
 | --------- | -------        | -------- | ---------------------                                                         |
 | `id`      | integer/string | yes      | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) |
 | `slug`    | string         | yes      | URL-encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`      |
+| `render_html`      | boolean    | no      | Return the rendered HTML of the wiki page  |
 
 ```shell
 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/wikis/home"

doc/api/wikis.md

@@ -6,7 +6,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
 # Project wikis API **(FREE)**
 
-> The `encoding` field was [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81150) in GitLab 14.9.
+> - The `encoding` field was [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81150) in GitLab 14.9.
+> - The `render_html` attribute was [added](https://gitlab.com/gitlab-org/gitlab/-/issues/336792) in GitLab 14.9.
 
 The project [wikis](../user/project/wiki/index.md) API is available only in APIv4.
 An API for [group wikis](group_wikis.md) is also available.
@@ -67,6 +68,7 @@ GET /projects/:id/wikis/:slug
 | --------- | ------- | -------- | --------------------- |
 | `id`      | integer/string    | yes      | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
 | `slug` | string  | yes       | URLencoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`  |
+| `render_html`      | boolean    | no      | Return the rendered HTML of the wiki page  |
 
 ```shell
 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis/home"

ee/spec/requests/api/wikis_spec.rb

@@ -128,6 +128,7 @@ RSpec.describe API::Wikis do
   describe 'GET /groups/:id/wikis/:slug' do
     let(:page) { create(:wiki_page, wiki: wiki) }
     let(:url) { "/groups/#{group.id}/wikis/#{page.slug}" }
+    let(:params) { {} }
 
     context 'when wiki is disabled' do
       before do
@@ -178,7 +179,8 @@ RSpec.describe API::Wikis do
       context 'when user is developer' do
         before do
           group.add_developer(user)
-          get api(url, user)
+
+          get api(url, user), params: params
         end
 
         include_examples 'wikis API returns wiki page'
@@ -194,7 +196,7 @@ RSpec.describe API::Wikis do
         before do
           group.add_maintainer(user)
 
-          get api(url, user)
+          get api(url, user), params: params
         end
 
         include_examples 'wikis API returns wiki page'
@@ -220,7 +222,7 @@ RSpec.describe API::Wikis do
         before do
           group.add_developer(user)
 
-          get api(url, user)
+          get api(url, user), params: params
         end
 
         include_examples 'wikis API returns wiki page'
@@ -236,7 +238,7 @@ RSpec.describe API::Wikis do
         before do
           group.add_maintainer(user)
 
-          get api(url, user)
+          get api(url, user), params: params
         end
 
         include_examples 'wikis API returns wiki page'

lib/api/entities/wiki_page.rb

@@ -3,7 +3,11 @@
 module API
   module Entities
     class WikiPage < WikiPageBasic
-      expose :content
+      include ::MarkupHelper
+
+      expose :content do |wiki_page, options|
+        options[:render_html] ? render_wiki_content(wiki_page) : wiki_page.content
+      end
 
       expose :encoding do |wiki_page|
         wiki_page.content.encoding.name

lib/api/wikis.rb

@@ -45,11 +45,12 @@ module API
         end
         params do
           requires :slug, type: String, desc: 'The slug of a wiki page'
+          optional :render_html, type: Boolean, default: false, desc: 'Render content to HTML'
         end
         get ':id/wikis/:slug' do
           authorize! :read_wiki, container
 
-          present wiki_page, with: Entities::WikiPage
+          present wiki_page, with: Entities::WikiPage, render_html: params[:render_html]
         end
 
         desc 'Create a wiki page' do

spec/helpers/markup_helper_spec.rb

@@ -315,33 +315,26 @@ RSpec.describe MarkupHelper do
   end
 
   describe '#render_wiki_content' do
-    let(:wiki) { double('WikiPage', path: "file.#{extension}") }
-    let(:wiki_repository) { double('Repository') }
+    let(:wiki) { build(:wiki, container: project) }
     let(:content) { 'wiki content' }
+    let(:slug) { 'nested/page' }
+    let(:wiki_page) { double('WikiPage', path: "file.#{extension}", content: content, slug: slug, wiki: wiki) }
+
     let(:context) do
       {
         pipeline: :wiki, project: project, wiki: wiki,
-        page_slug: 'nested/page', issuable_reference_expansion_enabled: true,
-        repository: wiki_repository
+        page_slug: slug, issuable_reference_expansion_enabled: true,
+        repository: wiki.repository
       }
     end
 
-    before do
-      expect(wiki).to receive(:content).and_return(content)
-      expect(wiki).to receive(:slug).and_return('nested/page')
-      expect(wiki).to receive(:repository).and_return(wiki_repository)
-      allow(wiki).to receive(:container).and_return(project)
-
-      helper.instance_variable_set(:@wiki, wiki)
-    end
-
     context 'when file is Markdown' do
       let(:extension) { 'md' }
 
       it 'renders using #markdown_unsafe helper method' do
         expect(helper).to receive(:markdown_unsafe).with('wiki content', context)
 
-        helper.render_wiki_content(wiki)
+        helper.render_wiki_content(wiki_page)
       end
 
       context 'when context has labels' do
@@ -350,7 +343,7 @@ RSpec.describe MarkupHelper do
         let(:content) { '~Bug' }
 
         it 'renders label' do
-          result = helper.render_wiki_content(wiki)
+          result = helper.render_wiki_content(wiki_page)
           doc = Nokogiri::HTML.parse(result)
 
           expect(doc.css('.gl-label-link')).not_to be_empty
@@ -366,7 +359,7 @@ RSpec.describe MarkupHelper do
         end
 
         it 'renders uploads relative to project' do
-          result = helper.render_wiki_content(wiki)
+          result = helper.render_wiki_content(wiki_page)
 
           expect(result).to include("#{project.full_path}#{upload_link}")
         end
@@ -379,7 +372,7 @@ RSpec.describe MarkupHelper do
       it 'renders using Gitlab::Asciidoc' do
         expect(Gitlab::Asciidoc).to receive(:render)
 
-        helper.render_wiki_content(wiki)
+        helper.render_wiki_content(wiki_page)
       end
     end
 
@@ -398,7 +391,7 @@ FooBar
       it 'renders using #markdown_unsafe helper method' do
         expect(helper).to receive(:markdown_unsafe).with(content, context)
 
-        result = helper.render_wiki_content(wiki)
+        result = helper.render_wiki_content(wiki_page)
 
         expect(result).to be_empty
       end
@@ -410,7 +403,7 @@ FooBar
       it 'renders all other formats using Gitlab::OtherMarkup' do
         expect(Gitlab::OtherMarkup).to receive(:render)
 
-        helper.render_wiki_content(wiki)
+        helper.render_wiki_content(wiki_page)
       end
     end
   end

spec/lib/api/entities/wiki_page_spec.rb

@@ -5,7 +5,10 @@ require 'spec_helper'
 RSpec.describe API::Entities::WikiPage do
   let_it_be_with_reload(:wiki_page) { create(:wiki_page) }
 
-  let(:entity) { described_class.new(wiki_page) }
+  let(:params) { {} }
+  let(:entity) { described_class.new(wiki_page, params) }
+
+  subject { entity.as_json }
 
   it 'returns the proper encoding for the wiki page content' do
     expect(entity.as_json[:encoding]).to eq 'UTF-8'
@@ -14,4 +17,26 @@ RSpec.describe API::Entities::WikiPage do
 
     expect(entity.as_json[:encoding]).to eq 'ISO-8859-1'
   end
+
+  it 'returns the raw wiki page content' do
+    expect(subject[:content]).to eq wiki_page.content
+  end
+
+  context 'when render_html param is passed' do
+    context 'when it is true' do
+      let(:params) { { render_html: true } }
+
+      it 'returns the wiki page content rendered' do
+        expect(subject[:content]).to eq "<p data-sourcepos=\"1:1-1:#{wiki_page.content.size}\" dir=\"auto\">#{wiki_page.content}</p>"
+      end
+    end
+
+    context 'when it is false' do
+      let(:params) { { render_html: false } }
+
+      it 'returns the raw wiki page content' do
+        expect(subject[:content]).to eq wiki_page.content
+      end
+    end
+  end
 end

spec/requests/api/wikis_spec.rb

@@ -130,41 +130,42 @@ RSpec.describe API::Wikis do
   describe 'GET /projects/:id/wikis/:slug' do
     let(:page) { create(:wiki_page, wiki: project.wiki) }
     let(:url) { "/projects/#{project.id}/wikis/#{page.slug}" }
+    let(:params) { {} }
+
+    subject(:request) { get api(url, user), params: params }
 
     context 'when wiki is disabled' do
       let(:project) { project_wiki_disabled }
 
-      context 'when user is guest' do
       before do
-          get api(url)
+        request
       end
 
+      context 'when user is guest' do
+        let(:user) { nil }
+
         include_examples 'wiki API 404 Project Not Found'
       end
 
       context 'when user is developer' do
-        before do
-          get api(url, developer)
-        end
+        let(:user) { developer }
 
         include_examples 'wiki API 403 Forbidden'
       end
 
       context 'when user is maintainer' do
-        before do
-          get api(url, maintainer)
-        end
+        let(:user) { maintainer }
 
         include_examples 'wiki API 403 Forbidden'
       end
     end
 
     context 'when wiki is available only for team members' do
-      let(:project) { create(:project, :wiki_repo, :wiki_private) }
+      let_it_be_with_reload(:project) { create(:project, :wiki_repo, :wiki_private) }
 
       context 'when user is guest' do
         before do
-          get api(url)
+          request
         end
 
         include_examples 'wiki API 404 Project Not Found'
@@ -173,7 +174,8 @@ RSpec.describe API::Wikis do
       context 'when user is developer' do
         before do
           project.add_developer(user)
-          get api(url, user)
+
+          request
         end
 
         include_examples 'wikis API returns wiki page'
@@ -189,7 +191,7 @@ RSpec.describe API::Wikis do
         before do
           project.add_maintainer(user)
 
-          get api(url, user)
+          request
         end
 
         include_examples 'wikis API returns wiki page'
@@ -203,11 +205,13 @@ RSpec.describe API::Wikis do
     end
 
     context 'when wiki is available for everyone with access' do
-      let(:project) { create(:project, :wiki_repo) }
+      let_it_be_with_reload(:project) { create(:project, :wiki_repo) }
 
       context 'when user is guest' do
+        let(:user) { nil }
+
         before do
-          get api(url)
+          request
         end
 
         include_examples 'wiki API 404 Project Not Found'
@@ -217,7 +221,7 @@ RSpec.describe API::Wikis do
         before do
           project.add_developer(user)
 
-          get api(url, user)
+          request
         end
 
         include_examples 'wikis API returns wiki page'
@@ -233,7 +237,7 @@ RSpec.describe API::Wikis do
         before do
           project.add_maintainer(user)
 
-          get api(url, user)
+          request
         end
 
         include_examples 'wikis API returns wiki page'

spec/support/shared_examples/lib/wikis_api_examples.rb

@@ -44,14 +44,32 @@ RSpec.shared_examples_for 'wikis API returns list of wiki pages' do
 end
 
 RSpec.shared_examples_for 'wikis API returns wiki page' do
-  it 'returns the wiki page' do
+  shared_examples 'returns wiki page' do
+    specify do
       expect(response).to have_gitlab_http_status(:ok)
       expect(json_response.size).to eq(5)
       expect(json_response.keys).to match_array(expected_keys_with_content)
-    expect(json_response['content']).to eq(page.content)
+      expect(json_response['content']).to eq(expected_content)
       expect(json_response['slug']).to eq(page.slug)
       expect(json_response['title']).to eq(page.title)
-    expect(json_response['encoding']).to eq('UTF-8')
+    end
+  end
+
+  let(:expected_content) { page.content }
+
+  it_behaves_like 'returns wiki page'
+
+  context 'when render param is false' do
+    let(:params) { { render_html: false } }
+
+    it_behaves_like 'returns wiki page'
+  end
+
+  context 'when render param is true' do
+    let(:params) { { render_html: true } }
+    let(:expected_content) { '<p data-sourcepos="1:1-1:21" dir="auto">Content for wiki page</p>' }
+
+    it_behaves_like 'returns wiki page'
   end
 end
 

spec/views/shared/wikis/_sidebar.html.haml_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe 'shared/wikis/_sidebar.html.haml' do
 
   context 'The sidebar comes from a custom page' do
     before do
-      assign(:sidebar_page, double('WikiPage', path: 'sidebar.md', slug: 'sidebar', content: 'Some sidebar content'))
+      assign(:sidebar_page, double('WikiPage', path: 'sidebar.md', slug: 'sidebar', content: 'Some sidebar content', wiki: wiki))
     end
 
     it 'does not show an alert' do