Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Support alternative mailing services (Mailgun, Mandrill, Sendgrid) (#2649)
ruslandoga7b2f4c99eeca
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex a237a87ab3..9ae7b8478c 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file.### Added- 'Last updated X seconds ago' info to 'current visitors' tooltips+- Add support for more Bamboo adapters, i.e. `Bamboo.MailgunAdapter`, `Bamboo.MandrillAdapter`, `Bamboo.SendGridAdapter` plausible/analytics#2649### Fixed- Empty values for Screen Size, OS and Browser are uniformly replaced with "(not set)"diff --git a/config/runtime.exs b/config/runtime.exsindex 55adddc5e0..8e6df2e449 100644--- a/config/runtime.exs+++ b/config/runtime.exs@@ -278,13 +278,32 @@ config :plausible, Plausible.ClickhouseRepo,case mailer_adapter do"Bamboo.PostmarkAdapter" ->config :plausible, Plausible.Mailer,- adapter: :"Elixir.#{mailer_adapter}",+ adapter: Bamboo.PostmarkAdapter,request_options: [recv_timeout: 10_000],api_key: get_var_from_path_or_env(config_dir, "POSTMARK_API_KEY")+ "Bamboo.MailgunAdapter" ->+ config :plausible, Plausible.Mailer,+ adapter: Bamboo.MailgunAdapter,+ hackney_opts: [recv_timeout: :timer.seconds(10)],+ api_key: get_var_from_path_or_env(config_dir, "MAILGUN_API_KEY"),+ domain: get_var_from_path_or_env(config_dir, "MAILGUN_DOMAIN")++ "Bamboo.MandrillAdapter" ->+ config :plausible, Plausible.Mailer,+ adapter: Bamboo.MandrillAdapter,+ hackney_opts: [recv_timeout: :timer.seconds(10)],+ api_key: get_var_from_path_or_env(config_dir, "MANDRILL_API_KEY")++ "Bamboo.SendGridAdapter" ->+ config :plausible, Plausible.Mailer,+ adapter: Bamboo.SendGridAdapter,+ hackney_opts: [recv_timeout: :timer.seconds(10)],+ api_key: get_var_from_path_or_env(config_dir, "SENDGRID_API_KEY")+"Bamboo.SMTPAdapter" ->config :plausible, Plausible.Mailer,- adapter: :"Elixir.#{mailer_adapter}",+ adapter: Bamboo.SMTPAdapter,server: get_var_from_path_or_env(config_dir, "SMTP_HOST_ADDR", "mail"),hostname: base_url.host,port: get_var_from_path_or_env(config_dir, "SMTP_HOST_PORT", "25"),@@ -303,7 +322,12 @@ case mailer_adapter doconfig :plausible, Plausible.Mailer, adapter: Bamboo.TestAdapter_ ->- raise "Unknown mailer_adapter; expected SMTPAdapter or PostmarkAdapter"+ raise ArgumentError, """+ Unknown mailer_adapter: #{inspect(mailer_adapter)}++ Please see https://hexdocs.pm/bamboo/readme.html#available-adapters+ for the list of available adapters that ship with Bamboo+ """endconfig :plausible, PlausibleWeb.Firewall,diff --git a/test/plausible/config_test.exs b/test/plausible/config_test.exsnew file mode 100644index 0000000000..c21f4885d0--- /dev/null+++ b/test/plausible/config_test.exs@@ -0,0 +1,130 @@+defmodule Plausible.ConfigTest do+ use ExUnit.Case++ describe "mailer" do+ test "defaults to Bamboo.SMTPAdapter" do+ env = {"MAILER_ADAPTER", nil}++ assert get_in(runtime_config(env), [:plausible, Plausible.Mailer]) == [+ adapter: Bamboo.SMTPAdapter,+ server: "mail",+ hostname: "localhost",+ port: "25",+ username: nil,+ password: nil,+ tls: :if_available,+ allowed_tls_versions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"],+ ssl: false,+ retries: 2,+ no_mx_lookups: true+ ]+ end++ test "Bamboo.PostmarkAdapter" do+ env = [+ {"MAILER_ADAPTER", "Bamboo.PostmarkAdapter"},+ {"POSTMARK_API_KEY", "some-postmark-key"}+ ]++ assert get_in(runtime_config(env), [:plausible, Plausible.Mailer]) == [+ adapter: Bamboo.PostmarkAdapter,+ request_options: [recv_timeout: 10_000],+ api_key: "some-postmark-key"+ ]+ end++ test "Bamboo.MailgunAdapter" do+ env = [+ {"MAILER_ADAPTER", "Bamboo.MailgunAdapter"},+ {"MAILGUN_API_KEY", "some-mailgun-key"},+ {"MAILGUN_DOMAIN", "example.com"}+ ]++ assert get_in(runtime_config(env), [:plausible, Plausible.Mailer]) == [+ adapter: Bamboo.MailgunAdapter,+ hackney_opts: [recv_timeout: 10_000],+ api_key: "some-mailgun-key",+ domain: "example.com"+ ]+ end++ test "Bamboo.MandrillAdapter" do+ env = [+ {"MAILER_ADAPTER", "Bamboo.MandrillAdapter"},+ {"MANDRILL_API_KEY", "some-mandrill-key"}+ ]++ assert get_in(runtime_config(env), [:plausible, Plausible.Mailer]) == [+ adapter: Bamboo.MandrillAdapter,+ hackney_opts: [recv_timeout: 10_000],+ api_key: "some-mandrill-key"+ ]+ end++ test "Bamboo.SendGridAdapter" do+ env = [+ {"MAILER_ADAPTER", "Bamboo.SendGridAdapter"},+ {"SENDGRID_API_KEY", "some-sendgrid-key"}+ ]++ assert get_in(runtime_config(env), [:plausible, Plausible.Mailer]) == [+ adapter: Bamboo.SendGridAdapter,+ hackney_opts: [recv_timeout: 10_000],+ api_key: "some-sendgrid-key"+ ]+ end++ test "Bamboo.SMTPAdapter" do+ env = [+ {"MAILER_ADAPTER", "Bamboo.SMTPAdapter"},+ {"SMTP_HOST_ADDR", "localhost"},+ {"SMTP_HOST_PORT", "2525"},+ {"SMTP_USER_NAME", "neo"},+ {"SMTP_USER_PWD", "one"},+ {"SMTP_HOST_SSL_ENABLED", "true"},+ {"SMTP_RETRIES", "3"},+ {"SMTP_MX_LOOKUPS_ENABLED", "true"}+ ]++ assert get_in(runtime_config(env), [:plausible, Plausible.Mailer]) == [+ {:adapter, Bamboo.SMTPAdapter},+ {:server, "localhost"},+ {:hostname, "localhost"},+ {:port, "2525"},+ {:username, "neo"},+ {:password, "one"},+ {:tls, :if_available},+ {:allowed_tls_versions, [:tlsv1, :"tlsv1.1", :"tlsv1.2"]},+ {:ssl, "true"},+ {:retries, "3"},+ {:no_mx_lookups, "true"}+ ]+ end++ test "unknown adapter raises" do+ env = {"MAILER_ADAPTER", "Bamboo.FakeAdapter"}++ assert_raise ArgumentError,+ ~r/Unknown mailer_adapter: "Bamboo.FakeAdapter"/,+ fn -> runtime_config(env) end+ end+ end++ defp runtime_config(env) do+ put_system_env_undo(env)+ Config.Reader.read!("config/runtime.exs", env: :prod)+ end++ defp put_system_env_undo(env) do+ before = System.get_env()++ {to_delete, to_put} = Enum.split_with(List.wrap(env), fn {_, v} -> is_nil(v) end)+ Enum.each(to_delete, fn {k, _} -> System.delete_env(k) end)+ System.put_env(to_put)++ on_exit(fn ->+ Enum.each(System.get_env(), fn {k, _} -> System.delete_env(k) end)+ System.put_env(before)+ end)+ end+end