Props Settings UI to match Goals Settings (#3322)
* Add hint to creatable ComboBoxes without suggestions available
* Load external resources once in funnel settings
* Load external resources once in goal settings
* Make Custom Props Settings UI match Goal Settings
* Remove unnecessary goals query
This should be done only once in the live view
* Remove funnels feature flag
* fixup
* Make the modal scrollable
* By default, focus first suggestion for creatables
* Add sample props to seeds
* Load all suggestions asynchronously, unless `Mix.env == :test`
* ComboBox: Fix inconsistent suggestions
We require "Create ..." element to be only focused
when there are no suggestions available.
This causes some issues, depending on the state,
the least focusable index might be either 0 ("Create...")
or 1. This patch addresses all the quirks with focus.
* Fix ComboBox max results message
So that AlpineJS doesn't think it's a focusable
option.
* Keep the state up to date when changing props
* Update seeds with sensible prop names
* Make escape work for closing combobox suggestions
Co-authored-by: Uku Taht <Uku.taht@gmail.com>
* Revert "Make escape work for closing combobox suggestions"
This reverts commit 306866d2a1.
@ukutaht unfortunately this makes it impossible to select
an suggestion.
* Revert "Revert "Make escape work for closing combobox suggestions""
This reverts commit 4844857812.
* Make ESC great again
* Improve readability
---------
Co-authored-by: Uku Taht <Uku.taht@gmail.com>
pull/3341/head
parent
7cb2c6bfa3
commit
0822bc61df
@ -0,0 +1,159 @@
|
||||
defmodule PlausibleWeb.Live.PropsSettings.Form do
|
||||
@moduledoc """
|
||||
Live view for the custom props creation form
|
||||
"""
|
||||
use Phoenix.LiveView
|
||||
import PlausibleWeb.Live.Components.Form
|
||||
alias PlausibleWeb.Live.Components.ComboBox
|
||||
|
||||
def mount(
|
||||
_params,
|
||||
%{
|
||||
"site_id" => _site_id,
|
||||
"current_user_id" => user_id,
|
||||
"domain" => domain,
|
||||
"rendered_by" => pid
|
||||
},
|
||||
socket
|
||||
) do
|
||||
site = Plausible.Sites.get_for_user!(user_id, domain, [:owner, :admin, :super_admin])
|
||||
|
||||
form = new_form(site)
|
||||
|
||||
{:ok,
|
||||
assign(socket,
|
||||
form: form,
|
||||
domain: domain,
|
||||
rendered_by: pid,
|
||||
prop_key_options_count: 0,
|
||||
site: site
|
||||
)}
|
||||
end
|
||||
|
||||
def render(assigns) do
|
||||
~H"""
|
||||
<div
|
||||
class="fixed inset-0 bg-gray-500 bg-opacity-75 transition-opacity z-50"
|
||||
phx-window-keydown="cancel-allow-prop"
|
||||
phx-key="Escape"
|
||||
>
|
||||
</div>
|
||||
<div class="fixed inset-0 flex items-center justify-center mt-16 z-50 overflow-y-auto overflow-x-hidden">
|
||||
<div class="w-1/2 h-full">
|
||||
<.form
|
||||
:let={f}
|
||||
for={@form}
|
||||
class="max-w-md w-full mx-auto bg-white dark:bg-gray-800 shadow-md rounded px-8 pt-6 pb-8 mb-4 mt-8"
|
||||
phx-submit="allow-prop"
|
||||
phx-click-away="cancel-allow-prop"
|
||||
>
|
||||
<h2 class="text-xl font-black dark:text-gray-100">Add Property for <%= @domain %></h2>
|
||||
|
||||
<div class="py-2">
|
||||
<.label for="prop_input">
|
||||
Property
|
||||
</.label>
|
||||
|
||||
<.live_component
|
||||
id="prop_input"
|
||||
submit_name="prop"
|
||||
class={[
|
||||
"py-2"
|
||||
]}
|
||||
module={ComboBox}
|
||||
suggest_fun={
|
||||
pid = self()
|
||||
|
||||
fn
|
||||
"", [] ->
|
||||
options =
|
||||
@site
|
||||
|> Plausible.Props.suggest_keys_to_allow()
|
||||
|> Enum.map(&{&1, &1})
|
||||
|
||||
send(pid, {:update_prop_key_options_count, Enum.count(options)})
|
||||
|
||||
options
|
||||
|
||||
input, options ->
|
||||
ComboBox.StaticSearch.suggest(input, options)
|
||||
end
|
||||
}
|
||||
creatable
|
||||
/>
|
||||
|
||||
<.error :for={{msg, opts} <- f[:allowed_event_props].errors}>
|
||||
<%= Enum.reduce(opts, msg, fn {key, value}, acc ->
|
||||
String.replace(acc, "%{#{key}}", fn _ -> to_string(value) end)
|
||||
end) %>
|
||||
</.error>
|
||||
</div>
|
||||
|
||||
<div class="py-4">
|
||||
<button type="submit" class="button text-base font-bold w-full">
|
||||
Add Property →
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<button
|
||||
:if={@prop_key_options_count > 0}
|
||||
title="Use this to add any existing properties from your past events into your settings. This allows you to set up properties without having to manually enter each item."
|
||||
class="mt-2 text-sm hover:underline text-indigo-600 dark:text-indigo-400 text-left"
|
||||
phx-click="allow-existing-props"
|
||||
>
|
||||
Already sending custom properties? Click to add <%= @prop_key_options_count %> existing properties we found.
|
||||
</button>
|
||||
</.form>
|
||||
</div>
|
||||
</div>
|
||||
"""
|
||||
end
|
||||
|
||||
def handle_info({:update_prop_key_options_count, count}, socket) do
|
||||
{:noreply, assign(socket, prop_key_options_count: count)}
|
||||
end
|
||||
|
||||
def handle_info({:selection_made, %{submit_value: _prop}}, socket) do
|
||||
{:noreply, socket}
|
||||
end
|
||||
|
||||
def handle_event("allow-prop", %{"prop" => prop}, socket) do
|
||||
case Plausible.Props.allow(socket.assigns.site, prop) do
|
||||
{:ok, site} ->
|
||||
send(socket.assigns.rendered_by, {:prop_allowed, prop})
|
||||
|
||||
{:noreply,
|
||||
assign(socket,
|
||||
site: site,
|
||||
form: new_form(site)
|
||||
)}
|
||||
|
||||
{:error, changeset} ->
|
||||
{:noreply,
|
||||
assign(socket,
|
||||
form: to_form(Map.put(changeset, :action, :validate))
|
||||
)}
|
||||
end
|
||||
end
|
||||
|
||||
def handle_event("allow-existing-props", _params, socket) do
|
||||
{:ok, site} = Plausible.Props.allow_existing_props(socket.assigns.site)
|
||||
send(socket.assigns.rendered_by, {:props_allowed, site.allowed_event_props})
|
||||
|
||||
{:noreply,
|
||||
assign(socket,
|
||||
site: site,
|
||||
form: new_form(site),
|
||||
prop_key_options_count: 0
|
||||
)}
|
||||
end
|
||||
|
||||
def handle_event("cancel-allow-prop", _value, socket) do
|
||||
send(socket.assigns.rendered_by, :cancel_add_prop)
|
||||
{:noreply, socket}
|
||||
end
|
||||
|
||||
defp new_form(site) do
|
||||
to_form(Plausible.Props.allow_changeset(site, []))
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,100 @@
|
||||
defmodule PlausibleWeb.Live.PropsSettings.List do
|
||||
@moduledoc """
|
||||
Phoenix LiveComponent module that renders a list of custom properties
|
||||
"""
|
||||
use Phoenix.LiveComponent
|
||||
use Phoenix.HTML
|
||||
|
||||
use Plausible.Funnel
|
||||
|
||||
attr(:props, :list, required: true)
|
||||
attr(:domain, :string, required: true)
|
||||
attr(:filter_text, :string)
|
||||
|
||||
def render(assigns) do
|
||||
~H"""
|
||||
<div>
|
||||
<div class="border-t border-gray-200 pt-4 sm:flex sm:items-center sm:justify-between">
|
||||
<form id="filter-form" phx-change="filter">
|
||||
<div class="text-gray-800 text-sm inline-flex items-center">
|
||||
<div class="relative mt-2 rounded-md shadow-sm flex">
|
||||
<div class="pointer-events-none absolute inset-y-0 left-0 flex items-center pl-3">
|
||||
<Heroicons.magnifying_glass class="feather mr-1 dark:text-gray-300" />
|
||||
</div>
|
||||
<input
|
||||
type="text"
|
||||
name="filter-text"
|
||||
id="filter-text"
|
||||
class="pl-8 shadow-sm dark:bg-gray-900 dark:text-gray-300 focus:ring-indigo-500 focus:border-indigo-500 block w-full sm:text-sm border-gray-300 dark:border-gray-500 rounded-md dark:bg-gray-800"
|
||||
placeholder="Search Properties"
|
||||
value={@filter_text}
|
||||
/>
|
||||
</div>
|
||||
|
||||
<Heroicons.backspace
|
||||
:if={String.trim(@filter_text) != ""}
|
||||
class="feather ml-2 cursor-pointer hover:text-red-500 dark:text-gray-300 dark:hover:text-red-500 mt-2"
|
||||
phx-click="reset-filter-text"
|
||||
id="reset-filter"
|
||||
/>
|
||||
</div>
|
||||
</form>
|
||||
<div class="mt-4 flex sm:ml-4 sm:mt-0">
|
||||
<button
|
||||
type="button"
|
||||
phx-click="add-prop"
|
||||
class="mt-2 block items-center rounded-md bg-indigo-600 p-2 text-sm font-semibold text-white shadow-sm hover:bg-indigo-500 focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-indigo-600"
|
||||
>
|
||||
+ Add Property
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
<%= if is_list(@props) && length(@props) > 0 do %>
|
||||
<ul id="allowed-props" class="mt-12 divide-gray-200 divide-y dark:divide-gray-600">
|
||||
<li :for={{prop, index} <- Enum.with_index(@props)} id={"prop-#{index}"} class="flex py-4">
|
||||
<span class="flex-1 truncate font-medium text-sm text-gray-800 dark:text-gray-200">
|
||||
<%= prop %>
|
||||
</span>
|
||||
<button
|
||||
id={"disallow-prop-#{prop}"}
|
||||
data-confirm={delete_confirmation_text(prop)}
|
||||
phx-click="disallow-prop"
|
||||
phx-value-prop={prop}
|
||||
class="w-4 h-4 text-red-600 hover:text-red-700"
|
||||
aria-label={"Remove #{prop} property"}
|
||||
>
|
||||
<Heroicons.trash class="feather feather-sm" />
|
||||
</button>
|
||||
</li>
|
||||
</ul>
|
||||
<% else %>
|
||||
<p class="text-sm text-gray-800 dark:text-gray-200 mt-12 mb-8 text-center">
|
||||
<span :if={String.trim(@filter_text) != ""}>
|
||||
No properties found for this site. Please refine or
|
||||
<a
|
||||
class="text-indigo-500 cursor-pointer underline"
|
||||
phx-click="reset-filter-text"
|
||||
id="reset-filter-hint"
|
||||
>
|
||||
reset your search.
|
||||
</a>
|
||||
</span>
|
||||
<span :if={String.trim(@filter_text) == "" && Enum.empty?(@props)}>
|
||||
No properties configured for this site.
|
||||
</span>
|
||||
</p>
|
||||
<% end %>
|
||||
</div>
|
||||
"""
|
||||
end
|
||||
|
||||
defp delete_confirmation_text(prop) do
|
||||
"""
|
||||
Are you sure you want to remove the following property:
|
||||
|
||||
#{prop}
|
||||
|
||||
This will just affect the UI, all of your analytics data will stay intact.
|
||||
"""
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,156 @@
|
||||
defmodule PlausibleWeb.Live.PropsSettings.FormTest do
|
||||
use PlausibleWeb.ConnCase, async: true
|
||||
import Phoenix.LiveViewTest
|
||||
import Plausible.Test.Support.HTML
|
||||
|
||||
describe "Props submission" do
|
||||
setup [:create_user, :log_in, :create_site]
|
||||
|
||||
test "renders form fields", %{conn: conn, site: site} do
|
||||
lv = get_liveview(conn, site)
|
||||
html = render(lv)
|
||||
|
||||
assert element_exists?(html, "form input[type=text][name=display-prop_input]")
|
||||
assert element_exists?(html, "form input[type=hidden][name=prop]")
|
||||
end
|
||||
|
||||
test "renders error on empty submission", %{conn: conn, site: site} do
|
||||
lv = get_liveview(conn, site)
|
||||
html = lv |> element("form") |> render_submit()
|
||||
assert html =~ "must be between 1 and 300 characters"
|
||||
end
|
||||
|
||||
test "renders error on whitespace submission", %{conn: conn, site: site} do
|
||||
lv = get_liveview(conn, site)
|
||||
html = lv |> element("form") |> render_submit(%{prop: " "})
|
||||
assert html =~ "must be between 1 and 300 characters"
|
||||
end
|
||||
|
||||
test "renders 'Create' suggestion", %{conn: conn, site: site} do
|
||||
lv = get_liveview(conn, site)
|
||||
type_into_combo(lv, "#prop_input", "Hello world")
|
||||
html = render(lv)
|
||||
assert text_of_element(html, "#dropdown-prop_input-option-0 a") == ~s/Create "Hello world"/
|
||||
end
|
||||
|
||||
test "clicking suggestion fills out input", %{conn: conn, site: site} = context do
|
||||
seed_props(context)
|
||||
lv = get_liveview(conn, site)
|
||||
type_into_combo(lv, "#prop_input", "amo")
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> element(~s/ul#dropdown-prop_input li#dropdown-prop_input-option-1 a/)
|
||||
|> render_click()
|
||||
|
||||
assert element_exists?(doc, ~s/input[type="hidden"][value="amount"]/)
|
||||
end
|
||||
|
||||
test "allowing a single property", %{conn: conn, site: site} do
|
||||
{parent, lv} = get_liveview(conn, site, with_parent?: true)
|
||||
refute render(parent) =~ "foobarbaz"
|
||||
lv |> element("form") |> render_submit(%{prop: "foobarbaz"})
|
||||
parent_html = render(parent)
|
||||
assert text_of_element(parent_html, "#prop-0") == "foobarbaz"
|
||||
|
||||
site = Plausible.Repo.reload!(site)
|
||||
assert site.allowed_event_props == ["foobarbaz"]
|
||||
end
|
||||
|
||||
test "allowing existing properties", %{conn: conn, site: site} = context do
|
||||
seed_props(context)
|
||||
{parent, lv} = get_liveview(conn, site, with_parent?: true)
|
||||
parent_html = render(parent)
|
||||
refute element_exists?(parent_html, "#prop-0")
|
||||
refute element_exists?(parent_html, "#prop-1")
|
||||
refute element_exists?(parent_html, "#prop-2")
|
||||
|
||||
lv
|
||||
|> element(~s/button[phx-click="allow-existing-props"]/)
|
||||
|> render_click()
|
||||
|
||||
parent_html = render(parent)
|
||||
assert text_of_element(parent_html, "#prop-0") == "amount"
|
||||
assert text_of_element(parent_html, "#prop-1") == "logged_in"
|
||||
assert text_of_element(parent_html, "#prop-2") == "is_customer"
|
||||
|
||||
site = Plausible.Repo.reload!(site)
|
||||
assert site.allowed_event_props == ["amount", "logged_in", "is_customer"]
|
||||
end
|
||||
|
||||
test "does not show allow existing props button when there are no events with props", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
lv = get_liveview(conn, site)
|
||||
refute element_exists?(render(lv), ~s/button[phx-click="allow-existing-props"]/)
|
||||
end
|
||||
|
||||
test "does not show allow existing props button after adding all suggestions",
|
||||
%{
|
||||
conn: conn,
|
||||
site: site
|
||||
} = context do
|
||||
seed_props(context)
|
||||
|
||||
conn
|
||||
|> get_liveview(site)
|
||||
|> element(~s/button[phx-click="allow-existing-props"]/)
|
||||
|> render_click()
|
||||
|
||||
site = Plausible.Repo.reload!(site)
|
||||
assert site.allowed_event_props == ["amount", "logged_in", "is_customer"]
|
||||
|
||||
html =
|
||||
conn
|
||||
|> get_liveview(site)
|
||||
|> render()
|
||||
|
||||
refute element_exists?(html, ~s/button[phx-click="allow-existing-props"]/)
|
||||
end
|
||||
end
|
||||
|
||||
defp seed_props(%{site: site}) do
|
||||
populate_stats(site, [
|
||||
build(:event,
|
||||
name: "Payment",
|
||||
"meta.key": ["amount"],
|
||||
"meta.value": ["500"]
|
||||
),
|
||||
build(:event,
|
||||
name: "Payment",
|
||||
"meta.key": ["amount", "logged_in"],
|
||||
"meta.value": ["100", "false"]
|
||||
),
|
||||
build(:event,
|
||||
name: "Payment",
|
||||
"meta.key": ["amount", "is_customer"],
|
||||
"meta.value": ["100", "false"]
|
||||
)
|
||||
])
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
defp get_liveview(conn, site, opts \\ []) do
|
||||
conn = assign(conn, :live_module, PlausibleWeb.Live.PropsSettings)
|
||||
{:ok, lv, _html} = live(conn, "/#{site.domain}/settings/properties")
|
||||
lv |> element(~s/button[phx-click="add-prop"]/) |> render_click()
|
||||
assert form_view = find_live_child(lv, "props-form")
|
||||
|
||||
if opts[:with_parent?] do
|
||||
{lv, form_view}
|
||||
else
|
||||
form_view
|
||||
end
|
||||
end
|
||||
|
||||
defp type_into_combo(lv, id, text) do
|
||||
lv
|
||||
|> element("input##{id}")
|
||||
|> render_change(%{
|
||||
"_target" => ["display-#{id}"],
|
||||
"display-#{id}" => "#{text}"
|
||||
})
|
||||
end
|
||||
end
|
||||
@ -1,202 +1,177 @@
|
||||
defmodule PlausibleWeb.Live.PropsSettings.FormTest do
|
||||
defmodule PlausibleWeb.Live.PropsSettingsTest do
|
||||
use PlausibleWeb.ConnCase, async: true
|
||||
import Phoenix.LiveViewTest
|
||||
import Plausible.Test.Support.HTML
|
||||
|
||||
defp seed(%{site: site}) do
|
||||
populate_stats(site, [
|
||||
build(:event,
|
||||
name: "Payment",
|
||||
"meta.key": ["amount"],
|
||||
"meta.value": ["500"]
|
||||
),
|
||||
build(:event,
|
||||
name: "Payment",
|
||||
"meta.key": ["amount", "logged_in"],
|
||||
"meta.value": ["100", "false"]
|
||||
),
|
||||
build(:event,
|
||||
name: "Payment",
|
||||
"meta.key": ["amount", "is_customer"],
|
||||
"meta.value": ["100", "false"]
|
||||
)
|
||||
])
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
setup [:create_user, :log_in, :create_site, :seed]
|
||||
|
||||
test "shows message when site has no allowed properties", %{conn: conn, site: site} do
|
||||
{:ok, _lv, doc} = get_liveview(conn, site)
|
||||
assert doc =~ "No properties configured for this site yet"
|
||||
end
|
||||
|
||||
test "renders dropdown with suggestions", %{conn: conn, site: site} do
|
||||
{:ok, _lv, doc} = get_liveview(conn, site)
|
||||
|
||||
assert text_of_element(doc, ~s/ul#dropdown-prop_input li#dropdown-prop_input-option-1/) ==
|
||||
"amount"
|
||||
|
||||
assert text_of_element(doc, ~s/ul#dropdown-prop_input li#dropdown-prop_input-option-2/) ==
|
||||
"logged_in"
|
||||
|
||||
assert text_of_element(doc, ~s/ul#dropdown-prop_input li#dropdown-prop_input-option-3/) ==
|
||||
"is_customer"
|
||||
end
|
||||
|
||||
test "input is a required field", %{conn: conn, site: site} do
|
||||
{:ok, _lv, doc} = get_liveview(conn, site)
|
||||
assert element_exists?(doc, ~s/input#prop_input[required]/)
|
||||
end
|
||||
|
||||
test "clicking suggestion fills out input", %{conn: conn, site: site} do
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
describe "GET /:website/settings/properties" do
|
||||
setup [:create_user, :log_in, :create_site]
|
||||
|
||||
test "lists props for the site and renders links", %{conn: conn, site: site} do
|
||||
{:ok, site} = Plausible.Props.allow(site, ["amount", "logged_in", "is_customer"])
|
||||
conn = get(conn, "/#{site.domain}/settings/properties")
|
||||
|
||||
resp = html_response(conn, 200)
|
||||
assert resp =~ "Attach Custom Properties"
|
||||
|
||||
assert element_exists?(
|
||||
resp,
|
||||
~s|a[href="https://plausible.io/docs/custom-props/introduction"]|
|
||||
)
|
||||
|
||||
assert resp =~ "amount"
|
||||
assert resp =~ "logged_in"
|
||||
assert resp =~ "is_customer"
|
||||
end
|
||||
|
||||
test "lists props with disallow actions", %{conn: conn, site: site} do
|
||||
{:ok, site} = Plausible.Props.allow(site, ["amount", "logged_in", "is_customer"])
|
||||
conn = get(conn, "/#{site.domain}/settings/properties")
|
||||
resp = html_response(conn, 200)
|
||||
|
||||
for p <- site.allowed_event_props do
|
||||
assert element_exists?(
|
||||
resp,
|
||||
~s/button[phx-click="disallow-prop"][phx-value-prop=#{p}]#disallow-prop-#{p}/
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> element(~s/ul#dropdown-prop_input li#dropdown-prop_input-option-1 a/)
|
||||
|> render_click()
|
||||
|
||||
assert element_exists?(doc, ~s/input[type="hidden"][value="amount"]/)
|
||||
end
|
||||
test "if no props are allowed, a proper info is displayed", %{conn: conn, site: site} do
|
||||
conn = get(conn, "/#{site.domain}/settings/properties")
|
||||
resp = html_response(conn, 200)
|
||||
assert resp =~ "No properties configured for this site"
|
||||
end
|
||||
|
||||
test "saving from suggestion adds to the list", %{conn: conn, site: site} do
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
test "if props are enabled, no info about missing props is displayed", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
{:ok, site} = Plausible.Props.allow(site, ["amount", "logged_in", "is_customer"])
|
||||
conn = get(conn, "/#{site.domain}/settings/properties")
|
||||
resp = html_response(conn, 200)
|
||||
refute resp =~ "No properties configured for this site"
|
||||
end
|
||||
|
||||
doc = select_and_submit(lv, 1)
|
||||
test "add property button is rendered", %{conn: conn, site: site} do
|
||||
conn = get(conn, "/#{site.domain}/settings/properties")
|
||||
resp = html_response(conn, 200)
|
||||
assert element_exists?(resp, ~s/button[phx-click="add-prop"]/)
|
||||
end
|
||||
|
||||
assert text_of_element(doc, ~s/ul#allowed-props li#prop-0 span/) == "amount"
|
||||
refute doc =~ "No properties configured for this site yet"
|
||||
test "search props input is rendered", %{conn: conn, site: site} do
|
||||
conn = get(conn, "/#{site.domain}/settings/properties")
|
||||
resp = html_response(conn, 200)
|
||||
assert element_exists?(resp, ~s/input[type="text"]#filter-text/)
|
||||
assert element_exists?(resp, ~s/form[phx-change="filter"]#filter-form/)
|
||||
end
|
||||
end
|
||||
|
||||
test "saving from manual input adds to the list", %{conn: conn, site: site} do
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
|
||||
type_into_combo(lv, "Operating System")
|
||||
# validating input
|
||||
# clicking suggestions fills out input
|
||||
# adding props
|
||||
# error when reached props limit
|
||||
# clearserror when fixed input
|
||||
# removal
|
||||
# removal shows confirmation
|
||||
# allow existing props: shows/hides
|
||||
# after adding all suggestions no allow existing props
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> form("#props-form")
|
||||
|> render_submit()
|
||||
describe "PropsSettings live view" do
|
||||
setup [:create_user, :log_in, :create_site]
|
||||
|
||||
assert text_of_element(doc, ~s/ul#allowed-props li#prop-0 span/) == "Operating System"
|
||||
refute doc =~ "No properties configured for this site yet"
|
||||
end
|
||||
test "allows prop removal", %{conn: conn, site: site} do
|
||||
{:ok, site} = Plausible.Props.allow(site, ["amount", "logged_in"])
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
|
||||
test "shows error when input is invalid", %{conn: conn, site: site} do
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
assert html =~ "amount"
|
||||
assert html =~ "logged_in"
|
||||
|
||||
type_into_combo(lv, " ")
|
||||
doc = lv |> form("#props-form") |> render_submit()
|
||||
html = lv |> element(~s/button#disallow-prop-amount/) |> render_click()
|
||||
|
||||
assert text_of_element(doc, ~s/div#prop-errors div/) == "must be between 1 and 300 characters"
|
||||
assert doc =~ "No properties configured for this site yet"
|
||||
end
|
||||
refute html =~ "amount"
|
||||
assert html =~ "logged_in"
|
||||
|
||||
test "shows error when reached prop limit", %{conn: conn, site: site} do
|
||||
props = for i <- 1..300, do: "my-prop-#{i}"
|
||||
{:ok, site} = Plausible.Props.allow(site, props)
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
html = get(conn, "/#{site.domain}/settings/properties") |> html_response(200)
|
||||
|
||||
type_into_combo(lv, "my-prop-301")
|
||||
doc = lv |> form("#props-form") |> render_submit()
|
||||
refute html =~ "amount"
|
||||
assert html =~ "logged_in"
|
||||
end
|
||||
|
||||
assert text_of_element(doc, ~s/div#prop-errors div/) == "should have at most 300 item(s)"
|
||||
end
|
||||
test "allows props filtering / search", %{conn: conn, site: site} do
|
||||
{:ok, site} = Plausible.Props.allow(site, ["amount", "logged_in", "is_customer"])
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
|
||||
test "clears error message when user fixes input", %{conn: conn, site: site} do
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
assert html =~ to_string("amount")
|
||||
assert html =~ to_string("logged_in")
|
||||
assert html =~ to_string("is_customer")
|
||||
|
||||
type_into_combo(lv, " ")
|
||||
doc = lv |> form("#props-form") |> render_submit()
|
||||
assert text_of_element(doc, ~s/div#prop-errors div/) == "must be between 1 and 300 characters"
|
||||
html = type_into_search(lv, "is_customer")
|
||||
|
||||
type_into_combo(lv, "my-prop")
|
||||
doc = lv |> form("#props-form") |> render_submit()
|
||||
refute element_exists?(doc, ~s/div#prop-errors/)
|
||||
end
|
||||
refute html =~ to_string("amount")
|
||||
refute html =~ to_string("logged_in")
|
||||
assert html =~ to_string("is_customer")
|
||||
end
|
||||
|
||||
test "clicking remove button removes from the list", %{conn: conn, site: site} do
|
||||
{:ok, site} = Plausible.Props.allow(site, "my-prop")
|
||||
{:ok, lv, doc} = get_liveview(conn, site)
|
||||
test "allows resetting filter text via backspace icon", %{conn: conn, site: site} do
|
||||
{:ok, site} = Plausible.Props.allow(site, ["amount", "logged_in", "is_customer"])
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
|
||||
assert text_of_element(doc, ~s/ul#allowed-props li#prop-0 span/) == "my-prop"
|
||||
refute element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/)
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> element(~s/ul#allowed-props li#prop-0 button[phx-click="disallow"]/)
|
||||
|> render_click()
|
||||
html = type_into_search(lv, to_string("is_customer"))
|
||||
|
||||
refute element_exists?(doc, ~s/ul#allowed-props li#prop-0 span/)
|
||||
assert doc =~ "No properties configured for this site yet"
|
||||
end
|
||||
assert element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/)
|
||||
|
||||
test "remove button shows a confirmation popup", %{conn: conn, site: site} do
|
||||
{:ok, site} = Plausible.Props.allow(site, "my-prop")
|
||||
{:ok, _lv, doc} = get_liveview(conn, site)
|
||||
html = lv |> element(~s/svg#reset-filter/) |> render_click()
|
||||
|
||||
assert "Are you sure you want to remove property 'my-prop'? This will just affect the UI, all of your analytics data will stay intact." ==
|
||||
doc
|
||||
|> Floki.find(~s/ul#allowed-props li#prop-0 button[phx-click="disallow"]/)
|
||||
|> text_of_attr("data-confirm")
|
||||
end
|
||||
assert html =~ to_string("is_customer")
|
||||
assert html =~ to_string("amount")
|
||||
assert html =~ to_string("logged_in")
|
||||
end
|
||||
|
||||
test "clicking allow existing props button saves props from events", %{conn: conn, site: site} do
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
test "allows resetting filter text via no match link", %{conn: conn, site: site} do
|
||||
lv = get_liveview(conn, site)
|
||||
html = type_into_search(lv, "Definitely this is not going to render any matches")
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> element(~s/button[phx-click="allow-existing-props"]/)
|
||||
|> render_click()
|
||||
assert html =~ "No properties found for this site. Please refine or"
|
||||
assert html =~ "reset your search"
|
||||
|
||||
assert text_of_element(doc, ~s/ul#allowed-props li#prop-0 span/) == "amount"
|
||||
assert text_of_element(doc, ~s/ul#allowed-props li#prop-1 span/) == "logged_in"
|
||||
assert text_of_element(doc, ~s/ul#allowed-props li#prop-2 span/) == "is_customer"
|
||||
end
|
||||
assert element_exists?(html, ~s/a[phx-click="reset-filter-text"]#reset-filter-hint/)
|
||||
html = lv |> element(~s/a#reset-filter-hint/) |> render_click()
|
||||
|
||||
test "does not show allow existing props button when there are no events with props", %{
|
||||
conn: conn,
|
||||
user: user
|
||||
} do
|
||||
{:ok, _lv, doc} = get_liveview(conn, insert(:site, members: [user]))
|
||||
refute element_exists?(doc, ~s/button[phx-click="allow-existing-props"]/)
|
||||
end
|
||||
refute html =~ "No properties found for this site. Please refine or"
|
||||
end
|
||||
|
||||
test "does not show allow existing props button after adding all suggestions", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
{:ok, lv, _doc} = get_liveview(conn, site)
|
||||
test "clicking Add Property button renders the form view", %{conn: conn, site: site} do
|
||||
lv = get_liveview(conn, site)
|
||||
html = lv |> element(~s/button[phx-click="add-prop"]/) |> render_click()
|
||||
|
||||
_doc = select_and_submit(lv, 1)
|
||||
_doc = select_and_submit(lv, 1)
|
||||
doc = select_and_submit(lv, 1)
|
||||
assert html =~ "Add Property for #{site.domain}"
|
||||
|
||||
refute element_exists?(doc, ~s/button[phx-click="allow-existing-props"]/)
|
||||
assert element_exists?(
|
||||
html,
|
||||
~s/div#props-form form[phx-submit="allow-prop"][phx-click-away="cancel-allow-prop"]/
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
defp get_liveview(conn, site) do
|
||||
defp get_liveview(conn, site, opts \\ []) do
|
||||
conn = assign(conn, :live_module, PlausibleWeb.Live.PropsSettings)
|
||||
{:ok, _lv, _doc} = live(conn, "/#{site.domain}/settings/properties")
|
||||
end
|
||||
{:ok, lv, html} = live(conn, "/#{site.domain}/settings/properties")
|
||||
|
||||
defp select_and_submit(lv, suggestion_index) do
|
||||
lv
|
||||
|> element(~s/ul#dropdown-prop_input li#dropdown-prop_input-option-#{suggestion_index} a/)
|
||||
|> render_click()
|
||||
|
||||
lv
|
||||
|> form("#props-form")
|
||||
|> render_submit()
|
||||
if Keyword.get(opts, :with_html?) do
|
||||
{lv, html}
|
||||
else
|
||||
lv
|
||||
end
|
||||
end
|
||||
|
||||
defp type_into_combo(lv, input) do
|
||||
defp type_into_search(lv, text) do
|
||||
lv
|
||||
|> element("input#prop_input")
|
||||
|> element("form#filter-form")
|
||||
|> render_change(%{
|
||||
"_target" => ["display-prop_input"],
|
||||
"display-prop_input" => input
|
||||
"_target" => ["filter-text"],
|
||||
"filter-text" => "#{text}"
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
Loading…
Reference in New Issue