From 54f70717c458af0ce919988b5d293c38f162cc65 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Wed, 9 Dec 2020 11:00:14 +0200 Subject: [PATCH 1/9] Add basic spike notifications Co-authored-by: Jerod Santo --- config/config.exs | 7 ++- config/releases.exs | 7 ++- lib/plausible/site/schema.ex | 1 + lib/plausible/site/spike_notification.ex | 30 +++++++++++++ lib/plausible_web/email.ex | 9 +++- .../email/spike_notification.html.eex | 1 + lib/workers/spike_notifier.ex | 39 ++++++++++++++++ mix.exs | 3 +- mix.lock | 1 + ...20201208173543_add_spike_notifications.exs | 14 ++++++ test/support/factory.ex | 4 ++ test/workers/spike_notifier_test.exs | 44 +++++++++++++++++++ 12 files changed, 154 insertions(+), 6 deletions(-) create mode 100644 lib/plausible/site/spike_notification.ex create mode 100644 lib/plausible_web/templates/email/spike_notification.html.eex create mode 100644 lib/workers/spike_notifier.ex create mode 100644 priv/repo/migrations/20201208173543_add_spike_notifications.exs create mode 100644 test/workers/spike_notifier_test.exs diff --git a/config/config.exs b/config/config.exs index cc3e1044a..553269240 100644 --- a/config/config.exs +++ b/config/config.exs @@ -118,7 +118,9 @@ extra_cron = [ # Daily at midday {"0 12 * * *", Plausible.Workers.SendCheckStatsEmails}, # Every 10 minutes - {"*/10 * * * *", Plausible.Workers.ProvisionSslCertificates} + {"*/10 * * * *", Plausible.Workers.ProvisionSslCertificates}, + # Every 15 minutes + {"*/15 * * * *", Plausible.Workers.SpikeNotifier} ] base_queues = [rotate_salts: 1] @@ -130,7 +132,8 @@ extra_queues = [ site_setup_emails: 1, trial_notification_emails: 1, schedule_email_reports: 1, - send_email_reports: 1 + send_email_reports: 1, + spike_notifications: 1 ] config :plausible, Oban, diff --git a/config/releases.exs b/config/releases.exs index a84b9306d..78fa2f57c 100644 --- a/config/releases.exs +++ b/config/releases.exs @@ -157,7 +157,9 @@ extra_cron = [ # Daily at midday {"0 12 * * *", Plausible.Workers.SendCheckStatsEmails}, # Every 10 minutes - {"*/10 * * * *", Plausible.Workers.ProvisionSslCertificates} + {"*/10 * * * *", Plausible.Workers.ProvisionSslCertificates}, + # Every 15 minutes + {"*/15 * * * *", Plausible.Workers.SpikeNotifier} ] base_queues = [rotate_salts: 1] @@ -169,7 +171,8 @@ extra_queues = [ site_setup_emails: 1, trial_notification_emails: 1, schedule_email_reports: 1, - send_email_reports: 1 + send_email_reports: 1, + spike_notifications: 1 ] config :plausible, Oban, diff --git a/lib/plausible/site/schema.ex b/lib/plausible/site/schema.ex index 8fe6582c7..985296dce 100644 --- a/lib/plausible/site/schema.ex +++ b/lib/plausible/site/schema.ex @@ -14,6 +14,7 @@ defmodule Plausible.Site do has_one :weekly_report, Plausible.Site.WeeklyReport has_one :monthly_report, Plausible.Site.MonthlyReport has_one :custom_domain, Plausible.Site.CustomDomain + has_one :spike_notification, Plausible.Site.SpikeNotification timestamps() end diff --git a/lib/plausible/site/spike_notification.ex b/lib/plausible/site/spike_notification.ex new file mode 100644 index 000000000..9cca56cdd --- /dev/null +++ b/lib/plausible/site/spike_notification.ex @@ -0,0 +1,30 @@ +defmodule Plausible.Site.SpikeNotification do + use Ecto.Schema + import Ecto.Changeset + + schema "spike_notifications" do + field :recipients, {:array, :string} + field :threshold, :integer + field :last_sent, :naive_datetime + belongs_to :site, Plausible.Site + + timestamps() + end + + def changeset(settings, attrs \\ %{}) do + settings + |> cast(attrs, [:site_id, :recipients]) + |> validate_required([:site_id, :recipients]) + |> unique_constraint(:site) + end + + def add_recipient(report, recipient) do + report + |> change(recipients: report.recipients ++ [recipient]) + end + + def remove_recipient(report, recipient) do + report + |> change(recipients: List.delete(report.recipients, recipient)) + end +end diff --git a/lib/plausible_web/email.ex b/lib/plausible_web/email.ex index d6ac2a1c6..490d99658 100644 --- a/lib/plausible_web/email.ex +++ b/lib/plausible_web/email.ex @@ -13,7 +13,6 @@ defmodule PlausibleWeb.Email do |> subject("Activate your Plausible free trial") |> render("activation_email.html", name: user.name, link: link) end - def welcome_email(user) do base_email() |> to(user) @@ -94,6 +93,14 @@ defmodule PlausibleWeb.Email do |> render("weekly_report.html", Keyword.put(assigns, :site, site)) end + def spike_notification(email, site, current_visitors) do + base_email() + |> to(email) + |> tag("spike-notification") + |> subject("Traffic spike on #{site.domain}") + |> render("spike_notification.html", %{current_visitors: current_visitors}) + end + def cancellation_email(user) do base_email() |> to(user.email) diff --git a/lib/plausible_web/templates/email/spike_notification.html.eex b/lib/plausible_web/templates/email/spike_notification.html.eex new file mode 100644 index 000000000..906bb3a65 --- /dev/null +++ b/lib/plausible_web/templates/email/spike_notification.html.eex @@ -0,0 +1 @@ +Yours site has <%= @current_visitors %> visitors. Nice! diff --git a/lib/workers/spike_notifier.ex b/lib/workers/spike_notifier.ex new file mode 100644 index 000000000..1faa9060e --- /dev/null +++ b/lib/workers/spike_notifier.ex @@ -0,0 +1,39 @@ +defmodule Plausible.Workers.SpikeNotifier do + use Plausible.Repo + alias Plausible.Stats.Query + use Oban.Worker, queue: :spike_notifications + @at_most_every "12 hours" + + @impl Oban.Worker + def perform(_args, _job, clickhouse \\ Plausible.Stats.Clickhouse) do + notifications = Repo.all( + from sn in Plausible.Site.SpikeNotification, + where: is_nil(sn.last_sent), + or_where: sn.last_sent < fragment("now() - INTERVAL ?", @at_most_every) + ) + + for notification <- notifications do + notification = Repo.preload(notification, :site) + query = Query.from(notification.site.timezone, %{"period" => "realtime"}) + current_visitors = clickhouse.current_visitors(notification.site, query) + notify(notification, current_visitors) + end + end + + def notify(notification, current_visitors) do + if current_visitors >= notification.threshold do + for recipient <- notification.recipients do + send_notification(recipient, notification.site, current_visitors) + end + end + end + + defp send_notification(recipient, site, current_visitors) do + template = PlausibleWeb.Email.spike_notification(recipient, site, current_visitors) + try do + Plausible.Mailer.send_email(template) + rescue + _ -> nil + end + end +end diff --git a/mix.exs b/mix.exs index 017c2982d..146b1a4cc 100644 --- a/mix.exs +++ b/mix.exs @@ -90,7 +90,8 @@ defmodule Plausible.MixProject do {:sshex, "2.2.1"}, {:geolix, "~> 1.0"}, {:clickhouse_ecto, git: "https://github.com/plausible/clickhouse_ecto.git"}, - {:geolix_adapter_mmdb2, "~> 0.5.0"} + {:geolix_adapter_mmdb2, "~> 0.5.0"}, + {:mix_test_watch, "~> 1.0", only: :dev} ] end diff --git a/mix.lock b/mix.lock index 90c62b087..b4a89c0b1 100644 --- a/mix.lock +++ b/mix.lock @@ -44,6 +44,7 @@ "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"}, "mime": {:hex, :mime, "1.3.1", "30ce04ab3175b6ad0bdce0035cba77bba68b813d523d1aac73d9781b4d193cf8", [:mix], [], "hexpm", "6cbe761d6a0ca5a31a0931bf4c63204bceb64538e664a8ecf784a9a6f3b875f1"}, "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"}, + "mix_test_watch": {:hex, :mix_test_watch, "1.0.2", "34900184cbbbc6b6ed616ed3a8ea9b791f9fd2088419352a6d3200525637f785", [:mix], [{:file_system, "~> 0.2.1 or ~> 0.3", [hex: :file_system, repo: "hexpm", optional: false]}], "hexpm", "47ac558d8b06f684773972c6d04fcc15590abdb97aeb7666da19fcbfdc441a07"}, "mmdb2_decoder": {:hex, :mmdb2_decoder, "3.0.0", "54828676a36e75e9a25bc9a0bb0598d4c7fcc767bf0b40674850b22e05b7b6cc", [:mix], [], "hexpm", "359dc9242915538d1dceb9f6d96c72201dca76ce62e49d22e2ed1e86f20bea8e"}, "nanoid": {:hex, :nanoid, "2.0.2", "f3f7b4bf103ab6667f22beb00b6315825ee3f30100dd2c93d534e5c02164e857", [:mix], [], "hexpm", "3095cb1fac7bbc78843a8ccd99f1af375d0da1d3ebaa8552e846b73438c0c44f"}, "oauther": {:hex, :oauther, "1.1.1", "7d8b16167bb587ecbcddd3f8792beb9ec3e7b65c1f8ebd86b8dd25318d535752", [:mix], [], "hexpm", "9374f4302045321874cccdc57eb975893643bd69c3b22bf1312dab5f06e5788e"}, diff --git a/priv/repo/migrations/20201208173543_add_spike_notifications.exs b/priv/repo/migrations/20201208173543_add_spike_notifications.exs new file mode 100644 index 000000000..a5386470e --- /dev/null +++ b/priv/repo/migrations/20201208173543_add_spike_notifications.exs @@ -0,0 +1,14 @@ +defmodule Plausible.Repo.Migrations.AddSpikeNotifications do + use Ecto.Migration + + def change do + create table(:spike_notifications) do + add :site_id, references(:sites), null: false + add :threshold, :integer, null: false + add :last_sent, :naive_datetime + add :recipients, {:array, :citext}, null: false, default: [] + + timestamps() + end + end +end diff --git a/test/support/factory.ex b/test/support/factory.ex index ec7cde25f..c0a341157 100644 --- a/test/support/factory.ex +++ b/test/support/factory.ex @@ -20,6 +20,10 @@ defmodule Plausible.Factory do merge_attributes(user, attrs) end + def spike_notification_factory do + %Plausible.Site.SpikeNotification{} + end + def site_factory do domain = sequence(:domain, &"example-#{&1}.com") diff --git a/test/workers/spike_notifier_test.exs b/test/workers/spike_notifier_test.exs new file mode 100644 index 000000000..fb673cb62 --- /dev/null +++ b/test/workers/spike_notifier_test.exs @@ -0,0 +1,44 @@ +defmodule Plausible.Workers.SpikeNotifierTest do + use Plausible.DataCase + use Bamboo.Test + import Double + alias Plausible.Workers.SpikeNotifier + + test "does not notify anyone if current visitors does not exceed notification threshold" do + site = insert(:site) + insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"]) + + clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 5 end) + SpikeNotifier.perform(nil, nil, clickhouse_stub) + + assert_no_emails_delivered() + end + + test "notifies all recipients when traffic is higher than configured threshold" do + site = insert(:site) + insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"]) + + clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 10 end) + SpikeNotifier.perform(nil, nil, clickhouse_stub) + + assert_email_delivered_with( + subject: "Traffic spike on #{site.domain}", + to: [nil: "jerod@example.com"] + ) + + assert_email_delivered_with( + subject: "Traffic spike on #{site.domain}", + to: [nil: "uku@example.com"] + ) + end + + test "does not notify anyone if a notification already went out in the last 12 hours" do + site = insert(:site) + insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"], last_sent: Timex.now()) + + clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 10 end) + SpikeNotifier.perform(nil, nil, clickhouse_stub) + + assert_no_emails_delivered() + end +end From 11c9bdc328b96243f7a474389dcc895befa455a2 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Wed, 9 Dec 2020 11:16:16 +0200 Subject: [PATCH 2/9] Make sure a notification is not sent again within 12 hours --- lib/plausible/site/spike_notification.ex | 5 +++++ lib/workers/spike_notifier.ex | 10 +++++++--- test/workers/spike_notifier_test.exs | 11 +++++++++-- 3 files changed, 21 insertions(+), 5 deletions(-) diff --git a/lib/plausible/site/spike_notification.ex b/lib/plausible/site/spike_notification.ex index 9cca56cdd..30a0a4371 100644 --- a/lib/plausible/site/spike_notification.ex +++ b/lib/plausible/site/spike_notification.ex @@ -18,6 +18,11 @@ defmodule Plausible.Site.SpikeNotification do |> unique_constraint(:site) end + def was_sent(schema) do + schema + |> change(last_sent: NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)) + end + def add_recipient(report, recipient) do report |> change(recipients: report.recipients ++ [recipient]) diff --git a/lib/workers/spike_notifier.ex b/lib/workers/spike_notifier.ex index 1faa9060e..086523288 100644 --- a/lib/workers/spike_notifier.ex +++ b/lib/workers/spike_notifier.ex @@ -1,19 +1,20 @@ defmodule Plausible.Workers.SpikeNotifier do use Plausible.Repo alias Plausible.Stats.Query + alias Plausible.Site.SpikeNotification use Oban.Worker, queue: :spike_notifications @at_most_every "12 hours" @impl Oban.Worker def perform(_args, _job, clickhouse \\ Plausible.Stats.Clickhouse) do notifications = Repo.all( - from sn in Plausible.Site.SpikeNotification, + from sn in SpikeNotification, where: is_nil(sn.last_sent), - or_where: sn.last_sent < fragment("now() - INTERVAL ?", @at_most_every) + or_where: sn.last_sent < fragment("now() - INTERVAL ?", @at_most_every), + preload: :site ) for notification <- notifications do - notification = Repo.preload(notification, :site) query = Query.from(notification.site.timezone, %{"period" => "realtime"}) current_visitors = clickhouse.current_visitors(notification.site, query) notify(notification, current_visitors) @@ -25,6 +26,9 @@ defmodule Plausible.Workers.SpikeNotifier do for recipient <- notification.recipients do send_notification(recipient, notification.site, current_visitors) end + notification + |> SpikeNotification.was_sent() + |> Repo.update end end diff --git a/test/workers/spike_notifier_test.exs b/test/workers/spike_notifier_test.exs index fb673cb62..7ee78fb60 100644 --- a/test/workers/spike_notifier_test.exs +++ b/test/workers/spike_notifier_test.exs @@ -34,9 +34,16 @@ defmodule Plausible.Workers.SpikeNotifierTest do test "does not notify anyone if a notification already went out in the last 12 hours" do site = insert(:site) - insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"], last_sent: Timex.now()) - + insert(:spike_notification, site: site, threshold: 10, recipients: ["uku@example.com"]) clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 10 end) + + SpikeNotifier.perform(nil, nil, clickhouse_stub) + + assert_email_delivered_with( + subject: "Traffic spike on #{site.domain}", + to: [nil: "uku@example.com"] + ) + SpikeNotifier.perform(nil, nil, clickhouse_stub) assert_no_emails_delivered() From f9a7e0d374cd28e6092e753ea10f77cb5d71afa0 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Wed, 9 Dec 2020 11:17:22 +0200 Subject: [PATCH 3/9] Remove unused schema functions --- lib/plausible/site/spike_notification.ex | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/lib/plausible/site/spike_notification.ex b/lib/plausible/site/spike_notification.ex index 30a0a4371..8d966cece 100644 --- a/lib/plausible/site/spike_notification.ex +++ b/lib/plausible/site/spike_notification.ex @@ -11,25 +11,8 @@ defmodule Plausible.Site.SpikeNotification do timestamps() end - def changeset(settings, attrs \\ %{}) do - settings - |> cast(attrs, [:site_id, :recipients]) - |> validate_required([:site_id, :recipients]) - |> unique_constraint(:site) - end - def was_sent(schema) do schema |> change(last_sent: NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)) end - - def add_recipient(report, recipient) do - report - |> change(recipients: report.recipients ++ [recipient]) - end - - def remove_recipient(report, recipient) do - report - |> change(recipients: List.delete(report.recipients, recipient)) - end end From f35ef2e0b1d17b1e2946a4f3b53654c11426bdc8 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Wed, 9 Dec 2020 15:59:41 +0200 Subject: [PATCH 4/9] Add settings UI for spike notifications --- lib/plausible/site/spike_notification.ex | 17 ++++ .../controllers/site_controller.ex | 64 +++++++++++++++ lib/plausible_web/router.ex | 11 +++ .../site/settings_email_reports.html.eex | 80 +++++++++++++++++++ .../controllers/site_controller_test.exs | 61 ++++++++++++++ test/support/factory.ex | 4 +- 6 files changed, 236 insertions(+), 1 deletion(-) diff --git a/lib/plausible/site/spike_notification.ex b/lib/plausible/site/spike_notification.ex index 8d966cece..b1de93e23 100644 --- a/lib/plausible/site/spike_notification.ex +++ b/lib/plausible/site/spike_notification.ex @@ -11,6 +11,23 @@ defmodule Plausible.Site.SpikeNotification do timestamps() end + def changeset(schema, attrs) do + schema + |> cast(attrs, [:site_id, :recipients, :threshold]) + |> validate_required([:site_id, :recipients, :threshold]) + |> unique_constraint(:site) + end + + def add_recipient(schema, recipient) do + schema + |> change(recipients: schema.recipients ++ [recipient]) + end + + def remove_recipient(schema, recipient) do + schema + |> change(recipients: List.delete(schema.recipients, recipient)) + end + def was_sent(schema) do schema |> change(last_sent: NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)) diff --git a/lib/plausible_web/controllers/site_controller.ex b/lib/plausible_web/controllers/site_controller.ex index 88ddd3846..6d973450c 100644 --- a/lib/plausible_web/controllers/site_controller.ex +++ b/lib/plausible_web/controllers/site_controller.ex @@ -164,6 +164,7 @@ defmodule PlausibleWeb.SiteController do site: site, weekly_report: Repo.get_by(Plausible.Site.WeeklyReport, site_id: site.id), monthly_report: Repo.get_by(Plausible.Site.MonthlyReport, site_id: site.id), + spike_notification: Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id), layout: {PlausibleWeb.LayoutView, "site_settings.html"} ) end @@ -382,6 +383,69 @@ defmodule PlausibleWeb.SiteController do |> redirect(to: "/#{URI.encode_www_form(site.domain)}/settings/email-reports") end + def enable_spike_notification(conn, %{"website" => website}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + + Plausible.Site.SpikeNotification.changeset(%Plausible.Site.SpikeNotification{}, %{ + site_id: site.id, + threshold: 10, + recipients: [conn.assigns[:current_user].email] + }) + |> Repo.insert!() + + conn + |> put_flash(:success, "You will a notification with traffic spikes going forward") + |> redirect(to: "/#{URI.encode_www_form(site.domain)}/settings/email-reports") + end + + def disable_spike_notification(conn, %{"website" => website}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + Repo.delete_all(from mr in Plausible.Site.SpikeNotification, where: mr.site_id == ^site.id) + + conn + |> put_flash(:success, "Spike notification disabled") + |> redirect(to: "/#{URI.encode_www_form(site.domain)}/settings/email-reports") + end + + def update_spike_notification(conn, %{"website" => website, "spike_notification" => params}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + notification = Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + + Plausible.Site.SpikeNotification.changeset(notification, params) + |> Repo.update!() + + conn + |> put_flash(:success, "Notification settings updated") + |> redirect(to: "/#{URI.encode_www_form(site.domain)}/settings/email-reports") + end + + def add_spike_notification_recipient(conn, %{"website" => website, "recipient" => recipient}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + + Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + |> Plausible.Site.SpikeNotification.add_recipient(recipient) + |> Repo.update!() + + conn + |> put_flash(:success, "Added #{recipient} as a recipient for the traffic spike notification") + |> redirect(to: "/#{URI.encode_www_form(site.domain)}/settings/email-reports") + end + + def remove_spike_notification_recipient(conn, %{"website" => website, "recipient" => recipient}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + + Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + |> Plausible.Site.SpikeNotification.remove_recipient(recipient) + |> Repo.update!() + + conn + |> put_flash( + :success, + "Removed #{recipient} as a recipient for the monthly report" + ) + |> redirect(to: "/#{URI.encode_www_form(site.domain)}/settings/email-reports") + end + def new_shared_link(conn, %{"website" => website}) do site = Sites.get_for_user!(conn.assigns[:current_user].id, website) changeset = Plausible.Site.SharedLink.changeset(%Plausible.Site.SharedLink{}, %{}) diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex index ffe9f431e..a74765b88 100644 --- a/lib/plausible_web/router.ex +++ b/lib/plausible_web/router.ex @@ -130,6 +130,17 @@ defmodule PlausibleWeb.Router do SiteController, :remove_monthly_report_recipient + post "/sites/:website/spike-notification/enable", SiteController, :enable_spike_notification + post "/sites/:website/spike-notification/disable", SiteController, :disable_spike_notification + put "/sites/:website/spike-notification", SiteController, :update_spike_notification + post "/sites/:website/spike-notification/recipients", + SiteController, + :add_spike_notification_recipient + + delete "/sites/:website/spike-notification/recipients/:recipient", + SiteController, + :remove_spike_notification_recipient + get "/sites/:website/shared-links/new", SiteController, :new_shared_link post "/sites/:website/shared-links", SiteController, :create_shared_link delete "/sites/:website/shared-links/:slug", SiteController, :delete_shared_link diff --git a/lib/plausible_web/templates/site/settings_email_reports.html.eex b/lib/plausible_web/templates/site/settings_email_reports.html.eex index cab8d809f..b95e00f67 100644 --- a/lib/plausible_web/templates/site/settings_email_reports.html.eex +++ b/lib/plausible_web/templates/site/settings_email_reports.html.eex @@ -109,3 +109,83 @@ <% end %> + +
+
+

Traffic spike notifications

+

Get notified when your site has unusually high number of current visitors

+ <%= link(to: "https://docs.plausible.io/email-reports/", target: "_blank") do %> + + <% end %> +
+ +
+ <%= if @spike_notification do %> + <%= button(to: "/sites/#{URI.encode_www_form(@site.domain)}/spike-notification/disable", method: :post, class: "bg-indigo-600 relative inline-flex flex-shrink-0 h-6 w-11 border-2 border-transparent rounded-full cursor-pointer transition-colors ease-in-out duration-200 focus:outline-none focus:ring") do %> + + <% end %> + <% else %> + <%= button(to: "/sites/#{URI.encode_www_form(@site.domain)}/spike-notification/enable", method: :post, class: "bg-gray-200 relative inline-flex flex-shrink-0 h-6 w-11 border-2 border-transparent rounded-full cursor-pointer transition-colors ease-in-out duration-200 focus:outline-none focus:ring") do %> + + <% end %> + <% end %> + Send notifications of traffic spikes +
+ + <%= if @spike_notification do %> +
+ + <%= form_for Plausible.Site.SpikeNotification.changeset(@spike_notification, %{}), "/sites/#{URI.encode_www_form(@site.domain)}/spike-notification", fn f -> %> +

Current visitor threshold

+
+
+
+ + +
+ <%= number_input f, :threshold, class: "focus:ring-indigo-500 focus:border-indigo-500 block w-full rounded-none rounded-l-md pl-10 sm:text-sm border-gray-300" %> +
+ +
+ <% end %> +

Notification recipients

+ <%= for recipient <- @spike_notification.recipients do %> +
+ + <%= recipient %> + + <%= button(to: "/sites/#{URI.encode_www_form(@site.domain)}/spike-notification/recipients/#{recipient}", method: :delete) do %> + + <% end %> +
+ <% end %> + <%= form_for @conn, "/sites/#{URI.encode_www_form(@site.domain)}/spike-notification/recipients", fn f -> %> +
+
+
+
+ +
+ <%= email_input f, :recipient, class: "focus:ring-indigo-500 focus:border-indigo-500 block w-full rounded-none rounded-l-md pl-10 sm:text-sm border-gray-300", placeholder: "recipient@example.com" %> +
+ + <%= submit class: "-ml-px relative button rounded-l-none" do %> + + Add recipient + <% end %> +
+
+ <% end %> +
+ <% end %> +
diff --git a/test/plausible_web/controllers/site_controller_test.exs b/test/plausible_web/controllers/site_controller_test.exs index 003eca460..879f64a3d 100644 --- a/test/plausible_web/controllers/site_controller_test.exs +++ b/test/plausible_web/controllers/site_controller_test.exs @@ -367,6 +367,67 @@ defmodule PlausibleWeb.SiteControllerTest do end end + describe "POST /sites/:website/spike-notification/enable" do + setup [:create_user, :log_in, :create_site] + + test "creates a spike notification record with the user email", %{conn: conn, site: site, user: user} do + post(conn, "/sites/#{site.domain}/spike-notification/enable") + + notification = Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + assert notification.recipients == [user.email] + end + end + + describe "POST /sites/:website/spike-notification/disable" do + setup [:create_user, :log_in, :create_site] + + test "deletes the spike notification record", %{conn: conn, site: site} do + insert(:spike_notification, site: site) + + post(conn, "/sites/#{site.domain}/spike-notification/disable") + + refute Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + end + end + + describe "PUT /sites/:website/spike-notification" do + setup [:create_user, :log_in, :create_site] + + test "updates spike notification threshold", %{conn: conn, site: site, user: user} do + insert(:spike_notification, site: site, threshold: 10) + put(conn, "/sites/#{site.domain}/spike-notification", %{"spike_notification" => %{"threshold" => "15"}}) + + notification = Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + assert notification.threshold == 15 + end + end + + describe "POST /sites/:website/spike-notification/recipients" do + setup [:create_user, :log_in, :create_site] + + test "adds a recipient to the spike notification", %{conn: conn, site: site} do + insert(:spike_notification, site: site) + + post(conn, "/sites/#{site.domain}/spike-notification/recipients", recipient: "user@email.com") + + report = Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + assert report.recipients == ["user@email.com"] + end + end + + describe "DELETE /sites/:website/spike-notification/recipients/:recipient" do + setup [:create_user, :log_in, :create_site] + + test "removes a recipient from the spike notification", %{conn: conn, site: site} do + insert(:spike_notification, site: site, recipients: ["recipient@email.com"]) + + delete(conn, "/sites/#{site.domain}/spike-notification/recipients/recipient@email.com") + + report = Repo.get_by(Plausible.Site.SpikeNotification, site_id: site.id) + assert report.recipients == [] + end + end + describe "GET /sites/:website/shared-links/new" do setup [:create_user, :log_in, :create_site] diff --git a/test/support/factory.ex b/test/support/factory.ex index c0a341157..016912a7a 100644 --- a/test/support/factory.ex +++ b/test/support/factory.ex @@ -21,7 +21,9 @@ defmodule Plausible.Factory do end def spike_notification_factory do - %Plausible.Site.SpikeNotification{} + %Plausible.Site.SpikeNotification{ + threshold: 10 + } end def site_factory do From 35e4051016e7097f4a40c624c7d8842f2aee6f0f Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Fri, 11 Dec 2020 11:50:44 +0200 Subject: [PATCH 5/9] Add more information to spike email --- lib/plausible_web/email.ex | 4 +-- .../email/spike_notification.html.eex | 26 ++++++++++++++++++- lib/workers/spike_notifier.ex | 17 ++++++++---- .../controllers/site_controller_test.exs | 2 +- test/workers/spike_notifier_test.exs | 3 +++ 5 files changed, 43 insertions(+), 9 deletions(-) diff --git a/lib/plausible_web/email.ex b/lib/plausible_web/email.ex index 490d99658..6e0fe6c12 100644 --- a/lib/plausible_web/email.ex +++ b/lib/plausible_web/email.ex @@ -93,12 +93,12 @@ defmodule PlausibleWeb.Email do |> render("weekly_report.html", Keyword.put(assigns, :site, site)) end - def spike_notification(email, site, current_visitors) do + def spike_notification(email, site, current_visitors, sources, dashboard_link) do base_email() |> to(email) |> tag("spike-notification") |> subject("Traffic spike on #{site.domain}") - |> render("spike_notification.html", %{current_visitors: current_visitors}) + |> render("spike_notification.html", %{site: site, current_visitors: current_visitors, sources: sources, link: dashboard_link}) end def cancellation_email(user) do diff --git a/lib/plausible_web/templates/email/spike_notification.html.eex b/lib/plausible_web/templates/email/spike_notification.html.eex index 906bb3a65..b8844c3ec 100644 --- a/lib/plausible_web/templates/email/spike_notification.html.eex +++ b/lib/plausible_web/templates/email/spike_notification.html.eex @@ -1 +1,25 @@ -Yours site has <%= @current_visitors %> visitors. Nice! +There are currently <%= @current_visitors %> visitors on <%= @site.domain %>. +
+
+The top 3 sources for current visitors:
+ + + + +
+ + <%= for %{"name" => source, "count" => visitors} <- @sources do %> + + + + <% end %> +
<%= source %> + <%= visitors %>
+
+<%= if @link do %> + View dashboard: @link +<% end %> +

+-- +

+<%= plausible_url() %>
diff --git a/lib/workers/spike_notifier.ex b/lib/workers/spike_notifier.ex index 086523288..b8dd7a3ac 100644 --- a/lib/workers/spike_notifier.ex +++ b/lib/workers/spike_notifier.ex @@ -17,14 +17,15 @@ defmodule Plausible.Workers.SpikeNotifier do for notification <- notifications do query = Query.from(notification.site.timezone, %{"period" => "realtime"}) current_visitors = clickhouse.current_visitors(notification.site, query) - notify(notification, current_visitors) + sources = clickhouse.top_sources(notification.site, query, 3, 1) + notify(notification, current_visitors, sources) end end - def notify(notification, current_visitors) do + def notify(notification, current_visitors, sources) do if current_visitors >= notification.threshold do for recipient <- notification.recipients do - send_notification(recipient, notification.site, current_visitors) + send_notification(recipient, notification.site, current_visitors, sources) end notification |> SpikeNotification.was_sent() @@ -32,8 +33,14 @@ defmodule Plausible.Workers.SpikeNotifier do end end - defp send_notification(recipient, site, current_visitors) do - template = PlausibleWeb.Email.spike_notification(recipient, site, current_visitors) + defp send_notification(recipient, site, current_visitors, sources) do + site = Repo.preload(site, :members) + + dashboard_link = if Enum.member?(site.members, recipient) do + PlausibleWeb.Endpoint.url() <> "/" <> URI.encode_www_form(site.domain) + end + + template = PlausibleWeb.Email.spike_notification(recipient, site, current_visitors, sources, dashboard_link) try do Plausible.Mailer.send_email(template) rescue diff --git a/test/plausible_web/controllers/site_controller_test.exs b/test/plausible_web/controllers/site_controller_test.exs index 879f64a3d..6a1c52b75 100644 --- a/test/plausible_web/controllers/site_controller_test.exs +++ b/test/plausible_web/controllers/site_controller_test.exs @@ -393,7 +393,7 @@ defmodule PlausibleWeb.SiteControllerTest do describe "PUT /sites/:website/spike-notification" do setup [:create_user, :log_in, :create_site] - test "updates spike notification threshold", %{conn: conn, site: site, user: user} do + test "updates spike notification threshold", %{conn: conn, site: site} do insert(:spike_notification, site: site, threshold: 10) put(conn, "/sites/#{site.domain}/spike-notification", %{"spike_notification" => %{"threshold" => "15"}}) diff --git a/test/workers/spike_notifier_test.exs b/test/workers/spike_notifier_test.exs index 7ee78fb60..214a77ace 100644 --- a/test/workers/spike_notifier_test.exs +++ b/test/workers/spike_notifier_test.exs @@ -9,6 +9,7 @@ defmodule Plausible.Workers.SpikeNotifierTest do insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"]) clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 5 end) + |> stub(:top_sources, fn _site, _query, _limit, _page -> [] end) SpikeNotifier.perform(nil, nil, clickhouse_stub) assert_no_emails_delivered() @@ -19,6 +20,7 @@ defmodule Plausible.Workers.SpikeNotifierTest do insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"]) clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 10 end) + |> stub(:top_sources, fn _site, _query, _limit, _page -> [] end) SpikeNotifier.perform(nil, nil, clickhouse_stub) assert_email_delivered_with( @@ -36,6 +38,7 @@ defmodule Plausible.Workers.SpikeNotifierTest do site = insert(:site) insert(:spike_notification, site: site, threshold: 10, recipients: ["uku@example.com"]) clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 10 end) + |> stub(:top_sources, fn _site, _query, _limit, _page -> [] end) SpikeNotifier.perform(nil, nil, clickhouse_stub) From 49c3fa56505e50d6b8b5c1ce8b983962083fd68d Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Fri, 11 Dec 2020 13:58:58 +0200 Subject: [PATCH 6/9] Improve email styling --- .../email/spike_notification.html.eex | 35 +++++++++++-------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/lib/plausible_web/templates/email/spike_notification.html.eex b/lib/plausible_web/templates/email/spike_notification.html.eex index b8844c3ec..901a913a3 100644 --- a/lib/plausible_web/templates/email/spike_notification.html.eex +++ b/lib/plausible_web/templates/email/spike_notification.html.eex @@ -1,23 +1,28 @@ -There are currently <%= @current_visitors %> visitors on <%= @site.domain %>. +There are currently <%= @current_visitors %> visitors on <%= link(@site.domain, to: "https://" <> @site.domain) %>.

