stefpankov

stefpankov

Conditional forward in Router based on run-time configuration

I need to use the forward macro in my application’s router only if a configuration flag is true, otherwise I don’t need to forward. I’ve set the config flag to my Endpoint and am trying to access it in the router module as such:

if MyApp.Endpoint.config(:use_sent_emails_plug, false) do
  forward "/sent-emails", Bamboo.SentEmailViewerPlug
end

However this approach throws a compilation error:

== Compilation error in file lib/my_app_web/router.ex ==
** (ArgumentError) argument error
    (stdlib) :ets.lookup(MyAppWeb.Endpoint, :use_sent_emails_plug)
    lib/phoenix/endpoint.ex:540: MyAppWeb.Endpoint.config/2
    lib/my_app_web/router.ex:4: (module)
    (stdlib) erl_eval.erl:680: :erl_eval.do_apply/6
    (elixir) lib/kernel/parallel_compiler.ex:229: anonymous fn/4 in Kernel.ParallelCompiler.spawn_workers/7

Thanks in advance for any help and insight.

Marked As Solved Switch mode

stefpankov

stefpankov

I had the mail adapter be configurable at run-time in the releases.exs config file, however i couldn’t really find a way to use that configuration in the router. After a lot of digging I figured out the whole compile time vs. run-time configuration and realized that there’s really no need for me to configure the mail driver at run-time so now for production I configure the mail driver with an env variable and it can be either local or sendgrid for different target environments.

So now the check looks like this:

if Application.get_env(:my_app, MyApp.Mailer)[:adapter] == Bamboo.LocalAdapter do
  forward "/sent-emails", Bamboo.SentEmailViewerPlug
end

Also Liked

arcanemachine

arcanemachine

This page is the top Google result for “phoenix conditional router forward”, so I’ll just leave a decently thorough answer that will hopefully help whoever bumps into this thread. (I’ll be honest: It’s probably gonna be me in 6 months! :sweat_smile:)


To forward a request to one of several different routers in Phoenix, do this:

  1. Forward the matching path in your router:

lib/your_project_web/router.ex

  scope "/" do
    pipe_through :api

    forward "/", YourProjectWeb.Plugs.ConditionalRequestForwarder
  end
  1. Create a plug that matches and dispatches to the appropriate router based on your condition:

lib/your_project_web/plugs/conditional_request_forwarder.ex

defmodule YourProjectWeb.Plugs.ConditionalRequestForwarder do
  @behaviour Plug

  def init(opts), do: opts

  def call(%Plug.Conn{} = conn, _opts) do
    case conn.params["some_param"] do
      nil -> YourProjectWeb.SomeRouter.call(conn, [])
      _ -> YourProjectWeb.SomeOtherRouter.call(conn, [])
    end
  end
end

And that’s how you can conditionally forward a request to one of several possible routers! :tada:

Where Next?

Trending in Questions Top

jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
saveman71
Hello ! We want new/edit form pages to POST/PUT to their own URL rather than the resources REST defaults (post /things, put /things/:id)...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
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
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New

We're in Beta

About us Mission Statement