Merge branch 'feature/migrate-find-wiki-page-to-gitaly' into 'master'

Migrate Gitlab::Git::Wiki#page to Gitaly

Closes gitaly#677

See merge request gitlab-org/gitlab-ce!14955

4 files changed, 110 insertions, 25 deletions

diff --git a/lib/gitlab/git/wiki.rb b/lib/gitlab/git/wiki.rb
index 9b387a19388..549d22adde5 100644
--- a/lib/gitlab/git/wiki.rb
+++ b/lib/gitlab/git/wiki.rb
@@ -58,14 +58,13 @@ module Gitlab
       end
 
       def page(title:, version: nil, dir: nil)
-        if version
-          version = Gitlab::Git::Commit.find(@repository, version).id
+        @repository.gitaly_migrate(:wiki_find_page) do |is_enabled|
+          if is_enabled
+            gitaly_find_page(title: title, version: version, dir: dir)
+          else
+            gollum_find_page(title: title, version: version, dir: dir)
+          end
         end
-
-        gollum_page = gollum_wiki.page(title, version, dir)
-        return unless gollum_page
-
-        new_page(gollum_page)
       end
 
       def file(name, version)
@@ -146,6 +145,17 @@ module Gitlab
         nil
       end
 
+      def gollum_find_page(title:, version: nil, dir: nil)
+        if version
+          version = Gitlab::Git::Commit.find(@repository, version).id
+        end
+
+        gollum_page = gollum_wiki.page(title, version, dir)
+        return unless gollum_page
+
+        new_page(gollum_page)
+      end
+
       def gitaly_write_page(name, format, content, commit_details)
         gitaly_wiki_client.write_page(name, format, content, commit_details)
       end
@@ -153,6 +163,13 @@ module Gitlab
       def gitaly_delete_page(page_path, commit_details)
         gitaly_wiki_client.delete_page(page_path, commit_details)
       end
+
+      def gitaly_find_page(title:, version: nil, dir: nil)
+        wiki_page, version = gitaly_wiki_client.find_page(title: title, version: version, dir: dir)
+        return unless wiki_page
+
+        Gitlab::Git::WikiPage.new(wiki_page, version)
+      end
     end
   end
 end
diff --git a/lib/gitlab/gitaly_client/wiki_page.rb b/lib/gitlab/gitaly_client/wiki_page.rb
new file mode 100644
index 00000000000..8226278d5f6
--- /dev/null
+++ b/lib/gitlab/gitaly_client/wiki_page.rb
@@ -0,0 +1,25 @@
+module Gitlab
+  module GitalyClient
+    class WikiPage
+      FIELDS = %i(title format url_path path name historical raw_data).freeze
+
+      attr_accessor(*FIELDS)
+
+      def initialize(params)
+        params = params.with_indifferent_access
+
+        FIELDS.each do |field|
+          instance_variable_set("@#{field}", params[field])
+        end
+      end
+
+      def historical?
+        @historical
+      end
+
+      def format
+        @format.to_sym
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/gitaly_client/wiki_service.rb b/lib/gitlab/gitaly_client/wiki_service.rb
index b7407dc1cc1..5d7930f5ff9 100644
--- a/lib/gitlab/gitaly_client/wiki_service.rb
+++ b/lib/gitlab/gitaly_client/wiki_service.rb
@@ -47,6 +47,39 @@ module Gitlab
         GitalyClient.call(@repository.storage, :wiki_service, :wiki_delete_page, request)
       end
 
+      def find_page(title:, version: nil, dir: nil)
+        request = Gitaly::WikiFindPageRequest.new(
+          repository: @gitaly_repo,
+          title: GitalyClient.encode(title),
+          revision: GitalyClient.encode(version),
+          directory: GitalyClient.encode(dir)
+        )
+
+        response = GitalyClient.call(@repository.storage, :wiki_service, :wiki_find_page, request)
+        wiki_page = version = nil
+
+        response.each do |message|
+          page = message.page
+          next unless page
+
+          if wiki_page
+            wiki_page.raw_data << page.raw_data
+          else
+            wiki_page = GitalyClient::WikiPage.new(page.to_h)
+            # All gRPC strings in a response are frozen, so we get
+            # an unfrozen version here so appending in the else clause below doesn't blow up.
+            wiki_page.raw_data = wiki_page.raw_data.dup
+
+            version = Gitlab::Git::WikiPageVersion.new(
+              Gitlab::Git::Commit.decorate(@repository, page.version.commit),
+              page.version.format
+            )
+          end
+        end
+
+        [wiki_page, version]
+      end
+
       private
 
       def gitaly_commit_details(commit_details)
diff --git a/spec/models/project_wiki_spec.rb b/spec/models/project_wiki_spec.rb
index 95d58b96f33..52a2b4b2850 100644
--- a/spec/models/project_wiki_spec.rb
+++ b/spec/models/project_wiki_spec.rb
@@ -117,31 +117,41 @@ describe ProjectWiki do
   end
 
   describe "#find_page" do
-    before do
-      create_page("index page", "This is an awesome Gollum Wiki")
-    end
+    shared_examples 'finding a wiki page' do
+      before do
+        create_page("index page", "This is an awesome Gollum Wiki")
+      end
 
-    after do
-      destroy_page(subject.pages.first.page)
-    end
+      after do
+        destroy_page(subject.pages.first.page)
+      end
 
-    it "returns the latest version of the page if it exists" do
-      page = subject.find_page("index page")
-      expect(page.title).to eq("index page")
-    end
+      it "returns the latest version of the page if it exists" do
+        page = subject.find_page("index page")
+        expect(page.title).to eq("index page")
+      end
+
+      it "returns nil if the page does not exist" do
+        expect(subject.find_page("non-existant")).to eq(nil)
+      end
+
+      it "can find a page by slug" do
+        page = subject.find_page("index-page")
+        expect(page.title).to eq("index page")
+      end
 
-    it "returns nil if the page does not exist" do
-      expect(subject.find_page("non-existant")).to eq(nil)
+      it "returns a WikiPage instance" do
+        page = subject.find_page("index page")
+        expect(page).to be_a WikiPage
+      end
     end
 
-    it "can find a page by slug" do
-      page = subject.find_page("index-page")
-      expect(page.title).to eq("index page")
+    context 'when Gitaly wiki_find_page is enabled' do
+      it_behaves_like 'finding a wiki page'
     end
 
-    it "returns a WikiPage instance" do
-      page = subject.find_page("index page")
-      expect(page).to be_a WikiPage
+    context 'when Gitaly wiki_find_page is disabled', :skip_gitaly_mock do
+      it_behaves_like 'finding a wiki page'
     end
   end