From 9a61a102732afde6c0eeebca32247a83b8b5f615 Mon Sep 17 00:00:00 2001 From: Vinicius Brasil Date: Mon, 24 Oct 2022 07:13:23 -0300 Subject: [PATCH] Do not report hard bounce e-mail errors to Sentry (#2361) --- lib/plausible/billing/billing.ex | 2 +- lib/plausible/billing/site_locker.ex | 2 +- lib/plausible/mailer.ex | 43 ++++++++++--------- lib/plausible/mailer_test.exs | 12 ++++++ .../controllers/auth_controller.ex | 4 +- .../controllers/invitation_controller.ex | 8 ++-- .../controllers/site/membership_controller.ex | 6 +-- .../controllers/site_controller.ex | 2 +- lib/workers/check_usage.ex | 4 +- lib/workers/import_google_analytics.ex | 4 +- lib/workers/notify_annual_renewal.ex | 4 +- lib/workers/send_check_stats_emails.ex | 2 +- lib/workers/send_email_report.ex | 2 +- lib/workers/send_site_setup_emails.ex | 6 +-- lib/workers/send_trial_notifications.ex | 8 ++-- lib/workers/spike_notifier.ex | 2 +- 16 files changed, 63 insertions(+), 48 deletions(-) create mode 100644 lib/plausible/mailer_test.exs diff --git a/lib/plausible/billing/billing.ex b/lib/plausible/billing/billing.ex index ad0762ee9..70a1e0593 100644 --- a/lib/plausible/billing/billing.ex +++ b/lib/plausible/billing/billing.ex @@ -69,7 +69,7 @@ defmodule Plausible.Billing do case Repo.update(changeset) do {:ok, updated} -> PlausibleWeb.Email.cancellation_email(subscription.user) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() {:ok, updated} diff --git a/lib/plausible/billing/site_locker.ex b/lib/plausible/billing/site_locker.ex index ee5755f2b..d8c2cff42 100644 --- a/lib/plausible/billing/site_locker.ex +++ b/lib/plausible/billing/site_locker.ex @@ -50,6 +50,6 @@ defmodule Plausible.Billing.SiteLocker do suggested_plan ) - Plausible.Mailer.send_email_safe(template) + Plausible.Mailer.send(template) end end diff --git a/lib/plausible/mailer.ex b/lib/plausible/mailer.ex index 8768e542a..5e82e30b4 100644 --- a/lib/plausible/mailer.ex +++ b/lib/plausible/mailer.ex @@ -1,29 +1,32 @@ defmodule Plausible.Mailer do use Bamboo.Mailer, otp_app: :plausible - def send_email(email) do - try do - Plausible.Mailer.deliver_now!(email) - rescue - error -> - Sentry.capture_exception(error, - stacktrace: __STACKTRACE__, - extra: %{extra: "Error while sending email"} - ) - - reraise error, __STACKTRACE__ + @spec send(Bamboo.Email.t()) :: :ok | {:error, :hard_bounce} | {:error, :unknown_error} + def send(email) do + case deliver_now(email) do + {:ok, _email} -> :ok + {:ok, _email, _response} -> :ok + {:error, error} -> handle_error(error) end end - def send_email_safe(email) do - try do - Plausible.Mailer.deliver_now!(email) - rescue - error -> - Sentry.capture_exception(error, - stacktrace: __STACKTRACE__, - extra: %{extra: "Error while sending email"} - ) + defp handle_error(%{response: response}) when is_binary(response) do + case Jason.decode(response) do + {:ok, %{"ErrorCode" => 406}} -> + {:error, :hard_bounce} + + {:ok, response} -> + Sentry.capture_message("Failed to send e-mail", extra: %{response: response}) + {:error, :unknown_error} + + {:error, _any} -> + Sentry.capture_message("Failed to send e-mail", extra: %{response: response}) + {:error, :unknown_error} end end + + defp handle_error(error) do + Sentry.capture_message("Failed to send e-mail", extra: %{response: error}) + {:error, :unknown_error} + end end diff --git a/lib/plausible/mailer_test.exs b/lib/plausible/mailer_test.exs new file mode 100644 index 000000000..f87083586 --- /dev/null +++ b/lib/plausible/mailer_test.exs @@ -0,0 +1,12 @@ +defmodule Plausible.MailerTest do + use Plausible.DataCase + use Bamboo.Test + + test "send/1 sends an email" do + user = build(:user) + email = PlausibleWeb.Email.welcome_email(user) + + assert :ok == Plausible.Mailer.send(email) + assert_delivered_email(email) + end +end diff --git a/lib/plausible_web/controllers/auth_controller.ex b/lib/plausible_web/controllers/auth_controller.ex index f8f58dc1a..adde571fe 100644 --- a/lib/plausible_web/controllers/auth_controller.ex +++ b/lib/plausible_web/controllers/auth_controller.ex @@ -146,7 +146,7 @@ defmodule PlausibleWeb.AuthController do defp send_email_verification(user) do code = Auth.issue_email_verification(user) email_template = PlausibleWeb.Email.activation_email(user, code) - result = Plausible.Mailer.send_email(email_template) + result = Plausible.Mailer.send(email_template) Logger.debug( "E-mail verification e-mail sent. In dev environment GET /sent-emails for details." @@ -228,7 +228,7 @@ defmodule PlausibleWeb.AuthController do code = Auth.issue_email_verification(user) email_template = PlausibleWeb.Email.activation_email(user, code) - Plausible.Mailer.send_email(email_template) + Plausible.Mailer.send(email_template) conn |> put_flash(:success, "Activation code was sent to #{user.email}") diff --git a/lib/plausible_web/controllers/invitation_controller.ex b/lib/plausible_web/controllers/invitation_controller.ex index f971a66e5..2b6d97bbe 100644 --- a/lib/plausible_web/controllers/invitation_controller.ex +++ b/lib/plausible_web/controllers/invitation_controller.ex @@ -91,22 +91,22 @@ defmodule PlausibleWeb.InvitationController do defp notify_invitation_accepted(%Invitation{role: :owner} = invitation) do PlausibleWeb.Email.ownership_transfer_accepted(invitation) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end defp notify_invitation_accepted(invitation) do PlausibleWeb.Email.invitation_accepted(invitation) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end defp notify_invitation_rejected(%Invitation{role: :owner} = invitation) do PlausibleWeb.Email.ownership_transfer_rejected(invitation) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end defp notify_invitation_rejected(invitation) do PlausibleWeb.Email.invitation_rejected(invitation) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end def remove_invitation(conn, %{"invitation_id" => invitation_id}) do diff --git a/lib/plausible_web/controllers/site/membership_controller.ex b/lib/plausible_web/controllers/site/membership_controller.ex index 6f1ec1c09..8b4b50a5e 100644 --- a/lib/plausible_web/controllers/site/membership_controller.ex +++ b/lib/plausible_web/controllers/site/membership_controller.ex @@ -68,7 +68,7 @@ defmodule PlausibleWeb.Site.MembershipController do PlausibleWeb.Email.new_user_invitation(invitation) end - Plausible.Mailer.send_email(email_template) + Plausible.Mailer.send(email_template) conn |> put_flash( @@ -124,7 +124,7 @@ defmodule PlausibleWeb.Site.MembershipController do |> Repo.preload([:site, :inviter]) PlausibleWeb.Email.ownership_transfer_request(invitation, user) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() conn |> put_flash(:success, "Site transfer request has been sent to #{email}") @@ -199,7 +199,7 @@ defmodule PlausibleWeb.Site.MembershipController do Repo.delete!(membership) PlausibleWeb.Email.site_member_removed(membership) - |> Plausible.Mailer.send_email() + |> Plausible.Mailer.send() redirect_target = if membership.user.id == conn.assigns[:current_user].id do diff --git a/lib/plausible_web/controllers/site_controller.ex b/lib/plausible_web/controllers/site_controller.ex index d4a73964a..78b3156c5 100644 --- a/lib/plausible_web/controllers/site_controller.ex +++ b/lib/plausible_web/controllers/site_controller.ex @@ -77,7 +77,7 @@ defmodule PlausibleWeb.SiteController do {:ok, %{site: site}} -> if is_first_site do PlausibleWeb.Email.welcome_email(user) - |> Plausible.Mailer.send_email() + |> Plausible.Mailer.send() end conn diff --git a/lib/workers/check_usage.ex b/lib/workers/check_usage.ex index fbc2e05a7..3bacfb05a 100644 --- a/lib/workers/check_usage.ex +++ b/lib/workers/check_usage.ex @@ -79,7 +79,7 @@ defmodule Plausible.Workers.CheckUsage do site_allowance ) - Plausible.Mailer.send_email_safe(template) + Plausible.Mailer.send(template) subscriber |> Plausible.Auth.GracePeriod.start_manual_lock_changeset(last_cycle_usage) @@ -100,7 +100,7 @@ defmodule Plausible.Workers.CheckUsage do suggested_plan ) - Plausible.Mailer.send_email_safe(template) + Plausible.Mailer.send(template) subscriber |> Plausible.Auth.GracePeriod.start_changeset(last_cycle_usage) diff --git a/lib/workers/import_google_analytics.ex b/lib/workers/import_google_analytics.ex index 2db423f50..e21c8a9cc 100644 --- a/lib/workers/import_google_analytics.ex +++ b/lib/workers/import_google_analytics.ex @@ -34,7 +34,7 @@ defmodule Plausible.Workers.ImportGoogleAnalytics do Enum.each(site.memberships, fn membership -> if membership.role in [:owner, :admin] do PlausibleWeb.Email.import_success(membership.user, site) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end end) @@ -62,7 +62,7 @@ defmodule Plausible.Workers.ImportGoogleAnalytics do Enum.each(site.memberships, fn membership -> if membership.role in [:owner, :admin] do PlausibleWeb.Email.import_failure(membership.user, site) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end end) end diff --git a/lib/workers/notify_annual_renewal.ex b/lib/workers/notify_annual_renewal.ex index f4215b842..40fde54a7 100644 --- a/lib/workers/notify_annual_renewal.ex +++ b/lib/workers/notify_annual_renewal.ex @@ -46,11 +46,11 @@ defmodule Plausible.Workers.NotifyAnnualRenewal do case user.subscription.status do "active" -> template = PlausibleWeb.Email.yearly_renewal_notification(user) - Plausible.Mailer.send_email_safe(template) + Plausible.Mailer.send(template) "deleted" -> template = PlausibleWeb.Email.yearly_expiration_notification(user) - Plausible.Mailer.send_email_safe(template) + Plausible.Mailer.send(template) _ -> Sentry.capture_message("Invalid subscription for renewal", user: user) diff --git a/lib/workers/send_check_stats_emails.ex b/lib/workers/send_check_stats_emails.ex index 3ab24bffb..c0a820bc6 100644 --- a/lib/workers/send_check_stats_emails.ex +++ b/lib/workers/send_check_stats_emails.ex @@ -29,7 +29,7 @@ defmodule Plausible.Workers.SendCheckStatsEmails do defp send_check_stats_email(user) do PlausibleWeb.Email.check_stats_email(user) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() Repo.insert_all("check_stats_emails", [ %{ diff --git a/lib/workers/send_email_report.ex b/lib/workers/send_email_report.ex index 5a7eb477b..2edd23224 100644 --- a/lib/workers/send_email_report.ex +++ b/lib/workers/send_email_report.ex @@ -79,6 +79,6 @@ defmodule Plausible.Workers.SendEmailReport do name: name ) - Plausible.Mailer.send_email_safe(template) + Plausible.Mailer.send(template) end end diff --git a/lib/workers/send_site_setup_emails.ex b/lib/workers/send_site_setup_emails.ex index fb365ee20..8406601b8 100644 --- a/lib/workers/send_site_setup_emails.ex +++ b/lib/workers/send_site_setup_emails.ex @@ -76,7 +76,7 @@ defmodule Plausible.Workers.SendSiteSetupEmails do defp send_create_site_email(user) do PlausibleWeb.Email.create_site_email(user) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() Repo.insert_all("create_site_emails", [ %{ @@ -88,7 +88,7 @@ defmodule Plausible.Workers.SendSiteSetupEmails do defp send_setup_success_email(user, site) do PlausibleWeb.Email.site_setup_success(user, site) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() Repo.insert_all("setup_success_emails", [ %{ @@ -100,7 +100,7 @@ defmodule Plausible.Workers.SendSiteSetupEmails do defp send_setup_help_email(user, site) do PlausibleWeb.Email.site_setup_help(user, site) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() Repo.insert_all("setup_help_emails", [ %{ diff --git a/lib/workers/send_trial_notifications.ex b/lib/workers/send_trial_notifications.ex index e5a84a223..28fd1bd17 100644 --- a/lib/workers/send_trial_notifications.ex +++ b/lib/workers/send_trial_notifications.ex @@ -51,25 +51,25 @@ defmodule Plausible.Workers.SendTrialNotifications do defp send_one_week_reminder(user) do PlausibleWeb.Email.trial_one_week_reminder(user) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end defp send_tomorrow_reminder(user) do usage = Plausible.Billing.usage_breakdown(user) PlausibleWeb.Email.trial_upgrade_email(user, "tomorrow", usage) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end defp send_today_reminder(user) do usage = Plausible.Billing.usage_breakdown(user) PlausibleWeb.Email.trial_upgrade_email(user, "today", usage) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end defp send_over_reminder(user) do PlausibleWeb.Email.trial_over_email(user) - |> Plausible.Mailer.send_email_safe() + |> Plausible.Mailer.send() end end diff --git a/lib/workers/spike_notifier.ex b/lib/workers/spike_notifier.ex index 52cde6cf1..ddd0331b1 100644 --- a/lib/workers/spike_notifier.ex +++ b/lib/workers/spike_notifier.ex @@ -58,6 +58,6 @@ defmodule Plausible.Workers.SpikeNotifier do dashboard_link ) - Plausible.Mailer.send_email_safe(template) + Plausible.Mailer.send(template) end end