From c7ed0d54ce670aaef337982decad3be850b786fc Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Thu, 31 Oct 2019 13:39:51 +0800 Subject: [PATCH 1/6] Add goals and conversions --- assets/js/app.js | 19 +++++++ assets/js/p.js | 9 +-- assets/js/plausible.js | 2 +- assets/js/stats/index.js | 9 +++ lib/plausible/goal/schema.ex | 35 ++++++++++++ lib/plausible/goals.ex | 38 +++++++++++++ lib/plausible/sites.ex | 7 +++ lib/plausible/stats/stats.ex | 35 ++++++++++++ .../controllers/site_controller.ex | 57 ++++++++++++++++++- .../controllers/stats_controller.ex | 16 ++++++ lib/plausible_web/router.ex | 5 ++ .../templates/auth/register_form.html.eex | 2 +- .../templates/layout/_tracking.html.eex | 4 +- .../templates/layout/focus.html.eex | 2 + .../templates/site/goal_settings.html.eex | 23 ++++++++ .../templates/site/new_goal.html.eex | 37 ++++++++++++ .../stats/conversions_preview.html.eex | 27 +++++++++ .../templates/stats/stats.html.eex | 15 +++-- .../migrations/20191031051340_add_goals.exs | 16 ++++++ .../controllers/site_controller_test.exs | 32 +++++++++++ 20 files changed, 377 insertions(+), 13 deletions(-) create mode 100644 lib/plausible/goal/schema.ex create mode 100644 lib/plausible/goals.ex create mode 100644 lib/plausible_web/templates/site/goal_settings.html.eex create mode 100644 lib/plausible_web/templates/site/new_goal.html.eex create mode 100644 lib/plausible_web/templates/stats/conversions_preview.html.eex create mode 100644 priv/repo/migrations/20191031051340_add_goals.exs diff --git a/assets/js/app.js b/assets/js/app.js index 4d53e4903..43f0918c2 100644 --- a/assets/js/app.js +++ b/assets/js/app.js @@ -31,3 +31,22 @@ if (flash) { flash.style.display = 'none' }, 2500) } + +const registerForm = document.getElementById('register-form') + +if (registerForm) { + registerForm.addEventListener('submit', function(e) { + e.preventDefault(); + setTimeout(submitForm, 1000); + var formSubmitted = false; + + function submitForm() { + if (!formSubmitted) { + formSubmitted = true; + registerForm.submit(); + } + } + + plausible('trigger', 'Signup', {callback: submitForm}); + }) +} diff --git a/assets/js/p.js b/assets/js/p.js index 40e7fc212..15d14553a 100644 --- a/assets/js/p.js +++ b/assets/js/p.js @@ -33,7 +33,7 @@ } function ignore(reason) { - console.warn('[Plausible] Ignoring pageview because ' + reason); + console.warn('[Plausible] Ignoring event because ' + reason); } function getUrl() { @@ -77,7 +77,7 @@ })) } - function trigger(eventName) { + function trigger(eventName, options) { if (/localhost$/.test(window.location.hostname)) return ignore('website is running locally'); if (window.location.protocol === 'file:') return ignore('website is running locally'); if (window.document.visibilityState === 'prerender') return ignore('document is prerendering'); @@ -95,13 +95,14 @@ request.onreadystatechange = function() { if (request.readyState == XMLHttpRequest.DONE) { setUserData(payload) + options && options.callback && options.callback() } } } - function page() { - trigger('pageview') + function page(options) { + trigger('pageview', options) } function trackPushState() { diff --git a/assets/js/plausible.js b/assets/js/plausible.js index 95049c0da..b23a3e3d6 100644 --- a/assets/js/plausible.js +++ b/assets/js/plausible.js @@ -33,7 +33,7 @@ } function ignore(reason) { - console.warn('[Plausible] Ignoring pageview because ' + reason); + console.warn('[Plausible] Ignoring event because ' + reason); } function getUrl() { diff --git a/assets/js/stats/index.js b/assets/js/stats/index.js index b2cf07b55..743a14c23 100644 --- a/assets/js/stats/index.js +++ b/assets/js/stats/index.js @@ -124,6 +124,15 @@ if (domainEl) { document.getElementById('browsers-stats').innerHTML = res router.updateLinkHandlers() }) + + if (document.getElementById('conversion-stats')) { + fetch(`/stats/${domain}/conversions${location.search}`) + .then(res => res.text()) + .then((res) => { + document.getElementById('conversion-stats').innerHTML = res + router.updateLinkHandlers() + }) + } }) setInterval(function() { diff --git a/lib/plausible/goal/schema.ex b/lib/plausible/goal/schema.ex new file mode 100644 index 000000000..9185ff6e3 --- /dev/null +++ b/lib/plausible/goal/schema.ex @@ -0,0 +1,35 @@ +defmodule Plausible.Goal do + use Ecto.Schema + import Ecto.Changeset + + schema "goals" do + field :name, :string + field :domain, :string + field :event_name, :string + field :page_path, :string + + timestamps() + end + + def changeset(goal, attrs \\ %{}) do + goal + |> cast(attrs, [:domain, :name, :event_name, :page_path]) + |> validate_required([:domain, :name]) + |> validate_event_name_and_page_path() + end + + defp validate_event_name_and_page_path(changeset) do + if present?(changeset, :event_name) || present?(changeset, :page_path) do + changeset + else + changeset + |> add_error(:event_name, "this field is required") + |> add_error(:page_path, "this field is required") + end + end + + defp present?(changeset, field) do + value = get_field(changeset, field) + value && value != "" + end +end diff --git a/lib/plausible/goals.ex b/lib/plausible/goals.ex new file mode 100644 index 000000000..e1ebc016d --- /dev/null +++ b/lib/plausible/goals.ex @@ -0,0 +1,38 @@ +defmodule Plausible.Goals do + use Plausible.Repo + alias Plausible.Goal + + def create(site, params) do + params = Map.merge(params, %{ + "name" => name_for(params), + "domain" => site.domain + }) + + changeset = Goal.changeset(%Goal{}, params) + |> Repo.insert + end + + def for_site(domain) do + Repo.all( + from g in Goal, + where: g.domain == ^domain + ) + end + + def delete(site, goal_name) do + Repo.one( + from g in Goal, + where: g.domain == ^site.domain and g.name == ^goal_name + ) |> Repo.delete! + end + + defp name_for(%{"event_name" => name}) when name != "" do + name + end + + defp name_for(%{"page_path" => path}) when path != "" do + "Visit #{path}" + end + + defp name_for(_), do: nil +end diff --git a/lib/plausible/sites.ex b/lib/plausible/sites.ex index abbc53031..6ecf74818 100644 --- a/lib/plausible/sites.ex +++ b/lib/plausible/sites.ex @@ -18,6 +18,13 @@ defmodule Plausible.Sites do ) end + def has_goals?(site) do + Repo.exists?( + from g in Plausible.Goal, + where: g.domain == ^site.domain + ) + end + def is_owner?(user_id, site) do Repo.exists?( from sm in Plausible.Site.Membership, diff --git a/lib/plausible/stats/stats.ex b/lib/plausible/stats/stats.ex index 1a08bf84c..e9e73db31 100644 --- a/lib/plausible/stats/stats.ex +++ b/lib/plausible/stats/stats.ex @@ -181,6 +181,41 @@ defmodule Plausible.Stats do ) end + def goal_conversions(site, query, limit \\ 5) do + goals = Repo.all(from g in Plausible.Goal, where: g.domain == ^site.domain) + conversions = fetch_pageview_goals(goals, site, query) + ++ fetch_event_goals(goals, site, query) + |> sort_conversions + end + + defp fetch_event_goals(goals, site, query) do + {:ok, first} = NaiveDateTime.new(query.date_range.first, ~T[00:00:00]) + first_datetime = Timex.to_datetime(first, site.timezone) + + {:ok, last} = NaiveDateTime.new(query.date_range.last |> Timex.shift(days: 1), ~T[00:00:00]) + last_datetime = Timex.to_datetime(last, site.timezone) + + events = Enum.map(goals, fn goal -> goal.name end) + |> Enum.filter(&(&1)) + + if Enum.count(events) > 0 do + Repo.all( + from e in Plausible.Event, + where: e.hostname == ^site.domain, + where: e.timestamp >= ^first_datetime and e.timestamp < ^last_datetime, + where: e.name in ^events, + group_by: e.name, + select: {e.name, count(e.user_id, :distinct)} + ) + else + [] + end + end + + defp fetch_pageview_goals(goals, site, query), do: [] + + defp sort_conversions(conversions), do: conversions + defp base_query(site, query) do {:ok, first} = NaiveDateTime.new(query.date_range.first, ~T[00:00:00]) first_datetime = Timex.to_datetime(first, site.timezone) diff --git a/lib/plausible_web/controllers/site_controller.ex b/lib/plausible_web/controllers/site_controller.ex index abf9886b6..f5d67fcb2 100644 --- a/lib/plausible_web/controllers/site_controller.ex +++ b/lib/plausible_web/controllers/site_controller.ex @@ -1,7 +1,7 @@ defmodule PlausibleWeb.SiteController do use PlausibleWeb, :controller use Plausible.Repo - alias Plausible.Sites + alias Plausible.{Sites, Goals} plug PlausibleWeb.RequireAccountPlug @@ -33,6 +33,61 @@ defmodule PlausibleWeb.SiteController do |> render("snippet.html", site: site, layout: {PlausibleWeb.LayoutView, "focus.html"}) end + def goals(conn, %{"website" => website}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + goals = Goals.for_site(site.domain) + + conn + |> assign(:skip_plausible_tracking, true) + |> render("goal_settings.html", + site: site, + goals: goals, + layout: {PlausibleWeb.LayoutView, "focus.html"} + ) + end + + def new_goal(conn, %{"website" => website}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + changeset = Plausible.Goal.changeset(%Plausible.Goal{}) + + conn + |> assign(:skip_plausible_tracking, true) + |> render("new_goal.html", + site: site, + changeset: changeset, + layout: {PlausibleWeb.LayoutView, "focus.html"} + ) + end + + def create_goal(conn, %{"website" => website, "goal" => goal}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + + case Plausible.Goals.create(site, goal) do + {:ok, _} -> + conn + |> put_flash(:success, "Goal created succesfully") + |> redirect(to: "/#{website}/goals") + {:error, :goal, changeset, _} -> + IO.inspect(changeset) + conn + |> assign(:skip_plausible_tracking, true) + |> render("new_goal.html", + site: site, + changeset: changeset, + layout: {PlausibleWeb.LayoutView, "focus.html"} + ) + end + end + + def delete_goal(conn, %{"website" => website, "name" => goal_name}) do + site = Sites.get_for_user!(conn.assigns[:current_user].id, website) + Plausible.Goals.delete(site, goal_name) + + conn + |> put_flash(:success, "Goal deleted succesfully") + |> redirect(to: "/#{website}/goals") + end + def settings(conn, %{"website" => website}) do site = Sites.get_for_user!(conn.assigns[:current_user].id, website) |> Repo.preload(:google_auth) diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex index 139e398cc..fabda2289 100644 --- a/lib/plausible_web/controllers/stats_controller.ex +++ b/lib/plausible_web/controllers/stats_controller.ex @@ -25,12 +25,14 @@ defmodule PlausibleWeb.StatsController do {conn, params} = fetch_period(conn, site) query = Stats.Query.from(site.timezone, params) current_visitors = Stats.current_visitors(site) + has_goals = user && Plausible.Sites.has_goals?(site) conn |> assign(:skip_plausible_tracking, !demo) |> put_session(site.domain <> "_offer_email_report", nil) |> render("stats.html", site: site, + has_goals: has_goals, query: query, current_visitors: current_visitors, title: "Plausible · " <> site.domain, @@ -310,6 +312,20 @@ defmodule PlausibleWeb.StatsController do end end + def conversions_preview(conn, %{"domain" => domain}) do + site = Repo.get_by(Plausible.Site, domain: domain) + + if site && current_user_can_access?(conn, site) do + {conn, params} = fetch_period(conn, site) + query = Stats.Query.from(site.timezone, params) + goals = Stats.goal_conversions(site, query) + + render(conn, "conversions_preview.html", layout: false, query: query, site: site, goals: goals) + else + render_error(conn, 404) + end + end + defp current_user_can_access?(_conn, %Plausible.Site{public: true}) do true end diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex index 9109b2231..2d5522c0a 100644 --- a/lib/plausible_web/router.ex +++ b/lib/plausible_web/router.ex @@ -93,6 +93,10 @@ defmodule PlausibleWeb.Router do put "/sites/:website/monthly-report", SiteController, :update_monthly_settings get "/:website/snippet", SiteController, :add_snippet get "/:website/settings", SiteController, :settings + get "/:website/goals", SiteController, :goals + get "/:website/goals/new", SiteController, :new_goal + post "/:website/goals", SiteController, :create_goal + delete "/:website/goals/:name", SiteController, :delete_goal put "/:website/settings", SiteController, :update_settings put "/:website/settings/google", SiteController, :update_google_auth delete "/:website", SiteController, :delete_site @@ -103,6 +107,7 @@ defmodule PlausibleWeb.Router do get "/stats/:domain/screen-sizes", StatsController, :screen_sizes_preview get "/stats/:domain/operating-systems", StatsController, :operating_systems_preview get "/stats/:domain/browsers", StatsController, :browsers_preview + get "/stats/:domain/conversions", StatsController, :conversions_preview get "/stats/:domain/main-graph", StatsController, :main_graph get "/:website/*path", StatsController, :stats end diff --git a/lib/plausible_web/templates/auth/register_form.html.eex b/lib/plausible_web/templates/auth/register_form.html.eex index b3473835e..73b1ecc69 100644 --- a/lib/plausible_web/templates/auth/register_form.html.eex +++ b/lib/plausible_web/templates/auth/register_form.html.eex @@ -1,4 +1,4 @@ -<%= form_for @changeset, "/register", [class: "max-w-sm w-full mx-auto bg-white shadow-md rounded px-8 py-6 mb-4 mt-8"], fn f -> %> +<%= form_for @changeset, "/register", [class: "max-w-sm w-full mx-auto bg-white shadow-md rounded px-8 py-6 mb-4 mt-8", id: "register-form"], fn f -> %>

Enter your details to get started

diff --git a/lib/plausible_web/templates/layout/_tracking.html.eex b/lib/plausible_web/templates/layout/_tracking.html.eex index 2d052dbc9..3b08489c5 100644 --- a/lib/plausible_web/templates/layout/_tracking.html.eex +++ b/lib/plausible_web/templates/layout/_tracking.html.eex @@ -1,10 +1,10 @@ -<%= if Mix.env() == :prod && !@conn.assigns[:skip_plausible_tracking] do %> +<%= if !@conn.assigns[:skip_plausible_tracking] do %> \ diff --git a/lib/plausible_web/templates/layout/focus.html.eex b/lib/plausible_web/templates/layout/focus.html.eex index 3abe2e267..0053f407e 100644 --- a/lib/plausible_web/templates/layout/focus.html.eex +++ b/lib/plausible_web/templates/layout/focus.html.eex @@ -23,5 +23,7 @@

©2019 Plausible Insights. All rights reserved.

+ + diff --git a/lib/plausible_web/templates/site/goal_settings.html.eex b/lib/plausible_web/templates/site/goal_settings.html.eex new file mode 100644 index 000000000..84384c3df --- /dev/null +++ b/lib/plausible_web/templates/site/goal_settings.html.eex @@ -0,0 +1,23 @@ +<%= if get_flash(@conn, :success) do %> + +<% end %> + +
+

Goals for <%= @site.domain %>

+
+ <%= if Enum.count(@goals) > 0 do %> + <%= for goal <- @goals do %> +
+ <%= goal.name %> + <%= button("❌", to: "/#{@site.domain}/goals/#{URI.encode(goal.name, &URI.char_unreserved?/1)}", method: :delete, class: "text-sm", data: [confirm: "Are you sure? This will permanently delete the goal #{goal.name}"]) %> +
+ <% end %> + <% else %> +
No goals configured for this site yet
+ <% end %> +
+ + <%= link("+ Add goal", to: "/#{@site.domain}/goals/new", class: "button mt-4 w-full") %> +
diff --git a/lib/plausible_web/templates/site/new_goal.html.eex b/lib/plausible_web/templates/site/new_goal.html.eex new file mode 100644 index 000000000..cca8366fc --- /dev/null +++ b/lib/plausible_web/templates/site/new_goal.html.eex @@ -0,0 +1,37 @@ +<%= form_for @changeset, "/#{@site.domain}/goals", [class: "max-w-sm w-full mx-auto bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4 mt-8"], fn f -> %> +

Add goal for <%= @site.domain %>

+
Goal trigger
+
+
Pageview
+
Custom event
+
+
+
+ <%= label f, :page_path, class: "block text-sm font-bold" %> + <%= text_input f, :page_path, class: "transition mt-3 bg-grey-lighter appearance-none border border-transparent rounded w-full p-2 text-grey-darker leading-normal appearance-none focus:outline-none focus:bg-white focus:border-grey-light", placeholder: "/success" %> + <%= error_tag f, :page_path %> +
+ +
+ + <%= submit "Add goal →", class: "button mt-4 w-full" %> +<% end %> + + diff --git a/lib/plausible_web/templates/stats/conversions_preview.html.eex b/lib/plausible_web/templates/stats/conversions_preview.html.eex new file mode 100644 index 000000000..883e39dd2 --- /dev/null +++ b/lib/plausible_web/templates/stats/conversions_preview.html.eex @@ -0,0 +1,27 @@ +
+

Conversions

+
by unique visitors
+
+ +
+ <%= if Enum.count(@goals) > 0 do %> + <%= for {key, count} <- @goals do %> +
+ <%= key %> + <%= large_number_format(count) %> +
+ <%= bar(count, @goals, :indigo) %> + <% end %> + <% else %> +
No conversions for this period
+
<%= link("Manage goals", to: "/#{@site.domain}/goals", class: "text-indigo") %>
+ <% end %> +
+<%= if Enum.count(@goals) >= 5 do %> +
+ + + MORE + +
+<% end %> diff --git a/lib/plausible_web/templates/stats/stats.html.eex b/lib/plausible_web/templates/stats/stats.html.eex index 3480662ff..87083b0b7 100644 --- a/lib/plausible_web/templates/stats/stats.html.eex +++ b/lib/plausible_web/templates/stats/stats.html.eex @@ -3,8 +3,7 @@ - <% end %> -
+ <% end %>

Analytics for <%= link(@site.domain, to: "//" <> @site.domain, target: "_blank") %>

@@ -91,14 +90,22 @@
-
+
-
+
+ + <%= if @has_goals do %> +
+
+
+
+
+ <% end %>
diff --git a/priv/repo/migrations/20191031051340_add_goals.exs b/priv/repo/migrations/20191031051340_add_goals.exs new file mode 100644 index 000000000..38942644c --- /dev/null +++ b/priv/repo/migrations/20191031051340_add_goals.exs @@ -0,0 +1,16 @@ +defmodule Plausible.Repo.Migrations.AddGoals do + use Ecto.Migration + + def change do + create table(:goals) do + add :domain, :text, null: false + add :name, :text, null: false + add :event_name, :text + add :page_path, :text + + timestamps() + end + + create unique_index(:goals, [:domain, :name]) + end +end diff --git a/test/plausible_web/controllers/site_controller_test.exs b/test/plausible_web/controllers/site_controller_test.exs index a4ebe48e6..6424600b9 100644 --- a/test/plausible_web/controllers/site_controller_test.exs +++ b/test/plausible_web/controllers/site_controller_test.exs @@ -123,4 +123,36 @@ defmodule PlausibleWeb.SiteControllerTest do refute Repo.exists?(from e in Plausible.Event, where: e.id == ^pageview.id) end end + + describe "POST /:website/goals" do + setup [:create_user, :log_in, :create_site] + + test "creates a pageview goal for the website", %{conn: conn, site: site} do + post(conn, "/#{site.domain}/goals", %{ + goal: %{ + page_path: "/success", + event_name: "" + } + }) + + goal = Repo.one(Plausible.Goal) + + assert goal.name == "Visit /success" + assert goal.event_name == nil + end + + test "creates a custom event goal for the website", %{conn: conn, site: site} do + post(conn, "/#{site.domain}/goals", %{ + goal: %{ + page_path: "", + event_name: "Signup" + } + }) + + goal = Repo.one(Plausible.Goal) + + assert goal.name == "Signup" + assert goal.page_path == nil + end + end end From bf8443d0282de519c51b03a9780c8e670e721450 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Thu, 31 Oct 2019 14:14:06 +0800 Subject: [PATCH 2/6] Test goal_conversions function --- lib/plausible/stats/stats.ex | 39 ++++++++++++++++---- test/plausible/stats/stats_test.exs | 55 +++++++++++++++++++++++++++++ test/support/factory.ex | 4 +++ 3 files changed, 91 insertions(+), 7 deletions(-) diff --git a/lib/plausible/stats/stats.ex b/lib/plausible/stats/stats.ex index e9e73db31..f3a8e1efa 100644 --- a/lib/plausible/stats/stats.ex +++ b/lib/plausible/stats/stats.ex @@ -181,11 +181,11 @@ defmodule Plausible.Stats do ) end - def goal_conversions(site, query, limit \\ 5) do + def goal_conversions(site, query, _limit \\ 5) do goals = Repo.all(from g in Plausible.Goal, where: g.domain == ^site.domain) - conversions = fetch_pageview_goals(goals, site, query) - ++ fetch_event_goals(goals, site, query) - |> sort_conversions + fetch_pageview_goals(goals, site, query) + ++ fetch_event_goals(goals, site, query) + |> sort_conversions() end defp fetch_event_goals(goals, site, query) do @@ -195,7 +195,7 @@ defmodule Plausible.Stats do {:ok, last} = NaiveDateTime.new(query.date_range.last |> Timex.shift(days: 1), ~T[00:00:00]) last_datetime = Timex.to_datetime(last, site.timezone) - events = Enum.map(goals, fn goal -> goal.name end) + events = Enum.map(goals, fn goal -> goal.event_name end) |> Enum.filter(&(&1)) if Enum.count(events) > 0 do @@ -212,9 +212,34 @@ defmodule Plausible.Stats do end end - defp fetch_pageview_goals(goals, site, query), do: [] + defp fetch_pageview_goals(goals, site, query) do + {:ok, first} = NaiveDateTime.new(query.date_range.first, ~T[00:00:00]) + first_datetime = Timex.to_datetime(first, site.timezone) + + {:ok, last} = NaiveDateTime.new(query.date_range.last |> Timex.shift(days: 1), ~T[00:00:00]) + last_datetime = Timex.to_datetime(last, site.timezone) + + pages = Enum.map(goals, fn goal -> goal.page_path end) + |> Enum.filter(&(&1)) + + if Enum.count(pages) > 0 do + Repo.all( + from e in Plausible.Event, + where: e.hostname == ^site.domain, + where: e.timestamp >= ^first_datetime and e.timestamp < ^last_datetime, + where: e.name == "pageview", + where: e.pathname in ^pages, + group_by: e.pathname, + select: {fragment("concat('Visit ', ?)", e.pathname), count(e.user_id, :distinct)} + ) + else + [] + end + end - defp sort_conversions(conversions), do: conversions + defp sort_conversions(conversions) do + Enum.sort_by(conversions, fn {_, count} -> -count end) + end defp base_query(site, query) do {:ok, first} = NaiveDateTime.new(query.date_range.first, ~T[00:00:00]) diff --git a/test/plausible/stats/stats_test.exs b/test/plausible/stats/stats_test.exs index 03f1efe1d..1e815782c 100644 --- a/test/plausible/stats/stats_test.exs +++ b/test/plausible/stats/stats_test.exs @@ -319,6 +319,61 @@ defmodule Plausible.StatsTest do end end + describe "goal_conversions" do + test "shows custom event conversions" do + site = insert(:site) + insert(:goal, %{domain: site.domain, event_name: "Register", name: "Register"}) + insert(:goal, %{domain: site.domain, event_name: "Newsletter signup", name: "Newsletter signup"}) + insert(:event, name: "Register", hostname: site.domain, user_id: @user_id, timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "Register", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "Newsletter signup", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "Irrelevant", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + query = Stats.Query.from(site.timezone, %{"period" => "day", "date" => "2019-01-01"}) + + conversions = Stats.goal_conversions(site, query) + + assert conversions == [ + {"Register", 2}, + {"Newsletter signup", 1} + ] + end + + test "shows pageview conversions" do + site = insert(:site) + insert(:goal, %{domain: site.domain, page_path: "/success", name: "Visit /success"}) + insert(:goal, %{domain: site.domain, page_path: "/register", name: "Visit /register"}) + insert(:event, name: "pageview", pathname: "/success", hostname: site.domain, user_id: @user_id, timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "pageview", pathname: "/success", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "pageview", pathname: "/register", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "pageview", pathname: "/irrelevant", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + query = Stats.Query.from(site.timezone, %{"period" => "day", "date" => "2019-01-01"}) + + conversions = Stats.goal_conversions(site, query) + + assert conversions == [ + {"Visit /success", 2}, + {"Visit /register", 1} + ] + end + + test "shows mixed conversions in order of occurence" do + site = insert(:site) + insert(:goal, %{domain: site.domain, page_path: "/success", name: "Visit /success"}) + insert(:goal, %{domain: site.domain, event_name: "Signup", name: "Signup"}) + insert(:event, name: "Signup", hostname: site.domain, user_id: @user_id, timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "pageview", pathname: "/success", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + insert(:event, name: "pageview", pathname: "/success", hostname: site.domain, user_id: UUID.uuid4(), timestamp: ~N[2019-01-01 01:00:00]) + query = Stats.Query.from(site.timezone, %{"period" => "day", "date" => "2019-01-01"}) + + conversions = Stats.goal_conversions(site, query) + + assert conversions == [ + {"Visit /success", 2}, + {"Signup", 1} + ] + end + end + defp months_ago(months) do Timex.now() |> Timex.shift(months: -months) end diff --git a/test/support/factory.ex b/test/support/factory.ex index f212bbe0b..b994345b9 100644 --- a/test/support/factory.ex +++ b/test/support/factory.ex @@ -42,6 +42,10 @@ defmodule Plausible.Factory do } end + def goal_factory do + %Plausible.Goal{} + end + def subscription_factory do %Plausible.Billing.Subscription{ paddle_subscription_id: sequence(:paddle_subscription_id, &"subscription-#{&1}"), From 71f6ccc73c5da94e2e77b0e7b205bb2abc939c70 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Thu, 31 Oct 2019 14:20:45 +0800 Subject: [PATCH 3/6] Add tests for site controller --- lib/plausible/goals.ex | 9 ++--- .../controllers/site_controller.ex | 6 +-- lib/plausible_web/router.ex | 2 +- .../templates/site/goal_settings.html.eex | 2 +- .../controllers/site_controller_test.exs | 38 +++++++++++++++++++ 5 files changed, 45 insertions(+), 12 deletions(-) diff --git a/lib/plausible/goals.ex b/lib/plausible/goals.ex index e1ebc016d..82fb10e33 100644 --- a/lib/plausible/goals.ex +++ b/lib/plausible/goals.ex @@ -8,7 +8,7 @@ defmodule Plausible.Goals do "domain" => site.domain }) - changeset = Goal.changeset(%Goal{}, params) + Goal.changeset(%Goal{}, params) |> Repo.insert end @@ -19,11 +19,8 @@ defmodule Plausible.Goals do ) end - def delete(site, goal_name) do - Repo.one( - from g in Goal, - where: g.domain == ^site.domain and g.name == ^goal_name - ) |> Repo.delete! + def delete(id) do + Repo.one(from g in Goal, where: g.id == ^id) |> Repo.delete! end defp name_for(%{"event_name" => name}) when name != "" do diff --git a/lib/plausible_web/controllers/site_controller.ex b/lib/plausible_web/controllers/site_controller.ex index f5d67fcb2..53aef9011 100644 --- a/lib/plausible_web/controllers/site_controller.ex +++ b/lib/plausible_web/controllers/site_controller.ex @@ -68,7 +68,6 @@ defmodule PlausibleWeb.SiteController do |> put_flash(:success, "Goal created succesfully") |> redirect(to: "/#{website}/goals") {:error, :goal, changeset, _} -> - IO.inspect(changeset) conn |> assign(:skip_plausible_tracking, true) |> render("new_goal.html", @@ -79,9 +78,8 @@ defmodule PlausibleWeb.SiteController do end end - def delete_goal(conn, %{"website" => website, "name" => goal_name}) do - site = Sites.get_for_user!(conn.assigns[:current_user].id, website) - Plausible.Goals.delete(site, goal_name) + def delete_goal(conn, %{"website" => website, "id" => goal_id}) do + Plausible.Goals.delete(goal_id) conn |> put_flash(:success, "Goal deleted succesfully") diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex index 2d5522c0a..e687bac0e 100644 --- a/lib/plausible_web/router.ex +++ b/lib/plausible_web/router.ex @@ -96,7 +96,7 @@ defmodule PlausibleWeb.Router do get "/:website/goals", SiteController, :goals get "/:website/goals/new", SiteController, :new_goal post "/:website/goals", SiteController, :create_goal - delete "/:website/goals/:name", SiteController, :delete_goal + delete "/:website/goals/:id", SiteController, :delete_goal put "/:website/settings", SiteController, :update_settings put "/:website/settings/google", SiteController, :update_google_auth delete "/:website", SiteController, :delete_site diff --git a/lib/plausible_web/templates/site/goal_settings.html.eex b/lib/plausible_web/templates/site/goal_settings.html.eex index 84384c3df..31f3268aa 100644 --- a/lib/plausible_web/templates/site/goal_settings.html.eex +++ b/lib/plausible_web/templates/site/goal_settings.html.eex @@ -11,7 +11,7 @@ <%= for goal <- @goals do %>
<%= goal.name %> - <%= button("❌", to: "/#{@site.domain}/goals/#{URI.encode(goal.name, &URI.char_unreserved?/1)}", method: :delete, class: "text-sm", data: [confirm: "Are you sure? This will permanently delete the goal #{goal.name}"]) %> + <%= button("❌", to: "/#{@site.domain}/goals/#{goal.id}", method: :delete, class: "text-sm", data: [confirm: "Are you sure? This will permanently delete the goal #{goal.name}"]) %>
<% end %> <% else %> diff --git a/test/plausible_web/controllers/site_controller_test.exs b/test/plausible_web/controllers/site_controller_test.exs index 6424600b9..1176dbe02 100644 --- a/test/plausible_web/controllers/site_controller_test.exs +++ b/test/plausible_web/controllers/site_controller_test.exs @@ -124,6 +124,16 @@ defmodule PlausibleWeb.SiteControllerTest do end end + describe "GET /:website/goals/new" do + setup [:create_user, :log_in, :create_site] + + test "shows form to create a new goal", %{conn: conn, site: site} do + conn = get(conn, "/#{site.domain}/goals/new") + + assert html_response(conn, 200) =~ "Add goal" + end + end + describe "POST /:website/goals" do setup [:create_user, :log_in, :create_site] @@ -155,4 +165,32 @@ defmodule PlausibleWeb.SiteControllerTest do assert goal.page_path == nil end end + + describe "GET /:website/goals" do + setup [:create_user, :log_in, :create_site] + + test "lists goals for the site", %{conn: conn, site: site} do + insert(:goal, domain: site.domain, event_name: "Custom event", name: "Custom event") + insert(:goal, domain: site.domain, page_path: "/register", name: "Visit /register") + + conn = get(conn, "/#{site.domain}/goals") + + + assert html_response(conn, 200) =~ "Goals for " <> site.domain + assert html_response(conn, 200) =~ "Custom event" + assert html_response(conn, 200) =~ "Visit /register" + end + end + + describe "DELETE /:website/goals/:id" do + setup [:create_user, :log_in, :create_site] + + test "lists goals for the site", %{conn: conn, site: site} do + goal = insert(:goal, domain: site.domain, event_name: "Custom event", name: "Custom event") + + delete(conn, "/#{site.domain}/goals/#{goal.id}") + + assert Repo.aggregate(Plausible.Goal, :count, :id) == 0 + end + end end From 0b96ed3b6c5d52d68761d51b32b8b4ef95b9057b Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Thu, 31 Oct 2019 14:36:16 +0800 Subject: [PATCH 4/6] Remove goal name --- lib/plausible/goal/schema.ex | 5 ++--- lib/plausible/goals.ex | 18 ++---------------- .../templates/site/goal_settings.html.eex | 4 ++-- lib/plausible_web/views/site_view.ex | 8 ++++++++ .../20191031063001_remove_goal_name.exs | 9 +++++++++ test/plausible/stats/stats_test.exs | 12 ++++++------ .../controllers/site_controller_test.exs | 10 +++++----- 7 files changed, 34 insertions(+), 32 deletions(-) create mode 100644 priv/repo/migrations/20191031063001_remove_goal_name.exs diff --git a/lib/plausible/goal/schema.ex b/lib/plausible/goal/schema.ex index 9185ff6e3..912ac84e8 100644 --- a/lib/plausible/goal/schema.ex +++ b/lib/plausible/goal/schema.ex @@ -3,7 +3,6 @@ defmodule Plausible.Goal do import Ecto.Changeset schema "goals" do - field :name, :string field :domain, :string field :event_name, :string field :page_path, :string @@ -13,8 +12,8 @@ defmodule Plausible.Goal do def changeset(goal, attrs \\ %{}) do goal - |> cast(attrs, [:domain, :name, :event_name, :page_path]) - |> validate_required([:domain, :name]) + |> cast(attrs, [:domain, :event_name, :page_path]) + |> validate_required([:domain]) |> validate_event_name_and_page_path() end diff --git a/lib/plausible/goals.ex b/lib/plausible/goals.ex index 82fb10e33..3f44ce2e8 100644 --- a/lib/plausible/goals.ex +++ b/lib/plausible/goals.ex @@ -3,13 +3,9 @@ defmodule Plausible.Goals do alias Plausible.Goal def create(site, params) do - params = Map.merge(params, %{ - "name" => name_for(params), - "domain" => site.domain - }) + params = Map.merge(params, %{"domain" => site.domain}) - Goal.changeset(%Goal{}, params) - |> Repo.insert + Goal.changeset(%Goal{}, params) |> Repo.insert end def for_site(domain) do @@ -22,14 +18,4 @@ defmodule Plausible.Goals do def delete(id) do Repo.one(from g in Goal, where: g.id == ^id) |> Repo.delete! end - - defp name_for(%{"event_name" => name}) when name != "" do - name - end - - defp name_for(%{"page_path" => path}) when path != "" do - "Visit #{path}" - end - - defp name_for(_), do: nil end diff --git a/lib/plausible_web/templates/site/goal_settings.html.eex b/lib/plausible_web/templates/site/goal_settings.html.eex index 31f3268aa..5e046f2f7 100644 --- a/lib/plausible_web/templates/site/goal_settings.html.eex +++ b/lib/plausible_web/templates/site/goal_settings.html.eex @@ -10,8 +10,8 @@ <%= if Enum.count(@goals) > 0 do %> <%= for goal <- @goals do %>
- <%= goal.name %> - <%= button("❌", to: "/#{@site.domain}/goals/#{goal.id}", method: :delete, class: "text-sm", data: [confirm: "Are you sure? This will permanently delete the goal #{goal.name}"]) %> + <%= goal_name(goal) %> + <%= button("❌", to: "/#{@site.domain}/goals/#{goal.id}", method: :delete, class: "text-sm", data: [confirm: "Are you sure? This will permanently delete the goal #{goal_name(goal)}"]) %>
<% end %> <% else %> diff --git a/lib/plausible_web/views/site_view.ex b/lib/plausible_web/views/site_view.ex index 3e824e555..be6c4258b 100644 --- a/lib/plausible_web/views/site_view.ex +++ b/lib/plausible_web/views/site_view.ex @@ -1,6 +1,14 @@ defmodule PlausibleWeb.SiteView do use PlausibleWeb, :view + def goal_name(%Plausible.Goal{page_path: page_path}) when is_binary(page_path) do + "Visit " <> page_path + end + + def goal_name(%Plausible.Goal{event_name: name}) when is_binary(name) do + name + end + def snippet() do """ \ From 3031464610bf1fbb5f119a964f420d7951eb8ba5 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Thu, 31 Oct 2019 14:39:40 +0800 Subject: [PATCH 6/6] Better explanation for the Goal removal --- lib/plausible_web/templates/site/goal_settings.html.eex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/plausible_web/templates/site/goal_settings.html.eex b/lib/plausible_web/templates/site/goal_settings.html.eex index 5e046f2f7..0fca28c07 100644 --- a/lib/plausible_web/templates/site/goal_settings.html.eex +++ b/lib/plausible_web/templates/site/goal_settings.html.eex @@ -11,7 +11,7 @@ <%= for goal <- @goals do %>
<%= goal_name(goal) %> - <%= button("❌", to: "/#{@site.domain}/goals/#{goal.id}", method: :delete, class: "text-sm", data: [confirm: "Are you sure? This will permanently delete the goal #{goal_name(goal)}"]) %> + <%= button("❌", to: "/#{@site.domain}/goals/#{goal.id}", method: :delete, class: "text-sm", data: [confirm: "Are you sure you want to remove goal #{goal_name(goal)}? This will just affect the UI, all of your analytics data will stay intact."]) %>
<% end %> <% else %>