From fd8cc95ea033c7b898e2868e7ba13ddb2da87f73 Mon Sep 17 00:00:00 2001 From: Robert May Date: Fri, 7 Jul 2023 12:11:24 +0100 Subject: [PATCH 1/2] Add a new faster git refs finder Moves functionality out of app/finders as it's not database-related. So far low on features compared to GitRefsFinder. Changelog: added --- lib/gitlab/git/finders/refs_finder.rb | 36 +++++++++++++++++++ .../gitlab/git/finders/refs_finder_spec.rb | 32 +++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 lib/gitlab/git/finders/refs_finder.rb create mode 100644 spec/lib/gitlab/git/finders/refs_finder_spec.rb diff --git a/lib/gitlab/git/finders/refs_finder.rb b/lib/gitlab/git/finders/refs_finder.rb new file mode 100644 index 00000000000000..3c89205b2b0175 --- /dev/null +++ b/lib/gitlab/git/finders/refs_finder.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +module Gitlab + module Git + module Finders + class RefsFinder + attr_reader :repository, :search, :ref_type + + def initialize(repository, search:, ref_type:) + @repository = repository + @search = search + @ref_type = ref_type + end + + def execute + pattern = [prefix, search, "*"].compact.join + + repository.list_refs( + [pattern] + ) + end + + private + + def prefix + case ref_type + when :branches + Gitlab::Git::BRANCH_REF_PREFIX + when :tags + Gitlab::Git::TAG_REF_PREFIX + end + end + end + end + end +end diff --git a/spec/lib/gitlab/git/finders/refs_finder_spec.rb b/spec/lib/gitlab/git/finders/refs_finder_spec.rb new file mode 100644 index 00000000000000..e95360c84e79c0 --- /dev/null +++ b/spec/lib/gitlab/git/finders/refs_finder_spec.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require "spec_helper" + +RSpec.describe Gitlab::Git::Finders::RefsFinder, feature_category: :source_code_management do + let_it_be(:user) { create(:user) } + let_it_be(:project) { create(:project, :repository) } + + let(:repository) { project.repository } + let(:finder) { described_class.new(repository, **params) } + let(:params) { {} } + + describe "#execute" do + subject { finder.execute } + + let(:params) do + { search: "mast", ref_type: :branches } + end + + it { is_expected.to be_an(Array) } + + it "returns matching ref object" do + expect(subject.length).to eq(1) + + ref = subject.first + + expect(ref).to be_a(Gitaly::ListRefsResponse::Reference) + expect(ref.name).to eq("refs/heads/master") + expect(ref.target).to be_a(String) + end + end +end -- GitLab From d8838aba21a63d7dd7d4d32f19af9a7dedef7731 Mon Sep 17 00:00:00 2001 From: Robert May Date: Mon, 17 Jul 2023 16:03:08 +0100 Subject: [PATCH 2/2] Expand spec coverage for alternative ref_type values --- lib/gitlab/git/finders/refs_finder.rb | 4 ++ .../gitlab/git/finders/refs_finder_spec.rb | 48 +++++++++++++++---- 2 files changed, 43 insertions(+), 9 deletions(-) diff --git a/lib/gitlab/git/finders/refs_finder.rb b/lib/gitlab/git/finders/refs_finder.rb index 3c89205b2b0175..a0117bc0fa91e4 100644 --- a/lib/gitlab/git/finders/refs_finder.rb +++ b/lib/gitlab/git/finders/refs_finder.rb @@ -6,6 +6,8 @@ module Finders class RefsFinder attr_reader :repository, :search, :ref_type + UnknownRefTypeError = Class.new(StandardError) + def initialize(repository, search:, ref_type:) @repository = repository @search = search @@ -28,6 +30,8 @@ def prefix Gitlab::Git::BRANCH_REF_PREFIX when :tags Gitlab::Git::TAG_REF_PREFIX + else + raise UnknownRefTypeError, "ref_type must be one of [:branches, :tags]" end end end diff --git a/spec/lib/gitlab/git/finders/refs_finder_spec.rb b/spec/lib/gitlab/git/finders/refs_finder_spec.rb index e95360c84e79c0..63d794d1e594cf 100644 --- a/spec/lib/gitlab/git/finders/refs_finder_spec.rb +++ b/spec/lib/gitlab/git/finders/refs_finder_spec.rb @@ -13,20 +13,50 @@ describe "#execute" do subject { finder.execute } - let(:params) do - { search: "mast", ref_type: :branches } + context "when :ref_type is :branches" do + let(:params) do + { search: "mast", ref_type: :branches } + end + + it { is_expected.to be_an(Array) } + + it "returns matching ref object" do + expect(subject.length).to eq(1) + + ref = subject.first + + expect(ref).to be_a(Gitaly::ListRefsResponse::Reference) + expect(ref.name).to eq("refs/heads/master") + expect(ref.target).to be_a(String) + end end - it { is_expected.to be_an(Array) } + context "when :ref_type is :tags" do + let(:params) do + { search: "v1.0.", ref_type: :tags } + end - it "returns matching ref object" do - expect(subject.length).to eq(1) + it { is_expected.to be_an(Array) } + + it "returns matching ref object" do + expect(subject.length).to eq(1) + + ref = subject.first + + expect(ref).to be_a(Gitaly::ListRefsResponse::Reference) + expect(ref.name).to eq("refs/tags/v1.0.0") + expect(ref.target).to be_a(String) + end + end - ref = subject.first + context "when :ref_type is invalid" do + let(:params) do + { search: "master", ref_type: nil } + end - expect(ref).to be_a(Gitaly::ListRefsResponse::Reference) - expect(ref.name).to eq("refs/heads/master") - expect(ref.target).to be_a(String) + it "raises an error" do + expect { subject }.to raise_error(described_class::UnknownRefTypeError) + end end end end -- GitLab