Module: Legion::Settings

Extended by:
Logging::Helper
Defined in:
lib/legion/settings.rb,
lib/legion/settings/os.rb,
lib/legion/settings/helper.rb,
lib/legion/settings/loader.rb,
lib/legion/settings/schema.rb,
lib/legion/settings/overlay.rb,
lib/legion/settings/version.rb,
lib/legion/settings/resolver.rb,
lib/legion/settings/deep_merge.rb,
lib/legion/settings/extensions.rb,
lib/legion/settings/project_env.rb,
lib/legion/settings/agent_loader.rb,
lib/legion/settings/dns_bootstrap.rb,
lib/legion/settings/validators/tls.rb,
lib/legion/settings/extensions/store.rb,
lib/legion/settings/validation_error.rb,
lib/legion/settings/extensions/filter.rb,
lib/legion/settings/extensions/normalizer.rb

Defined Under Namespace

Modules: AgentLoader, DeepMerge, Extensions, Helper, OS, Overlay, ProjectEnv, Resolver, Validators Classes: DnsBootstrap, Loader, Schema, ValidationError

Constant Summary collapse

CORE_MODULES = 
%i[transport cache crypt data logging client region process].freeze
VERSION = 
'1.4.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.loader ⇒ Object

Returns the value of attribute loader.



21
22
23
 
# File 'lib/legion/settings.rb', line 21

def loader
  @loader
end

Class Method Details

.[](key) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/legion/settings.rb', line 58

def [](key)
  logger.info('Legion::Settings was not loaded, auto-loading now') if @loader.nil?
  load if @loader.nil?

  # Fast path: skip overlay resolution when no overlay is active
  return @loader[key] unless Overlay.active?

  overlay_val = Overlay.overlay_for(key)
  base_val = @loader[key]
  if overlay_val.is_a?(Hash) && base_val.is_a?(Hash)
    deep_merge_for_overlay(base_val, overlay_val)
  elsif !overlay_val.nil?
    overlay_val
  else
    base_val
  end
rescue NoMethodError, TypeError => e
  logger.debug("Legion::Settings#[] key=#{key} failed: #{e.message}")
  nil
end

.add_cross_validation(&block) ⇒ Object 



128
129
130
 
# File 'lib/legion/settings.rb', line 128

def add_cross_validation(&block)
  cross_validations << block
end

.define_schema(key, overrides) ⇒ Object 



124
125
126
 
# File 'lib/legion/settings.rb', line 124

def define_schema(key, overrides)
  schema.define_override(key.to_sym, overrides)
end

.dev_mode? ⇒ Boolean

Returns:

  • (Boolean) 


156
157
158
159
160
161
162
163
 
# File 'lib/legion/settings.rb', line 156

def dev_mode?
  return true if ENV['LEGION_DEV'] == 'true'

  Legion::Settings[:dev] ? true : false
rescue StandardError => e
  logger.debug("Legion::Settings#dev_mode? failed: #{e.message}")
  false
end

.dig(*keys) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/legion/settings.rb', line 79

def dig(*keys)
  return nil if keys.empty?

  logger.info('Legion::Settings was not loaded, auto-loading now') if @loader.nil?
  load if @loader.nil?

  root = self[keys.first]
  return root if keys.length == 1
  return nil unless root.respond_to?(:dig)

  root.dig(*keys[1..])
rescue NoMethodError, TypeError => e
  logger.debug("Legion::Settings#dig keys=#{keys.inspect} failed: #{e.message}")
  nil
end

.enterprise_privacy? ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
168
169
170
171
172
 
# File 'lib/legion/settings.rb', line 165

def enterprise_privacy?
  return true if ENV['LEGION_ENTERPRISE_PRIVACY'] == 'true'

  Legion::Settings[:enterprise_data_privacy] ? true : false
rescue StandardError => e
  logger.debug("Legion::Settings#enterprise_privacy? failed: #{e.message}")
  false
end

.errors ⇒ Object 



203
204
205
206
 
# File 'lib/legion/settings.rb', line 203

def errors
  ensure_loader
  @loader.errors
end

.get(options = {}) ⇒ Object 



54
55
56
 
# File 'lib/legion/settings.rb', line 54

def get(options = {})
  @loader || @loader = load(options)
