PR feedback & ensure installer is idempotent

Author: zachdaniel

lib/mix/tasks/sentry.install.ex

@@ -13,6 +13,10 @@ defmodule Mix.Tasks.Sentry.Install.Docs do
     """
     #{short_doc()}
 
+    This installer is built with, and requires, igniter to be used. Igniter is a tool 
+    for biulding package installers. For information on how to add igniter to your 
+    project, see the documentation https://hexdocs.pm/igniter/readme.html#installation.
+
     ## Example
 
     ```bash
@@ -51,16 +55,6 @@ if Code.ensure_loaded?(Igniter) do
     def igniter(igniter) do
       app_name = Igniter.Project.Application.app_name(igniter)
 
-      mix_env_code =
-        quote do
-          Mix.env()
-        end
-
-      cwd_code =
-        quote do
-          [File.cwd!()]
-        end
-
       # Do your work here and return an updated igniter
       igniter
       |> Igniter.Project.Config.configure(
@@ -85,7 +79,7 @@ if Code.ensure_loaded?(Igniter) do
         "prod.exs",
         app_name,
         [:root_source_code_paths],
-        {:code, quote(do: [File.cwd!()]}
+        {:code, quote(do: [File.cwd!()])}
       )
       |> configure_phoenix()
       |> add_logger_handler()
@@ -106,7 +100,14 @@ if Code.ensure_loaded?(Igniter) do
 
       Igniter.Project.Module.find_and_update_module(igniter, app_module, fn zipper ->
         with {:ok, zipper} <- Igniter.Code.Function.move_to_def(zipper, :start, 2),
-             {:ok, zipper} <- Igniter.Code.Common.move_to_do_block(zipper) do
+             {:ok, zipper} <- Igniter.Code.Common.move_to_do_block(zipper),
+             :error <-
+               Igniter.Code.Function.move_to_function_call_in_current_scope(
+                 zipper,
+                 {:logger, :add_handler},
+                 [2, 3, 4],
+                 &Igniter.Code.Function.argument_equals?(&1, 1, Sentry.LoggerHandler)
+               ) do
           code =
             """
             :logger.add_handler(:sentry_handler, Sentry.LoggerHandler, %{
@@ -149,26 +150,34 @@ if Code.ensure_loaded?(Igniter) do
     end
 
     defp add_plug_capture(zipper) do
-      with {:ok, zipper} <- Igniter.Code.Module.move_to_use(zipper, Phoenix.Endpoint) do
+      with :error <- Igniter.Code.Module.move_to_use(zipper, Sentry.PlugCapture),
+           {:ok, zipper} <- Igniter.Code.Module.move_to_use(zipper, Phoenix.Endpoint) do
         Igniter.Code.Common.add_code(zipper, "use Sentry.PlugCapture", placement: :before)
       else
         _ ->
-          {:ok, zipper}
+          zipper
       end
     end
 
     defp add_plug_context(zipper) do
-      with {:ok, zipper} <-
+      with :error <-
+             Igniter.Code.Function.move_to_function_call_in_current_scope(
+               zipper,
+               :plug,
+               [1, 2],
+               &Igniter.Code.Function.argument_equals?(&1, 0, Sentry.PlugContext)
+             ),
+           {:ok, zipper} <-
              Igniter.Code.Function.move_to_function_call_in_current_scope(
                zipper,
                :plug,
-               [2, 1],
+               [1, 2],
                &Igniter.Code.Function.argument_equals?(&1, 0, Plug.Parsers)
              ) do
         Igniter.Code.Common.add_code(zipper, "plug Sentry.PlugContext", placement: :after)
       else
         _ ->
-          {:ok, zipper}
+          zipper
       end
     end
   end

mix.lock

@@ -23,7 +23,7 @@
   "hackney": {:hex, :hackney, "1.20.1", "8d97aec62ddddd757d128bfd1df6c5861093419f8f7a4223823537bad5d064e2", [:rebar3], [{:certifi, "~> 2.12.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~> 6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~> 1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~> 1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.4.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~> 1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~> 0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "fe9094e5f1a2a2c0a7d10918fee36bfec0ec2a979994cff8cfe8058cd9af38e3"},
   "hpax": {:hex, :hpax, "1.0.1", "c857057f89e8bd71d97d9042e009df2a42705d6d690d54eca84c8b29af0787b0", [:mix], [], "hexpm", "4e2d5a4f76ae1e3048f35ae7adb1641c36265510a2d4638157fbcb53dda38445"},
   "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~> 0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"},
-  "igniter": {:hex, :igniter, "0.5.37", "e677c009fcad535759dfb8fec0214af38acf1f27b7d6d0277d6be61d6bb391e8", [:mix], [{:glob_ex, "~> 0.1.7", [hex: :glob_ex, repo: "hexpm", optional: false]}, {:inflex, "~> 2.0", [hex: :inflex, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:owl, "~> 0.11", [hex: :owl, repo: "hexpm", optional: false]}, {:phx_new, "~> 1.7", [hex: :phx_new, repo: "hexpm", optional: true]}, {:req, "~> 0.5", [hex: :req, repo: "hexpm", optional: false]}, {:rewrite, ">= 1.1.1 and < 2.0.0-0", [hex: :rewrite, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.4", [hex: :sourceror, repo: "hexpm", optional: false]}, {:spitfire, ">= 0.1.3 and < 1.0.0-0", [hex: :spitfire, repo: "hexpm", optional: false]}], "hexpm", "ca4e5f7c1edead2c6b8955886b010878660c69f3a3f97bf46641b3c39ed339ce"},
+  "igniter": {:hex, :igniter, "0.5.38", "436a6414abc9245e539d6c92a6f4854f62270fbf6547c4acf1e5a65c0e4f4d4b", [:mix], [{:glob_ex, "~> 0.1.7", [hex: :glob_ex, repo: "hexpm", optional: false]}, {:inflex, "~> 2.0", [hex: :inflex, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:owl, "~> 0.11", [hex: :owl, repo: "hexpm", optional: false]}, {:phx_new, "~> 1.7", [hex: :phx_new, repo: "hexpm", optional: true]}, {:req, "~> 0.5", [hex: :req, repo: "hexpm", optional: false]}, {:rewrite, ">= 1.1.1 and < 2.0.0-0", [hex: :rewrite, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.4", [hex: :sourceror, repo: "hexpm", optional: false]}, {:spitfire, ">= 0.1.3 and < 1.0.0-0", [hex: :spitfire, repo: "hexpm", optional: false]}], "hexpm", "e5f1474a2a7ad186f3b71074d9d1ef25d306634e12af4ea01beae06ba958491d"},
   "inflex": {:hex, :inflex, "2.1.0", "a365cf0821a9dacb65067abd95008ca1b0bb7dcdd85ae59965deef2aa062924c", [:mix], [], "hexpm", "14c17d05db4ee9b6d319b0bff1bdf22aa389a25398d1952c7a0b5f3d93162dd8"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "makeup": {:hex, :makeup, "1.1.2", "9ba8837913bdf757787e71c1581c21f9d2455f4dd04cfca785c70bbfff1a76a3", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cce1566b81fbcbd21eca8ffe808f33b221f9eee2cbc7a1706fc3da9ff18e6cac"},

test/mix/sentry.install_test.exs

@@ -20,9 +20,28 @@ defmodule Mix.Tasks.Sentry.InstallTest do
     + |  plug Sentry.PlugContext
     """)
     |> assert_has_patch("lib/test/application.ex", """
-    + |    :logger.add_handler(:my_sentry_handler, Sentry.LoggerHandler, %{
+    + |    :logger.add_handler(:sentry_handler, Sentry.LoggerHandler, %{
     + |      config: %{metadata: [:file, :line]}
     + |    })
     """)
   end
+
+  test "installation is idempotent" do
+    phx_test_project()
+    |> Igniter.compose_task("sentry.install", ["--dsn", "test_dsn"])
+    |> apply_igniter!()
+    |> Igniter.compose_task("sentry.install", ["--dsn", "test_dsn"])
+    |> assert_unchanged()
+  end
+
+  test "installation will reset your dsn for you, however" do
+    phx_test_project()
+    |> Igniter.compose_task("sentry.install", ["--dsn", "test_dsn"])
+    |> apply_igniter!()
+    |> Igniter.compose_task("sentry.install", ["--dsn", "test_dsn2"])
+    |> assert_has_patch("config/prod.exs", """
+    - |  dsn: "test_dsn",
+    + |  dsn: "test_dsn2",
+    """)
+  end
 end