Use Util.inspect_pid/1 on more processes

Whenever possible, have error messages show process labels or names

Author: nathanl

lib/db_connection.ex

@@ -82,6 +82,7 @@ defmodule DBConnection do
   require Logger
 
   alias DBConnection.Holder
+  alias DBConnection.Util
 
   require Holder
 
@@ -1357,7 +1358,7 @@ defmodule DBConnection do
   end
 
   defp stop(%DBConnection{pool_ref: pool_ref}, kind, reason, stack) do
-    msg = "client #{inspect(self())} stopped: " <> Exception.format(kind, reason, stack)
+    msg = "client #{Util.inspect_pid(self())} stopped: " <> Exception.format(kind, reason, stack)
     exception = DBConnection.ConnectionError.exception(msg)
     _ = Holder.stop(pool_ref, exception)
     :ok

lib/db_connection/connection.ex

@@ -100,7 +100,7 @@ defmodule DBConnection.Connection do
             [
               inspect(mod),
               " (",
-              inspect(self()),
+              Util.inspect_pid(self()),
               ") failed to connect: " | Exception.format_banner(:error, err, [])
             ]
           end,
@@ -116,7 +116,7 @@ defmodule DBConnection.Connection do
               inspect(mod),
               ?\s,
               ?(,
-              inspect(self()),
+              Util.inspect_pid(self()),
               ") failed to connect: "
               | Exception.format_banner(:error, err, [])
             ]
@@ -142,7 +142,7 @@ defmodule DBConnection.Connection do
           inspect(mod),
           ?\s,
           ?(,
-          inspect(self()),
+          Util.inspect_pid(self()),
           ") disconnected: " | Exception.format_banner(:error, err, [])
         ]
       end)
