Fix nil is being preinted when params are nil #1

Author: giovanni-voismart

lib/ecto_logbook.ex

@@ -146,13 +146,16 @@ defmodule EctoLogbook do
   def preprocess_metadata(meta), do: meta
 
   defp maybe_inline_params(query, metadata, conf, reset_color) do
-    case conf[:inline_params] do
-      true ->
+    cond do
+      conf[:inline_params] ->
         param_reset_color = (reset_color != "" && __MODULE__.Colors.sql_color(query)) || ""
         repo = (metadata[:repo] && metadata[:repo].__adapter__()) || nil
         __MODULE__.Inline.inline_params(query, metadata[:cast_params], param_reset_color, repo)
 
-      _ ->
+      metadata[:cast_params] == nil ->
+        query
+
+      true ->
         "#{query} #{inspect(metadata[:cast_params])}"
     end
   end

lib/ecto_logbook/inline.ex

@@ -6,6 +6,9 @@ defmodule EctoLogbook.Inline do
   alias EctoLogbook.Colors
   alias EctoLogbook.PrintableParameter
 
+  @type params :: [any()] | nil
+  @type color :: String.t()
+
   @spec inline_value(any(), String.t()) :: String.t()
   defp inline_value(value, reset_color) do
     value
@@ -18,8 +21,8 @@ defmodule EctoLogbook.Inline do
       |> Colors.colorize(IO.ANSI.light_blue(), reset_color)
   end
 
-  @spec reduce_query_params([String.t()], [any()], String.t(), String.t()) :: String.t()
-  defp reduce_query_params([], _params, _color, acc), do: acc
+  @spec reduce_query_params([String.t()], params(), color(), String.t()) :: String.t()
+  defp reduce_query_params([], _params, _reset_color, acc), do: acc
 
   defp reduce_query_params([part | parts], [param | params], color, acc) do
     reduce_query_params(parts, params, color, acc <> part <> inline_value(param, color))
@@ -32,8 +35,10 @@ defmodule EctoLogbook.Inline do
   @doc """
   Substitutes parameters placeholders in `query` with their actual values
   """
-  @spec inline_params(String.t(), [any()], String.t(), module()) :: String.t()
-  def inline_params(query, [], _color, _repo_adapter), do: query
+  @spec inline_params(String.t(), params(), color(), module()) :: String.t()
+  def inline_params(query, [], _reset_color, _repo_adapter), do: query
+
+  def inline_params(query, nil, _reset_color, _repo_adapter), do: query
 
   def inline_params(query, params, reset_color, Ecto.Adapters.Postgres) do
     String.split(query, ~r/\$\d+/) |> reduce_query_params(params, reset_color, "")

test/ecto_logbook_test.exs

@@ -99,6 +99,11 @@ defmodule EctoLogbookTest do
                ~S|INSERT INTO "posts" ("array_of_enums") VALUES (?1) RETURNING "id" [[:foo, :baz]]|
                |> String.replace("\"", "\\\"")
     end
+
+    test "don't inspect params when nil" do
+      assert :ok = EctoLogbook.install(Repo2)
+      assert capture_log(fn -> Repo2.query!("SELECT 1") end) =~ ~S|msg="SELECT 1"|
+    end
   end
 
   defp setup_repo(repo) do

test/ecto_logbook_test/inline_test.exs

@@ -17,6 +17,11 @@ defmodule EctoLogbookTest.InlineTest do
                "query $1 @2 ?"
     end
 
+    test "query is unchanged when params are nil" do
+      assert Inline.inline_params("query $1 @2 ?", nil, @disable_color, Ecto.Adapters.Postgres) ==
+               "query $1 @2 ?"
+    end
+
     test "query is unchanged when the adapter is not supported" do
       assert Inline.inline_params(
                "query $1 @2 ?",