From 1fedaf18c3e2114e076b058d6db3fcc71176a02e Mon Sep 17 00:00:00 2001 From: Vini Brasil Date: Sat, 5 Aug 2023 10:35:31 -0300 Subject: [PATCH] Remove allowed props list from dashboard data attribute (#3230) This commit removes the allowed props list from the data attribute passed to React. The list was used for checking whether props configured or not. This commit adds a new `hasProps` attribute, and removes the list. --- assets/js/dashboard/mount.js | 2 +- assets/js/dashboard/stats/behaviours/index.js | 4 ++-- lib/plausible/props.ex | 7 +++++++ lib/plausible_web/controllers/stats_controller.ex | 4 ++-- lib/plausible_web/templates/stats/stats.html.eex | 2 +- test/plausible/props_test.exs | 11 +++++++++++ 6 files changed, 24 insertions(+), 6 deletions(-) diff --git a/assets/js/dashboard/mount.js b/assets/js/dashboard/mount.js index fb4751257..f135ed3df 100644 --- a/assets/js/dashboard/mount.js +++ b/assets/js/dashboard/mount.js @@ -19,8 +19,8 @@ if (container) { conversionsEnabled: container.dataset.conversionsEnabled === 'true', funnelsEnabled: container.dataset.funnelsEnabled === 'true', propsEnabled: container.dataset.propsEnabled === 'true', + hasProps: container.dataset.hasProps === 'true', funnels: JSON.parse(container.dataset.funnels), - allowedEventProps: JSON.parse(container.dataset.allowedEventProps), statsBegin: container.dataset.statsBegin, nativeStatsBegin: container.dataset.nativeStatsBegin, embedded: container.dataset.embedded, diff --git a/assets/js/dashboard/stats/behaviours/index.js b/assets/js/dashboard/stats/behaviours/index.js index 913a39743..cccf0bc59 100644 --- a/assets/js/dashboard/stats/behaviours/index.js +++ b/assets/js/dashboard/stats/behaviours/index.js @@ -166,8 +166,8 @@ export default function Behaviours(props) { } function renderProps() { - if (site.allowedEventProps && site.allowedEventProps.length > 0) { - return + if (site.hasProps) { + return } else if (adminAccess) { return ( 0 + end end diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex index ca5035eea..19087125e 100644 --- a/lib/plausible_web/controllers/stats_controller.ex +++ b/lib/plausible_web/controllers/stats_controller.ex @@ -65,7 +65,7 @@ defmodule PlausibleWeb.StatsController do site: site, has_goals: Plausible.Sites.has_goals?(site), funnels: Plausible.Funnels.list(site), - allowed_event_props: site.allowed_event_props, + has_props: Plausible.Props.configured?(site), stats_start_date: stats_start_date, native_stats_start_date: NaiveDateTime.to_date(site.native_stats_start_at), title: title(conn, site), @@ -309,7 +309,7 @@ defmodule PlausibleWeb.StatsController do site: shared_link.site, has_goals: Sites.has_goals?(shared_link.site), funnels: Plausible.Funnels.list(shared_link.site), - allowed_event_props: shared_link.site.allowed_event_props, + has_props: Plausible.Props.configured?(shared_link.site), stats_start_date: shared_link.site.stats_start_date, native_stats_start_date: NaiveDateTime.to_date(shared_link.site.native_stats_start_at), title: title(conn, shared_link.site), diff --git a/lib/plausible_web/templates/stats/stats.html.eex b/lib/plausible_web/templates/stats/stats.html.eex index a8f896fcd..973a91288 100644 --- a/lib/plausible_web/templates/stats/stats.html.eex +++ b/lib/plausible_web/templates/stats/stats.html.eex @@ -22,7 +22,7 @@ data-funnels-enabled="<%= @site.funnels_enabled %>" data-props-enabled="<%= @site.props_enabled %>" data-funnels="<%= Jason.encode!(@funnels) %>" - data-allowed-event-props="<%= Jason.encode!(@allowed_event_props) %>" + data-has-props="<%= @has_props %>" data-logged-in="<%= !!@conn.assigns[:current_user] %>" data-stats-begin="<%= @stats_start_date %>" data-native-stats-begin="<%= @native_stats_start_date %>" diff --git a/test/plausible/props_test.exs b/test/plausible/props_test.exs index e9a028d69..e488ecdba 100644 --- a/test/plausible/props_test.exs +++ b/test/plausible/props_test.exs @@ -241,4 +241,15 @@ defmodule Plausible.PropsTest do assert ["first_time_customer", "logged_in", "with_error"] == site |> Plausible.Props.suggest_keys_to_allow() |> Enum.sort() end + + test "configured?/1 returns whether the site has allow at least one prop" do + site = insert(:site) + refute Plausible.Props.configured?(site) + + {:ok, site} = Plausible.Props.allow(site, "hello-world") + assert Plausible.Props.configured?(site) + + {:ok, site} = Plausible.Props.disallow(site, "hello-world") + refute Plausible.Props.configured?(site) + end end