Commit 2bdf6ede authored by Rémy Coutable's avatar Rémy Coutable

Simplify Gitlab::CurrentSettings now that the logic is in CacheableAttributes

Signed-off-by: default avatarRémy Coutable <remy@rymai.me>
parent a46929ea
...@@ -9,8 +9,8 @@ module Gitlab ...@@ -9,8 +9,8 @@ module Gitlab
end end
end end
def fake_application_settings(defaults = ::ApplicationSetting.defaults) def fake_application_settings(attributes = {})
Gitlab::FakeApplicationSettings.new(defaults) Gitlab::FakeApplicationSettings.new(::ApplicationSetting.defaults.merge(attributes || {}))
end end
def method_missing(name, *args, &block) def method_missing(name, *args, &block)
...@@ -25,43 +25,35 @@ module Gitlab ...@@ -25,43 +25,35 @@ module Gitlab
def ensure_application_settings! def ensure_application_settings!
return in_memory_application_settings if ENV['IN_MEMORY_APPLICATION_SETTINGS'] == 'true' return in_memory_application_settings if ENV['IN_MEMORY_APPLICATION_SETTINGS'] == 'true'
cached_application_settings || uncached_application_settings
end
def cached_application_settings
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
end
end
def uncached_application_settings
return fake_application_settings unless connect_to_db? return fake_application_settings unless connect_to_db?
db_settings = ::ApplicationSetting.current current_settings = ::ApplicationSetting.current
# If there are pending migrations, it's possible there are columns that # If there are pending migrations, it's possible there are columns that
# need to be added to the application settings. To prevent Rake tasks # need to be added to the application settings. To prevent Rake tasks
# and other callers from failing, use any loaded settings and return # and other callers from failing, use any loaded settings and return
# defaults for missing columns. # defaults for missing columns.
if ActiveRecord::Migrator.needs_migration? if ActiveRecord::Migrator.needs_migration?
defaults = ::ApplicationSetting.defaults return fake_application_settings(current_settings&.attributes)
defaults.merge!(db_settings.attributes.symbolize_keys) if db_settings.present?
return fake_application_settings(defaults)
end end
return db_settings if db_settings.present? return current_settings if current_settings.present?
with_fallback_to_fake_application_settings do
::ApplicationSetting.create_from_defaults || in_memory_application_settings ::ApplicationSetting.create_from_defaults || in_memory_application_settings
end end
end
def in_memory_application_settings def in_memory_application_settings
@in_memory_application_settings ||= ::ApplicationSetting.new(::ApplicationSetting.defaults) # rubocop:disable Gitlab/ModuleWithInstanceVariables with_fallback_to_fake_application_settings do
rescue ActiveRecord::StatementInvalid, ActiveRecord::UnknownAttributeError @in_memory_application_settings ||= ::ApplicationSetting.build_from_defaults # rubocop:disable Gitlab/ModuleWithInstanceVariables
# In case migrations the application_settings table is not created yet, end
# we fallback to a simple OpenStruct end
def with_fallback_to_fake_application_settings(&block)
yield
rescue
# In case the application_settings table is not created yet, or if a new
# ApplicationSetting column is not yet migrated we fallback to a simple OpenStruct
fake_application_settings fake_application_settings
end end
......
require 'spec_helper' require 'spec_helper'
describe Gitlab::CurrentSettings do describe Gitlab::CurrentSettings do
include StubENV
before do before do
stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'false') stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'false')
end end
describe '#current_application_settings' do describe '#current_application_settings', :use_clean_rails_memory_store_caching do
it 'allows keys to be called directly' do it 'allows keys to be called directly' do
db_settings = create(:application_setting, db_settings = create(:application_setting,
home_page_url: 'http://mydomain.com', home_page_url: 'http://mydomain.com',
...@@ -19,46 +17,54 @@ describe Gitlab::CurrentSettings do ...@@ -19,46 +17,54 @@ describe Gitlab::CurrentSettings do
expect(described_class.metrics_sample_interval).to be(15) expect(described_class.metrics_sample_interval).to be(15)
end end
context 'with DB available' do context 'when ENV["IN_MEMORY_APPLICATION_SETTINGS"] is true' do
before do before do
# For some reason, `allow(described_class).to receive(:connect_to_db?).and_return(true)` causes issues stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'true')
# 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(:table_exists?).and_call_original
allow(ActiveRecord::Base.connection).to receive(:table_exists?).with('application_settings').and_return(true)
end end
it 'attempts to use cached values first' do it 'returns an in-memory ApplicationSetting object' do
expect(ApplicationSetting).to receive(:cached) expect(ApplicationSetting).not_to receive(:current)
expect(described_class.current_application_settings).to be_a(ApplicationSetting) expect(described_class.current_application_settings).to be_a(ApplicationSetting)
expect(described_class.current_application_settings).not_to be_persisted
end
end end
it 'falls back to DB if Redis returns an empty value' do context 'with DB unavailable' do
expect(ApplicationSetting).to receive(:cached).and_return(nil) before do
expect(ApplicationSetting).to receive(:last).and_call_original.twice # 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
expect(described_class.current_application_settings).to be_a(ApplicationSetting) allow(ActiveRecord::Base.connection).to receive(:active?).and_return(false)
end end
it 'falls back to DB if Redis fails' do it 'returns an in-memory ApplicationSetting object' do
db_settings = ApplicationSetting.create!(ApplicationSetting.defaults) expect(ApplicationSetting).not_to receive(:current)
expect(ApplicationSetting).to receive(:cached).and_raise(::Redis::BaseError) expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
expect(Rails.cache).to receive(:fetch).with(ApplicationSetting::CACHE_KEY).and_raise(Redis::BaseError) end
end
expect(described_class.current_application_settings).to eq(db_settings) context 'with DB available' do
# This method returns the ::ApplicationSetting.defaults hash
# but with respect of custom attribute accessors of ApplicationSetting model
def settings_from_defaults
ar_wrapped_defaults = ::ApplicationSetting.build_from_defaults.attributes
ar_wrapped_defaults.slice(*::ApplicationSetting.defaults.keys)
end end
it 'creates default ApplicationSettings if none are present' do before do
expect(ApplicationSetting).to receive(:cached).and_raise(::Redis::BaseError) # For some reason, `allow(described_class).to receive(:connect_to_db?).and_return(true)` causes issues
expect(Rails.cache).to receive(:fetch).with(ApplicationSetting::CACHE_KEY).and_raise(Redis::BaseError) # 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)
end
it 'creates default ApplicationSettings if none are present' do
settings = described_class.current_application_settings settings = described_class.current_application_settings
expect(settings).to be_a(ApplicationSetting) expect(settings).to be_a(ApplicationSetting)
expect(settings).to be_persisted expect(settings).to be_persisted
expect(settings).to have_attributes(ApplicationSetting.defaults) expect(settings).to have_attributes(settings_from_defaults)
end end
context 'with migrations pending' do context 'with migrations pending' do
...@@ -69,7 +75,7 @@ describe Gitlab::CurrentSettings do ...@@ -69,7 +75,7 @@ describe Gitlab::CurrentSettings do
it 'returns an in-memory ApplicationSetting object' do it 'returns an in-memory ApplicationSetting object' do
settings = described_class.current_application_settings settings = described_class.current_application_settings
expect(settings).to be_a(OpenStruct) expect(settings).to be_a(Gitlab::FakeApplicationSettings)
expect(settings.sign_in_enabled?).to eq(settings.sign_in_enabled) expect(settings.sign_in_enabled?).to eq(settings.sign_in_enabled)
expect(settings.sign_up_enabled?).to eq(settings.sign_up_enabled) expect(settings.sign_up_enabled?).to eq(settings.sign_up_enabled)
end end
...@@ -81,7 +87,7 @@ describe Gitlab::CurrentSettings do ...@@ -81,7 +87,7 @@ describe Gitlab::CurrentSettings do
settings = described_class.current_application_settings settings = described_class.current_application_settings
app_defaults = ApplicationSetting.last app_defaults = ApplicationSetting.last
expect(settings).to be_a(OpenStruct) expect(settings).to be_a(Gitlab::FakeApplicationSettings)
expect(settings.home_page_url).to eq(db_settings.home_page_url) 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
expect(settings.signup_enabled).to be_falsey expect(settings.signup_enabled).to be_falsey
...@@ -91,34 +97,29 @@ describe Gitlab::CurrentSettings do ...@@ -91,34 +97,29 @@ describe Gitlab::CurrentSettings do
settings.each { |key, _| expect(settings[key]).to eq(app_defaults[key]) } settings.each { |key, _| expect(settings[key]).to eq(app_defaults[key]) }
end end
end end
end
context 'with DB unavailable' do context 'when ApplicationSettings.current is present' do
before do it 'returns the existing application settings' do
# For some reason, `allow(described_class).to receive(:connect_to_db?).and_return(false)` causes issues expect(ApplicationSetting).to receive(:current).and_return(:current_settings)
# 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(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 it 'returns an in-memory ApplicationSetting object' do
expect(ApplicationSetting).not_to receive(:current) expect(ApplicationSetting).to receive(:create_from_defaults).and_raise(ActiveRecord::StatementInvalid)
expect(ApplicationSetting).not_to receive(:last)
expect(described_class.current_application_settings).to be_a(OpenStruct) expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
end end
end end
context 'when ENV["IN_MEMORY_APPLICATION_SETTINGS"] is true' do context 'when the application_settings table is not fully migrated' do
before do
stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'true')
end
it 'returns an in-memory ApplicationSetting object' do it 'returns an in-memory ApplicationSetting object' do
expect(ApplicationSetting).not_to receive(:current) expect(ApplicationSetting).to receive(:create_from_defaults).and_raise(ActiveRecord::UnknownAttributeError)
expect(ApplicationSetting).not_to receive(:last)
expect(described_class.current_application_settings).to be_a(ApplicationSetting) expect(described_class.current_application_settings).to be_a(Gitlab::FakeApplicationSettings)
expect(described_class.current_application_settings).not_to be_persisted end
end end
end end
end end
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment