Packages
credo
1.5.4
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/check/warning/application_config_in_module_attribute.ex
defmodule Credo.Check.Warning.ApplicationConfigInModuleAttribute do
use Credo.Check,
base_priority: :high,
tags: [:controversial],
category: :warning,
explanations: [
check: """
Module attributes are evaluated at compile time and not at run time. As
a result, certain configuration read calls made in your module attributes
may work as expected during local development, but may break once in a
deployed context.
This check analyzes all of the module attributes present within a module,
and validates that there are no unsafe calls.
These unsafe calls include:
- `Application.fetch_env/2`
- `Application.fetch_env!/2`
- `Application.get_all_env/1`
- `Application.get_env/3`
- `Application.get_env/2`
As of Elixir 1.10 you can leverage `Application.compile_env/3` and
`Application.compile_env!/2` if you wish to set configuration at
compile time using module attributes.
"""
]
@doc false
@impl true
def run(%SourceFile{} = source_file, params \\ []) do
issue_meta = IssueMeta.for(source_file, params)
Credo.Code.prewalk(source_file, &traverse(&1, &2, issue_meta))
end
defp traverse({:@, meta, [attribute_definition]} = ast, issues, issue_meta) do
case traverse_attribute(attribute_definition) do
nil ->
{ast, issues}
{attribute, call} ->
{ast, issues_for_call(attribute, call, meta, issue_meta, issues)}
end
end
defp traverse(ast, issues, _issue_meta) do
{ast, issues}
end
defp traverse_attribute({attribute, _, _} = ast) do
case Macro.prewalk(ast, nil, &get_forbidden_call/2) do
{_ast, nil} ->
nil
{_ast, call} ->
{attribute, call}
end
end
defp traverse_attribute(_ast) do
nil
end
defp get_forbidden_call(
{{:., _, [{:__aliases__, _, [:Application]}, :fetch_env]}, _meta, _args} = ast,
_acc
) do
{ast, "Application.fetch_env/2"}
end
defp get_forbidden_call(
{{:., _, [{:__aliases__, _, [:Application]}, :fetch_env!]}, _meta, _args} = ast,
_acc
) do
{ast, "Application.fetch_env!/2"}
end
defp get_forbidden_call(
{{:., _, [{:__aliases__, _, [:Application]}, :get_all_env]}, _meta, _args} = ast,
_acc
) do
{ast, "Application.get_all_env/1"}
end
defp get_forbidden_call(
{{:., _, [{:__aliases__, _, [:Application]}, :get_env]}, _meta, args} = ast,
_acc
) do
{ast, "Application.get_env/#{length(args)}"}
end
defp get_forbidden_call(ast, acc) do
{ast, acc}
end
defp issues_for_call(attribute, call, meta, issue_meta, issues) do
options = [
message:
"Module attribute @#{Atom.to_string(attribute)} makes use of unsafe Application configuration call #{
call
}",
trigger: call,
line_no: meta[:line]
]
[format_issue(issue_meta, options) | issues]
end
end