The top 3 sources for current visitors:
- - - - + +
- - <%= for %{"name" => source, "count" => visitors} <- @sources do %> - - - - <% end %> -
<%= source %> - <%= visitors %>
-
+ + + + + + + + <%= for %{"name" => source, "count" => visitors} <- @sources do %> + + + + + <% end %> +
PageVisitors
<%= source %><%= visitors %>
+ <%= if @link do %> - View dashboard: @link +

+View dashboard: @link <% end %>

-- From 7f9525e805a6a8100b7847bbf996fa1437660326 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Fri, 11 Dec 2020 14:28:31 +0200 Subject: [PATCH 7/9] Only send sources when there are sources to send --- .../email/spike_notification.html.eex | 32 ++++++++++--------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/lib/plausible_web/templates/email/spike_notification.html.eex b/lib/plausible_web/templates/email/spike_notification.html.eex index 901a913a3..6d27a9ed6 100644 --- a/lib/plausible_web/templates/email/spike_notification.html.eex +++ b/lib/plausible_web/templates/email/spike_notification.html.eex @@ -1,24 +1,26 @@ There are currently <%= @current_visitors %> visitors on <%= link(@site.domain, to: "https://" <> @site.domain) %>.

-The top 3 sources for current visitors:
+<%= if Enum.count(@sources) > 0 do %> + The top 3 sources for current visitors:
- - - - - - - - - <%= for %{"name" => source, "count" => visitors} <- @sources do %> +
PageVisitors
+ - - + + - <% end %> - -
<%= source %><%= visitors %>PageVisitors
+ + + <%= for %{"name" => source, "count" => visitors} <- @sources do %> + + <%= source %> + <%= visitors %> + + <% end %> + + +<% end %> <%= if @link do %>

