Chatwoot/lib/config_loader.rb
Sony Mathew 18d3c40fb3
feat: installation config in super admin console (#1641)
* feat: installation config in super admin console

* Added the ability for super admins to view, edit and update
installation config values. Also they can add new isntallation config
values. The impact of editing and adding depends on which all
installation config values are being used in the code.
* Known limitation now: Ability to edit hash values (for eg: feature
flags) are disabled. This requires more work and will be taken up in
a secondary set of changes.
* Minor UX improvement. Clicking on the Sidekiq option in the super
admin siebar will now open the sidekiq dashboard in a new tab rather
than in the same tab that you were using super admin.

* fix: method name fix in custom adminsitrate field

* feat: added locked attribute to global config
* Added the locked attribute to instalaltion config table. Added
necessary migrations. Added changes in config loader.
* Added the changes on the installation config yml
* Locked the account feature defaults in code

* feat: show only editable configs in admin console
* Added a new scope in installation config model
* Added scope in adminstrate controller for installation_config

* fix: new installation config create error
* Fixed the error in new installation config create

* fix: specs coverage
* Added specs for installation config super admin controller

* chore: update git ignore with encrypted config ext
2021-01-15 13:21:53 +05:30

90 lines
3 KiB
Ruby

class ConfigLoader
DEFAULT_OPTIONS = {
config_path: nil,
reconcile_only_new: true
}.freeze
def process(options = {})
options = DEFAULT_OPTIONS.merge(options)
# function of the "reconcile_only_new" flag
# if true,
# it leaves the existing config and feature flags as it is and
# creates the missing configs and feature flags with their default values
# if false,
# then it overwrites existing config and feature flags with default values
# also creates the missing configs and feature flags with their default values
@reconcile_only_new = options[:reconcile_only_new]
# setting the config path
@config_path = options[:config_path].presence
@config_path ||= Rails.root.join('config')
# general installation configs
reconcile_general_config
# default account based feature configs
reconcile_feature_config
end
private
def general_configs
@general_configs ||= YAML.safe_load(File.read("#{@config_path}/installation_config.yml")).freeze
end
def account_features
@account_features ||= YAML.safe_load(File.read("#{@config_path}/features.yml")).freeze
end
def reconcile_general_config
general_configs.each do |config|
new_config = config.with_indifferent_access
existing_config = InstallationConfig.find_by(name: new_config[:name])
save_general_config(existing_config, new_config)
end
end
def save_general_config(existing, latest)
if existing
# save config only if reconcile flag is false and existing configs value does not match default value
save_as_new_config(latest) if !@reconcile_only_new && compare_values(existing, latest)
else
save_as_new_config(latest)
end
end
def compare_values(existing, latest)
existing.value != latest[:value] ||
(!latest[:locked].nil? && existing.locked != latest[:locked])
end
def save_as_new_config(latest)
config = InstallationConfig.find_or_create_by(name: latest[:name])
config.value = latest[:value]
config.locked = latest[:locked]
config.save!
end
def reconcile_feature_config
config = InstallationConfig.find_by(name: 'ACCOUNT_LEVEL_FEATURE_DEFAULTS')
if config
return false if config.value.to_s == account_features.to_s
compare_and_save_feature(config)
else
save_as_new_config({ name: 'ACCOUNT_LEVEL_FEATURE_DEFAULTS', value: account_features, locked: true })
end
end
def compare_and_save_feature(config)
features = if @reconcile_only_new
# leave the existing feature flag values as it is and add new feature flags with default values
(config.value + account_features).uniq { |h| h['name'] }
else
# update the existing feature flag values with default values and add new feature flags with default values
(account_features + config.value).uniq { |h| h['name'] }
end
config.update({ name: 'ACCOUNT_LEVEL_FEATURE_DEFAULTS', value: features, locked: true })
end
end