end

.load(options = {}) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/legion/settings.rb', line 25

def load(options = {})
  has_config = options[:config_file] || options[:config_dir] || options[:config_dirs]&.any?

  # Already fully loaded with config files — skip unless forced
  return @loader if @loaded && !options[:force]

  # Create Loader once; reuse for subsequent calls (preserves module merges)
  if @loader.nil? || options[:force]
    @loader = Legion::Settings::Loader.new
    @loader.load_env
    @loader.load_dns_bootstrap
  end

  @loader.load_file(options[:config_file]) if options[:config_file]
  @loader.load_directory(options[:config_dir]) if options[:config_dir]
  options[:config_dirs]&.each do |directory|
    @loader.load_directory(directory)
  end

  @loaded = true if has_config
  load_project_env
  logger.info("Settings loaded from #{@loader.loaded_files.size} files")
  @loader
end

.load_project_env(start_dir: nil, loader: nil) ⇒ String?

Load (or reload) the nearest ‘.legionio.env` file into the settings loader. Searches from Dir.pwd upward. Env-file values take priority over global settings but are overridden by a request overlay (with_overlay).

Parameters:

  • start_dir (String, nil) (defaults to: nil) —

    directory to start searching from (defaults to Dir.pwd)

Returns:

  • (String, nil) —

    path to the loaded file, or nil if none found



149
150
151
152
153
154
 
# File 'lib/legion/settings.rb', line 149

def load_project_env(start_dir: nil, loader: nil)
  target_loader = loader || ensure_loader
  path = ProjectEnv.load_into(target_loader.settings, start_dir: start_dir)
  target_loader.mark_dirty! if path
  path
end

.loaded? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/legion/settings.rb', line 50

def loaded?
  @loaded == true
end

.logger ⇒ Object 



324
325
326
 
# File 'lib/legion/settings.rb', line 324

def logger
  log
end

.merge_settings(key, hash) ⇒ Object 



100
101
102
103
104
105
106
107
 
# File 'lib/legion/settings.rb', line 100

def merge_settings(key, hash)
  ensure_loader
  thing = {}
  thing[key.to_sym] = hash
  @loader.load_module_settings(thing)
  schema.register(key.to_sym, hash)
  # Validation deferred to validate! — don't validate on every merge during boot
end

.on_reload {|changes| ... } ⇒ Object

Register a callback to be invoked after reload! detects changes. Multiple callbacks can be registered; they are called in order.

Yields:

  • (changes) —

    the changes hash { key => { old: …, new: … } }

Raises:

  • (ArgumentError) 


299
300
301
302
303
304
 
# File 'lib/legion/settings.rb', line 299

def on_reload(&block)
  raise ArgumentError, 'on_reload requires a block' unless block

  @reload_callbacks ||= []
  @reload_callbacks << block
end

.register_library(key, defaults) ⇒ Object

Clean hook for legion-* core libraries to register their defaults. Called at the bottom of the library’s settings.rb file. Library defaults fill in gaps; user JSON config wins. Idempotent — calling twice with the same key is safe.

Usage in legion-transport/lib/legion/transport/settings.rb:

Legion::Settings.register_library(:transport, Legion::Transport::Settings.default)



116
117
118
119
120
121
122
 
# File 'lib/legion/settings.rb', line 116

def register_library(key, defaults)
  sym = key.to_sym
  return if @registered_libraries&.include?(sym)

  merge_settings(sym, defaults)
  (@registered_libraries ||= []) << sym
end

.reload! ⇒ Hash

Hot-reload: re-read all previously loaded config files, re-resolve vault:// / env:// / lease:// references, and notify registered callbacks of changed keys.

Safe to call from a SIGHUP handler or API endpoint.

Returns:

  • (Hash) —

    changed keys { key => { old: …, new: … } }



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/legion/settings.rb', line 217

def reload!
  @reload_mutex ||= Mutex.new
  @reload_mutex.synchronize do
    return {} unless @loader

    old_hash = @loader.to_hash.dup
    files = @loader.loaded_files.dup

    # Re-create loader and replay the same files
    new_loader = Legion::Settings::Loader.new
    new_loader.load_env
    new_loader.load_dns_bootstrap
    files.each { |f| new_loader.load_file(f) if File.exist?(f) }

    # Replay module merges so extension defaults are preserved
    if @loader.respond_to?(:merged_modules)
      @loader.merged_modules.each do |mod_key, mod_defaults|
        new_loader.load_module_settings(mod_key => mod_defaults)
      end
    end

    # Replay project env overrides (.legionio.env)
    load_project_env(loader: new_loader)

    # Re-resolve secrets (vault://, env://, lease://)
    begin
      require 'legion/settings/resolver'
      Resolver.resolve_secrets!(new_loader.to_hash)
    rescue StandardError => e
      logger.warn("Settings reload: secret resolution failed: #{e.message}")
    end

    new_hash = new_loader.to_hash
    changes = diff_settings(old_hash, new_hash)

    if changes.empty?
      logger.info('Settings reload: no changes detected')
    else
      @loader = new_loader
      logger.info("Settings reload: #{changes.size} key(s) changed — #{changes.keys.join(', ')}")
      fire_reload_callbacks(changes)
    end

    changes
  end
end

.reset! ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/legion/settings.rb', line 306

def reset!
  if @reload_worker&.alive? && @reload_worker != Thread.current
    @reload_worker.kill
    @reload_worker.join
  end

  @loader = nil
  @loaded = nil
  @schema = nil
  @cross_validations = nil
  @registered_libraries = nil
  @reload_callbacks = nil
  @reload_mutex = nil
  @reload_flag = nil
  @reload_worker = nil
  Overlay.clear_overlay!
end

.resolve_secrets! ⇒ Object 



192
193
194
195
196
197
 
# File 'lib/legion/settings.rb', line 192

def resolve_secrets!
  ensure_loader
  require 'legion/settings/resolver'
  Resolver.resolve_secrets!(@loader.to_hash)
  logger.debug('Secret resolution complete')
end

.schema ⇒ Object 



199
200
201
 
# File 'lib/legion/settings.rb', line 199

def schema
  @schema ||= Schema.new
end

.set_prop(key, value) ⇒ Object 



95
96
97
98
 
# File 'lib/legion/settings.rb', line 95

def set_prop(key, value)
  ensure_loader
  @loader[key] = value
end

.validate! ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/legion/settings.rb', line 174

def validate!
  ensure_loader
  revalidate_all_modules
  run_cross_validations
  detect_unknown_keys
  if errors.empty?
    logger.info('Settings validation passed')
    return
  end

  unless dev_mode?
    logger.warn("Settings validation failed with #{errors.size} error(s)")
    raise ValidationError, errors
  end

  warn_validation_errors(errors)
end

.watch! {|changes| ... } ⇒ Object

Register a SIGHUP handler that triggers reload! Optionally accepts a block that will be called with the changes hash after each successful reload.

Yields:

  • (changes) —

    optional callback receiving the changes hash



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/legion/settings.rb', line 269

def watch!(&block)
  on_reload(&block) if block

  unless Signal.list.key?('HUP')
    logger.info('Settings: SIGHUP not available on this platform — watch! is a no-op')
    return
  end

  # Single coalescing worker thread: SIGHUP sets the flag, worker drains it.
  @reload_flag ||= Queue.new
  @reload_worker ||= Thread.new do
    loop do
      @reload_flag.pop # blocks until signalled
      # Drain any queued signals so rapid SIGHUPs collapse into one reload
      @reload_flag.pop until @reload_flag.empty?
      logger.info('Settings: SIGHUP received — reloading configuration')
      reload!
    rescue StandardError => e
      logger.error("Settings: reload after SIGHUP failed: #{e.message}")
    end
  end

  trap('HUP') { @reload_flag << :reload }
  logger.info('Settings: SIGHUP handler registered for config hot-reload')
end

.with_overlay(overrides) { ... } ⇒ Object

Execute a block with thread-local settings overrides active. Overlays are nestable — inner overlays merge on top of outer ones. Resolution order inside the block: overlay > project env > global settings.

Parameters:

  • overrides (Hash) —

    settings to override for the duration of the block

Yields:

  • the block executed with the overlay active

Returns:

  • the return value of the block



139
140
141
 
# File 'lib/legion/settings.rb', line 139

def with_overlay(overrides, &)
  Overlay.with_overlay(overrides, &)
end