View Source Bonfire.Common.ConfigModules (bonfire v0.3.5-classic-beta.10)

A Global cache of known config modules to be queried by associated schema, or vice versa.

Use of the ConfigModules Service requires:

  1. Exporting config_module/0 in relevant modules, returning a Module or otp_app atom
  2. To populate :bonfire, :config_modules_search_path in config the list of OTP applications where config_modules are declared.
  3. Start the Bonfire.Common.ConfigModules application before querying.
  4. OTP 21.2 or greater, though we recommend using the most recent release available.

While this module is a GenServer, it is only responsible for setup of the cache and then exits with :ignore having done so. It is not recommended to restart the service as this will lead to a stop the world garbage collection of all processes and the copying of the entire cache to each process that has queried it since its last local garbage collection.

Link to this section Summary

Types

A query is either a config_module name atom or (Pointer) id binary

Functions

Returns a specification to start this module under a supervisor.

Look up a config, throw :not_found if not found.

Get a config identified by schema

Look up many configs at once, throw :not_found if any of them are not found

Populates the global cache with config_module data via introspection.

Link to this section Types

@type query() :: binary() | atom()

A query is either a config_module name atom or (Pointer) id binary

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

config_function_error(error, args)

View Source

Look up a config, throw :not_found if not found.

@spec config_module(query :: query()) :: {:ok, atom()} | {:error, :not_found}

Get a config identified by schema

@spec config_modules([binary() | atom()]) :: [binary()]

Look up many configs at once, throw :not_found if any of them are not found

Link to this function

maybe_config_module(query)

View Source
Link to this function

search_app_modules(search_path \\ search_path())

View Source
@spec start_link(ignored :: term()) :: GenServer.on_start()

Populates the global cache with config_module data via introspection.