ngeraedts

ngeraedts

Conditional import fails to compile

I’m trying to import a helper module in my application that is only available in under :dev and :test mix environments.

I’ve got the following in my mix.exs to prevent the helper module from being compiled under :prod:

  defp elixirc_paths(:test), do: ["lib", "test/fixtures", "test/support"]
  defp elixirc_paths(:dev), do: ["lib", "test/fixtures"]
  defp elixirc_paths(_), do: ["lib"]

and then the following in the body of one of my modules:

def MyAppWeb.ProxyController do
  ...
  # Insert controller actions to serve fixture data in development and testing
  if Mix.env() in [:dev, :test] do
    import MyApp.Fixtures, only: [mock_proxy: 1]

    mock_proxy(:the_thing)
  end
  ...
end

The mock_proxy/1 macro injects some function clauses to the module. This works great under :dev or :test environments, but fails in :prod with the following error?

== Compilation error in file lib/my_app_web/controllers/proxy_controller.ex ==
** (CompileError) lib/my_app_web/controllers/proxy_controller.ex:18: module MyApp.Fixtures is not loaded and could not be found
    (stdlib 3.14.2) lists.erl:1358: :lists.mapfoldl/3
    (stdlib 3.14.2) lists.erl:1359: :lists.mapfoldl/3
    (elixir 1.12.1) expanding macro: Kernel.if/2

I thought this wouldn’t happen because of the if statement at the module level, but clearly something else is going on. I can “fix” this by compiling this path in all environments, but I’d like to avoid that if I can.

Any thoughts on what I’m missing here?

Marked As Solved

aziz

aziz

The code needs to be put in a macro which can return something depending on a condition. I was able to make the following work:

defmodule Compile do
  defmacro only_in(envs, body) do
    if Mix.env() == envs or Mix.env() in envs do
      body
    end
  end
end

def MyAppWeb.ProxyController do
  require Compile

  Compile.only_in [:dev, :test] do
    import MyApp.Fixtures, only: [mock_proxy: 1]
    mock_proxy(:the_thing)
  end
end

This is just a suggestion. Maybe there’s a better way but this should help you to make progress for now. :+1:

Also Liked

aziz

aziz

Here is an improved version that allows an optional else-body:

defmodule Compile do
  defmacro only_in(envs, body) do
    if Mix.env() in List.wrap(envs) do
      body[:do]
    else
      body[:else]
    end
  end
end

def MyAppWeb.ProxyController do
  require Compile

  Compile.only_in [:dev, :test] do
    import MyApp.Fixtures, only: [mock_proxy: 1]
    mock_proxy(:the_thing)
  else
    IO.puts("No mock for prod.")
  end
end
josevalim

josevalim

Creator of Elixir

Correct! The code in “if” won’t be executed but it still has to be expanded, hence the failure.

Where Next?

Popular in Questions Top

jerry
Good day to you all. I have been struggling to get a query involving like and ilike to work. Can anyone assist me on this, please? pro...
New
pgiesin
This should be a simple problem but I just can’t seem to figure it out. I have a standalone Elixir app that won’t find the database. Dep...
New
_russellb
I want to try my hand at web scraping. What tools/libraries do I need to use. I’m hoping to turn this into something professional so don’...
New
Werner
Hi, I’m using Ubuntu 18.04 and after updating to OTP-24.0 yesterday i have this warning when I run “mix local.hex”: 14:57:30.512 [warn] ...
New
vertexbuffer
Hello, can anybody help here..? I have a list of players and I what to delete an element, but every for loop the list is reverting to ori...
New
lastday4you
I wanted to check elixir version in phoenix because i found that my elixir is 1.5 but when i use Enum.chunk_by it said the function is un...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
Exadra37
Sometimes I want to check if the input into a function is not a blank string. My first approach: defmodule Example do def do_stuff(s...
New
lucidguppy
I have a super simple question about elixir - how would I take a file like this foo bar baz and output a new file that enumerates th...
New
idi527
I’ve been re-reading swift book again and noticed that multiline strings there don’t have a trailing line break, unlike in elixir iex(2)...
New

Other popular topics Top

peerreynders
Manning 2016 Halloween weekend sale via Deal of the Day Friday, October 28 - Half off all MEAPs - code WM102816LT Saturday, October 29 ...
326 29600 154
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
New
malloryerik
Hi, this is for people who, like me, have had some friction using .html.heex templates in VSCode. The solution seems to be, in a hyphena...
New
KronicDeth
Elixir plugin for JetBrain’s IntelliJ Platform (including Rubymine) This is a plugin that adds support for Elixir to JetBrains IntelliJ...
289 35421 110
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
SoCreat
i’m a new one to elixir which editor can i use vs code? or atom? Thanks! :smiley:
New
alice
Hey, Just curious what are the main benefits of Elixir compared to Clojure? When is Elixir more useful than Clojure and vice versa? Th...
New
johnnyicon
Hi all, I've just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage. I'm trying to use Postg...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers' Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New

We're in Beta

About us Mission Statement