I am experiencing an issue, which I am pretty sure is caused just by me not understanding stuff. Which is usual
I am currently writing a small package. Its only purpose is providing a few helper mix tasks. I want them to be configurable by the user through his Config but provide some defaults as well.
The issue is that even though I specified :env: key in the &application/0 in mix.exs the defaults are still missing and all of my Application.compile_env calls are failing obviously.
I traced the issue to my application not getting loaded. But why? I don’t understand why the hell application that I am trying to compile is not getting loaded?
Elixir version is 1.10.3 compiled with erlang 23.
important contents of the mix.exs:
defmodule FooBar.MixProject do
use Mix.Project
def project do
[
app: :foobar,
version: "0.1.0",
elixir: "~> 1.10"
]
end
def application do
[
extra_applications: [:logger],
env: [
foo: "bar"
]
]
end
end
somewhere in the project:
defmodule FooBar.Spam do
@foo Application.compile_env!(:foobar, :foo)
end
and when I run mix compile I get an error:
** (ArgumentError) could not fetch application environment :foo for application :foobar because the application was not loaded/started. If your application depends on :foobar at runtime, make sure to load/start it or list it under :extra_applications in your mix.exs file
So, the issue is pretty clear - application is not loaded. And if I load it manually when standing on pry it works.
My question is why it is not loaded by default? If I should load it myself, where is the best place to do so?
Yes, as far as i understand :mod key is for custom startup process. Like starting a supervision tree, etc.
But, tbh, my app is more of a library and not an OTP app per se and i don’t really need custom start logic…
In the same docs it is written
Generally, build tools like Mix take care of starting an application and all of its dependencies for you
Thanks for the answers. But I still don’t understand.
It seems like compile_env! just doesn’t work at all…
Using fetch_env doesn’t help at all as it will just return :error. It will compile, yes, but the app still won’t be loaded and therefore values will still be empty. I just don’t understand why mix doesn’t load the application.
Shouldn’t it load the app on compile? Or when the task is run?
It looks like mix simply ignores it at all!
I think I will open an issue in elixir repo as I am starting to get really frustrated and the docs are not helpful here at all :\
Using application/0:env for compile-time-only environment values seems at least strange. Why use :env instead of the config/config.exs though?
And to answer your question more directly, as you see in documentation.app file is compiled after all Elixir files (as compile.app needs list of all modules in application), so it cannot be available during compilation. If you want to have compile-time environment then use config/config.exs.
Okay, that makes sense now, thanks for the answer! Then, I am fixing my issue in the wrong way.
I am writing a library and publishing it to hex. I want to make this library configurable I use compile env values throughout. But, as config.exs of my library won’t get published to hex as well as not available to the user of the library, I want to provide some defaults. As far as I understood I have only 2 options at this:
Use compile_env/3 and provide defaults there. But that seems like a bad idea, as all of my defaults will be scattered.
Use the :env key in application. Which works a bit differently than I expected and not an option for me.
Am I missing something? Is this truly the only available options?
This is somewhat a workaround, but it seems to be working for me.
I have my default configuration in the config/config.exs and adding following to the mix.exs:
def application do
[
...
env: Application.get_all_env(:my_app)
]
end
After I run mix compile there is my config in the ebin/my_app.app file
Because config/config.exs is loaded before the compilation, mix compile.app has access to the application config.