LukasKnuth

LukasKnuth

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?

Showing Posts 1 to 1

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.

— All posts loaded —

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
FlyingNoodle
If a change or preparation module uses Ash.Changeset.get_argument/2 or Ash.Query.get_argument/2 (or any of the other get_argument functio...
New
ryanwinchester
apply_graft/2 doesn’t rewrite an add_many sub-workflow’s deps on an add step. Grafted jobs cancel with “upstream job was deleted” Version...
New

Other Trending Topics Top

mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge &amp; Solve. They are GUI (Emerge) and State management (S...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews