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
Remove Props FF (#3242)
RobertJoonas5ba21c04fe0c
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 99612fe3f1..15ffe4ea81 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -5,7 +5,21 @@ All notable changes to this project will be documented in this file.### Added- Add `referrers.csv` to CSV export+- Add a new Properties section in the dashboard to break down by custom properties+- Add `custom_props.csv` to CSV export (almost the same as the old `prop_breakdown.csv`, but has different column headers, and includes props for pageviews too, not only custom events)+- Add `referrers.csv` to CSV export++### Removed+- Removed the nested custom event property breakdown UI when filtering by a goal in Goal Conversions+- Removed the `prop-breakdown.csv` file from CSV export++### Changed+- Limit the number of Goal Conversions shown on the dashboard and render a "Details" link when there are more entries to show+- Show Outbound Links / File Downloads / 404 Pages / Cloaked Links instead of Goal Conversions when filtering by the corresponding goal+- Require custom properties to be explicitly added from Site Settings > Custom Properties in order for them to show up on the dashboard++>>>>>>> f7ed6464 (update changelog)### Fixed- Only return `(none)` values in custom property breakdown for the first page (pagination) of results- Fixed weekly/monthly e-mail report [rendering issues](https://github.com/plausible/analytics/issues/284)diff --git a/assets/js/dashboard/stats/behaviours/deprecated-conversions.js b/assets/js/dashboard/stats/behaviours/deprecated-conversions.jsdeleted file mode 100644index ece6678ea3..0000000000--- a/assets/js/dashboard/stats/behaviours/deprecated-conversions.js+++ /dev/null@@ -1,119 +0,0 @@-import React from 'react';-import { Link } from 'react-router-dom'-import FlipMove from 'react-flip-move'--import Bar from '../bar'-import PropBreakdown from './prop-breakdown'-import numberFormatter from '../../util/number-formatter'-import * as api from '../../api'-import * as url from '../../util/url'-import { escapeFilterValue } from '../../util/filters'-import LazyLoader from '../../components/lazy-loader'-import Money from './money'--export default class DeprecatedConversions extends React.Component {- constructor(props) {- super(props)- this.htmlNode = React.createRef()- this.state = { loading: true, }- this.onVisible = this.onVisible.bind(this)- this.fetchConversions = this.fetchConversions.bind(this)- }-- componentWillUnmount() {- document.removeEventListener('tick', this.fetchConversions)- }-- onVisible() {- this.fetchConversions()- if (this.props.query.period === 'realtime') {- document.addEventListener('tick', this.fetchConversions)- }- }-- componentDidUpdate(prevProps) {- if (this.props.query !== prevProps.query) {- const height = this.htmlNode.current.offsetHeight- this.setState({ loading: true, goals: null, prevHeight: height })- this.fetchConversions()- }- }-- fetchConversions() {- api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/conversions`, this.props.query, {limit: 100})- .then((res) => this.setState({ loading: false, goals: res, prevHeight: null }))- }-- renderGoal(goal, renderRevenueColumn) {- const renderProps = this.props.query.filters['goal'] == goal.name && goal.prop_names-- return (- <div className="my-2 text-sm" key={goal.name}>- <div className="flex items-center justify-between my-2">- <span className="flex-1">- <Bar- count={goal.visitors}- all={this.state.goals}- bg="bg-red-50 dark:bg-gray-500 dark:bg-opacity-15"- plot="visitors"- >- <Link to={url.setQuery('goal', escapeFilterValue(goal.name))} className="block px-2 py-1.5 hover:underline relative z-9 break-all lg:truncate dark:text-gray-200">{goal.name}</Link>- </Bar>- </span>- <div className="dark:text-gray-200">- <span className="inline-block w-20 font-medium text-right">{numberFormatter(goal.visitors)}</span>- <span className="hidden md:inline-block md:w-20 font-medium text-right">{numberFormatter(goal.events)}</span>- <span className="inline-block w-20 font-medium text-right">{goal.conversion_rate}%</span>- {renderRevenueColumn && <span className="hidden md:inline-block md:w-20 font-medium text-right"><Money formatted={goal.total_revenue} /></span>}- {renderRevenueColumn && <span className="hidden md:inline-block md:w-20 font-medium text-right"><Money formatted={goal.average_revenue} /></span>}- </div>- </div>- { renderProps && <PropBreakdown site={this.props.site} query={this.props.query} goal={goal} renderRevenueColumn={renderRevenueColumn } /> }- </div>- )- }-- renderInner() {- if (this.state.loading) {- return <div className="mx-auto my-2 loading"><div></div></div>- } else if (this.state.goals) {- const hasRevenue = this.state.goals.some((goal) => goal.total_revenue)-- return (- <React.Fragment>- <div className="flex items-center justify-between mt-3 mb-2 text-xs font-bold tracking-wide text-gray-500 dark:text-gray-400">- <span>Goal</span>- <div className="text-right">- <span className="inline-block w-20">Uniques</span>- <span className="hidden md:inline-block md:w-20">Total</span>- <span className="inline-block w-20">CR</span>- {hasRevenue && <span className="hidden md:inline-block md:w-20">Revenue</span>}- {hasRevenue && <span className="hidden md:inline-block md:w-20">Average</span>}- </div>- </div>- <FlipMove>- { this.state.goals.map((goal) => this.renderGoal.bind(this)(goal, hasRevenue) ) }- </FlipMove>- </React.Fragment>- )- }- }-- renderConversions() {- return (- <div ref={this.htmlNode} style={{ minHeight: '132px', height: this.state.prevHeight ?? 'auto' }} >- <LazyLoader onVisible={this.onVisible}>- {this.renderInner()}- </LazyLoader>- </div>- )- }-- render() {- return (- <div>- {this.renderConversions()}- </div>- )- }-}diff --git a/assets/js/dashboard/stats/behaviours/index.js b/assets/js/dashboard/stats/behaviours/index.jsindex 0283d8f234..fe5f841d44 100644--- a/assets/js/dashboard/stats/behaviours/index.js+++ b/assets/js/dashboard/stats/behaviours/index.js@@ -5,7 +5,6 @@ import classNames from 'classnames'import * as storage from '../../util/storage'import GoalConversions, { specialTitleWhenGoalFilter } from './goal-conversions'-import DeprecatedConversions from './deprecated-conversions'import Properties from './props'import Funnel from './funnel'import { FeatureSetupNotice } from '../../components/notice'@@ -147,11 +146,7 @@ export default function Behaviours(props) {function renderConversions() {if (site.hasGoals) {- if (site.flags.props) {- return <GoalConversions site={site} query={query} onGoalFilterClick={onGoalFilterClick} />- } else {- return <DeprecatedConversions site={site} query={query} />- }+ return <GoalConversions site={site} query={query} onGoalFilterClick={onGoalFilterClick} />}else if (adminAccess) {return (@@ -245,7 +240,7 @@ export default function Behaviours(props) {if (site.conversionsEnabled) {enabledModes.push(CONVERSIONS)}- if (site.propsEnabled && site.flags.props) {+ if (site.propsEnabled) {enabledModes.push(PROPS)}if (site.funnelsEnabled && !isRealtime() && site.flags.funnels) {diff --git a/lib/plausible/props.ex b/lib/plausible/props.exindex ece53135b2..0a18a62885 100644--- a/lib/plausible/props.ex+++ b/lib/plausible/props.ex@@ -118,10 +118,6 @@ defmodule Plausible.Props do)end- def enabled_for?(%Plausible.Auth.User{} = user) do- FunWithFlags.enabled?(:props, for: user)- end-defp valid?(key) doString.length(key) in 1..@max_prop_key_lengthenddiff --git a/lib/plausible/site/admin.ex b/lib/plausible/site/admin.exindex 3083098ba0..6333b1d7db 100644--- a/lib/plausible/site/admin.ex+++ b/lib/plausible/site/admin.ex@@ -41,14 +41,6 @@ defmodule Plausible.SiteAdmin dopublic: nil,owner: %{value: &get_owner_email/1},other_members: %{value: &get_other_members/1},- allowed_event_props: %{- value: fn site ->- case site.allowed_event_props do- nil -> ""- list -> Enum.join(list, ", ")- end- end- },limits: %{value: fn site ->case site.ingest_rate_limit_threshold do@@ -61,39 +53,6 @@ defmodule Plausible.SiteAdmin do]end- def list_actions(_conn) do- [- set_allowed_event_props: %{- inputs: [- %{- name: "props",- title:- "Insert comma separated property names (e.g: author, logged_in, url, ...). Submit a blank field to allow all property names",- default: ""- }- ],- name: "Allow only these custom properties",- action: &set_allowed_props_for_site/3- }- ]- end-- def set_allowed_props_for_site(_conn, [site], params) do- props_list =- case String.trim(params["props"]) do- "" -> nil- props -> String.split(props, ~r/\s*,\s*/)- end-- {:ok, _site} = Plausible.Props.allow(site, props_list)-- :ok- end-- def set_allowed_props_for_site(_, _, _) do- {:error, "Please select only one site for this action"}- end-defp format_date(date) doTimex.format!(date, "{Mshort} {D}, {YYYY}")enddiff --git a/lib/plausible/stats/custom_props.ex b/lib/plausible/stats/custom_props.exindex b33ec2c4e2..d4bb9715b1 100644--- a/lib/plausible/stats/custom_props.ex+++ b/lib/plausible/stats/custom_props.ex@@ -22,18 +22,6 @@ defmodule Plausible.Stats.CustomProps do|> Enum.into(%{})end- @doc """- Expects a single goal filter in the query. Returns a list of custom- props for that goal. Works for both custom event and pageview goals.- """- def props_for_goal(site, query) do- case query.filters["event:goal"] do- {:is, _} -> fetch_prop_names(site, query)- {:matches, _} -> fetch_prop_names(site, query)- _ -> []- end- end-def fetch_prop_names(site, query) docase Query.get_filter_by_prefix(query, "event:props:") do{"event:props:" <> key, _} ->diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.exindex 8a6c9c19df..4568a096f2 100644--- a/lib/plausible_web/controllers/api/stats_controller.ex+++ b/lib/plausible_web/controllers/api/stats_controller.ex@@ -3,7 +3,7 @@ defmodule PlausibleWeb.Api.StatsController douse Plausible.Repouse Plug.ErrorHandleralias Plausible.Stats- alias Plausible.Stats.{Query, Filters, Comparisons, CustomProps}+ alias Plausible.Stats.{Query, Filters, Comparisons}require Logger@@ -1167,7 +1167,6 @@ defmodule PlausibleWeb.Api.StatsController do|> transform_keys(%{goal: :name})|> Enum.map(fn goal ->goal- |> Map.put(:prop_names, CustomProps.props_for_goal(site, query))|> Map.put(:conversion_rate, calculate_cr(total_visitors, goal[:visitors]))|> Enum.map(&format_revenue_metric/1)|> Map.new()@@ -1273,61 +1272,6 @@ defmodule PlausibleWeb.Api.StatsController doendend- def prop_breakdown(conn, params) do- site = conn.assigns[:site]- query = Query.from(site, params) |> Filters.add_prefix()- pagination = parse_pagination(params)-- total_q = Query.remove_event_filters(query, [:goal, :props])-- %{:visitors => %{value: unique_visitors}} = Stats.aggregate(site, total_q, [:visitors])-- prop_name = "event:props:" <> params["prop_name"]-- props =- Stats.breakdown(- site,- query,- prop_name,- [:visitors, :events, :average_revenue, :total_revenue],- pagination- )- |> transform_keys(%{- params["prop_name"] => :name,- :events => :total_conversions,- :visitors => :unique_conversions- })- |> Enum.map(fn prop ->- prop- |> Map.put(:conversion_rate, calculate_cr(unique_visitors, prop[:unique_conversions]))- |> Enum.map(&format_revenue_metric/1)- |> Map.new()- end)-- if params["csv"] do- props- else- json(conn, props)- end- end-- def all_props_breakdown(conn, params) do- site = conn.assigns[:site]- query = Query.from(site, params) |> Filters.add_prefix()-- prop_names = Plausible.Stats.CustomProps.props_for_goal(site, query)-- values =- prop_names- |> Enum.map(fn prop ->- prop_breakdown(conn, Map.put(params, "prop_name", prop))- |> Enum.map(&Map.put(&1, :prop, prop))- end)- |> Enum.concat()-- to_csv(values, [:prop, :name, :unique_conversions, :total_conversions])- end-def current_visitors(conn, _) dosite = conn.assigns[:site]json(conn, Stats.current_visitors(site))diff --git a/lib/plausible_web/controllers/site_controller.ex b/lib/plausible_web/controllers/site_controller.exindex 9e929e7f72..95b99daea9 100644--- a/lib/plausible_web/controllers/site_controller.ex+++ b/lib/plausible_web/controllers/site_controller.ex@@ -291,17 +291,13 @@ defmodule PlausibleWeb.SiteController doenddef settings_props(conn, _params) do- if Plausible.Props.enabled_for?(conn.assigns.current_user) do- conn- |> assign(:skip_plausible_tracking, true)- |> render("settings_props.html",- site: conn.assigns.site,- layout: {PlausibleWeb.LayoutView, "site_settings.html"},- connect_live_socket: true- )- else- conn |> Plug.Conn.put_status(401) |> Plug.Conn.halt()- end+ conn+ |> assign(:skip_plausible_tracking, true)+ |> render("settings_props.html",+ site: conn.assigns.site,+ layout: {PlausibleWeb.LayoutView, "site_settings.html"},+ connect_live_socket: true+ )enddef settings_search_console(conn, _params) dodiff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.exindex 2c0838a0a9..205ee6bb8f 100644--- a/lib/plausible_web/controllers/stats_controller.ex+++ b/lib/plausible_web/controllers/stats_controller.ex@@ -145,19 +145,10 @@ defmodule PlausibleWeb.StatsController do'operating_systems.csv' => fn -> Api.StatsController.operating_systems(conn, params) end,'devices.csv' => fn -> Api.StatsController.screen_sizes(conn, params) end,'conversions.csv' => fn -> Api.StatsController.conversions(conn, params) end,- 'prop_breakdown.csv' => fn -> Api.StatsController.all_props_breakdown(conn, params) end,- 'referrers.csv' => fn -> Api.StatsController.referrers(conn, params) end+ 'referrers.csv' => fn -> Api.StatsController.referrers(conn, params) end,+ 'custom_props.csv' => fn -> Api.StatsController.all_custom_prop_values(conn, params) end}- csvs =- if FunWithFlags.enabled?(:props, for: conn.assigns[:current_user]) do- Map.put(csvs, 'custom_props.csv', fn ->- Api.StatsController.all_custom_prop_values(conn, params)- end)- else- csvs- end-csv_values =Map.values(csvs)|> Plausible.ClickhouseRepo.parallel_tasks()@@ -346,8 +337,7 @@ defmodule PlausibleWeb.StatsController dodefp get_flags(user) do%{- funnels: Plausible.Funnels.enabled_for?(user),- props: FunWithFlags.enabled?(:props, for: user)+ funnels: Plausible.Funnels.enabled_for?(user)}enddiff --git a/lib/plausible_web/live/props_settings.ex b/lib/plausible_web/live/props_settings.exindex efd1e1ca54..fc2cf532e6 100644--- a/lib/plausible_web/live/props_settings.ex+++ b/lib/plausible_web/live/props_settings.ex@@ -12,8 +12,6 @@ defmodule PlausibleWeb.Live.PropsSettings do%{"site_id" => _site_id, "domain" => domain, "current_user_id" => user_id},socket) do- true = Plausible.Props.enabled_for?(%Plausible.Auth.User{id: user_id})-site =if Plausible.Auth.is_super_admin?(user_id) doPlausible.Sites.get_by_domain(domain)diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.exindex badb271473..bdd98ef6f2 100644--- a/lib/plausible_web/router.ex+++ b/lib/plausible_web/router.ex@@ -89,7 +89,6 @@ defmodule PlausibleWeb.Router doget "/:domain/screen-sizes", StatsController, :screen_sizesget "/:domain/conversions", StatsController, :conversionsget "/:domain/custom-prop-values/:prop_key", StatsController, :custom_prop_values- get "/:domain/property/:prop_name", StatsController, :prop_breakdownget "/:domain/suggestions/:filter_name", StatsController, :filter_suggestionsenddiff --git a/lib/plausible_web/views/layout_view.ex b/lib/plausible_web/views/layout_view.exindex ca73d49e95..aeae09fd79 100644--- a/lib/plausible_web/views/layout_view.ex+++ b/lib/plausible_web/views/layout_view.ex@@ -30,9 +30,7 @@ defmodule PlausibleWeb.LayoutView doif Plausible.Funnels.enabled_for?(conn.assigns[:current_user]) do[key: "Funnels", value: "funnels"]end,- if Plausible.Props.enabled_for?(conn.assigns[:current_user]) do- [key: "Custom Properties", value: "properties"]- end,+ [key: "Custom Properties", value: "properties"],[key: "Search Console", value: "search-console"],[key: "Email reports", value: "email-reports"],if !is_selfhost() && conn.assigns[:site].custom_domain dodiff --git a/priv/repo/seeds.exs b/priv/repo/seeds.exsindex 0d9cdefc9b..f365871867 100644--- a/priv/repo/seeds.exs+++ b/priv/repo/seeds.exs@@ -13,7 +13,6 @@user = Plausible.Factory.insert(:user, email: "[email protected]", password: "plausible")FunWithFlags.enable(:funnels)-FunWithFlags.enable(:props)native_stats_range =Date.range(diff --git a/test/plausible_web/controllers/CSVs/30d-filter-goal/prop_breakdown.csv b/test/plausible_web/controllers/CSVs/30d-filter-goal/prop_breakdown.csvdeleted file mode 100644index cc987c30cb..0000000000--- a/test/plausible_web/controllers/CSVs/30d-filter-goal/prop_breakdown.csv+++ /dev/null@@ -1,2 +0,0 @@-prop,name,unique_conversions,total_conversions-variant,A,1,1diff --git a/test/plausible_web/controllers/CSVs/30d-filter-path/prop_breakdown.csv b/test/plausible_web/controllers/CSVs/30d-filter-path/prop_breakdown.csvdeleted file mode 100644index c31750f137..0000000000--- a/test/plausible_web/controllers/CSVs/30d-filter-path/prop_breakdown.csv+++ /dev/null@@ -1 +0,0 @@-prop,name,unique_conversions,total_conversionsdiff --git a/test/plausible_web/controllers/CSVs/30d/prop_breakdown.csv b/test/plausible_web/controllers/CSVs/30d/prop_breakdown.csvdeleted file mode 100644index c31750f137..0000000000--- a/test/plausible_web/controllers/CSVs/30d/prop_breakdown.csv+++ /dev/null@@ -1 +0,0 @@-prop,name,unique_conversions,total_conversionsdiff --git a/test/plausible_web/controllers/CSVs/6m/prop_breakdown.csv b/test/plausible_web/controllers/CSVs/6m/prop_breakdown.csvdeleted file mode 100644index c31750f137..0000000000--- a/test/plausible_web/controllers/CSVs/6m/prop_breakdown.csv+++ /dev/null@@ -1 +0,0 @@-prop,name,unique_conversions,total_conversionsdiff --git a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs b/test/plausible_web/controllers/api/stats_controller/conversions_test.exsindex d14b9b24be..1c50e0457f 100644--- a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs@@ -37,14 +37,12 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Signup","visitors" => 2,"events" => 3,- "prop_names" => [],"conversion_rate" => 33.3},%{"name" => "Visit /register","visitors" => 2,"events" => 2,- "prop_names" => [],"conversion_rate" => 33.3}]@@ -86,7 +84,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Payment","visitors" => 1,"events" => 2,- "prop_names" => [],"conversion_rate" => 33.3}]@@ -127,7 +124,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Payment","visitors" => 2,"events" => 2,- "prop_names" => [],"conversion_rate" => 66.7}]@@ -166,7 +162,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Payment","visitors" => 2,"events" => 3,- "prop_names" => [],"conversion_rate" => 66.7}]@@ -207,7 +202,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Payment","visitors" => 2,"events" => 3,- "prop_names" => [],"conversion_rate" => 66.7}]@@ -258,7 +252,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Payment","visitors" => 5,"events" => 5,- "prop_names" => [],"conversion_rate" => 100.0,"average_revenue" => %{"short" => "€166.7M", "long" => "€166,733,566.75"},"total_revenue" => %{"short" => "€500.2M", "long" => "€500,200,700.25"}@@ -293,7 +286,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"average_revenue" => %{"long" => "€10.00", "short" => "€10.0"},"conversion_rate" => 33.3,"name" => "Payment",- "prop_names" => [],"events" => 1,"total_revenue" => %{"long" => "€10.00", "short" => "€10.0"},"visitors" => 1@@ -302,7 +294,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"average_revenue" => nil,"conversion_rate" => 66.7,"name" => "Signup",- "prop_names" => [],"events" => 2,"total_revenue" => nil,"visitors" => 2@@ -311,7 +302,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"average_revenue" => nil,"conversion_rate" => 33.3,"name" => "Visit /checkout",- "prop_names" => [],"events" => 1,"total_revenue" => nil,"visitors" => 1@@ -336,7 +326,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Signup","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 100.0}]@@ -372,193 +361,11 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Signup","visitors" => 2,"events" => 2,- "prop_names" => ["variant"],"conversion_rate" => 33.3}]end- test "returns only the prop name for the property in filter", %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Payment",- "meta.key": ["logged_in"],- "meta.value": ["true"]- ),- build(:event,- name: "Payment",- "meta.key": ["logged_in"],- "meta.value": ["false"]- ),- build(:event,- name: "Payment",- "meta.key": ["author"],- "meta.value": ["John"]- )- ])-- insert(:goal, %{site: site, event_name: "Payment"})-- filters = Jason.encode!(%{goal: "Payment", props: %{"logged_in" => "true|(none)"}})- conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")-- assert json_response(conn, 200) == [- %{- "name" => "Payment",- "visitors" => 2,- "events" => 2,- "prop_names" => ["logged_in"],- "conversion_rate" => 66.7- }- ]- end-- test "returns prop_names=[] when goal :member + property filter are applied at the same time",- %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Payment",- "meta.key": ["logged_in"],- "meta.value": ["true"]- ),- build(:event,- name: "Payment",- "meta.key": ["logged_in"],- "meta.value": ["false"]- ),- build(:event,- name: "Payment",- "meta.key": ["author"],- "meta.value": ["John"]- )- ])-- insert(:goal, %{site: site, event_name: "Payment"})- insert(:goal, %{site: site, event_name: "Signup"})-- filters = Jason.encode!(%{goal: "Payment|Signup", props: %{"logged_in" => "true|(none)"}})- conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")-- assert [%{"prop_names" => []}] = json_response(conn, 200)- end-- test "filters out garbage prop_names", %{conn: conn, site: site} do- {:ok, site} = Plausible.Props.allow(site, ["author"])-- populate_stats(site, [- build(:event,- name: "Payment",- "meta.key": ["author"],- "meta.value": ["Valdis"]- ),- build(:event,- name: "Payment",- "meta.key": ["Garbage"],- "meta.value": ["321"]- ),- build(:event,- name: "Payment",- "meta.key": ["OnlyGarbage"],- "meta.value": ["123"]- )- ])-- insert(:goal, %{site: site, event_name: "Payment"})-- filters = Jason.encode!(%{goal: "Payment"})- conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")-- assert [%{"prop_names" => ["author"]}] = json_response(conn, 200)- end-- test "filters out garbage prop_names when session filters are applied",- %{- conn: conn,- site: site- } do- {:ok, site} = Plausible.Props.allow(site, ["author", "logged_in"])-- populate_stats(site, [- build(:event,- name: "Payment",- pathname: "/",- "meta.key": ["author"],- "meta.value": ["Valdis"]- ),- build(:event,- name: "Payment",- pathname: "/ignore",- "meta.key": ["logged_in"],- "meta.value": ["true"]- ),- build(:event,- name: "Payment",- pathname: "/",- "meta.key": ["garbage"],- "meta.value": ["123"]- )- ])-- insert(:goal, %{site: site, event_name: "Payment"})-- filters = Jason.encode!(%{goal: "Payment", entry_page: "/"})- conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")-- assert [%{"prop_names" => ["author"]}] = json_response(conn, 200)- end-- test "does not filter any prop names by default (when site.allowed_event_props is nil)",- %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Payment",- "meta.key": ["Garbage"],- "meta.value": ["321"]- ),- build(:event,- name: "Payment",- "meta.key": ["OnlyGarbage"],- "meta.value": ["123"]- )- ])-- insert(:goal, %{site: site, event_name: "Payment"})-- filters = Jason.encode!(%{goal: "Payment"})- conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")-- assert [%{"prop_names" => prop_names}] = json_response(conn, 200)- assert "Garbage" in prop_names- assert "OnlyGarbage" in prop_names- end-- test "does not filter out special prop keys", %{conn: conn, site: site} do- {:ok, site} = Plausible.Props.allow(site, ["author"])-- populate_stats(site, [- build(:event,- name: "Outbound Link: Click",- "meta.key": ["url", "path", "first_time_customer"],- "meta.value": ["http://link.test", "/abc", "true"]- )- ])-- insert(:goal, %{site: site, event_name: "Outbound Link: Click"})-- filters = Jason.encode!(%{goal: "Outbound Link: Click"})- conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")- assert [%{"prop_names" => ["url", "path"]}] = json_response(conn, 200)- end-test "can filter by multiple mixed goals", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview, pathname: "/"),@@ -585,14 +392,12 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Signup","visitors" => 2,"events" => 2,- "prop_names" => [],"conversion_rate" => 33.3},%{"name" => "Visit /register","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 16.7}]@@ -626,14 +431,12 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "CTA","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 16.7},%{"name" => "Visit /register","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 16.7}]@@ -662,14 +465,12 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Visit /blog/**","visitors" => 2,"events" => 2,- "prop_names" => [],"conversion_rate" => 66.7},%{"name" => "Visit /billing/upgrade","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 33.3}]@@ -702,14 +503,12 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Visit /blog**","visitors" => 2,"events" => 2,- "prop_names" => [],"conversion_rate" => 33.3},%{"name" => "Signup","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 16.7}]@@ -743,14 +542,12 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Visit /ano**","visitors" => 2,"events" => 2,- "prop_names" => [],"conversion_rate" => 33.3},%{"name" => "CTA","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 16.7}]@@ -781,7 +578,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Visit /register","visitors" => 1,"events" => 1,- "prop_names" => [],"conversion_rate" => 25}]@@ -814,7 +610,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Signup","visitors" => 1,"events" => 1,- "prop_names" => ["variant"],"conversion_rate" => 50}]@@ -882,94 +677,49 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"conversion_rate" => 100.0,"visitors" => 8,"name" => "Visit /**",- "events" => 8,- "prop_names" => []+ "events" => 8},%{"conversion_rate" => 37.5,"visitors" => 3,"name" => "Visit /signup/**",- "events" => 3,- "prop_names" => []+ "events" => 3},%{"conversion_rate" => 37.5,"visitors" => 3,"name" => "Visit /*",- "events" => 3,- "prop_names" => []+ "events" => 3},%{"conversion_rate" => 25.0,"visitors" => 2,"name" => "Visit /billing**/success",- "events" => 2,- "prop_names" => []+ "events" => 2},%{"conversion_rate" => 25.0,"visitors" => 2,"name" => "Visit /reg*",- "events" => 2,- "prop_names" => []+ "events" => 2},%{"conversion_rate" => 12.5,"visitors" => 1,"name" => "Visit /signup/*",- "events" => 1,- "prop_names" => []+ "events" => 1},%{"conversion_rate" => 12.5,"visitors" => 1,"name" => "Visit /billing*/success",- "events" => 1,- "prop_names" => []+ "events" => 1},%{"conversion_rate" => 12.5,"visitors" => 1,"name" => "Visit /register",- "events" => 1,- "prop_names" => []- }- ]- end-- test "returns prop names when filtered by glob goal", %{conn: conn, site: site} do- insert(:goal, %{site: site, page_path: "/register**"})-- populate_stats(site, [- build(:pageview,- pathname: "/register",- "meta.key": ["logged_in"],- "meta.value": ["false"],- timestamp: ~N[2019-07-01 23:00:00]- ),- build(:pageview,- pathname: "/register-success",- "meta.key": ["logged_in", "author"],- "meta.value": ["true", "John"],- timestamp: ~N[2019-07-01 23:00:00]- )- ])-- filters = Jason.encode!(%{goal: "Visit /register**"})-- conn =- get(- conn,- "/api/stats/#{site.domain}/conversions?period=day&date=2019-07-01&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "conversion_rate" => 100.0,- "visitors" => 2,- "name" => "Visit /register**",- "events" => 2,- "prop_names" => ["logged_in", "author"]+ "events" => 1}]enddiff --git a/test/plausible_web/controllers/api/stats_controller/prop_breakdown_test.exs b/test/plausible_web/controllers/api/stats_controller/prop_breakdown_test.exsdeleted file mode 100644index 41d3daccf2..0000000000--- a/test/plausible_web/controllers/api/stats_controller/prop_breakdown_test.exs+++ /dev/null@@ -1,608 +0,0 @@-defmodule PlausibleWeb.Api.StatsController.PropBreakdownTest do- use PlausibleWeb.ConnCase-- # credo:disable-for-next-line- # TODO: Remove this file once the new Properties feature is live.-- # All tests in this file were copied into `custom_prop_breakdown_test.exs`- # testing the exact same features for the new- # `/api/stats/:domain/custom-prop-values/:key` route.-- describe "GET /api/stats/:domain/property/:key" do- setup [:create_user, :log_in, :create_new_site]-- test "returns property breakdown for goal", %{conn: conn, site: site} do- populate_stats(site, [- build(:pageview, pathname: "/"),- build(:pageview, pathname: "/"),- build(:pageview, pathname: "/register"),- build(:event, name: "Signup", "meta.key": ["variant"], "meta.value": ["A"]),- build(:event, name: "Signup", "meta.key": ["variant"], "meta.value": ["B"]),- build(:event, name: "Signup", "meta.key": ["variant"], "meta.value": ["B"])- ])-- insert(:goal, %{site: site, event_name: "Signup"})- filters = Jason.encode!(%{goal: "Signup"})- prop_key = "variant"-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/#{prop_key}?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "unique_conversions" => 2,- "name" => "B",- "total_conversions" => 2,- "conversion_rate" => 33.3- },- %{- "unique_conversions" => 1,- "name" => "A",- "total_conversions" => 1,- "conversion_rate" => 16.7- }- ]- end-- test "returns (none) values in property breakdown for goal", %{conn: conn, site: site} do- populate_stats(site, [- build(:pageview, pathname: "/"),- build(:pageview, pathname: "/"),- build(:pageview, pathname: "/register"),- build(:event, name: "Signup"),- build(:event, name: "Signup"),- build(:event, name: "Signup", "meta.key": ["variant"], "meta.value": ["A"])- ])-- insert(:goal, %{site: site, event_name: "Signup"})- filters = Jason.encode!(%{goal: "Signup"})- prop_key = "variant"-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/#{prop_key}?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "unique_conversions" => 2,- "name" => "(none)",- "total_conversions" => 2,- "conversion_rate" => 33.3- },- %{- "unique_conversions" => 1,- "name" => "A",- "total_conversions" => 1,- "conversion_rate" => 16.7- }- ]- end-- test "does not return (none) value in property breakdown with is filter on prop_value", %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "0"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "0",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 50.0- }- ]- end-- test "returns only (none) value in property breakdown with is (none) filter", %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "(none)"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "(none)",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 50.0- }- ]- end-- test "returns (none) value in property breakdown with is_not filter on prop_value", %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["20"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["20"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "!0"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "20",- "unique_conversions" => 2,- "total_conversions" => 2,- "conversion_rate" => 50.0- },- %{- "name" => "(none)",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 25.0- }- ]- end-- test "does not return (none) value in property breakdown with is_not (none) filter", %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "!(none)"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "0",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 50.0- }- ]- end-- test "does not return (none) value in property breakdown with member filter on prop_value", %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["1"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["1"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "0|1"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "1",- "unique_conversions" => 2,- "total_conversions" => 2,- "conversion_rate" => 50.0- },- %{- "name" => "0",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 25.0- }- ]- end-- test "returns (none) value in property breakdown with member filter including a (none) value",- %{conn: conn, site: site} do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["1"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["1"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "1|(none)"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "1",- "unique_conversions" => 2,- "total_conversions" => 2,- "conversion_rate" => 50.0- },- %{- "name" => "(none)",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 25.0- }- ]- end-- test "returns (none) value in property breakdown with not_member filter on prop_value", %{- conn: conn,- site: site- } do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0.01"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["20"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["20"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "!0|0.01"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "20",- "unique_conversions" => 2,- "total_conversions" => 2,- "conversion_rate" => 40.0- },- %{- "name" => "(none)",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 20.0- }- ]- end-- test "does not return (none) value in property breakdown with not_member filter including a (none) value",- %{conn: conn, site: site} do- populate_stats(site, [- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["0"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["20"]- ),- build(:event,- name: "Purchase",- "meta.key": ["cost"],- "meta.value": ["20"]- ),- build(:event, name: "Purchase")- ])-- insert(:goal, %{site: site, event_name: "Purchase"})-- filters =- Jason.encode!(%{- goal: "Purchase",- props: %{cost: "!0|(none)"}- })-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "20",- "unique_conversions" => 2,- "total_conversions" => 2,- "conversion_rate" => 50.0- }- ]- end-- test "returns property breakdown with a pageview goal filter", %{conn: conn, site: site} do- populate_stats(site, [- build(:pageview, pathname: "/"),- build(:pageview, pathname: "/register"),- build(:pageview, pathname: "/register", "meta.key": ["variant"], "meta.value": ["A"]),- build(:pageview, pathname: "/register", "meta.key": ["variant"], "meta.value": ["A"])- ])-- insert(:goal, %{site: site, page_path: "/register"})- filters = Jason.encode!(%{goal: "Visit /register"})-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/variant?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "unique_conversions" => 2,- "name" => "A",- "total_conversions" => 2,- "conversion_rate" => 50.0- },- %{- "unique_conversions" => 1,- "name" => "(none)",- "total_conversions" => 1,- "conversion_rate" => 25.0- }- ]- end-- test "property breakdown with prop filter", %{conn: conn, site: site} do- populate_stats(site, [- build(:pageview, user_id: 1),- build(:event, user_id: 1, name: "Signup", "meta.key": ["variant"], "meta.value": ["A"]),- build(:pageview, user_id: 2),- build(:event, user_id: 2, name: "Signup", "meta.key": ["variant"], "meta.value": ["B"])- ])-- insert(:goal, %{site: site, event_name: "Signup"})- filters = Jason.encode!(%{goal: "Signup", props: %{"variant" => "B"}})- prop_key = "variant"-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/#{prop_key}?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "unique_conversions" => 1,- "name" => "B",- "total_conversions" => 1,- "conversion_rate" => 50.0- }- ]- end-- test "Property breakdown with prop and goal filter", %{conn: conn, site: site} do- populate_stats(site, [- build(:pageview, user_id: 1, utm_campaign: "campaignA"),- build(:event,- user_id: 1,- name: "ButtonClick",- "meta.key": ["variant"],- "meta.value": ["A"]- ),- build(:pageview, user_id: 2, utm_campaign: "campaignA"),- build(:event,- user_id: 2,- name: "ButtonClick",- "meta.key": ["variant"],- "meta.value": ["B"]- )- ])-- insert(:goal, %{site: site, event_name: "ButtonClick"})-- filters =- Jason.encode!(%{- goal: "ButtonClick",- props: %{variant: "A"},- utm_campaign: "campaignA"- })-- prop_key = "variant"-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/#{prop_key}?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "A",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 50.0- }- ]- end-- test "Property breakdown with goal and source filter", %{conn: conn, site: site} do- populate_stats(site, [- build(:pageview, user_id: 1, referrer_source: "Google"),- build(:event,- user_id: 1,- name: "ButtonClick",- "meta.key": ["variant"],- "meta.value": ["A"]- ),- build(:pageview, user_id: 2, referrer_source: "Google"),- build(:pageview, user_id: 3, referrer_source: "ignore"),- build(:event,- user_id: 3,- name: "ButtonClick",- "meta.key": ["variant"],- "meta.value": ["B"]- )- ])-- insert(:goal, %{site: site, event_name: "ButtonClick"})-- filters =- Jason.encode!(%{- goal: "ButtonClick",- source: "Google"- })-- prop_key = "variant"-- conn =- get(- conn,- "/api/stats/#{site.domain}/property/#{prop_key}?period=day&filters=#{filters}"- )-- assert json_response(conn, 200) == [- %{- "name" => "A",- "unique_conversions" => 1,- "total_conversions" => 1,- "conversion_rate" => 50.0- }- ]- end- end-enddiff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exsindex 132072759a..41e69e0116 100644--- a/test/plausible_web/controllers/stats_controller_test.exs+++ b/test/plausible_web/controllers/stats_controller_test.exs@@ -145,7 +145,6 @@ defmodule PlausibleWeb.StatsControllerTest doassert 'exit_pages.csv' in zipassert 'operating_systems.csv' in zipassert 'pages.csv' in zip- assert 'prop_breakdown.csv' in zipassert 'regions.csv' in zipassert 'sources.csv' in zipassert 'utm_campaigns.csv' in zipdiff --git a/test/test_helper.exs b/test/test_helper.exsindex 72fb0e84eb..eac352c8dd 100644--- a/test/test_helper.exs+++ b/test/test_helper.exs@@ -2,6 +2,5 @@Mox.defmock(Plausible.HTTPClient.Mock, for: Plausible.HTTPClient.Interface)Application.ensure_all_started(:double)FunWithFlags.enable(:funnels)-FunWithFlags.enable(:props)Ecto.Adapters.SQL.Sandbox.mode(Plausible.Repo, :manual)ExUnit.configure(exclude: [:slow])