LukasKnuth

LukasKnuth

Validate runtime config on application start

In my config/runtime.exs I have the following:

timezone = System.get_env("TZ") || "Etc/UTC"

unless Timex.is_valid_timezone?(timezone) do
  raise """
  The timezone specified in the TZ environment variable is invalid.
  """
end

config :my_app, MyApp, timezone: timezone

My intention is that a valid Timezone will work as expected while an invalid one (such as Europe/Börlin) crashes the application early.In the rest of the App, I can then assume that the user-supplied timezone is always valid.

This works as expected in dev, on prod however, this results in a crash at runtime:

ERROR! Config provider Config.Reader failed with:
** (ArgumentError) errors were found at the given arguments:
  * 1st argument: the table identifier does not refer to an existing ETS table
    (stdlib 6.2) :ets.lookup(:tzdata_current_release, :release_version)
    (tzdata 1.1.3) lib/tzdata/release_reader.ex:74: Tzdata.ReleaseReader.current_release
    (tzdata 1.1.3) lib/tzdata/release_reader.ex:17: Tzdata.ReleaseReader.simple_lookup/1
    (tzdata 1.1.3) lib/tzdata/release_reader.ex:9: Tzdata.ReleaseReader.zone_and_link_li
    (tzdata 1.1.3) lib/tzdata.ex:61: Tzdata.zone_exists?/1
    (timex 3.7.13) lib/timezone/timezone.ex:230: Timex.Timezone.name_of/1
    (timex 3.7.13) lib/timex.ex:857: Timex.is_valid_timezone?/1
    /app/releases/0.1.0/runtime.exs:13: (file)

I’m assuming this happens because the Timex application isn’t started yet when the runtime configuration is evaluated.

So instead, I now have this workaround that achieves the same thing:

defmodule MyApp.Application do
  use Application

  @impl true
  def start(_type, _args) do
    with :ok <- validate_timezone_config() do
      # shortened
      Supervisor.start_link(children, opts)
    end
  end

  defp validate_timezone_config do
    timezone = Briefly.user_timezone()

    case Timex.is_valid_timezone?(timezone) do
      true -> :ok
      false -> {:error, "Configured timezone '#{timezone}' is invalid"}
    end
  end
end

If an invalid timezone is supplied, the app crashes early:

11:39:02.487 [notice] Application briefly exited: Briefly.Application.start(:normal, []) returned an error: "Configured timezone 'Europe/Börlin' is invalid"
** (exit) :terminating
    (kernel 10.2.1) application_controller.erl:511: :application_controller.call/2
    (kernel 10.2.1) application.erl:367: :application."-ensure_all_started/3-lc$^0/1-0-"/1
    (kernel 10.2.1) application.erl:367: :application.ensure_all_started/3
    (mix 1.18.2) lib/mix/tasks/app.start.ex:72: Mix.Tasks.App.Start.start/3
    (mix 1.18.2) lib/mix/task.ex:495: anonymous fn/3 in Mix.Task.run_task/5
    (mix 1.18.2) lib/mix/tasks/run.ex:129: Mix.Tasks.Run.run/5
    (mix 1.18.2) lib/mix/tasks/run.ex:85: Mix.Tasks.Run.run/1
    (mix 1.18.2) lib/mix/task.ex:495: anonymous fn/3 in Mix.Task.run_task/5

Is this considered an anti-pattern? Is there a more appropriate/easier way to validate runtime configuration during startup?

Most Liked

LostKobrakai

LostKobrakai

You should be able to do Application.ensure_all_started in the runtime config, but that would also mean you cannot configure the started application and its dependencies anymore in runtime.exs. Validating in the application start callback is free of that chicken-egg type problem of what runs first.

Where Next?

Popular in Questions Top

JDanielMartinez
Hi! May someone helps me, please! I have two apps into an umbrella project: the first one is Database, which manages queries, and the se...
New
shahryarjb
Hello, I get Persian date from my client and convert it to normal calendar like this: def jalali_string_to_miladi_english_number(persi...
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
sergio_101
I am VERY much an elixir newbie. I have taken one elixir course and one phoenix course on Udemy. During that course, I saw the instructor...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New
New
polypush135
As many of you may have realized by now (sorry for all the posts here) I’ve been working on a db problem where I’m trying to aggregate a ...
New
makeitrein
Hey all, just started picking up Elixir last week and am writing a scraper as a learning project. Baby step #1 is extracting the number ...
New
hpopp
To simplify some tasks at work, I wrote and published this package yesterday. It’s a simple macro that enables Access behaviour on struct...
New
Codball
Mix format works fine if run from the cmd. I’ve followed this to facilitate the implementation into VSC which involves downloading an ext...
New

Other popular topics Top

minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
Harrisonl
We have an ECS cluster with 4 services, where each task joins a single cluster, via discovery ECS discovery service. Currently when I de...
New
ycv005
I have followed this StackOverflow post to install the specific version of Erlang. And When I am running mix ecto.setup then getting fol...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
grych
Hi folks, Few months ago I have announced the proof-of-concept of the library to manipulate the browsers DOM objects directly from Elixi...
639 49522 488
New
New
danschultzer
None of the current solutions worked well for me, so I went ahead and built a user management system from scratch. This project took far...
548 27727 240
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
qwerescape
Is there a way to get the call stack or stack trace at any point in the code? Not from exceptions, but an expression that returns how the...
New

We're in Beta

About us Mission Statement