Skip to content

refactor(igniter): uses Tower.Igniter.runtime_configure_reporter/3 #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grzuy merged 6 commits into from
Sep 23, 2025
Merged

refactor(igniter): uses Tower.Igniter.runtime_configure_reporter/3 #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d397703
use Tower.Igniter.configure_reporter
grzuy Sep 18, 2025
46a28a5
bump tower
grzuy Sep 19, 2025
3528fca
test: just test idempotence and from scratch here - other cases in tower
grzuy Sep 19, 2025
6876fed
Merge branch 'main' into tower-igniter
grzuy Sep 23, 2025
aa32018
bump tower
grzuy Sep 23, 2025
8399701
Merge branch 'main' into tower-igniter
grzuy Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 7 additions & 129 deletions lib/mix/tasks/tower_bugsnag.install.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
if Code.ensure_loaded?(Igniter) && Code.ensure_loaded?(Tower.Igniter) do
if Code.ensure_loaded?(Igniter) and
Code.ensure_loaded?(Tower.Igniter) and
function_exported?(Tower.Igniter, :runtime_configure_reporter, 3) do
defmodule Mix.Tasks.TowerBugsnag.Install do
@example "mix igniter.install tower_bugsnag"

Expand All @@ -15,143 +17,19 @@ if Code.ensure_loaded?(Igniter) && Code.ensure_loaded?(Tower.Igniter) do

use Igniter.Mix.Task

@default_runtime_config """
import Config

if config_env() == :prod do
config :tower_bugsnag, api_key: System.get_env("BUGSNAG_API_KEY")
end
"""

@prod_config_patterns [
"""
if config_env() == :prod do
__cursor__()
end
""",
"""
if :prod == config_env() do
__cursor__()
end
"""
]

@bugsnag_config_code """
config :tower_bugsnag, api_key: System.get_env("BUGSNAG_API_KEY")
"""

@impl Igniter.Mix.Task
def info(_argv, _composing_task) do
%Igniter.Mix.Task.Info{
group: :tower,
adds_deps: [],
installs: [],
example: @example,
only: nil,
positional: [],
composes: [],
schema: [],
defaults: [],
aliases: [],
required: []
}
%Igniter.Mix.Task.Info{group: :tower, example: @example}
end

@impl Igniter.Mix.Task
def igniter(igniter) do
igniter
|> Tower.Igniter.reporters_list_append(TowerBugsnag)
|> configure_runtime()
end

defp configure_runtime(igniter) do
if runtime_config_exists?(igniter) do
igniter
else
add_runtime_config(igniter)
end
end

defp runtime_config_exists?(igniter) do
Igniter.Project.Config.configures_key?(igniter, "runtime.exs", :tower_bugsnag, [
:api_key
])
end

defp add_runtime_config(igniter) do
Igniter.create_or_update_elixir_file(
igniter,
"config/runtime.exs",
@default_runtime_config,
&update_runtime_config/1
)
end

defp update_runtime_config(zipper) do
if Igniter.Project.Config.configures_key?(zipper, :tower_bugsnag, :api_key) do
{:ok, zipper}
else
add_config_to_prod_block(zipper)
end
end

defp add_config_to_prod_block(zipper) do
zipper
|> Igniter.Code.Common.move_to_cursor_match_in_scope(@prod_config_patterns)
|> case do
{:ok, zipper} ->
handle_existing_prod_block(zipper)

:error ->
add_prod_block_with_config(zipper)
end
end

defp handle_existing_prod_block(zipper) do
if Igniter.Project.Config.configures_key?(zipper, :tower_bugsnag, :api_key) do
{:ok, zipper}
else
update_existing_config_or_add_new(zipper)
end
end

defp update_existing_config_or_add_new(zipper) do
case find_existing_bugsnag_config(zipper) do
{:ok, _zipper} ->
update_existing_bugsnag_config(zipper)

_ ->
Igniter.Code.Common.add_code(zipper, @bugsnag_config_code)
end
end