@@ -343,7 +343,7 @@ defmodule DBConnection.Connection do
 
   def handle_event(:info, msg, :no_state, %{mod: mod} = s) do
     Logger.info(fn ->
-      [inspect(mod), ?\s, ?(, inspect(self()), ") missed message: " | inspect(msg)]
+      [inspect(mod), ?\s, ?(, Util.inspect_pid(self()), ") missed message: " | inspect(msg)]
     end)
 
     handle_timeout(s)

lib/db_connection/holder.ex

@@ -2,6 +2,8 @@ defmodule DBConnection.Holder do
   @moduledoc false
   require Record
 
+  alias DBConnection.Util
+
   @queue true
   @timeout 15000
   @time_unit 1000
@@ -84,7 +86,7 @@ defmodule DBConnection.Holder do
              %{
                exception
                | message:
-                   "could not checkout the connection owned by #{inspect(caller)}. " <>
+                   "could not checkout the connection owned by #{Util.inspect_pid(caller)}. " <>
                      "When using the sandbox, connections are shared, so this may imply " <>
                      "another process is using a connection. Reason: #{message}"
              }}
@@ -332,7 +334,7 @@ defmodule DBConnection.Holder do
 
     call_reason =
       if maybe_pid do
-        "Error happened when attempting to transfer to #{inspect(maybe_pid)} " <>
+        "Error happened when attempting to transfer to #{Util.inspect_pid(maybe_pid)} " <>
           "(alive: #{Process.alive?(maybe_pid)})"
       else
         "Error happened when looking up connection"
@@ -342,7 +344,7 @@ defmodule DBConnection.Holder do
     #{inspect(__MODULE__)} #{inspect(holder)} #{reason}, pool inconsistent.
     #{call_reason}.
 
-    SELF: #{inspect(self())}
+    SELF: #{Util.inspect_pid(self())}
     ETS INFO: #{inspect(:ets.info(holder))}
 
     Please report at https://github.com/elixir-ecto/db_connection/issues"

lib/db_connection/ownership/manager.ex

@@ -262,11 +262,11 @@ defmodule DBConnection.Ownership.Manager do
     if log do
       Logger.log(log, fn ->
         [
-          inspect(caller),
+          Util.inspect_pid(caller),
           " checked out connection in ",
           inspect(mode),
           " mode using proxy ",
-          inspect(proxy)
+          Util.inspect_pid(proxy)
         ]
       end)
     end
@@ -306,7 +306,13 @@ defmodule DBConnection.Ownership.Manager do
   defp owner_allow(%{ets: ets, log: log} = state, caller, allow, ref, proxy) do
     if log do
       Logger.log(log, fn ->
-        [inspect(allow), " was allowed by ", inspect(caller), " on proxy ", inspect(proxy)]
+        [
+          Util.inspect_pid(allow),
+          " was allowed by ",
+          Util.inspect_pid(caller),
+          " on proxy ",
+          Util.inspect_pid(proxy)
+        ]
       end)
     end
 
@@ -324,7 +330,13 @@ defmodule DBConnection.Ownership.Manager do
   defp owner_unallow(%{ets: ets, log: log} = state, caller, unallow, ref, proxy) do
     if log do
       Logger.log(log, fn ->
-        [inspect(unallow), " was unallowed by ", inspect(caller), " on proxy ", inspect(proxy)]
+        [
+          Util.inspect_pid(unallow),
+          " was unallowed by ",
+          Util.inspect_pid(caller),
+          " on proxy ",
+          Util.inspect_pid(proxy)
+        ]
       end)
     end
 
@@ -348,9 +360,9 @@ defmodule DBConnection.Ownership.Manager do
         if log do
           Logger.log(log, fn ->
             [
-              Enum.map_join(entries, ", ", &inspect/1),
+              Enum.map_join(entries, ", ", &Util.inspect_pid/1),
               " lost connection from proxy ",
-              inspect(proxy)
+              Util.inspect_pid(proxy)
             ]
           end)
         end

lib/db_connection/ownership/proxy.ex

@@ -158,7 +158,8 @@ defmodule DBConnection.Ownership.Proxy do
 
   @impl true
   def handle_cast({:stop, caller}, %{owner: {owner, _}} = state) do
-    message = "#{inspect(caller)} checked in the connection owned by #{inspect(owner)}"
+    message =
+      "#{Util.inspect_pid(caller)} checked in the connection owned by #{Util.inspect_pid(owner)}"
 
     message =
       case pruned_stacktrace(caller) do
@@ -167,7 +168,7 @@ defmodule DBConnection.Ownership.Proxy do
 
         current_stack ->
           message <>
-            "\n\n#{inspect(caller)} triggered the checkin at location:\n\n" <>
+            "\n\n#{Util.inspect_pid(caller)} triggered the checkin at location:\n\n" <>
             Exception.format_stacktrace(current_stack)
       end
 
@@ -237,10 +238,10 @@ defmodule DBConnection.Ownership.Proxy do
         current_stack ->
           reason <>
             """
-            \n\nClient #{inspect(client)} is still using a connection from owner at location:
+            \n\nClient #{Util.inspect_pid(client)} is still using a connection from owner at location:
 
             #{Exception.format_stacktrace(current_stack)}
-            The connection itself was checked out by #{inspect(client)} at location:
+            The connection itself was checked out by #{Util.inspect_pid(client)} at location:
 
             #{Exception.format_stacktrace(checkout_stack)}
             """

lib/db_connection/util.ex

@@ -4,7 +4,7 @@ defmodule DBConnection.Util do
   @doc """
   Inspect a pid, including the process label if possible.
   """
-  def inspect_pid(pid) do
+  def inspect_pid(pid) when is_pid(pid) do
     with :undefined <- get_label(pid),
          :undefined <- get_name(pid) do
       inspect(pid)
@@ -13,6 +13,8 @@ defmodule DBConnection.Util do
     end
   end
 
+  def inspect_pid(other), do: inspect(other)
+
   defp get_name(pid) do
     try do
       Process.info(pid, :registered_name)