Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix weekly/monthly report e-mails (MJML) #3150

Merged
merged 3 commits into from
Jul 17, 2023
Merged

Fix weekly/monthly report e-mails (MJML) #3150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f469c1
Render weekly/monthly reports with MJML
aerosol Jul 17, 2023
8e567bd
Update changelog
aerosol Jul 17, 2023
e1769d3
Fix APP-2NA (#3119)
aerosol Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file.

## Unreleased

### Fixed
- Fixed weekly/monthly e-mail report [rendering issues](https://github.com/plausible/analytics/issues/284)

## v2.0.0 - 2023-07-12

### Added
Expand Down
4 changes: 3 additions & 1 deletion lib/plausible_web/email.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,13 @@ defmodule PlausibleWeb.Email do
end

def weekly_report(email, site, assigns) do
assigns = Keyword.put(assigns, :site, site)

base_email(%{layout: nil})
|> to(email)
|> tag("weekly-report")
|> subject("#{assigns[:name]} report for #{site.domain}")
|> render("weekly_report.html", Keyword.put(assigns, :site, site))
|> html_body(PlausibleWeb.MJML.WeeklyReport.render(assigns))
end

def spike_notification(email, site, current_visitors, sources, dashboard_link) do
Expand Down
181 changes: 181 additions & 0 deletions lib/plausible_web/mjml/templates/weekly_report.mjml.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
<mjml>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From 697 lines of code to 181. Looking good! 🙌

<mj-head>
<mj-attributes>
<mj-text color="#3d4852" font-family="'Helvetica Neue', Helvetica, Arial, sans-serif" font-size="14px" />
<mj-button background-color="#4338ca" font-family="'Helvetica Neue', Helvetica, Arial, sans-serif" color="#ffffff" font-size="14px" />
<mj-class name="text-lg" font-size="24px" font-weight="bold" />
<mj-class name="text-sm" font-size="14px" font-weight="normal" />
<mj-class name="text-label" font-size="14px" font-weight="bold" color="#666666" />
<mj-class name="trend-good" font-size="14px" font-weight="bold" color="#15803d" />
<mj-class name="trend-bad" font-size="14px" font-weight="bold" color="#b91c1c" />
<mj-column vertical-align="middle" />
<mj-divider border-width="1px" border-color="#aaaaaa" />
</mj-attributes>
</mj-head>
<mj-body>
<mj-section padding="25px 0 0 0">
<mj-column>
<mj-text mj-class="text-sm" height="40px">
Plausible Analytics
</mj-text>
<mj-text mj-class="text-lg">
<%= @site.domain %>
</mj-text>
<mj-text mj-class="text-sm" padding="0 25px 0 25px">
<%= @name %> Report (<%= Timex.format!(@query.date_range.last, "{D} {Mshort} {YYYY}") %>)
</mj-text>
</mj-column>
</mj-section>

<mj-section>
<mj-column>
<mj-divider />
</mj-column>
</mj-section>

<mj-section padding="0">
<mj-column>
<mj-text mj-class="text-label">UNIQUE VISITORS</mj-text>
<mj-text mj-class="text-lg" css-class="visitors">
<%= PlausibleWeb.StatsView.large_number_format(@unique_visitors) %>
</mj-text>
<%= cond do %>
<% @change_visitors == nil -> %>
<mj-text mj-class="text-sm">N/A</mj-text>
<% @change_visitors >= 0 -> %>
<mj-text mj-class="text-sm trend-good">
+<%= @change_visitors %>%
</mj-text>
<% @change_visitors < 0 -> %>
<mj-text mj-class="text-sm trend-bad">
<%= @change_visitors %>%
</mj-text>
<% end %>
<mj-spacer height="30px" />
</mj-column>
<mj-column>
<mj-text mj-class="text-label">PAGEVIEWS</mj-text>
<mj-text mj-class="text-lg" css-class="pageviews">
<%= PlausibleWeb.StatsView.large_number_format(@pageviews) %>
</mj-text>
<%= cond do %>
<% is_nil(@change_pageviews) -> %>
<mj-text mj-class="text-sm">N/A</mj-text>
<% @change_pageviews >= 0 -> %>
<mj-text mj-class="text-sm trend-good">
+<%= @change_pageviews %>%
</mj-text>
<% @change_pageviews < 0 -> %>
<mj-text mj-class="text-sm trend-bad">
<%= @change_pageviews %>%
</mj-text>
<% end %>
<mj-spacer height="30px" />
</mj-column>

<mj-column>
<mj-text mj-class="text-label">BOUNCE RATE</mj-text>
<mj-text mj-class="text-lg">
<%= @bounce_rate %>
</mj-text>

<%= cond do %>
<% @change_bounce_rate == nil -> %>
<mj-text mj-class="text-sm">N/A</mj-text>
<% @change_bounce_rate <= 0 -> %>
<mj-text mj-class="text-sm trend-good">
<%= @change_bounce_rate %>%
</mj-text>
<% @change_bounce_rate > 0 -> %>
<mj-text mj-class="text-sm trend-bad">
+<%= @change_bounce_rate %>%
</mj-text>
<% end %>
<mj-spacer height="30px" />
</mj-column>
</mj-section>

<mj-section padding="0">
<mj-column>
<mj-divider />
</mj-column>
</mj-section>

<mj-section>
<mj-group>
<mj-column>
<mj-text font-weight="bold">Referrer</mj-text>

<%= for source <- @sources do %>
<mj-text css-class="referrer-name">
<%= source[:source] %>
</mj-text>
<% end %>
</mj-column>
<mj-column>
<mj-text font-weight="bold" align="right">Visitors</mj-text>

<%= for source <- @sources do %>
<mj-text align="right" css-class="referrer-count">
<%= PlausibleWeb.StatsView.large_number_format(source[:visitors]) %>
</mj-text>
<% end %>
</mj-column>
</mj-group>
</mj-section>

<mj-section padding="0">
<mj-column>
<mj-divider />
</mj-column>
</mj-section>

<mj-section>
<mj-group>
<mj-column>
<mj-text font-weight="bold">
Page
</mj-text>

<%= for page <- @pages do %>
<mj-text css-class="page-name">
<%= page[:page] %>
</mj-text>
<% end %>
</mj-column>
<mj-column>
<mj-text font-weight="bold" align="right">
Visitors
</mj-text>

<%= for page <- @pages do %>
<mj-text align="right" css-class="page-count">
<%= PlausibleWeb.StatsView.large_number_format(page[:visitors]) %>
</mj-text>
<% end %>
</mj-column>
</mj-group>
</mj-section>

<%= if @login_link do %>
<mj-section>
<mj-column>
<mj-button href="<%= PlausibleWeb.Router.Helpers.auth_url(PlausibleWeb.Endpoint, :login_form) %>">Login to view your dashboard</mj-button>
</mj-column>
</mj-section>
<% end %>

<mj-section>
<mj-column>
<mj-divider />
</mj-column>
</mj-section>
<mj-section padding="0">
<mj-column>
<mj-text mj-class="text-sm" padding="0 25px 25px 25px">
Don't want to receive these e-mails? <a href="<%= @unsubscribe_link %>">Click here</a> to unsusbscribe.
</mj-text>
</mj-column>
</mj-section>
</mj-body>
</mjml>
7 changes: 7 additions & 0 deletions lib/plausible_web/mjml/weekly_report.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
defmodule PlausibleWeb.MJML.WeeklyReport do
@moduledoc """
MJML rendered for the weekly report e-mail
"""

use MjmlEEx, mjml_template: "templates/weekly_report.mjml.eex"
end
Loading