From f3dd5d696e6f32a1bb549793f5329cbf481da67a Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Thu, 5 Sep 2019 17:11:07 +0100 Subject: [PATCH] Add weekly email report template --- lib/mix/tasks/send_email_reports.ex | 68 ++ lib/plausible_web/email.ex | 9 + .../templates/email/weekly_report.html.eex | 666 ++++++++++++++++++ .../20190906111810_add_email_reporting.exs | 19 + 4 files changed, 762 insertions(+) create mode 100644 lib/mix/tasks/send_email_reports.ex create mode 100644 lib/plausible_web/templates/email/weekly_report.html.eex create mode 100644 priv/repo/migrations/20190906111810_add_email_reporting.exs diff --git a/lib/mix/tasks/send_email_reports.ex b/lib/mix/tasks/send_email_reports.ex new file mode 100644 index 000000000..caf96fa78 --- /dev/null +++ b/lib/mix/tasks/send_email_reports.ex @@ -0,0 +1,68 @@ +defmodule Mix.Tasks.SendEmailReports do + use Mix.Task + use Plausible.Repo + require Logger + + def run(args) do + Application.ensure_all_started(:plausible) + execute(args) + end + + @doc""" + The email report should be sent on Monday at 9am according to the timezone + of the site. This job runs every hour to be able to send it with hourly precision. + """ + def execute(args \\ []) do + sites = Repo.all( + from s in Plausible.Site, + join: es in "email_settings", on: es.site_id == s.id, + left_join: se in "sent_email_reports", on: se.site_id == s.id and se.year == fragment("EXTRACT(year from (now() at time zone ?))", s.timezone) and se.week == fragment("EXTRACT(week from (now() at time zone ?))", s.timezone), + where: is_nil(se), # We haven't sent a report for this site on this week + where: fragment("EXTRACT(dow from (now() at time zone ?))", s.timezone) == 1, # It's monday in the local timezone + where: fragment("EXTRACT(hour from (now() at time zone ?))", s.timezone) >= 9, # It's after 9am + select: s, + preload: :members + ) + + for site <- sites do + [owner] = site.members + IO.puts("Sending email report for #{site.domain} to #{owner.email}") + send_report(owner.email, site) + end + end + + defp send_report(email, site) do + query = Plausible.Stats.Query.from(site.timezone, %{"period" => "7d"}) + {pageviews, unique_visitors} = Plausible.Stats.pageviews_and_visitors(site, query) + {change_pageviews, change_visitors} = Plausible.Stats.compare_pageviews_and_visitors(site, query, {pageviews, unique_visitors}) + referrers = Plausible.Stats.top_referrers(site, query) + pages = Plausible.Stats.top_pages(site, query) + settings_link = PlausibleWeb.Endpoint.url() <> "/#{site.domain}/settings#email-reports" + view_link = PlausibleWeb.Endpoint.url() <> "/#{site.domain}?period=7d" + + PlausibleWeb.Email.weekly_report(email, site, + unique_visitors: unique_visitors, + change_visitors: change_visitors, + pageviews: pageviews, + change_pageviews: change_pageviews, + referrers: referrers, + settings_link: settings_link, + view_link: view_link, + pages: pages, + query: query + ) |> Plausible.Mailer.deliver_now() + + email_report_sent(site) + end + + defp email_report_sent(site) do + {year, week} = Timex.now(site.timezone) |> DateTime.to_date |> Timex.iso_week + + Repo.insert_all("sent_email_reports", [%{ + site_id: site.id, + year: year, + week: week, + timestamp: Timex.now() + }]) + end +end diff --git a/lib/plausible_web/email.ex b/lib/plausible_web/email.ex index 87a30bd40..742c8016b 100644 --- a/lib/plausible_web/email.ex +++ b/lib/plausible_web/email.ex @@ -87,4 +87,13 @@ defmodule PlausibleWeb.Email do |> subject("New feedback submission") |> text_body(text) end + + def weekly_report(email, site, assigns) do + new_email() + |> to(email) + |> from("Uku Taht ") + |> tag("weekly-report") + |> subject("Weekly report for #{site.domain}") + |> render("weekly_report.html", Keyword.put(assigns, :site, site)) + end end diff --git a/lib/plausible_web/templates/email/weekly_report.html.eex b/lib/plausible_web/templates/email/weekly_report.html.eex new file mode 100644 index 000000000..fa745b99f --- /dev/null +++ b/lib/plausible_web/templates/email/weekly_report.html.eex @@ -0,0 +1,666 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/priv/repo/migrations/20190906111810_add_email_reporting.exs b/priv/repo/migrations/20190906111810_add_email_reporting.exs new file mode 100644 index 000000000..abfcd3bf5 --- /dev/null +++ b/priv/repo/migrations/20190906111810_add_email_reporting.exs @@ -0,0 +1,19 @@ +defmodule Plausible.Repo.Migrations.AddEmailReporting do + use Ecto.Migration + + def change do + create table(:email_settings) do + add :site_id, references(:sites, on_delete: :delete_all), null: false + + timestamps() + end + + create table(:sent_email_reports) do + add :site_id, references(:sites, on_delete: :delete_all), null: false + add :year, :integer + add :week, :integer + + add :timestamp, :naive_datetime + end + end +end