From acce144809f71409d2d46270329d5ddc101e2526 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Fri, 11 Dec 2020 17:01:09 +0200 Subject: [PATCH 8/9] Show noref in notification email --- .../email/spike_notification.html.eex | 24 ++++--------------- lib/workers/spike_notifier.ex | 2 +- test/workers/spike_notifier_test.exs | 6 ++--- 3 files changed, 9 insertions(+), 23 deletions(-) diff --git a/lib/plausible_web/templates/email/spike_notification.html.eex b/lib/plausible_web/templates/email/spike_notification.html.eex index 6d27a9ed6..2cb164fbc 100644 --- a/lib/plausible_web/templates/email/spike_notification.html.eex +++ b/lib/plausible_web/templates/email/spike_notification.html.eex @@ -1,25 +1,11 @@ There are currently <%= @current_visitors %> visitors on <%= link(@site.domain, to: "https://" <> @site.domain) %>. -
-
<%= if Enum.count(@sources) > 0 do %> +
+
The top 3 sources for current visitors:
- - - - - - - - - - <%= for %{"name" => source, "count" => visitors} <- @sources do %> - - - - - <% end %> - -
PageVisitors
<%= source %><%= visitors %>
+ <%= for %{name: source, count: visitors} <- @sources do %> + <%= source %> - <%= visitors %> visitors
+ <% end %> <% end %> <%= if @link do %> diff --git a/lib/workers/spike_notifier.ex b/lib/workers/spike_notifier.ex index b8dd7a3ac..add1af17f 100644 --- a/lib/workers/spike_notifier.ex +++ b/lib/workers/spike_notifier.ex @@ -17,7 +17,7 @@ defmodule Plausible.Workers.SpikeNotifier do for notification <- notifications do query = Query.from(notification.site.timezone, %{"period" => "realtime"}) current_visitors = clickhouse.current_visitors(notification.site, query) - sources = clickhouse.top_sources(notification.site, query, 3, 1) + sources = clickhouse.top_sources(notification.site, query, 3, 1, true) notify(notification, current_visitors, sources) end end diff --git a/test/workers/spike_notifier_test.exs b/test/workers/spike_notifier_test.exs index 214a77ace..22a2ce158 100644 --- a/test/workers/spike_notifier_test.exs +++ b/test/workers/spike_notifier_test.exs @@ -9,7 +9,7 @@ defmodule Plausible.Workers.SpikeNotifierTest do insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"]) clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 5 end) - |> stub(:top_sources, fn _site, _query, _limit, _page -> [] end) + |> stub(:top_sources, fn _site, _query, _limit, _page, _show_noref -> [] end) SpikeNotifier.perform(nil, nil, clickhouse_stub) assert_no_emails_delivered() @@ -20,7 +20,7 @@ defmodule Plausible.Workers.SpikeNotifierTest do insert(:spike_notification, site: site, threshold: 10, recipients: ["jerod@example.com", "uku@example.com"]) clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 10 end) - |> stub(:top_sources, fn _site, _query, _limit, _page -> [] end) + |> stub(:top_sources, fn _site, _query, _limit, _page, _show_noref -> [] end) SpikeNotifier.perform(nil, nil, clickhouse_stub) assert_email_delivered_with( @@ -38,7 +38,7 @@ defmodule Plausible.Workers.SpikeNotifierTest do site = insert(:site) insert(:spike_notification, site: site, threshold: 10, recipients: ["uku@example.com"]) clickhouse_stub = stub(Plausible.Stats.Clickhouse, :current_visitors, fn _site, _query -> 10 end) - |> stub(:top_sources, fn _site, _query, _limit, _page -> [] end) + |> stub(:top_sources, fn _site, _query, _limit, _page, _show_noref -> [] end) SpikeNotifier.perform(nil, nil, clickhouse_stub) From b8ab1812895b74af1cc4abb2ce8de1b328b7f1e9 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Fri, 11 Dec 2020 17:02:02 +0200 Subject: [PATCH 9/9] Add changelog entry --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6aa7dd21f..c6dd52468 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file. - Add tracker module to automatically track outbound links plausible/analytics#389 - Display weekday on the visitor graph plausible/analytics#175 - Collect and display browser & OS versions plausible/analytics#397 +- Simple notifications around traffic spikes plausible/analytics#453 ### Changed - Use alpine as base image to decrease Docker image size plausible/analytics#353