From 8dc8423319954faa358efecee220f9dde68b0995 Mon Sep 17 00:00:00 2001 From: Vini Brasil Date: Wed, 26 Apr 2023 12:22:33 +0100 Subject: [PATCH] Prepare Comparisons for release (#2873) This pull request removes the comparisons feature flag, making it visible to all users. It also removes percentages from top stats in default view, leaving those for the comparison view only. --- assets/js/dashboard/comparison-input.js | 9 +- assets/js/dashboard/datepicker.js | 2 +- assets/js/dashboard/stats/graph/top-stats.js | 18 +- .../controllers/api/stats_controller.ex | 54 +++--- .../controllers/stats_controller.ex | 3 +- priv/repo/seeds.exs | 2 - test/plausible/imported/imported_test.exs | 36 +--- .../api/stats_controller/top_stats_test.exs | 170 +++--------------- 8 files changed, 67 insertions(+), 227 deletions(-) diff --git a/assets/js/dashboard/comparison-input.js b/assets/js/dashboard/comparison-input.js index 5f3763e48..c94ae9211 100644 --- a/assets/js/dashboard/comparison-input.js +++ b/assets/js/dashboard/comparison-input.js @@ -42,7 +42,6 @@ export const isComparisonEnabled = function(mode) { } export const toggleComparisons = function(history, query, site) { - if (!site.flags.comparisons) return if (COMPARISON_DISABLED_PERIODS.includes(query.period)) return if (isComparisonEnabled(query.comparison)) { @@ -112,7 +111,6 @@ function MatchDayOfWeekInput({ history, query, site }) { } const ComparisonInput = function({ site, query, history }) { - if (!site.flags.comparisons) return null if (COMPARISON_DISABLED_PERIODS.includes(query.period)) return null if (!isComparisonEnabled(query.comparison)) return null @@ -133,7 +131,9 @@ const ComparisonInput = function({ site, query, history }) { const [uiMode, setUiMode] = React.useState("menu") React.useEffect(() => { - if (uiMode == "datepicker" && calendar) calendar.current.flatpickr.open() + if (uiMode == "datepicker") { + setTimeout(() => calendar.current.flatpickr.open(), 100) + } }, [uiMode]) const flatpickrOptions = { @@ -183,8 +183,7 @@ const ComparisonInput = function({ site, query, history }) { { uiMode == "datepicker" &&
-
- } + } diff --git a/assets/js/dashboard/datepicker.js b/assets/js/dashboard/datepicker.js index b4ea787f5..e42c93e15 100644 --- a/assets/js/dashboard/datepicker.js +++ b/assets/js/dashboard/datepicker.js @@ -362,7 +362,7 @@ function DatePicker({query, site, history}) { C - { !COMPARISON_DISABLED_PERIODS.includes(query.period) && site.flags.comparisons && + { !COMPARISON_DISABLED_PERIODS.includes(query.period) &&
{ diff --git a/assets/js/dashboard/stats/graph/top-stats.js b/assets/js/dashboard/stats/graph/top-stats.js index b645a053e..81140bddd 100644 --- a/assets/js/dashboard/stats/graph/top-stats.js +++ b/assets/js/dashboard/stats/graph/top-stats.js @@ -15,18 +15,11 @@ function Maybe({condition, children}) { } export default class TopStats extends React.Component { - renderPercentageComparison(name, comparison, forceDarkMode = false) { + renderPercentageComparison(name, comparison) { const formattedComparison = numberFormatter(Math.abs(comparison)) - const defaultClassName = classNames({ - "text-xs dark:text-gray-100": !forceDarkMode, - "text-xs text-gray-100": forceDarkMode - }) - - const noChangeClassName = classNames({ - "text-xs text-gray-700 dark:text-gray-300": !forceDarkMode, - "text-xs text-gray-300": forceDarkMode - }) + const defaultClassName = "text-xs text-gray-100" + const noChangeClassName = "text-xs text-gray-300" if (comparison > 0) { const color = name === 'Bounce rate' ? 'text-red-400' : 'text-green-500' @@ -72,7 +65,7 @@ export default class TopStats extends React.Component {
{query.comparison &&
{this.topStatNumberLong(stat.name, stat.value)} vs. {this.topStatNumberLong(stat.name, stat.comparison_value)} {statName} - {this.renderPercentageComparison(stat.name, stat.change, true)} + {this.renderPercentageComparison(stat.name, stat.change)}
} {!query.comparison &&
@@ -141,9 +134,6 @@ export default class TopStats extends React.Component {

{this.topStatNumberShort(stat.name, stat.value)}

- - {this.renderPercentageComparison(stat.name, stat.change)} -

{ formatDateRange(site, topStatData.from, topStatData.to) }

diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index cd194a3b2..9366da680 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -194,11 +194,10 @@ defmodule PlausibleWeb.Api.StatsController do with :ok <- validate_params(params) do query = Query.from(site, params) |> Filters.add_prefix() - comparison_mode = params["comparison"] || "previous_period" comparison_opts = parse_comparison_opts(params) comparison_query = - case Stats.Comparisons.compare(site, query, comparison_mode, comparison_opts) do + case Stats.Comparisons.compare(site, query, params["comparison"], comparison_opts) do {:ok, query} -> query {:error, _cause} -> nil end @@ -362,34 +361,21 @@ defmodule PlausibleWeb.Api.StatsController do conversion_rate = calculate_cr(unique_visitors, converted_visitors) prev_conversion_rate = calculate_cr(prev_unique_visitors, prev_converted_visitors) - stats = [ - %{ - name: "Unique visitors", - value: unique_visitors, - comparison_value: prev_unique_visitors, - change: percent_change(prev_unique_visitors, unique_visitors) - }, - %{ - name: "Unique conversions", - value: converted_visitors, - comparison_value: prev_converted_visitors, - change: percent_change(prev_converted_visitors, converted_visitors) - }, - %{ - name: "Total conversions", - value: completions, - comparison_value: prev_completions, - change: percent_change(prev_completions, completions) - }, - %{ - name: "Conversion rate", - value: conversion_rate, - comparison_value: prev_conversion_rate, - change: percent_change(prev_conversion_rate, conversion_rate) - } - ] + build_item = fn name, value, comparison_value -> + if comparison_value do + change = percent_change(comparison_value, value) + %{name: name, value: value, comparison_value: comparison_value, change: change} + else + %{name: name, value: value} + end + end - {stats, 100} + {[ + build_item.("Unique visitors", unique_visitors, prev_unique_visitors), + build_item.("Unique conversions", converted_visitors, prev_converted_visitors), + build_item.("Total conversions", completions, prev_completions), + build_item.("Conversion rate", conversion_rate, prev_conversion_rate) + ], 100} end defp fetch_top_stats(site, query, comparison_query) do @@ -437,10 +423,14 @@ defmodule PlausibleWeb.Api.StatsController do defp top_stats_entry(current_results, prev_results, name, key) do if current_results[key] do value = get_in(current_results, [key, :value]) - prev_value = get_in(prev_results, [key, :value]) - change = prev_value && calculate_change(key, prev_value, value) - %{name: name, value: value, comparison_value: prev_value, change: change} + if prev_results do + prev_value = get_in(prev_results, [key, :value]) + change = calculate_change(key, prev_value, value) + %{name: name, value: value, comparison_value: prev_value, change: change} + else + %{name: name, value: value} + end end end diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex index dd6600cb7..58174a3b3 100644 --- a/lib/plausible_web/controllers/stats_controller.ex +++ b/lib/plausible_web/controllers/stats_controller.ex @@ -331,8 +331,7 @@ defmodule PlausibleWeb.StatsController do %{ custom_dimension_filter: FunWithFlags.enabled?(:custom_dimension_filter, for: user), visits_metric: FunWithFlags.enabled?(:visits_metric, for: user), - views_per_visit_metric: FunWithFlags.enabled?(:views_per_visit_metric, for: user), - comparisons: FunWithFlags.enabled?(:comparisons, for: user) + views_per_visit_metric: FunWithFlags.enabled?(:views_per_visit_metric, for: user) } end diff --git a/priv/repo/seeds.exs b/priv/repo/seeds.exs index 40ca674f9..12f0e8efe 100644 --- a/priv/repo/seeds.exs +++ b/priv/repo/seeds.exs @@ -10,8 +10,6 @@ # We recommend using the bang functions (`insert!`, `update!` # and so on) as they will fail if something goes wrong. -FunWithFlags.enable(:comparisons) - user = Plausible.Factory.insert(:user, email: "user@plausible.test", password: "plausible") native_stats_range = diff --git a/test/plausible/imported/imported_test.exs b/test/plausible/imported/imported_test.exs index 34fbf052c..a3a0fcfcc 100644 --- a/test/plausible/imported/imported_test.exs +++ b/test/plausible/imported/imported_test.exs @@ -1119,36 +1119,12 @@ defmodule Plausible.ImportedTest do assert %{ "top_stats" => [ - %{ - "change" => 100, - "name" => "Unique visitors", - "value" => 1 - }, - %{ - "change" => 100, - "name" => "Total visits", - "value" => 1 - }, - %{ - "change" => 100, - "name" => "Total pageviews", - "value" => 1 - }, - %{ - "change" => 0, - "name" => "Views per visit", - "value" => 0.0 - }, - %{ - "change" => nil, - "name" => "Bounce rate", - "value" => 0 - }, - %{ - "change" => 100, - "name" => "Visit duration", - "value" => 60 - } + %{"name" => "Unique visitors", "value" => 1}, + %{"name" => "Total visits", "value" => 1}, + %{"name" => "Total pageviews", "value" => 1}, + %{"name" => "Views per visit", "value" => 0.0}, + %{"name" => "Bounce rate", "value" => 0}, + %{"name" => "Visit duration", "value" => 60} ] } = json_response(conn, 200) end diff --git a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs index 5c324bbbc..8711a482e 100644 --- a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs @@ -18,8 +18,6 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) assert %{ - "change" => 100, - "comparison_value" => 0, "name" => "Unique visitors", "value" => 2 } in res["top_stats"] @@ -37,8 +35,6 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) assert %{ - "change" => 100, - "comparison_value" => 0, "name" => "Total pageviews", "value" => 3 } in res["top_stats"] @@ -56,9 +52,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Total visits", "value" => 3} in res[ - "top_stats" - ] + assert %{"name" => "Total visits", "value" => 3} in res["top_stats"] end test "counts pages per visit", %{conn: conn, site: site} do @@ -73,12 +67,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0.0, - "name" => "Views per visit", - "value" => 1.33 - } in res["top_stats"] + assert %{"name" => "Views per visit", "value" => 1.33} in res["top_stats"] end test "calculates bounce rate", %{conn: conn, site: site} do @@ -92,9 +81,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => nil, "comparison_value" => 0, "name" => "Bounce rate", "value" => 50} in res[ - "top_stats" - ] + assert %{"name" => "Bounce rate", "value" => 50} in res["top_stats"] end test "calculates average visit duration", %{conn: conn, site: site} do @@ -116,12 +103,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Visit duration", - "value" => 450 - } in res["top_stats"] + assert %{"name" => "Visit duration", "value" => 450} in res["top_stats"] end test "calculates time on page instead when filtered for page", %{conn: conn, site: site} do @@ -152,9 +134,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 900} in res[ - "top_stats" - ] + assert %{"name" => "Time on page", "value" => 900} in res["top_stats"] end test "calculates time on page when filtered for multiple pages", %{ @@ -193,9 +173,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 480} in res[ - "top_stats" - ] + assert %{"name" => "Time on page", "value" => 480} in res["top_stats"] end test "calculates time on page when filtered for multiple negated pages", %{ @@ -234,9 +212,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 60} in res[ - "top_stats" - ] + assert %{"name" => "Time on page", "value" => 60} in res["top_stats"] end test "calculates time on page when filtered for multiple wildcard pages", %{ @@ -276,9 +252,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 480} in res[ - "top_stats" - ] + assert %{"name" => "Time on page", "value" => 480} in res["top_stats"] end test "calculates time on page when filtered for multiple negated wildcard pages", %{ @@ -320,9 +294,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Time on page", "value" => 600} in res[ - "top_stats" - ] + assert %{"name" => "Time on page", "value" => 600} in res["top_stats"] end end @@ -357,42 +329,12 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) assert res["top_stats"] == [ - %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 3 - }, - %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Total visits", - "value" => 3 - }, - %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Total pageviews", - "value" => 4 - }, - %{ - "change" => 100, - "comparison_value" => 0.0, - "name" => "Views per visit", - "value" => 1.5 - }, - %{ - "change" => nil, - "comparison_value" => 0, - "name" => "Bounce rate", - "value" => 33 - }, - %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Visit duration", - "value" => 303 - } + %{"name" => "Unique visitors", "value" => 3}, + %{"name" => "Total visits", "value" => 3}, + %{"name" => "Total pageviews", "value" => 4}, + %{"name" => "Views per visit", "value" => 1.5}, + %{"name" => "Bounce rate", "value" => 33}, + %{"name" => "Visit duration", "value" => 303} ] end end @@ -498,12 +440,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 2 - } in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] end test "page glob filter", %{conn: conn, site: site} do @@ -523,12 +460,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 2 - } in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] end test "contains (~) filter", %{conn: conn, site: site} do @@ -548,12 +480,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 2 - } in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] end test "returns only visitors with specific screen size", %{conn: conn, site: site} do @@ -573,12 +500,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 2 - } in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] end test "returns only visitors with specific browser", %{conn: conn, site: site} do @@ -598,12 +520,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 2 - } in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] end test "returns only visitors with specific operating system", %{conn: conn, site: site} do @@ -623,12 +540,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 2 - } in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] end test "returns number of visits from one specific referral source", %{conn: conn, site: site} do @@ -661,9 +573,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Total visits", "value" => 2} in res[ - "top_stats" - ] + assert %{"name" => "Total visits", "value" => 2} in res["top_stats"] end end @@ -688,12 +598,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique visitors", - "value" => 3 - } in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 3} in res["top_stats"] end test "returns converted visitors", %{conn: conn, site: site} do @@ -714,12 +619,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0, - "name" => "Unique conversions", - "value" => 1 - } in res["top_stats"] + assert %{"name" => "Unique conversions", "value" => 1} in res["top_stats"] end test "returns conversion rate", %{conn: conn, site: site} do @@ -740,15 +640,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{ - "change" => 100, - "comparison_value" => 0.0, - "name" => "Conversion rate", - "value" => 33.3 - } in res["top_stats"] + assert %{"name" => "Conversion rate", "value" => 33.3} in res["top_stats"] end - test "returns conversion rate with change=nil when comparison mode disallowed", %{ + test "returns conversion rate without change when comparison mode disallowed", %{ conn: conn, site: site } do @@ -764,17 +659,12 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do conn = get( conn, - "/api/stats/#{site.domain}/top-stats?period=all&filters=#{filters}" + "/api/stats/#{site.domain}/top-stats?period=all&filters=#{filters}&comparison_mode=year_over_year" ) res = json_response(conn, 200) - assert %{ - "change" => nil, - "comparison_value" => nil, - "name" => "Conversion rate", - "value" => 33.3 - } in res["top_stats"] + assert %{"name" => "Conversion rate", "value" => 33.3} in res["top_stats"] end end @@ -794,9 +684,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 50, "comparison_value" => 2, "name" => "Total visits", "value" => 3} in res[ - "top_stats" - ] + assert %{"name" => "Total visits", "value" => 3} in res["top_stats"] end test "returns comparison data when mode is custom", %{site: site, conn: conn} do