Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Prepare Comparisons for release (#2873)
Vini Brasil8dc842331995
diff --git a/assets/js/dashboard/comparison-input.js b/assets/js/dashboard/comparison-input.jsindex 5f3763e485..c94ae92112 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) returnif (COMPARISON_DISABLED_PERIODS.includes(query.period)) returnif (isComparisonEnabled(query.comparison)) {@@ -112,7 +111,6 @@ function MatchDayOfWeekInput({ history, query, site }) {}const ComparisonInput = function({ site, query, history }) {- if (!site.flags.comparisons) return nullif (COMPARISON_DISABLED_PERIODS.includes(query.period)) return nullif (!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" &&<div className="h-0 absolute"><Flatpickr ref={calendar} options={flatpickrOptions} className="invisible" />- </div>- }+ </div> }</Menu></div></div>diff --git a/assets/js/dashboard/datepicker.js b/assets/js/dashboard/datepicker.jsindex b4ea787f59..e42c93e156 100644--- a/assets/js/dashboard/datepicker.js+++ b/assets/js/dashboard/datepicker.js@@ -362,7 +362,7 @@ function DatePicker({query, site, history}) {<span className='font-normal'>C</span></span></div>- { !COMPARISON_DISABLED_PERIODS.includes(query.period) && site.flags.comparisons &&+ { !COMPARISON_DISABLED_PERIODS.includes(query.period) &&<div className="py-1 date-option-group border-t border-gray-200 dark:border-gray-500"><spanonClick={() => {diff --git a/assets/js/dashboard/stats/graph/top-stats.js b/assets/js/dashboard/stats/graph/top-stats.jsindex b645a053e0..81140bddd0 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 {<div>{query.comparison && <div className="whitespace-nowrap">{this.topStatNumberLong(stat.name, stat.value)} vs. {this.topStatNumberLong(stat.name, stat.comparison_value)} {statName}- <span className="ml-2">{this.renderPercentageComparison(stat.name, stat.change, true)}</span>+ <span className="ml-2">{this.renderPercentageComparison(stat.name, stat.change)}</span></div>}{!query.comparison && <div className="whitespace-nowrap">@@ -141,9 +134,6 @@ export default class TopStats extends React.Component {<div><span className="flex items-center justify-between whitespace-nowrap"><p className="font-bold text-xl dark:text-gray-100" id={METRIC_MAPPING[stat.name]}>{this.topStatNumberShort(stat.name, stat.value)}</p>- <Maybe condition={!query.comparison}>- {this.renderPercentageComparison(stat.name, stat.change)}- </Maybe></span><Maybe condition={query.comparison}><p className="text-xs dark:text-gray-100">{ formatDateRange(site, topStatData.from, topStatData.to) }</p>diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.exindex cd194a3b22..9366da6805 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 dowith :ok <- validate_params(params) doquery = 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} -> nilend@@ -362,34 +361,21 @@ defmodule PlausibleWeb.Api.StatsController doconversion_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}enddefp fetch_top_stats(site, query, comparison_query) do@@ -437,10 +423,14 @@ defmodule PlausibleWeb.Api.StatsController dodefp top_stats_entry(current_results, prev_results, name, key) doif current_results[key] dovalue = 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}+ endendenddiff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.exindex dd6600cb72..58174a3b31 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)}enddiff --git a/priv/repo/seeds.exs b/priv/repo/seeds.exsindex 40ca674f95..12f0e8efe4 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: "[email protected]", password: "plausible")native_stats_range =diff --git a/test/plausible/imported/imported_test.exs b/test/plausible/imported/imported_test.exsindex 34fbf052c6..a3a0fcfcc7 100644--- a/test/plausible/imported/imported_test.exs+++ b/test/plausible/imported/imported_test.exs@@ -1119,36 +1119,12 @@ defmodule Plausible.ImportedTest doassert %{"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)enddiff --git a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exsindex 5c324bbbc6..8711a482e3 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 dores = 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 dores = 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 dores = 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"]endtest "counts pages per visit", %{conn: conn, site: site} do@@ -73,12 +67,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "calculates bounce rate", %{conn: conn, site: site} do@@ -92,9 +81,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "calculates average visit duration", %{conn: conn, site: site} do@@ -116,12 +103,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "calculates time on page instead when filtered for page", %{conn: conn, site: site} do@@ -152,9 +134,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "calculates time on page when filtered for multiple pages", %{@@ -193,9 +173,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "calculates time on page when filtered for multiple negated pages", %{@@ -234,9 +212,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "calculates time on page when filtered for multiple wildcard pages", %{@@ -276,9 +252,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "calculates time on page when filtered for multiple negated wildcard pages", %{@@ -320,9 +294,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endend@@ -357,42 +329,12 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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}]endend@@ -498,12 +440,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "page glob filter", %{conn: conn, site: site} do@@ -523,12 +460,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "contains (~) filter", %{conn: conn, site: site} do@@ -548,12 +480,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "returns only visitors with specific screen size", %{conn: conn, site: site} do@@ -573,12 +500,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "returns only visitors with specific browser", %{conn: conn, site: site} do@@ -598,12 +520,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "returns only visitors with specific operating system", %{conn: conn, site: site} do@@ -623,12 +540,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "returns number of visits from one specific referral source", %{conn: conn, site: site} do@@ -661,9 +573,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endend@@ -688,12 +598,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "returns converted visitors", %{conn: conn, site: site} do@@ -714,12 +619,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "returns conversion rate", %{conn: conn, site: site} do@@ -740,15 +640,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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 doconn =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"]endend@@ -794,9 +684,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest dores = 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"]endtest "returns comparison data when mode is custom", %{site: site, conn: conn} do