QutBioacoustics/baw-server

View on GitHub
lib/gems/baw-app/lib/initializers/config.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

require_relative '../custom_types'

# The schema for our Settings files
class BawConfigContract < Dry::Validation::Contract
  ActionsConfigSchema = Dry::Schema.define {
    config.validate_keys = true

    required(:actions).hash do
      required(:active_storage).hash do
        required(:queue).filled(:string)
      end

      required(:active_job_default).hash do
        required(:queue).filled(:string)
      end

      required(:media).hash do
        required(:queue).filled(:string)
        required(:cache_to_redis).filled(:bool)
      end

      required(:harvest).hash do
        required(:queue).filled(:string)
        required(:to_do_path).filled(
          Baw::CustomTypes::CreatedDirPathname
        )
        required(:config_file_name).filled(:string)
      end

      required(:harvest_scan).hash do
        required(:queue).filled(:string)
      end

      required(:harvest_delete).hash do
        required(:queue).filled(:string)
        required(:delete_after).filled(:integer, gt?: 0)
      end
    end
  }

  SftpgoConfigSchema = Dry::Schema.define {
    required(:upload_service).hash do
      required(:admin_host).filled(:string)
      required(:public_host).filled(:string)
      required(:port).value(:integer, gt?: 0)
      required(:username).filled(:string)
      required(:password).filled(:string)
      required(:sftp_port).filled(:integer, gt?: 0)
    end
  }

  InternalConfigSchema = Dry::Schema.define {
    required(:internal).hash do
      required(:allow_list).array(Baw::CustomTypes::IPAddr)
    end
  }

  PathsConfigSchema = Dry::Schema.define {
    required(:paths).hash do
      required(:temp_dir).filled(:string)
      required(:programs_dir).filled(:string)
      required(:cached_spectrograms).array(Baw::CustomTypes::CreatedDirPathname)
      required(:cached_audios).array(Baw::CustomTypes::CreatedDirPathname)
      required(:analysis_scripts).array(Baw::CustomTypes::CreatedDirPathname)
      required(:cached_analysis_jobs).array(Baw::CustomTypes::CreatedDirPathname)
      required(:worker_log_file).filled(:string)
      required(:mailer_log_file).filled(:string)
      required(:audio_tools_log_file).filled(:string)
      required(:temp_dir).filled(:string)
      required(:programs_dir).filled(:string)
    end
  }

  # TODO: add more validation
  # Note: ruby config does not make use of values that may have been coerced during validation
  schema(
    ActionsConfigSchema,
    SftpgoConfigSchema,
    InternalConfigSchema,
    PathsConfigSchema
  ) do
    required(:trusted_proxies).array(Baw::CustomTypes::IPAddr)

    required(:audio_recording_max_overlap_sec).value(:float)
    required(:audio_recording_min_duration_sec).value(:float)

    required(:logs).hash do
      required(:tag).maybe(:string)
      required(:directory).filled(:string)
    end

    required(:resque).hash do
      required(:connection).hash
      required(:namespace).filled(:string)
      required(:log_level).filled(Baw::CustomTypes::LogLevel)
      required(:polling_interval_seconds).filled(Baw::CustomTypes::Coercible::Float)
    end

    required(:resque_scheduler).hash do
      required(:polling_interval_seconds).filled(Baw::CustomTypes::Coercible::Float)
      required(:log_level).filled(Baw::CustomTypes::LogLevel)
    end
  end

  rule(:audio_recording_max_overlap_sec, :audio_recording_min_duration_sec) do
    invalid = values[:audio_recording_max_overlap_sec] >= values[:audio_recording_min_duration_sec]
    if invalid
      message = "Maximum overlap and trim duration (#{values[:audio_recording_max_overlap_sec]}) " \
                "must be less than minimum audio recording duration (#{values[:audio_recording_min_duration_sec]})."
      key.failure(message)
    end
  end
end

module ConfigExtensions
  # override the default settings locations
  def setting_files(config_root, env)
    BawApp.config_files(config_root, env)
  end
end
Config.singleton_class.prepend ConfigExtensions

Config.setup do |config|
  # Name of the constant exposing loaded settings
  config.const_name = 'Settings'

  # Raise an error if a setting is not present in the config file
  config.fail_on_missing = true

  # Ability to remove elements of the array set in earlier loaded settings file. For example value: '--'.
  #
  # config.knockout_prefix = nil

  # Overwrite an existing value when merging a `nil` value.
  # When set to `false`, the existing value is retained after merge.
  #
  # config.merge_nil_values = true

  # Overwrite arrays found in previously loaded settings file. When set to `false`, arrays will be merged.
  #
  # config.overwrite_arrays = true

  # Load environment variables from the `ENV` object and override any settings defined in files.
  #
  # config.use_env = false

  # Define ENV variable prefix deciding which variables to load into config.
  #
  # Reading variables from ENV is case-sensitive. If you define lowercase value below, ensure your ENV variables are
  # prefixed in the same way.
  #
  # When not set it defaults to `config.const_name`.
  #
  config.env_prefix = 'BAW_SETTINGS'

  # What string to use as level separator for settings loaded from ENV variables. Default value of '.' works well
  # with Heroku, but you might want to change it for example for '__' to easy override settings from command line, where
  # using dots in variable names might not be allowed (eg. Bash).
  #
  # config.env_separator = '.'

  # Ability to process variables names:
  #   * nil  - no change
  #   * :downcase - convert to lower case
  #
  # config.env_converter = :downcase

  # Parse numeric values as integers instead of strings.
  #
  # config.env_parse_values = true

  # Validate presence and type of specific config values. Check https://github.com/dry-rb/dry-validation for details.
  config.validation_contract = BawConfigContract.new
end