refactor: Move version to runtime config (#3533)

Author: joshlarson

config/config.exs

@@ -58,8 +58,6 @@ config :dotcom, :search_service, Dotcom.SearchService
 
 config :dotcom, :upcoming_departures_module, Dotcom.UpcomingDepartures
 
-config :dotcom, :version, System.get_env("SENTRY_RELEASE", "missing-version")
-
 config :dotcom, :service_rollover_time, ~T[03:00:00]
 
 config :dotcom, :timezone, "America/New_York"

config/runtime.exs

@@ -197,7 +197,8 @@ config :dotcom,
   env: config_env(),
   env_name: System.get_env("SENTRY_ENVIRONMENT"),
   # soon: use a better env var name
-  is_prod_env?: System.get_env("SENTRY_ENVIRONMENT") == "prod"
+  is_prod_env?: System.get_env("SENTRY_ENVIRONMENT") == "prod",
+  version: System.get_env("SENTRY_RELEASE", "missing-version")
 
 if System.get_env("LOGGER_LEVEL") in ~w(emergency alert critical error warning notice info debug all none) &&
      config_env() != :test do

deploy/dotcom/prod/Dockerfile

@@ -4,8 +4,6 @@ FROM hexpm/elixir:1.20.4-erlang-29.0.6-alpine-3.23.5 AS builder
 ENV LANG="C.UTF-8" MIX_ENV="prod"
 ENV CYPRESS_INSTALL_BINARY=0
 ARG SENTRY_DSN=""
-ARG SENTRY_RELEASE
-ENV SENTRY_RELEASE=${SENTRY_RELEASE}
 
 WORKDIR /home
 
@@ -50,5 +48,8 @@ RUN apk add libssl3
 COPY --from=builder /home/_build /home/_build
 
 # RUN
+ARG SENTRY_RELEASE
+ENV SENTRY_RELEASE=${SENTRY_RELEASE}
+
 EXPOSE 4000
 CMD ["/home/_build/prod/rel/dotcom/bin/dotcom", "start"]

lib/dotcom/cache/key_generator.ex

@@ -3,18 +3,17 @@ defmodule Dotcom.Cache.KeyGenerator do
   Generate a readable cache key based on the module, function, and arguments.
   """
 
-  @version Application.compile_env(:dotcom, :version)
-
   @behaviour Nebulex.Caching.KeyGenerator
 
   @impl Nebulex.Caching.KeyGenerator
   def generate(mod, fun, args) do
+    version = Application.get_env(:dotcom, :version)
     unique_id = args |> inspect() |> Base.encode64()
 
     module_name =
       Util.get_or_save_persistent_term({:key_generator, mod}, fn -> clean_mod(mod) end)
 
-    "#{module_name}|#{fun}|#{unique_id}|#{@version}"
+    "#{module_name}|#{fun}|#{unique_id}|#{version}"
   end
 
   defp clean_mod(mod) do

lib/dotcom_web/controllers/version_controller.ex

@@ -4,11 +4,11 @@ defmodule DotcomWeb.VersionController do
   """
   use DotcomWeb, :controller
 
-  @version Application.compile_env(:dotcom, :version)
-
   def version(conn, _params) do
+    version = Application.get_env(:dotcom, :version)
+
     conn
     |> put_resp_content_type("text/plain")
-    |> send_resp(:ok, @version)
+    |> send_resp(:ok, version)
   end
 end

test/dotcom_web/controllers/version_controller_test.exs

@@ -2,13 +2,13 @@ defmodule DotcomWeb.VersionControllerTest do
   @moduledoc false
   use DotcomWeb.ConnCase
 
-  @version Application.compile_env(:dotcom, :version)
-
   describe "version/2" do
     test "returns 200 with the configured version", %{conn: conn} do
+      version = Application.get_env(:dotcom, :version)
+
       response = get(conn, version_path(conn, :version))
       assert response.status == 200
-      assert response.resp_body == @version
+      assert response.resp_body == version
       assert get_resp_header(response, "content-type") == ["text/plain; charset=utf-8"]
     end
   end