d171ff6016
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
200 lines
6.7 KiB
Ruby
200 lines
6.7 KiB
Ruby
require 'spec_helper'
|
|
|
|
describe SnippetsFinder do
|
|
include Gitlab::Allowable
|
|
using RSpec::Parameterized::TableSyntax
|
|
|
|
describe '#initialize' do
|
|
it 'raises ArgumentError when a project and author are given' do
|
|
user = build(:user)
|
|
project = build(:project)
|
|
|
|
expect { described_class.new(user, author: user, project: project) }
|
|
.to raise_error(ArgumentError)
|
|
end
|
|
end
|
|
|
|
context 'filter by scope' do
|
|
let(:user) { create :user }
|
|
let!(:snippet1) { create(:personal_snippet, :private, author: user) }
|
|
let!(:snippet2) { create(:personal_snippet, :internal, author: user) }
|
|
let!(:snippet3) { create(:personal_snippet, :public, author: user) }
|
|
|
|
it "returns all snippets for 'all' scope" do
|
|
snippets = described_class.new(user, scope: :all).execute
|
|
|
|
expect(snippets).to include(snippet1, snippet2, snippet3)
|
|
end
|
|
|
|
it "returns all snippets for 'are_private' scope" do
|
|
snippets = described_class.new(user, scope: :are_private).execute
|
|
|
|
expect(snippets).to include(snippet1)
|
|
expect(snippets).not_to include(snippet2, snippet3)
|
|
end
|
|
|
|
it "returns all snippets for 'are_internal' scope" do
|
|
snippets = described_class.new(user, scope: :are_internal).execute
|
|
|
|
expect(snippets).to include(snippet2)
|
|
expect(snippets).not_to include(snippet1, snippet3)
|
|
end
|
|
|
|
it "returns all snippets for 'are_private' scope" do
|
|
snippets = described_class.new(user, scope: :are_public).execute
|
|
|
|
expect(snippets).to include(snippet3)
|
|
expect(snippets).not_to include(snippet1, snippet2)
|
|
end
|
|
end
|
|
|
|
context 'filter by author' do
|
|
let(:user) { create :user }
|
|
let(:user1) { create :user }
|
|
let!(:snippet1) { create(:personal_snippet, :private, author: user) }
|
|
let!(:snippet2) { create(:personal_snippet, :internal, author: user) }
|
|
let!(:snippet3) { create(:personal_snippet, :public, author: user) }
|
|
|
|
it "returns all public and internal snippets" do
|
|
snippets = described_class.new(user1, author: user).execute
|
|
|
|
expect(snippets).to include(snippet2, snippet3)
|
|
expect(snippets).not_to include(snippet1)
|
|
end
|
|
|
|
it "returns internal snippets" do
|
|
snippets = described_class.new(user, author: user, scope: :are_internal).execute
|
|
|
|
expect(snippets).to include(snippet2)
|
|
expect(snippets).not_to include(snippet1, snippet3)
|
|
end
|
|
|
|
it "returns private snippets" do
|
|
snippets = described_class.new(user, author: user, scope: :are_private).execute
|
|
|
|
expect(snippets).to include(snippet1)
|
|
expect(snippets).not_to include(snippet2, snippet3)
|
|
end
|
|
|
|
it "returns public snippets" do
|
|
snippets = described_class.new(user, author: user, scope: :are_public).execute
|
|
|
|
expect(snippets).to include(snippet3)
|
|
expect(snippets).not_to include(snippet1, snippet2)
|
|
end
|
|
|
|
it "returns all snippets" do
|
|
snippets = described_class.new(user, author: user).execute
|
|
|
|
expect(snippets).to include(snippet1, snippet2, snippet3)
|
|
end
|
|
|
|
it "returns only public snippets if unauthenticated user" do
|
|
snippets = described_class.new(nil, author: user).execute
|
|
|
|
expect(snippets).to include(snippet3)
|
|
expect(snippets).not_to include(snippet2, snippet1)
|
|
end
|
|
|
|
it 'returns all snippets for an admin' do
|
|
admin = create(:user, :admin)
|
|
snippets = described_class.new(admin, author: user).execute
|
|
|
|
expect(snippets).to include(snippet1, snippet2, snippet3)
|
|
end
|
|
end
|
|
|
|
context 'filter by project' do
|
|
let(:user) { create :user }
|
|
let(:group) { create :group, :public }
|
|
let(:project1) { create(:project, :public, group: group) }
|
|
|
|
before do
|
|
@snippet1 = create(:project_snippet, :private, project: project1)
|
|
@snippet2 = create(:project_snippet, :internal, project: project1)
|
|
@snippet3 = create(:project_snippet, :public, project: project1)
|
|
end
|
|
|
|
it "returns public snippets for unauthorized user" do
|
|
snippets = described_class.new(nil, project: project1).execute
|
|
|
|
expect(snippets).to include(@snippet3)
|
|
expect(snippets).not_to include(@snippet1, @snippet2)
|
|
end
|
|
|
|
it "returns public and internal snippets for non project members" do
|
|
snippets = described_class.new(user, project: project1).execute
|
|
|
|
expect(snippets).to include(@snippet2, @snippet3)
|
|
expect(snippets).not_to include(@snippet1)
|
|
end
|
|
|
|
it "returns public snippets for non project members" do
|
|
snippets = described_class.new(user, project: project1, scope: :are_public).execute
|
|
|
|
expect(snippets).to include(@snippet3)
|
|
expect(snippets).not_to include(@snippet1, @snippet2)
|
|
end
|
|
|
|
it "returns internal snippets for non project members" do
|
|
snippets = described_class.new(user, project: project1, scope: :are_internal).execute
|
|
|
|
expect(snippets).to include(@snippet2)
|
|
expect(snippets).not_to include(@snippet1, @snippet3)
|
|
end
|
|
|
|
it "does not return private snippets for non project members" do
|
|
snippets = described_class.new(user, project: project1, scope: :are_private).execute
|
|
|
|
expect(snippets).not_to include(@snippet1, @snippet2, @snippet3)
|
|
end
|
|
|
|
it "returns all snippets for project members" do
|
|
project1.add_developer(user)
|
|
|
|
snippets = described_class.new(user, project: project1).execute
|
|
|
|
expect(snippets).to include(@snippet1, @snippet2, @snippet3)
|
|
end
|
|
|
|
it "returns private snippets for project members" do
|
|
project1.add_developer(user)
|
|
|
|
snippets = described_class.new(user, project: project1, scope: :are_private).execute
|
|
|
|
expect(snippets).to include(@snippet1)
|
|
end
|
|
|
|
it 'returns all snippets for an admin' do
|
|
admin = create(:user, :admin)
|
|
snippets = described_class.new(admin, project: project1).execute
|
|
|
|
expect(snippets).to include(@snippet1, @snippet2, @snippet3)
|
|
end
|
|
end
|
|
|
|
describe '#execute' do
|
|
let(:project) { create(:project, :public) }
|
|
let!(:project_snippet) { create(:project_snippet, :public, project: project) }
|
|
let!(:personal_snippet) { create(:personal_snippet, :public) }
|
|
let(:user) { create(:user) }
|
|
subject(:finder) { described_class.new(user) }
|
|
|
|
it 'returns project- and personal snippets' do
|
|
expect(finder.execute).to contain_exactly(project_snippet, personal_snippet)
|
|
end
|
|
|
|
context 'when the user cannot read cross project' do
|
|
before do
|
|
allow(Ability).to receive(:allowed?).and_call_original
|
|
allow(Ability).to receive(:allowed?).with(user, :read_cross_project) { false }
|
|
end
|
|
|
|
it 'returns only personal snippets when the user cannot read cross project' do
|
|
expect(finder.execute).to contain_exactly(personal_snippet)
|
|
end
|
|
end
|
|
end
|
|
|
|
it_behaves_like 'snippet visibility'
|
|
end
|