Rename bread_crumbs to breadcrumbs.

Author: odarriba

dev.exs

@@ -71,17 +71,17 @@ defmodule ErrorTrackerDevWeb.PageController do
   end
 
   def call(conn, :noroute) do
-    ErrorTracker.add_bread_crumb("ErrorTrackerDevWeb.PageController.no_route")
+    ErrorTracker.add_breadcrumb("ErrorTrackerDevWeb.PageController.no_route")
     raise Phoenix.Router.NoRouteError, conn: conn, router: ErrorTrackerDevWeb.Router
   end
 
   def call(_conn, :exception) do
-    ErrorTracker.add_bread_crumb("ErrorTrackerDevWeb.PageController.exception")
+    ErrorTracker.add_breadcrumb("ErrorTrackerDevWeb.PageController.exception")
     raise "This is a controller exception"
   end
 
   def call(_conn, :exit) do
-    ErrorTracker.add_bread_crumb("ErrorTrackerDevWeb.PageController.exit")
+    ErrorTracker.add_breadcrumb("ErrorTrackerDevWeb.PageController.exit")
     exit(:timeout)
   end
 
@@ -145,13 +145,13 @@ defmodule ErrorTrackerDevWeb.Endpoint do
 
   plug Plug.RequestId
   plug Plug.Telemetry, event_prefix: [:phoenix, :endpoint]
-  plug :add_bread_crumb
+  plug :add_breadcrumb
   plug :maybe_exception
   plug :set_csp
   plug ErrorTrackerDevWeb.Router
 
-  def add_bread_crumb(conn, _) do
-    ErrorTracker.add_bread_crumb("ErrorTrackerDevWeb.Endpoint.add_bread_crumb")
+  def add_breadcrumb(conn, _) do
+    ErrorTracker.add_breadcrumb("ErrorTrackerDevWeb.Endpoint.add_breadcrumb")
     conn
   end
 

lib/error_tracker.ex

@@ -119,13 +119,13 @@ defmodule ErrorTracker do
     {:ok, stacktrace} = ErrorTracker.Stacktrace.new(stacktrace)
     {:ok, error} = Error.new(kind, reason, stacktrace)
     context = Map.merge(get_context(), given_context)
-    bread_crumbs = exception_bread_crumbs(exception) ++ get_bread_crumbs()
+    breadcrumbs = exception_breadcrumbs(exception) ++ get_breadcrumbs()
 
     if enabled?() && !ignored?(error, context) do
       sanitized_context = sanitize_context(context)
 
       {_error, occurrence} =
-        upsert_error!(error, stacktrace, sanitized_context, bread_crumbs, reason)
+        upsert_error!(error, stacktrace, sanitized_context, breadcrumbs, reason)
 
       occurrence
     else
@@ -205,21 +205,21 @@ defmodule ErrorTracker do
   end
 
   @spec set_context(String.t()) :: list(String.t())
-  def add_bread_crumb(bread_crumb) when is_binary(bread_crumb) do
-    current_bread_crumbs = Process.get(:error_tracker_bread_crumbs, [])
-    new_bread_crumbs = current_bread_crumbs ++ [bread_crumb]
+  def add_breadcrumb(breadcrumb) when is_binary(breadcrumb) do
+    current_breadcrumbs = Process.get(:error_tracker_breadcrumbs, [])
+    new_breadcrumbs = current_breadcrumbs ++ [breadcrumb]
 
-    Process.put(:error_tracker_bread_crumbs, new_bread_crumbs)
+    Process.put(:error_tracker_breadcrumbs, new_breadcrumbs)
 
-    new_bread_crumbs
+    new_breadcrumbs
   end
 
   @doc """
   Obtain the context of the current process.
   """
-  @spec get_bread_crumbs() :: list(String.t())
-  def get_bread_crumbs do
-    Process.get(:error_tracker_bread_crumbs, [])
+  @spec get_breadcrumbs() :: list(String.t())
+  def get_breadcrumbs do
+    Process.get(:error_tracker_breadcrumbs, [])
   end
 
   defp enabled? do
@@ -254,15 +254,15 @@ defmodule ErrorTracker do
     end
   end
 
-  defp exception_bread_crumbs(exception) do
+  defp exception_breadcrumbs(exception) do
     case exception do
-      {_kind, exception} -> exception_bread_crumbs(exception)
-      %{bread_crumbs: bread_crumbs} -> bread_crumbs
+      {_kind, exception} -> exception_breadcrumbs(exception)
+      %{bread_crumbs: breadcrumbs} -> breadcrumbs
       _other -> []
     end
   end
 
-  defp upsert_error!(error, stacktrace, context, bread_crumbs, reason) do
+  defp upsert_error!(error, stacktrace, context, breadcrumbs, reason) do
     existing_status =
       Repo.one(from e in Error, where: [fingerprint: ^error.fingerprint], select: e.status)
 
