Show worker/supervisor ids in app supervision graph (#449)

livebook-dev · Jun 24, 2024 · 467bb05 · 467bb05
1 parent 94db44d
commit 467bb05
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 10 deletions.
diff --git a/lib/kino/process.ex b/lib/kino/process.ex
@@ -751,7 +751,7 @@ defmodule Kino.Process do
     "#{idx}[(\"`#{module_or_atom_to_string(id)}\n**_#{protection}_**`\")]:::ets"
   end
 
-  defp graph_node(%{idx: idx, pid: pid, type: type}) do
+  defp graph_node(%{idx: idx, id: id, pid: pid, type: type}) do
     type =
       if idx == 0 do
         :root
@@ -763,8 +763,16 @@ defmodule Kino.Process do
       case process_info(pid, :registered_name) do
         {:registered_name, []} ->
           case get_label(pid) do
-            :undefined -> inspect(pid)
-            process_label -> format_for_mermaid_graph_node(pid, process_label)
+            :undefined ->
+              if idx == 0 do
+                inspect(pid)
+              else
+                # Use worker/supervisor id as label
+                format_for_mermaid_graph_node(pid, id)
+              end
+
+            process_label ->
+              format_for_mermaid_graph_node(pid, process_label)
           end
 
         {:registered_name, name} ->

diff --git a/test/kino/process_test.exs b/test/kino/process_test.exs
@@ -20,9 +20,13 @@ defmodule Kino.ProcessTest do
       ] = Supervisor.which_children(pid)
 
       content = pid |> Kino.Process.sup_tree(render_ets_tables: true) |> mermaid()
+      agent_pid_text = :erlang.pid_to_list(agent_pid) |> List.to_string()
+
       assert content =~ "0(supervisor_parent):::root ---> 1(ets_owner):::worker"
       assert content =~ "0(supervisor_parent):::root ---> 2(ets_heir):::worker"
-      assert content =~ "0(supervisor_parent):::root ---> 3(#{inspect(agent_pid)}):::worker"
+
+      assert content =~
+               "0(supervisor_parent):::root ---> 3(\"Agent<br/>#{agent_pid_text}\"):::worker"
 
       assert content =~
                "1(ets_owner):::worker -- owner --> 4[(\"`test_ets_table\n**_protected_**`\")]:::ets"
@@ -33,7 +37,9 @@ defmodule Kino.ProcessTest do
       content = :supervisor_parent |> Kino.Process.sup_tree(render_ets_tables: true) |> mermaid()
       assert content =~ "0(supervisor_parent):::root ---> 1(ets_owner):::worker"
       assert content =~ "0(supervisor_parent):::root ---> 2(ets_heir):::worker"
-      assert content =~ "0(supervisor_parent):::root ---> 3(#{inspect(agent_pid)}):::worker"
+
+      assert content =~
+               "0(supervisor_parent):::root ---> 3(\"Agent<br/>#{agent_pid_text}\"):::worker"
 
       assert content =~
                "1(ets_owner):::worker -- owner --> 4[(\"`test_ets_table\n**_protected_**`\")]:::ets"
@@ -52,15 +58,22 @@ defmodule Kino.ProcessTest do
       ] = Supervisor.which_children(pid)
 
       content = pid |> Kino.Process.sup_tree() |> mermaid()
+      agent_pid_text = :erlang.pid_to_list(agent_pid) |> List.to_string()
       assert content =~ "0(supervisor_parent):::root ---> 1(ets_owner):::worker"
       assert content =~ "0(supervisor_parent):::root ---> 2(ets_heir):::worker"
-      assert content =~ "0(supervisor_parent):::root ---> 3(#{inspect(agent_pid)}):::worker"
+
+      assert content =~
+               "0(supervisor_parent):::root ---> 3(\"Agent<br/>#{agent_pid_text}\"):::worker"
+
       refute content =~ ":::ets"
 
       content = :supervisor_parent |> Kino.Process.sup_tree() |> mermaid()
       assert content =~ "0(supervisor_parent):::root ---> 1(ets_owner):::worker"
       assert content =~ "0(supervisor_parent):::root ---> 2(ets_heir):::worker"
-      assert content =~ "0(supervisor_parent):::root ---> 3(#{inspect(agent_pid)}):::worker"
+
+      assert content =~
+               "0(supervisor_parent):::root ---> 3(\"Agent<br/>#{agent_pid_text}\"):::worker"
+
       refute content =~ ":::ets"
     end
 
@@ -81,14 +94,19 @@ defmodule Kino.ProcessTest do
         })
 
       [_, {_, agent, _, _}] = Supervisor.which_children(pid)
+      agent_pid_text = :erlang.pid_to_list(agent) |> List.to_string()
 
       content = Kino.Process.sup_tree(pid) |> mermaid()
       assert content =~ "0(supervisor_parent):::root ---> 1(agent_child):::worker"
-      assert content =~ "0(supervisor_parent):::root ---> 2(#{inspect(agent)}):::worker"
+
+      assert content =~
+               "0(supervisor_parent):::root ---> 2(\"Agent<br/>#{agent_pid_text}\"):::worker"
 
       content = Kino.Process.sup_tree(:supervisor_parent) |> mermaid()
       assert content =~ "0(supervisor_parent):::root ---> 1(agent_child):::worker"
-      assert content =~ "0(supervisor_parent):::root ---> 2(#{inspect(agent)}):::worker"
+
+      assert content =~
+               "0(supervisor_parent):::root ---> 2(\"Agent<br/>#{agent_pid_text}\"):::worker"
     end
 
     test "shows supervision tree with children alongside non-started children" do
@@ -108,10 +126,13 @@ defmodule Kino.ProcessTest do
         })
 
       [{:not_started, :undefined, _, _}, {_, agent, _, _}] = Supervisor.which_children(pid)
+      agent_pid_text = :erlang.pid_to_list(agent) |> List.to_string()
 
       content = Kino.Process.sup_tree(pid) |> mermaid()
       assert content =~ "0(supervisor_parent):::root ---> 1(id: :not_started):::notstarted"
-      assert content =~ "0(supervisor_parent):::root ---> 2(#{inspect(agent)}):::worker"
+
+      assert content =~
+               "0(supervisor_parent):::root ---> 2(\"Agent<br/>#{agent_pid_text}\"):::worker"
     end
 
     # TODO: remove once we require Elixir v1.17.0