Module to simplify access to configuration values with default values.

There should be no configuration required to start using :ua_inspector if you rely on the default values:

remote_database = "https://raw.githubusercontent.com/matomo-org/device-detector/6.3.2/regexes"
remote_shortcode = "https://raw.githubusercontent.com/matomo-org/device-detector/6.3.2"

config :ua_inspector,
  database_path: Application.app_dir(:ua_inspector, "priv"),
  http_opts: [],
  remote_path: [
    bot: remote_database,
    browser_engine: remote_database <> "/client",
    client: remote_database <> "/client",
    client_hints: remote_database <> "/client/hints",
    device: remote_database <> "/device",
    os: remote_database,
    short_code_map: remote_shortcode,
    vendor_fragment: remote_database
  ],
  remote_release: "6.3.2",
  startup_silent: false,
  startup_sync: true,
  yaml_file_reader: {:yamerl_constr, :file, [[:str_node_as_binary]]}

The default :database_path is evaluated at runtime and not compiled into a release!

How to Configure

There are two ways to change the configuration values with the preferred way depending on your environment and personal taste.

Static Configuration

If you can ensure the configuration are static and not dependent on i.e. the server your application is running on, you can use a static approach by modifying your config.exs file:

config :ua_inspector,
  database_path: "/path/to/ua_inspector/databases"

Dynamic Configuration

If a compile time configuration is not possible or does not match the usual approach taken in your application you can use a runtime approach.

This is done by defining an initializer module that will automatically be called by UAInspector.Supervisor upon startup/restart. The configuration is expected to consist of a {mod, fun} or {mod, fun, args} tuple:

# {mod, fun}
config :ua_inspector,
  init: {MyInitModule, :my_init_mf}

# {mod, fun, args}
config :ua_inspector,
  init: {MyInitModule, :my_init_mfargs, [:foo, :bar]}

defmodule MyInitModule do
  @spec my_init_mf() :: :ok
  def my_init_mf(), do: my_init_mfargs(:foo, :bar)

  @spec my_init_mfargs(atom, atom) :: :ok
  def my_init_mfargs(:foo, :bar) do
    priv_dir = Application.app_dir(:my_app, "priv")

    Application.put_env(:ua_inspector, :database_path, priv_dir)
  end
end

The function is required to always return :ok.

Startup Behaviour

By default the database files will be read during application startup.

You can change this behaviour by configuring an immediate asynchronous reload:

config :ua_inspector,
  startup_sync: false

This can lead to the first parsing calls to work with an empty database and therefore not return the results you expect.

Starting Silently

When starting the application you will receive messages via Logger.info/1 under certain circumstances:

• a database file fails to be parsed
• a database file contains no entries
• you are using the default database and the release version tracked by the mix download task is different from the current default release

If you want to prevent these messages you can configure the startup the be completely silent:

config :ua_inspector,
  startup_silent: true

Database Configuration

Configuring the database to use can be done using two related values:

• :database_path
• :remote_path

The :database_path is the directory to look for when loading the databases. It is also the place where UAInspector.Downloader stores a downloaded copy.

For the time being the detailed list of database files is not configurable. This is a major caveat for personal database copies and short code mappings (they have additional path information appended to the base). This behaviour is subject to change.

The full configuration for remote paths contains the following values:

config :ua_inspector,
  remote_path: [
    bot: "http://example.com",
    browser_engine: "http://example.com",
    client: "http://example.com",
    client_hints: "http://example.com",
    device: "http://example.com",
    os: "http://example.com",
    short_code_map: "http://example.com",
    vendor_fragment: "http://example.com"
  ]

Default Database Release Version

If you are using the default configuration the release "6.3.2" will be used. You can specify a different version/tag/release to be used:

config :ua_inspector,
  remote_release: "v1.0.0"

Please be aware that using a non-default release can lead to unexpected results based on the specific changes between the releases.

If the default release changes (expect this to be the case with every release of UAInspector) you should download a new copy of the database and/or update your own release configuration. As the list of used files or special in-code detections can change with each release there may otherwise be unexpected messages during application startup or incorrect results from agent detection.

Download Configuration

Using the default configuration all download requests for your database files are done using :hackney. To pass custom configuration values to hackney you can use the key :http_opts:

# increase download timeout to 10 seconds (default: 5 seconds)
config :ua_inspector,
  http_opts: [recv_timeout: 10_000]

Please look at :hackney.request/5 for a complete list of available options.

If you want to change the library used to download the databases you can configure a module implementing the UAInspector.Downloader.Adapter behaviour:

config :ua_inspector,
  downloader_adapter: MyDownloaderAdapter

YAML File Reader Configuration

By default the library :yamerl will be used to read and decode the YAML database files. You can configure this reader to be a custom module:

config :ua_inspector,
  yaml_file_reader: {module, function}

config :ua_inspector,
  yaml_file_reader: {module, function, extra_args}

The configured module will receive the file to read as the first argument with any optionally configured extra arguments after that.