@@ -288,7 +288,7 @@ defmodule ErrorTracker do
           |> Occurrence.changeset(%{
             stacktrace: stacktrace,
             context: context,
-            bread_crumbs: bread_crumbs,
+            breadcrumbs: breadcrumbs,
             reason: reason
           })
           |> Repo.insert!()

lib/error_tracker/migration/mysql/v04.ex

@@ -5,13 +5,13 @@ defmodule ErrorTracker.Migration.MySQL.V04 do
 
   def up(_opts) do
     alter table(:error_tracker_occurrences) do
-      add :bread_crumbs, :json, null: true
+      add :breadcrumbs, :json, null: true
     end
   end
 
   def down(_opts) do
     alter table(:error_tracker_occurrences) do
-      remove :bread_crumbs
+      remove :breadcrumbs
     end
   end
 end

lib/error_tracker/migration/postgres/v04.ex

@@ -5,13 +5,13 @@ defmodule ErrorTracker.Migration.Postgres.V04 do
 
   def up(_opts) do
     alter table(:error_tracker_occurrences) do
-      add :bread_crumbs, {:array, :string}, default: [], null: false
+      add :breadcrumbs, {:array, :string}, default: [], null: false
     end
   end
 
   def down(_opts) do
     alter table(:error_tracker_occurrences) do
-      remove :bread_crumbs
+      remove :breadcrumbs
     end
   end
 end

lib/error_tracker/migration/sqlite/v04.ex

@@ -5,13 +5,13 @@ defmodule ErrorTracker.Migration.SQLite.V04 do
 
   def up(_opts) do
     alter table(:error_tracker_occurrences) do
-      add :bread_crumbs, {:array, :string}, default: [], null: false
+      add :breadcrumbs, {:array, :string}, default: [], null: false
     end
   end
 
   def down(_opts) do
     alter table(:error_tracker_occurrences) do
-      remove :bread_crumbs
+      remove :breadcrumbs
     end
   end
 end

lib/error_tracker/schemas/occurrence.ex

@@ -18,7 +18,7 @@ defmodule ErrorTracker.Occurrence do
     field :reason, :string
 
     field :context, :map
-    field :bread_crumbs, {:array, :string}
+    field :breadcrumbs, {:array, :string}
 
     embeds_one :stacktrace, ErrorTracker.Stacktrace
     belongs_to :error, ErrorTracker.Error
@@ -29,7 +29,7 @@ defmodule ErrorTracker.Occurrence do
   @doc false
   def changeset(occurrence, attrs) do
     occurrence
-    |> cast(attrs, [:context, :reason, :bread_crumbs])
+    |> cast(attrs, [:context, :reason, :breadcrumbs])
     |> maybe_put_stacktrace()
     |> validate_required([:reason, :stacktrace])
     |> validate_context()

lib/error_tracker/web/live/show.html.heex

@@ -25,17 +25,17 @@
         <%= @error.source_line %></pre>
     </.section>
 
-    <.section :if={@occurrence.bread_crumbs != []} title="Bread crumbs">
+    <.section :if={@occurrence.breadcrumbs != []} title="Bread crumbs">
       <div class="relative overflow-x-auto shadow-md sm:rounded-lg ring-1 ring-gray-900">
         <table class="w-full text-sm text-gray-400 table-fixed">
           <tr
-            :for={{bread_crumb, index} <- Enum.with_index(@occurrence.bread_crumbs)}
+            :for={{breadcrumb, index} <- Enum.with_index(@occurrence.breadcrumbs)}
             class="border-b bg-gray-400/10 border-gray-900 last:border-b-0"
           >
             <td class="w-11 pl-2 py-4 font-medium text-white relative text-right">
-              <%= length(@occurrence.bread_crumbs) - index %>.
+              <%= length(@occurrence.breadcrumbs) - index %>.
             </td>
-            <td class="px-2 py-4 font-medium text-white relative"><%= bread_crumb %></td>
+            <td class="px-2 py-4 font-medium text-white relative"><%= breadcrumb %></td>
           </tr>
         </table>
       </div>

test/error_tracker_test.exs

@@ -101,14 +101,14 @@ defmodule ErrorTrackerTest do
     end
 
     test "includes bread crumbs if present" do
-      bread_crumbs = ["bread crumb 1", "bread crumb 2"]
+      breadcrumbs = ["breadcrumb 1", "breadcrumb 2"]
 
       occurrence =
         report_error(fn ->
-          raise ErrorWithBreadcrumbs, message: "test", bread_crumbs: bread_crumbs
+          raise ErrorWithBreadcrumbs, message: "test", bread_crumbs: breadcrumbs
         end)
 
-      assert occurrence.bread_crumbs == bread_crumbs
+      assert occurrence.breadcrumbs == breadcrumbs
     end
   end