Make Gitlab::CurrentSettings.current_application_settings return cached settings early if they exist without issuing any DB query
Signed-off-by: Rémy Coutable <remy@rymai.me>
This commit is contained in:
Rémy Coutable
parent
1bcdd25ce2
commit
6afe6fa6bc
|
|
@ -32,8 +32,10 @@ module Gitlab
|
|||
|
||||
begin
|
||||
::ApplicationSetting.cached
|
||||
rescue ::Redis::BaseError, ::Errno::ENOENT, ::Errno::EADDRNOTAVAIL
|
||||
# In case Redis isn't running or the Redis UNIX socket file is not available
|
||||
rescue
|
||||
# In case Redis isn't running
|
||||
# or the Redis UNIX socket file is not available
|
||||
# or the DB is not running (we use migrations in the cache key)
|
||||
end
|
||||
end
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,13 @@ describe Gitlab::CurrentSettings do
|
|||
stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'false')
|
||||
end
|
||||
|
||||
shared_context 'with settings in cache' do
|
||||
before do
|
||||
create(:application_setting)
|
||||
described_class.current_application_settings # warm the cache
|
||||
end
|
||||
end
|
||||
|
||||
describe '#current_application_settings', :use_clean_rails_memory_store_caching do
|
||||
it 'allows keys to be called directly' do
|
||||
db_settings = create(:application_setting,
|
||||
|
|
@ -31,16 +38,29 @@ describe Gitlab::CurrentSettings do
|
|||
end
|
||||
|
||||
context 'with DB unavailable' do
|
||||
before do
|
||||
# For some reason, `allow(described_class).to receive(:connect_to_db?).and_return(false)` causes issues
|
||||
# during the initialization phase of the test suite, so instead let's mock the internals of it
|
||||
allow(ActiveRecord::Base.connection).to receive(:active?).and_return(false)
|
||||
context 'and settings in cache' do
|
||||
include_context 'with settings in cache'
|
||||
|
||||
it 'fetches the settings from cache without issuing any query' do
|
||||
expect(ActiveRecord::QueryRecorder.new { described_class.current_application_settings }.count).to eq(0)
|
||||
end
|
||||
end
|
||||
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
expect(ApplicationSetting).not_to receive(:current)
|
||||
context 'and no settings in cache' do
|
||||
before do
|
||||
# For some reason, `allow(described_class).to receive(:connect_to_db?).and_return(false)` causes issues
|
||||
# during the initialization phase of the test suite, so instead let's mock the internals of it
|
||||
allow(ActiveRecord::Base.connection).to receive(:active?).and_return(false)
|
||||
expect(ApplicationSetting).not_to receive(:current)
|
||||
end
|
||||
|
||||
expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
end
|
||||
|
||||
it 'does not issue any query' do
|
||||
expect(ActiveRecord::QueryRecorder.new { described_class.current_application_settings }.count).to eq(0)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
|
|
@ -52,73 +72,86 @@ describe Gitlab::CurrentSettings do
|
|||
ar_wrapped_defaults.slice(*::ApplicationSetting.defaults.keys)
|
||||
end
|
||||
|
||||
before do
|
||||
# For some reason, `allow(described_class).to receive(:connect_to_db?).and_return(true)` causes issues
|
||||
# during the initialization phase of the test suite, so instead let's mock the internals of it
|
||||
allow(ActiveRecord::Base.connection).to receive(:active?).and_return(true)
|
||||
allow(ActiveRecord::Base.connection).to receive(:cached_table_exists?).with('application_settings').and_return(true)
|
||||
context 'and settings in cache' do
|
||||
include_context 'with settings in cache'
|
||||
|
||||
it 'fetches the settings from cache' do
|
||||
# For some reason, `allow(described_class).to receive(:connect_to_db?).and_return(true)` causes issues
|
||||
# during the initialization phase of the test suite, so instead let's mock the internals of it
|
||||
expect(ActiveRecord::Base.connection).not_to receive(:active?)
|
||||
expect(ActiveRecord::Base.connection).not_to receive(:cached_table_exists?)
|
||||
expect(ActiveRecord::Migrator).not_to receive(:needs_migration?)
|
||||
expect(ActiveRecord::QueryRecorder.new { described_class.current_application_settings }.count).to eq(0)
|
||||
end
|
||||
end
|
||||
|
||||
it 'creates default ApplicationSettings if none are present' do
|
||||
settings = described_class.current_application_settings
|
||||
|
||||
expect(settings).to be_a(ApplicationSetting)
|
||||
expect(settings).to be_persisted
|
||||
expect(settings).to have_attributes(settings_from_defaults)
|
||||
end
|
||||
|
||||
context 'with migrations pending' do
|
||||
context 'and no settings in cache' do
|
||||
before do
|
||||
expect(ActiveRecord::Migrator).to receive(:needs_migration?).and_return(true)
|
||||
allow(ActiveRecord::Base.connection).to receive(:active?).and_return(true)
|
||||
allow(ActiveRecord::Base.connection).to receive(:cached_table_exists?).with('application_settings').and_return(true)
|
||||
end
|
||||
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
it 'creates default ApplicationSettings if none are present' do
|
||||
settings = described_class.current_application_settings
|
||||
|
||||
expect(settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
expect(settings.sign_in_enabled?).to eq(settings.sign_in_enabled)
|
||||
expect(settings.sign_up_enabled?).to eq(settings.sign_up_enabled)
|
||||
expect(settings).to be_a(ApplicationSetting)
|
||||
expect(settings).to be_persisted
|
||||
expect(settings).to have_attributes(settings_from_defaults)
|
||||
end
|
||||
|
||||
it 'uses the existing database settings and falls back to defaults' do
|
||||
db_settings = create(:application_setting,
|
||||
home_page_url: 'http://mydomain.com',
|
||||
signup_enabled: false)
|
||||
settings = described_class.current_application_settings
|
||||
app_defaults = ApplicationSetting.last
|
||||
context 'with migrations pending' do
|
||||
before do
|
||||
expect(ActiveRecord::Migrator).to receive(:needs_migration?).and_return(true)
|
||||
end
|
||||
|
||||
expect(settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
expect(settings.home_page_url).to eq(db_settings.home_page_url)
|
||||
expect(settings.signup_enabled?).to be_falsey
|
||||
expect(settings.signup_enabled).to be_falsey
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
settings = described_class.current_application_settings
|
||||
|
||||
# Check that unspecified values use the defaults
|
||||
settings.reject! { |key, _| [:home_page_url, :signup_enabled].include? key }
|
||||
settings.each { |key, _| expect(settings[key]).to eq(app_defaults[key]) }
|
||||
expect(settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
expect(settings.sign_in_enabled?).to eq(settings.sign_in_enabled)
|
||||
expect(settings.sign_up_enabled?).to eq(settings.sign_up_enabled)
|
||||
end
|
||||
|
||||
it 'uses the existing database settings and falls back to defaults' do
|
||||
db_settings = create(:application_setting,
|
||||
home_page_url: 'http://mydomain.com',
|
||||
signup_enabled: false)
|
||||
settings = described_class.current_application_settings
|
||||
app_defaults = ApplicationSetting.last
|
||||
|
||||
expect(settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
expect(settings.home_page_url).to eq(db_settings.home_page_url)
|
||||
expect(settings.signup_enabled?).to be_falsey
|
||||
expect(settings.signup_enabled).to be_falsey
|
||||
|
||||
# Check that unspecified values use the defaults
|
||||
settings.reject! { |key, _| [:home_page_url, :signup_enabled].include? key }
|
||||
settings.each { |key, _| expect(settings[key]).to eq(app_defaults[key]) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when ApplicationSettings.current is present' do
|
||||
it 'returns the existing application settings' do
|
||||
expect(ApplicationSetting).to receive(:current).and_return(:current_settings)
|
||||
context 'when ApplicationSettings.current is present' do
|
||||
it 'returns the existing application settings' do
|
||||
expect(ApplicationSetting).to receive(:current).and_return(:current_settings)
|
||||
|
||||
expect(described_class.current_application_settings).to eq(:current_settings)
|
||||
expect(described_class.current_application_settings).to eq(:current_settings)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when the application_settings table does not exists' do
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
expect(ApplicationSetting).to receive(:create_from_defaults).and_raise(ActiveRecord::StatementInvalid)
|
||||
context 'when the application_settings table does not exists' do
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
expect(ApplicationSetting).to receive(:create_from_defaults).and_raise(ActiveRecord::StatementInvalid)
|
||||
|
||||
expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when the application_settings table is not fully migrated' do
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
expect(ApplicationSetting).to receive(:create_from_defaults).and_raise(ActiveRecord::UnknownAttributeError)
|
||||
context 'when the application_settings table is not fully migrated' do
|
||||
it 'returns an in-memory ApplicationSetting object' do
|
||||
expect(ApplicationSetting).to receive(:create_from_defaults).and_raise(ActiveRecord::UnknownAttributeError)
|
||||
|
||||
expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
Loading…
Reference in New Issue