defp find_existing_bugsnag_config(zipper) do
Igniter.Code.Function.move_to_function_call_in_current_scope(
zipper,
:=,
2,
fn call ->
Igniter.Code.Function.argument_equals?(call, 0, :tower_bugsnag)
end
)
end

defp update_existing_bugsnag_config(zipper) do
zipper
|> Igniter.Project.Config.modify_config_code(
[:api_key],
|> Tower.Igniter.runtime_configure_reporter(
:tower_bugsnag,
Sourceror.parse_string!(~s[System.get_env("BUGSNAG_API_KEY")])
api_key: {:code, Sourceror.parse_string!(~s[System.get_env("BUGSNAG_API_KEY")])}
)
|> then(&{:ok, &1})
end

defp add_prod_block_with_config(zipper) do
Igniter.Code.Common.add_code(zipper, """
if config_env() == :prod do
#{@bugsnag_config_code}
end
""")
end
end
else
Expand All @@ -175,7 +53,7 @@ else
@impl Mix.Task
def run(_argv) do
Mix.shell().error("""
The task 'tower_bugsnag.install' requires igniter and tower > 0.8.3. Please install igniter or update tower and try again.
The task 'tower_bugsnag.install' requires igniter and tower >= 0.8.4. Please install igniter or update tower and try again.

For more information, see: https://hexdocs.pm/igniter/readme.html#installation
""")
Expand Down
101 changes: 1 addition & 100 deletions test/mix/tasks/tower_bugsnag.install_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,110 +17,11 @@ if Code.ensure_loaded?(Tower.Igniter) do
"config/runtime.exs",
"""
import Config

if config_env() == :prod do
config :tower_bugsnag, api_key: System.get_env("BUGSNAG_API_KEY")
end
"""
)
end

test "modifies existing tower configs if available" do
test_project(
files: %{
"config/config.exs" => """
import Config

config :tower, reporters: [TowerEmail]
""",
"config/runtime.exs" => """
import Config
"""
}
)
|> Igniter.compose_task("tower_bugsnag.install", [])
|> assert_has_patch(
"config/config.exs",
"""
|import Config
|
- |config :tower, reporters: [TowerEmail]
+ |config :tower, reporters: [TowerEmail, TowerBugsnag]
"""
)
|> assert_has_patch(
"config/runtime.exs",
"""
|import Config
|
+ |if config_env() == :prod do
+ | config :tower_bugsnag, api_key: System.get_env("BUGSNAG_API_KEY")
+ |end
+ |
config :tower_bugsnag, api_key: System.get_env("BUGSNAG_API_KEY")
"""
)
end

test "modifies existing tower configs if config_env() == :prod block exists" do
test_project(
files: %{
"config/config.exs" => """
import Config

config :tower, reporters: [TowerEmail]
""",
"config/runtime.exs" => """
import Config

if config_env() == :prod do
IO.puts("hello")
end
"""
}
)
|> Igniter.compose_task("tower_bugsnag.install", [])
|> assert_has_patch(
"config/config.exs",
"""
|import Config
|
- |config :tower, reporters: [TowerEmail]
+ |config :tower, reporters: [TowerEmail, TowerBugsnag]
"""
)
|> assert_has_patch(
"config/runtime.exs",
"""
|if config_env() == :prod do
| IO.puts("hello")
+ | config :tower_bugsnag, api_key: System.get_env("BUGSNAG_API_KEY")
|end
|
"""
)
end

test "does not modify existing tower_bugsnag configs if config_env() == :prod block exists" do
test_project(
files: %{
"config/config.exs" => """
import Config

config :tower, reporters: [TowerEmail, TowerBugsnag]
""",
"config/runtime.exs" => """
import Config

if config_env() == :prod do
config :tower_bugsnag, api_key: System.get_env("BUGSNAG_API_KEY")
end
"""
}
)
|> Igniter.compose_task("tower_bugsnag.install", [])
|> assert_unchanged()
end

test "is idempotent" do
test_project()
|> Igniter.compose_task("tower_bugsnag.install", [])
Expand Down
Loading