f9c456bd0c
Previously, we called the `peek_enabled?` method like so:
prepend_before_action :set_peek_request_id, if: :peek_enabled?
Now we don't have a `set_peek_request_id` method, so we don't need that
line. However, the `peek_enabled?` part had a side-effect: it would also
populate the request store cache for whether the performance bar was
enabled for the current request or not.
This commit makes that side-effect explicit, and replaces all uses of
`peek_enabled?` with the more explicit
`Gitlab::PerformanceBar.enabled_for_request?`. There is one spec that
still sets `SafeRequestStore[:peek_enabled]` directly, because it is
contrasting behaviour with and without a request store enabled.
The upshot is:
1. We still set the value in one place. We make it more explicit that
that's what we're doing.
2. Reading that value uses a consistent method so it's easier to find in
future.
125 lines
4 KiB
Ruby
125 lines
4 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
describe Gitlab::PerformanceBar do
|
|
shared_examples 'allowed user IDs are cached' do
|
|
before do
|
|
# Warm the caches
|
|
described_class.enabled_for_user?(user)
|
|
end
|
|
|
|
it 'caches the allowed user IDs in cache', :use_clean_rails_memory_store_caching do
|
|
expect do
|
|
expect(described_class.l1_cache_backend).to receive(:fetch).and_call_original
|
|
expect(described_class.l2_cache_backend).not_to receive(:fetch)
|
|
expect(described_class.enabled_for_user?(user)).to be_truthy
|
|
end.not_to exceed_query_limit(0)
|
|
end
|
|
|
|
it 'caches the allowed user IDs in L1 cache for 1 minute', :use_clean_rails_memory_store_caching do
|
|
Timecop.travel 2.minutes do
|
|
expect do
|
|
expect(described_class.l1_cache_backend).to receive(:fetch).and_call_original
|
|
expect(described_class.l2_cache_backend).to receive(:fetch).and_call_original
|
|
expect(described_class.enabled_for_user?(user)).to be_truthy
|
|
end.not_to exceed_query_limit(0)
|
|
end
|
|
end
|
|
|
|
it 'caches the allowed user IDs in L2 cache for 5 minutes', :use_clean_rails_memory_store_caching do
|
|
Timecop.travel 6.minutes do
|
|
expect do
|
|
expect(described_class.l1_cache_backend).to receive(:fetch).and_call_original
|
|
expect(described_class.l2_cache_backend).to receive(:fetch).and_call_original
|
|
expect(described_class.enabled_for_user?(user)).to be_truthy
|
|
end.not_to exceed_query_limit(2)
|
|
end
|
|
end
|
|
end
|
|
|
|
it { expect(described_class.l1_cache_backend).to eq(Gitlab::ThreadMemoryCache.cache_backend) }
|
|
it { expect(described_class.l2_cache_backend).to eq(Rails.cache) }
|
|
|
|
describe '.enabled_for_user?' do
|
|
let(:user) { create(:user) }
|
|
|
|
before do
|
|
stub_application_setting(performance_bar_allowed_group_id: -1)
|
|
end
|
|
|
|
it 'returns false when given user is nil' do
|
|
expect(described_class.enabled_for_user?(nil)).to be_falsy
|
|
end
|
|
|
|
it 'returns true when given user is an admin' do
|
|
user = build_stubbed(:user, :admin)
|
|
|
|
expect(described_class.enabled_for_user?(user)).to be_truthy
|
|
end
|
|
|
|
it 'returns false when allowed_group_id is nil' do
|
|
expect(described_class).to receive(:allowed_group_id).and_return(nil)
|
|
|
|
expect(described_class.enabled_for_user?(user)).to be_falsy
|
|
end
|
|
|
|
context 'when allowed group ID does not exist' do
|
|
it 'returns false' do
|
|
expect(described_class.enabled_for_user?(user)).to be_falsy
|
|
end
|
|
end
|
|
|
|
context 'when allowed group exists' do
|
|
let!(:my_group) { create(:group, path: 'my-group') }
|
|
|
|
before do
|
|
stub_application_setting(performance_bar_allowed_group_id: my_group.id)
|
|
end
|
|
|
|
context 'when user is not a member of the allowed group' do
|
|
it 'returns false' do
|
|
expect(described_class.enabled_for_user?(user)).to be_falsy
|
|
end
|
|
|
|
it_behaves_like 'allowed user IDs are cached'
|
|
end
|
|
|
|
context 'when user is a member of the allowed group' do
|
|
before do
|
|
my_group.add_developer(user)
|
|
end
|
|
|
|
it 'returns true' do
|
|
expect(described_class.enabled_for_user?(user)).to be_truthy
|
|
end
|
|
|
|
it_behaves_like 'allowed user IDs are cached'
|
|
end
|
|
end
|
|
|
|
context 'when allowed group is nested' do
|
|
let!(:nested_my_group) { create(:group, parent: create(:group, path: 'my-org'), path: 'my-group') }
|
|
|
|
before do
|
|
create(:group, path: 'my-group')
|
|
nested_my_group.add_developer(user)
|
|
stub_application_setting(performance_bar_allowed_group_id: nested_my_group.id)
|
|
end
|
|
|
|
it 'returns the nested group' do
|
|
expect(described_class.enabled_for_user?(user)).to be_truthy
|
|
end
|
|
end
|
|
|
|
context 'when a nested group has the same path' do
|
|
before do
|
|
create(:group, :nested, path: 'my-group').add_developer(user)
|
|
end
|
|
|
|
it 'returns false' do
|
|
expect(described_class.enabled_for_user?(user)).to be_falsy
|
|
end
|
|
end
|
|
end
|
|
end
|