Merge pull request #4 from codergeek121/html-template

codergeek121 · web-flow · commit 5dd2a0992925 · 2024-01-10T21:59:46.000+01:00
Simple email template with all information
diff --git a/Gemfile b/Gemfile
@@ -10,3 +10,5 @@ gem "sqlite3"
 
 # Start debugger with binding.b [https://github.com/ruby/debug]
 gem "debug", ">= 1.0.0"
+
+gem "rails-dom-testing"
diff --git a/app/views/email_error_reporter/error_mailer/_frame.html.erb b/app/views/email_error_reporter/error_mailer/_frame.html.erb
@@ -1,3 +1,3 @@
 <tr>
-  <td><%= frame %></td>
+  <td style="font-family: monospace; padding: 2px;"><%= frame %></td>
 </tr>
diff --git a/app/views/email_error_reporter/error_mailer/error.html.erb b/app/views/email_error_reporter/error_mailer/error.html.erb
@@ -1,8 +1,22 @@
-<h1><%= @error.class %></h1>
-<p><%= @error.message %></p>
-
-<div>
-  <table border="1">
-    <%= render(partial: "frame", collection: @backtrace) || render("no_backtrace") -%>
-  </table>
-</div>
+<html>
+  <body style="max-width: 768px; margin: 0 auto;">
+    <h1 style="margin-top: 12px; font-family: sans-serif; font-size: 19px;"><%= @error.class %></h1>
+    <h2 style="font-family: sans-serif; font-size: 15px;"><%= @error.message %></h2>
+
+    <p data-test-id="source">Source: <%= @source ? @source : "No source present" %></p>
+    <p data-test-id="handled">Handled: <%= @handled ? "✅" : "❌" %></p>
+
+    <details style="margin-bottom: 12px;">
+      <summary>Stacktrace</summary>
+
+      <table data-test-id="backtrace" border="1" width="100%" style="margin-top: 12px; margin-bottom: 12px; border-collapse: collapse; border-color: #000000">
+        <%= render(partial: "frame", collection: @backtrace) || render("no_backtrace") -%>
+      </table>
+    </details>
+
+    <details>
+      <summary>Context</summary>
+      <pre data-test-id="context" style="font-family: mono; background: #eeeeee;"><code><%= @context %></code></pre>
+    </details>
+  </body>
+</html>
diff --git a/test/dummy/config/application.rb b/test/dummy/config/application.rb
@@ -22,5 +22,6 @@ class Application < Rails::Application
     #
     # config.time_zone = "Central Time (US & Canada)"
     # config.eager_load_paths << Rails.root.join("extras")
+    config.action_mailer.default_options = { from: 'no-reply@example.com' }
   end
 end
diff --git a/test/dummy/config/environments/test.rb b/test/dummy/config/environments/test.rb
@@ -61,4 +61,6 @@
 
   # Raise error when a before_action's only/except options reference missing actions
   config.action_controller.raise_on_missing_callback_actions = true
+
+  config.email_error_reporter.to = ["test@example.com"]
 end
diff --git a/test/error_mailer_test.rb b/test/error_mailer_test.rb
@@ -5,18 +5,6 @@ class EmailErrorReporter::ErrorMailerTest < ActionMailer::TestCase
     @exception = Exception.new("some message")
   end
 
-  test "renders the template correctly" do
-    assert_equal [], error_mail.to
-    assert_equal read_fixture("error").join, error_mail.body.to_s
-  end
-
-  test "renders a backtrace" do
-    @exception.set_backtrace(["foo", "bar"])
-
-    assert_equal [], error_mail.to
-    assert_equal read_fixture("error_with_backtrace").join, error_mail.body.to_s
-  end
-
   test "severity: error" do
     email = error_mail(severity: :error)
     assert_equal "🔥" + "  Exception", email.subject
@@ -32,6 +20,21 @@ class EmailErrorReporter::ErrorMailerTest < ActionMailer::TestCase
     assert_equal "ℹ️" + "  Exception", email.subject
   end
 
+  test "email content" do
+    @exception.set_backtrace(["foo", "bar"])
+    email = error_mail(handled: true, severity: :info).deliver_now
+    assert_dom_email do
+      assert_dom "h1", "Exception"
+      assert_dom "h2", "some message"
+      assert_dom test_id("source"), "Source: No source present"
+      assert_dom test_id("handled"), "Handled: ✅"
+      assert_dom test_id("context"), "{}"
+      assert_dom "table" do
+        assert_dom "tr", 2
+      end
+    end
+  end
+
   private
 
   def error_mail(**kwargs)
@@ -43,4 +46,8 @@ def error_mail(**kwargs)
       **kwargs
     )
   end
+
+  def test_id(value)
+    "[data-test-id='#{value}']"
+  end
 end

Original file line number	Diff line number	Diff line change
`@@ -22,5 +22,6 @@ class Application < Rails::Application`
`22`	`22`	`#`
`23`	`23`	`# config.time_zone = "Central Time (US & Canada)"`
`24`	`24`	`# config.eager_load_paths << Rails.root.join("extras")`
	`25`	`+ config.action_mailer.default_options = { from: '[email protected]' }`
`25`	`26`	`end`
`26`	`27`	`end`
-Original file line number
+Diff line change
   # Raise error when a before_action's only/except options reference missing actions
   config.action_controller.raise_on_missing_callback_actions = true
++
 +  config.email_error_reporter.to = ["[email protected]"]
 end