Add small build option (#3536)
* Update applications * Clone community config * Move modules to experimental dir * Update runtime config * Apply first set of compile-time conditionals * Move funnel schemas to experimental * Make funnel schema-less build compile * Use experimental/lib for elixir code * Move JS funnels to experimental * Clean up conditional rendering * Tidy up the pipeline * Make two builds pass tests without warnings * Reuse existing dotenvs * Do a bunch of renames * Clean up naming * Run secondary CI * Update router * Remove RewriteFunnelDupes migration Tests were disabled already and it was a one-off shot * Fixup quota mixins * Add moduledoc * Change MIX_ENV for seconary test run * Skip crm on small * !fixup * Exclude flags pipeline * Update lib/plausible_web/controllers/stats_controller.ex Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> --------- Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>pull/3537/head r2023.11.20-255
parent
2512f3cbe2
commit
b9ec38038c
@ -0,0 +1,11 @@
|
||||
import Config
|
||||
|
||||
import_config "dev.exs"
|
||||
|
||||
config :esbuild,
|
||||
default: [
|
||||
args:
|
||||
~w(js/app.js js/dashboard.js js/embed.host.js js/embed.content.js --bundle --target=es2017 --loader:.js=jsx --outdir=../priv/static/js --define:BUILD_EXTRA=false),
|
||||
cd: Path.expand("../assets", __DIR__),
|
||||
env: %{"NODE_PATH" => Path.expand("../deps", __DIR__)}
|
||||
]
|
||||
@ -0,0 +1,3 @@
|
||||
import Config
|
||||
|
||||
import_config "test.exs"
|
||||
@ -1,9 +1,46 @@
|
||||
defmodule Plausible do
|
||||
@moduledoc """
|
||||
Plausible keeps the contexts that define your domain
|
||||
and business logic.
|
||||
|
||||
Contexts are also responsible for managing your data, regardless
|
||||
if it comes from the database, an external API or others.
|
||||
Build-related macros
|
||||
"""
|
||||
|
||||
@small_builds [:small, :small_test]
|
||||
|
||||
defmacro __using__(_) do
|
||||
quote do
|
||||
require Plausible
|
||||
import Plausible
|
||||
end
|
||||
end
|
||||
|
||||
defmacro on_small_build(do: block) do
|
||||
if Mix.env() in @small_builds do
|
||||
quote do
|
||||
unquote(block)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defmacro on_full_build(do: block) do
|
||||
if Mix.env() not in @small_builds do
|
||||
quote do
|
||||
unquote(block)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defmacro full_build?() do
|
||||
full_build? = Mix.env() not in @small_builds
|
||||
|
||||
quote do
|
||||
unquote(full_build?)
|
||||
end
|
||||
end
|
||||
|
||||
defmacro small_build?() do
|
||||
small_build? = Mix.env() in @small_builds
|
||||
|
||||
quote do
|
||||
unquote(small_build?)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@ -1,191 +0,0 @@
|
||||
defmodule Plausible.DataMigration.RewriteFunnelDupes do
|
||||
@moduledoc """
|
||||
A data fix migration that seeks funnels having steps
|
||||
whose goals are equally named.
|
||||
It then tries to rewrite the duplicate goals using the
|
||||
oldest goal available. In extreme cases, e.g. when multiple
|
||||
duplicates are found for a single funnel, it will either
|
||||
reduce or completely remove the funnel.
|
||||
This enables us to run a migration later on that will
|
||||
delete duplicate goals and enforce goal uniqueness at the
|
||||
database level via a CHECK constraint.
|
||||
|
||||
To run, just call the `run` function.
|
||||
"""
|
||||
use Plausible.DataMigration, dir: "FunnelDupeGoals", repo: Plausible.Repo
|
||||
import Ecto.Query
|
||||
|
||||
def run(_ \\ []) do
|
||||
{:ok, %{rows: rows}} = run_sql("list-funnels-with-dupe-goal-ids")
|
||||
data = Enum.map(rows, &to_map/1)
|
||||
|
||||
by_site_id = Enum.group_by(data, & &1.site_id)
|
||||
|
||||
Enum.into(by_site_id, %{}, fn {site_id, data} ->
|
||||
site_meta =
|
||||
%{}
|
||||
|> Map.put(:domain, List.first(data).domain)
|
||||
|> Map.put(:site_id, site_id)
|
||||
|> Map.put(
|
||||
:changes,
|
||||
Enum.map(
|
||||
data,
|
||||
fn d ->
|
||||
%{
|
||||
site_id: site_id,
|
||||
og_goal_id: d.goal_id,
|
||||
goal_name: d.goal_name,
|
||||
funnel_name: d.funnel_name,
|
||||
funnel_id: d.funnel_id,
|
||||
funnel_step_id: d.funnel_step_id,
|
||||
to: Enum.min(d.dupe_goal_ids),
|
||||
og_steps_count: length(d.all_goal_ids)
|
||||
}
|
||||
end
|
||||
)
|
||||
|> Enum.group_by(& &1.funnel_id)
|
||||
)
|
||||
|
||||
{site_id, site_meta}
|
||||
end)
|
||||
|> translate_to_db_ops()
|
||||
|> execute()
|
||||
end
|
||||
|
||||
def execute(data) do
|
||||
Plausible.Repo.transaction(fn ->
|
||||
for {site_id, meta} <- data do
|
||||
IO.puts("\n\nProcessing site ID: #{site_id} (#{meta.domain}):")
|
||||
|
||||
for {funnel_id, changes} <- meta.changes do
|
||||
IO.puts(
|
||||
"\nProcessing changes for funnel ID: #{funnel_id} - '#{Enum.at(changes, 0).funnel_name}'"
|
||||
)
|
||||
|
||||
Enum.each(changes, fn change ->
|
||||
apply_change(funnel_id, change)
|
||||
end)
|
||||
end
|
||||
|
||||
IO.puts("\nFinished processing site ID: #{site_id} (#{meta.domain}).")
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
def apply_change(funnel_id, %{update_type: :delete_whole_funnel} = change) do
|
||||
IO.puts(
|
||||
"Deleting whole funnel '#{change.funnel_name}', there is no way to make it functional without duplicates"
|
||||
)
|
||||
|
||||
Plausible.Repo.delete_all(
|
||||
from(f in Plausible.Funnel,
|
||||
where: f.site_id == ^change.site_id,
|
||||
where: f.id == ^funnel_id
|
||||
)
|
||||
)
|
||||
end
|
||||
|
||||
def apply_change(funnel_id, %{update_type: :delete_step} = change) do
|
||||
IO.puts(
|
||||
"Deleting step ID:#{change.funnel_step_id} '#{change.goal_name}' - otherwise there will be duplicates in the funnel."
|
||||
)
|
||||
|
||||
step =
|
||||
Plausible.Repo.get_by!(Plausible.Funnel.Step,
|
||||
funnel_id: funnel_id,
|
||||
id: change.funnel_step_id
|
||||
)
|
||||
|
||||
{:ok, _} = Plausible.Repo.delete(step)
|
||||
end
|
||||
|
||||
def apply_change(
|
||||
_funnel_id,
|
||||
%{update_type: :update_step, og_goal_id: goal_id, to: goal_id} = change
|
||||
) do
|
||||
IO.puts(
|
||||
"Doing nothing for step '#{change.goal_name}' - the duplicate goal exists, but the update is no-op"
|
||||
)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
def apply_change(funnel_id, %{update_type: :update_step} = change) do
|
||||
IO.puts(
|
||||
"Updating step '#{change.goal_name}' from goal_id:#{change.og_goal_id} to goal_id:#{change.to}"
|
||||
)
|
||||
|
||||
step =
|
||||
Plausible.Repo.get_by!(Plausible.Funnel.Step,
|
||||
funnel_id: funnel_id,
|
||||
id: change.funnel_step_id
|
||||
)
|
||||
|
||||
change = Ecto.Changeset.change(step, goal_id: change.to)
|
||||
{:ok, _} = Plausible.Repo.update(change)
|
||||
end
|
||||
|
||||
def translate_to_db_ops(data) do
|
||||
for {site, meta} <- data do
|
||||
{site, to_db_ops(meta)}
|
||||
end
|
||||
end
|
||||
|
||||
def to_db_ops(meta) do
|
||||
new_changes =
|
||||
for {funnel_id, changes} <- meta.changes do
|
||||
safe_step_updates = changes |> Enum.uniq_by(& &1.to)
|
||||
|
||||
steps_to_delete = changes -- safe_step_updates
|
||||
|
||||
safe_step_updates =
|
||||
safe_step_updates
|
||||
|> Enum.map(&Map.put(&1, :update_type, :update_step))
|
||||
|
||||
changes =
|
||||
Enum.map(steps_to_delete, &Map.put(&1, :update_type, :delete_step)) ++ safe_step_updates
|
||||
|
||||
og_steps_count = Enum.at(changes, 0).og_steps_count
|
||||
|
||||
steps_after_changes = og_steps_count - Enum.count(steps_to_delete)
|
||||
|
||||
if steps_after_changes >= 2 do
|
||||
{funnel_id, changes}
|
||||
else
|
||||
{funnel_id,
|
||||
[
|
||||
Enum.at(changes, 0)
|
||||
|> Map.put(:update_type, :delete_whole_funnel)
|
||||
]}
|
||||
end
|
||||
end
|
||||
|
||||
Map.put(meta, :changes, new_changes)
|
||||
end
|
||||
|
||||
def to_map(row) do
|
||||
[
|
||||
domain,
|
||||
site_id,
|
||||
funnel_name,
|
||||
funnel_id,
|
||||
funnel_step_id,
|
||||
goal_id,
|
||||
goal_name,
|
||||
dupe_goal_ids,
|
||||
all_goal_ids
|
||||
] = row
|
||||
|
||||
%{
|
||||
domain: domain,
|
||||
site_id: site_id,
|
||||
funnel_name: funnel_name,
|
||||
funnel_id: funnel_id,
|
||||
funnel_step_id: funnel_step_id,
|
||||
goal_id: goal_id,
|
||||
goal_name: goal_name,
|
||||
dupe_goal_ids: dupe_goal_ids,
|
||||
all_goal_ids: all_goal_ids
|
||||
}
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,26 @@
|
||||
defmodule Plausible.Funnel.Const do
|
||||
@moduledoc """
|
||||
Compile-time convience constants for funnel characteristics.
|
||||
"""
|
||||
@min_steps 2
|
||||
@max_steps 8
|
||||
|
||||
defmacro min_steps() do
|
||||
quote do
|
||||
unquote(@min_steps)
|
||||
end
|
||||
end
|
||||
|
||||
defmacro max_steps() do
|
||||
quote do
|
||||
unquote(@max_steps)
|
||||
end
|
||||
end
|
||||
|
||||
defmacro __using__(_opts \\ []) do
|
||||
quote do
|
||||
require Plausible.Funnel.Const
|
||||
alias Plausible.Funnel
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -1,128 +0,0 @@
|
||||
defmodule Plausible.DataMigration.RewriteFunnelDupesTest do
|
||||
use Plausible.DataCase, async: true
|
||||
|
||||
alias Plausible.DataMigration.RewriteFunnelDupes
|
||||
|
||||
import ExUnit.CaptureIO
|
||||
|
||||
for goal_type <- ["event_name", "page_path"] do
|
||||
@tag :skip
|
||||
test "deletes a funnel that cannot be cleaned up from dupe goals (#{goal_type})" do
|
||||
site = insert(:site)
|
||||
|
||||
goals =
|
||||
setup_goals!(site, [
|
||||
%{unquote(goal_type) => "/AAA"},
|
||||
%{unquote(goal_type) => "/AAA"},
|
||||
%{unquote(goal_type) => "/AAA"}
|
||||
])
|
||||
|
||||
funnel = setup_funnel!(site, "test", goals)
|
||||
|
||||
io = assert capture_io(fn -> RewriteFunnelDupes.run() end)
|
||||
assert io =~ "Processing site ID: #{site.id}"
|
||||
assert io =~ "Deleting whole funnel"
|
||||
|
||||
refute Repo.reload(funnel)
|
||||
end
|
||||
|
||||
@tag :skip
|
||||
test "reduces a funnel if possible (#{goal_type})" do
|
||||
site = insert(:site)
|
||||
|
||||
goals =
|
||||
setup_goals!(site, [
|
||||
%{unquote(goal_type) => "/AAA"},
|
||||
%{unquote(goal_type) => "/BBB"},
|
||||
%{unquote(goal_type) => "/AAA"},
|
||||
%{unquote(goal_type) => "/CCC"}
|
||||
])
|
||||
|
||||
funnel = setup_funnel!(site, "test", goals)
|
||||
|
||||
io = assert capture_io(fn -> RewriteFunnelDupes.run() end)
|
||||
assert io =~ "Processing site ID: #{site.id}"
|
||||
assert io =~ "Deleting step"
|
||||
|
||||
assert_funnel(site.id, funnel.id, [
|
||||
%{unquote(goal_type) => "/AAA"},
|
||||
%{unquote(goal_type) => "/BBB"},
|
||||
%{unquote(goal_type) => "/CCC"}
|
||||
])
|
||||
end
|
||||
end
|
||||
|
||||
@tag :skip
|
||||
test "dupe names in mixed goal types don't matter" do
|
||||
site = insert(:site)
|
||||
|
||||
gs = [
|
||||
%{"event_name" => "/AAA"},
|
||||
%{"page_path" => "/AAA"},
|
||||
%{"event_name" => "/foo"},
|
||||
%{"page_path" => "/foo"}
|
||||
]
|
||||
|
||||
goals = setup_goals!(site, gs)
|
||||
|
||||
funnel = setup_funnel!(site, "test", goals)
|
||||
|
||||
capture_io(fn -> RewriteFunnelDupes.run() end)
|
||||
|
||||
assert_funnel(site.id, funnel.id, gs)
|
||||
end
|
||||
|
||||
@tag :skip
|
||||
test "goals across multiple funnels" do
|
||||
site = insert(:site)
|
||||
|
||||
goals = [
|
||||
%{"event_name" => "/AAA"},
|
||||
%{"event_name" => "/AAA"},
|
||||
%{"page_path" => "/foo"},
|
||||
%{"event_name" => "/AAA"}
|
||||
]
|
||||
|
||||
[g1, g2, g3, g4] = setup_goals!(site, goals)
|
||||
|
||||
funnel1 = setup_funnel!(site, "test1", [g1, g2, g3, g4])
|
||||
funnel2 = setup_funnel!(site, "test2", [g2, g1, g3, g4])
|
||||
funnel3 = setup_funnel!(site, "test3", [g2, g3])
|
||||
funnel4 = setup_funnel!(site, "test4", [g2, g1])
|
||||
|
||||
capture_io(fn -> RewriteFunnelDupes.run() end)
|
||||
|
||||
assert_funnel(site.id, funnel1.id, [%{"event_name" => "/AAA"}, %{"page_path" => "/foo"}])
|
||||
assert_funnel(site.id, funnel2.id, [%{"event_name" => "/AAA"}, %{"page_path" => "/foo"}])
|
||||
assert_funnel(site.id, funnel3.id, [%{"event_name" => "/AAA"}, %{"page_path" => "/foo"}])
|
||||
|
||||
refute Plausible.Funnels.get(site.id, funnel4.id)
|
||||
end
|
||||
|
||||
defp setup_goals!(site, goals) do
|
||||
for goal <- goals do
|
||||
{:ok, g} = Plausible.Goals.create(site, goal)
|
||||
g
|
||||
end
|
||||
end
|
||||
|
||||
def setup_funnel!(site, name, goals) do
|
||||
{:ok, funnel} = Plausible.Funnels.create(site, name, Enum.map(goals, &%{"goal_id" => &1.id}))
|
||||
funnel
|
||||
end
|
||||
|
||||
def assert_funnel(site_id, funnel_id, goals) do
|
||||
funnel_goals =
|
||||
Plausible.Funnels.get(site_id, funnel_id)
|
||||
|> Map.fetch!(:steps)
|
||||
|> Enum.map(& &1.goal)
|
||||
|
||||
assert Enum.count(funnel_goals) == Enum.count(goals)
|
||||
|
||||
Enum.zip(funnel_goals, goals)
|
||||
|> Enum.each(fn {funnel_goal, expect} ->
|
||||
key = Map.keys(expect) |> List.first() |> String.to_existing_atom()
|
||||
assert Map.fetch!(funnel_goal, key) == Map.values(expect) |> List.first()
|
||||
end)
|
||||
end
|
||||
end
|
||||
@ -1,355 +1,363 @@
|
||||
defmodule Plausible.FunnelsTest do
|
||||
use Plausible.DataCase
|
||||
|
||||
alias Plausible.Goals
|
||||
alias Plausible.Funnels
|
||||
alias Plausible.Stats
|
||||
|
||||
setup do
|
||||
site = insert(:site)
|
||||
|
||||
{:ok, g1} = Goals.create(site, %{"page_path" => "/go/to/blog/**"})
|
||||
{:ok, g2} = Goals.create(site, %{"event_name" => "Signup"})
|
||||
{:ok, g3} = Goals.create(site, %{"page_path" => "/checkout"})
|
||||
{:ok, g4} = Goals.create(site, %{"event_name" => "Leave feedback"})
|
||||
{:ok, g5} = Goals.create(site, %{"page_path" => "/recommend"})
|
||||
{:ok, g6} = Goals.create(site, %{"event_name" => "Extra event"})
|
||||
{:ok, g7} = Goals.create(site, %{"event_name" => "Extra event 2"})
|
||||
{:ok, g8} = Goals.create(site, %{"event_name" => "Extra event 3"})
|
||||
{:ok, g9} = Goals.create(site, %{"event_name" => "Extra event 4"})
|
||||
|
||||
{:ok,
|
||||
%{
|
||||
site: site,
|
||||
goals: [g1, g2, g3],
|
||||
steps: [g1, g2, g3, g4, g5, g6, g7, g8, g9] |> Enum.map(&%{"goal_id" => &1.id})
|
||||
}}
|
||||
end
|
||||
|
||||
describe "Common context" do
|
||||
test "create and store a funnel given a set of goals", %{site: site, steps: [g1, g2, g3 | _]} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
assert funnel.inserted_at
|
||||
assert funnel.name == "From blog to signup and purchase"
|
||||
assert [fg1, fg2, fg3] = funnel.steps
|
||||
|
||||
assert fg1.goal_id == g1["goal_id"]
|
||||
assert fg2.goal_id == g2["goal_id"]
|
||||
assert fg3.goal_id == g3["goal_id"]
|
||||
|
||||
assert fg1.step_order == 1
|
||||
assert fg2.step_order == 2
|
||||
assert fg3.step_order == 3
|
||||
end
|
||||
|
||||
test "retrieve a funnel by id and site, get steps in order", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
[g3, g1, g2]
|
||||
)
|
||||
|
||||
assert funnel = Funnels.get(site, funnel.id)
|
||||
assert funnel.name == "Lorem ipsum"
|
||||
assert [%{step_order: 1}, %{step_order: 2}, %{step_order: 3}] = funnel.steps
|
||||
end
|
||||
|
||||
test "funnels can be deleted by id and a site", %{site: site, steps: [g1, g2 | _]} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Sample funnel",
|
||||
[g1, g2]
|
||||
)
|
||||
|
||||
assert :ok = Funnels.delete(site, funnel.id)
|
||||
# deletion is idempotent
|
||||
assert :ok = Funnels.delete(site, funnel.id)
|
||||
refute Funnels.get(site, funnel.id)
|
||||
end
|
||||
|
||||
test "a funnel cannot be made of < 2 steps", %{site: site, steps: [g1 | _]} do
|
||||
assert {:error, :invalid_funnel_size} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
[g1]
|
||||
)
|
||||
@moduletag :full_build_only
|
||||
|
||||
use Plausible
|
||||
|
||||
on_full_build do
|
||||
alias Plausible.Goals
|
||||
alias Plausible.Funnels
|
||||
alias Plausible.Stats
|
||||
|
||||
setup do
|
||||
site = insert(:site)
|
||||
|
||||
{:ok, g1} = Goals.create(site, %{"page_path" => "/go/to/blog/**"})
|
||||
{:ok, g2} = Goals.create(site, %{"event_name" => "Signup"})
|
||||
{:ok, g3} = Goals.create(site, %{"page_path" => "/checkout"})
|
||||
{:ok, g4} = Goals.create(site, %{"event_name" => "Leave feedback"})
|
||||
{:ok, g5} = Goals.create(site, %{"page_path" => "/recommend"})
|
||||
{:ok, g6} = Goals.create(site, %{"event_name" => "Extra event"})
|
||||
{:ok, g7} = Goals.create(site, %{"event_name" => "Extra event 2"})
|
||||
{:ok, g8} = Goals.create(site, %{"event_name" => "Extra event 3"})
|
||||
{:ok, g9} = Goals.create(site, %{"event_name" => "Extra event 4"})
|
||||
|
||||
{:ok,
|
||||
%{
|
||||
site: site,
|
||||
goals: [g1, g2, g3],
|
||||
steps: [g1, g2, g3, g4, g5, g6, g7, g8, g9] |> Enum.map(&%{"goal_id" => &1.id})
|
||||
}}
|
||||
end
|
||||
|
||||
test "a funnel can be made of 8 steps maximum", %{site: site, steps: too_many_steps} do
|
||||
assert {:ok, _} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
Enum.take(too_many_steps, 8)
|
||||
)
|
||||
|
||||
assert {:error, :invalid_funnel_size} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
too_many_steps
|
||||
)
|
||||
describe "Common context" do
|
||||
test "create and store a funnel given a set of goals", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
assert funnel.inserted_at
|
||||
assert funnel.name == "From blog to signup and purchase"
|
||||
assert [fg1, fg2, fg3] = funnel.steps
|
||||
|
||||
assert fg1.goal_id == g1["goal_id"]
|
||||
assert fg2.goal_id == g2["goal_id"]
|
||||
assert fg3.goal_id == g3["goal_id"]
|
||||
|
||||
assert fg1.step_order == 1
|
||||
assert fg2.step_order == 2
|
||||
assert fg3.step_order == 3
|
||||
end
|
||||
|
||||
test "retrieve a funnel by id and site, get steps in order", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
[g3, g1, g2]
|
||||
)
|
||||
|
||||
assert funnel = Funnels.get(site, funnel.id)
|
||||
assert funnel.name == "Lorem ipsum"
|
||||
assert [%{step_order: 1}, %{step_order: 2}, %{step_order: 3}] = funnel.steps
|
||||
end
|
||||
|
||||
test "funnels can be deleted by id and a site", %{site: site, steps: [g1, g2 | _]} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Sample funnel",
|
||||
[g1, g2]
|
||||
)
|
||||
|
||||
assert :ok = Funnels.delete(site, funnel.id)
|
||||
# deletion is idempotent
|
||||
assert :ok = Funnels.delete(site, funnel.id)
|
||||
refute Funnels.get(site, funnel.id)
|
||||
end
|
||||
|
||||
test "a funnel cannot be made of < 2 steps", %{site: site, steps: [g1 | _]} do
|
||||
assert {:error, :invalid_funnel_size} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
[g1]
|
||||
)
|
||||
end
|
||||
|
||||
test "a funnel can be made of 8 steps maximum", %{site: site, steps: too_many_steps} do
|
||||
assert {:ok, _} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
Enum.take(too_many_steps, 8)
|
||||
)
|
||||
|
||||
assert {:error, :invalid_funnel_size} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
too_many_steps
|
||||
)
|
||||
end
|
||||
|
||||
test "a goal can only appear once in a funnel", %{steps: [g1 | _], site: site} do
|
||||
{:error, _changeset} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
[g1, g1]
|
||||
)
|
||||
end
|
||||
|
||||
test "funnels can be listed per site, starting from most recently added", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
Funnels.create(site, "Funnel 1", [g3, g1])
|
||||
Funnels.create(site, "Funnel 2", [g2, g1, g3])
|
||||
|
||||
funnels_list = Funnels.list(site)
|
||||
|
||||
assert [%{name: "Funnel 2", steps_count: 3}, %{name: "Funnel 1", steps_count: 2}] =
|
||||
funnels_list
|
||||
end
|
||||
end
|
||||
|
||||
test "a goal can only appear once in a funnel", %{steps: [g1 | _], site: site} do
|
||||
{:error, _changeset} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"Lorem ipsum",
|
||||
[g1, g1]
|
||||
)
|
||||
end
|
||||
|
||||
test "funnels can be listed per site, starting from most recently added", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
Funnels.create(site, "Funnel 1", [g3, g1])
|
||||
Funnels.create(site, "Funnel 2", [g2, g1, g3])
|
||||
|
||||
funnels_list = Funnels.list(site)
|
||||
|
||||
assert [%{name: "Funnel 2", steps_count: 3}, %{name: "Funnel 1", steps_count: 2}] =
|
||||
funnels_list
|
||||
end
|
||||
end
|
||||
|
||||
describe "Plausible.Stats.Funnel" do
|
||||
test "funnels can be evaluated per site within a time range against an ephemeral definition",
|
||||
%{
|
||||
site: site,
|
||||
goals: [g1, g2, g3 | _]
|
||||
} do
|
||||
funnel_definition =
|
||||
Funnels.ephemeral_definition(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[
|
||||
%{
|
||||
"goal_id" => "#{g1.id}",
|
||||
"goal" => %{
|
||||
"id" => "#{g1.id}",
|
||||
"event_name" => g1.event_name,
|
||||
"page_path" => g1.page_path
|
||||
}
|
||||
},
|
||||
%{
|
||||
"goal_id" => g2.id,
|
||||
"goal" => %{
|
||||
"id" => g2.id,
|
||||
"event_name" => g2.event_name,
|
||||
"page_path" => g2.page_path
|
||||
}
|
||||
},
|
||||
%{
|
||||
"goal_id" => g3.id,
|
||||
"goal" => %{
|
||||
"id" => g3.id,
|
||||
"event_name" => g3.event_name,
|
||||
"page_path" => g3.page_path
|
||||
}
|
||||
}
|
||||
]
|
||||
)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/irrelevant/page/not/in/funnel", user_id: 999),
|
||||
build(:pageview, pathname: "/go/to/blog/foo", user_id: 123),
|
||||
build(:event, name: "Signup", user_id: 123),
|
||||
build(:pageview, pathname: "/checkout", user_id: 123),
|
||||
build(:pageview, pathname: "/go/to/blog/bar", user_id: 666),
|
||||
build(:event, name: "Signup", user_id: 666)
|
||||
])
|
||||
|
||||
query = Plausible.Stats.Query.from(site, %{"period" => "all"})
|
||||
|
||||
funnel_data = Stats.funnel(site, query, funnel_definition)
|
||||
|
||||
assert {:ok,
|
||||
describe "Plausible.Stats.Funnel" do
|
||||
test "funnels can be evaluated per site within a time range against an ephemeral definition",
|
||||
%{
|
||||
site: site,
|
||||
goals: [g1, g2, g3 | _]
|
||||
} do
|
||||
funnel_definition =
|
||||
Funnels.ephemeral_definition(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[
|
||||
%{
|
||||
all_visitors: 3,
|
||||
entering_visitors: 2,
|
||||
entering_visitors_percentage: "66.67",
|
||||
never_entering_visitors: 1,
|
||||
never_entering_visitors_percentage: "33.33",
|
||||
steps: [
|
||||
%{
|
||||
label: "Visit /go/to/blog/**",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Signup",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "100",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Visit /checkout",
|
||||
visitors: 1,
|
||||
conversion_rate: "50",
|
||||
conversion_rate_step: "50",
|
||||
dropoff: 1,
|
||||
dropoff_percentage: "50"
|
||||
}
|
||||
]
|
||||
}} = funnel_data
|
||||
end
|
||||
|
||||
test "funnels can be evaluated per site within a time range", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/go/to/blog/foo", user_id: 123),
|
||||
build(:event, name: "Signup", user_id: 123),
|
||||
build(:pageview, pathname: "/checkout", user_id: 123),
|
||||
build(:pageview, pathname: "/go/to/blog/bar", user_id: 666),
|
||||
build(:event, name: "Signup", user_id: 666)
|
||||
])
|
||||
|
||||
query = Plausible.Stats.Query.from(site, %{"period" => "all"})
|
||||
|
||||
funnel_data = Stats.funnel(site, query, funnel.id)
|
||||
|
||||
assert {:ok,
|
||||
"goal_id" => "#{g1.id}",
|
||||
"goal" => %{
|
||||
"id" => "#{g1.id}",
|
||||
"event_name" => g1.event_name,
|
||||
"page_path" => g1.page_path
|
||||
}
|
||||
},
|
||||
%{
|
||||
all_visitors: 2,
|
||||
entering_visitors: 2,
|
||||
entering_visitors_percentage: "100",
|
||||
never_entering_visitors: 0,
|
||||
never_entering_visitors_percentage: "0",
|
||||
steps: [
|
||||
%{
|
||||
label: "Visit /go/to/blog/**",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0
|
||||
},
|
||||
%{
|
||||
label: "Signup",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "100",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Visit /checkout",
|
||||
visitors: 1,
|
||||
conversion_rate: "50",
|
||||
conversion_rate_step: "50",
|
||||
dropoff: 1,
|
||||
dropoff_percentage: "50"
|
||||
}
|
||||
]
|
||||
}} = funnel_data
|
||||
end
|
||||
|
||||
test "funnels can be evaluated even where there are no visits yet", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
query = Plausible.Stats.Query.from(site, %{"period" => "all"})
|
||||
|
||||
funnel_data = Stats.funnel(site, query, funnel.id)
|
||||
|
||||
assert {:ok,
|
||||
"goal_id" => g2.id,
|
||||
"goal" => %{
|
||||
"id" => g2.id,
|
||||
"event_name" => g2.event_name,
|
||||
"page_path" => g2.page_path
|
||||
}
|
||||
},
|
||||
%{
|
||||
all_visitors: 0,
|
||||
entering_visitors: 0,
|
||||
entering_visitors_percentage: "0",
|
||||
never_entering_visitors: 0,
|
||||
never_entering_visitors_percentage: "0",
|
||||
steps: [
|
||||
%{
|
||||
label: "Visit /go/to/blog/**",
|
||||
visitors: 0,
|
||||
conversion_rate: "0",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Signup",
|
||||
visitors: 0,
|
||||
conversion_rate: "0",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Visit /checkout",
|
||||
visitors: 0,
|
||||
conversion_rate: "0",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
}
|
||||
]
|
||||
}} = funnel_data
|
||||
end
|
||||
|
||||
@tag :slow
|
||||
test "sampling", %{site: site, steps: [g1, g2, g3 | _]} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
stats =
|
||||
1..50_000
|
||||
|> Enum.flat_map(fn _ ->
|
||||
user_id = SipHash.hash!("0123456789ABCDEF", :crypto.strong_rand_bytes(64))
|
||||
|
||||
[
|
||||
build(:pageview, pathname: "/go/to/blog/foo", user_id: user_id),
|
||||
build(:event, name: "Signup", user_id: user_id),
|
||||
build(:pageview, pathname: "/checkout", user_id: user_id)
|
||||
]
|
||||
end)
|
||||
|
||||
populate_stats(site, stats)
|
||||
|
||||
query =
|
||||
Plausible.Stats.Query.from(site, %{"period" => "all", "sample_threshold" => "10000"})
|
||||
|
||||
{:ok, funnel_data} = Stats.funnel(site, query, funnel.id)
|
||||
assert_in_delta funnel_data[:all_visitors], 50_000, 5000
|
||||
"goal_id" => g3.id,
|
||||
"goal" => %{
|
||||
"id" => g3.id,
|
||||
"event_name" => g3.event_name,
|
||||
"page_path" => g3.page_path
|
||||
}
|
||||
}
|
||||
]
|
||||
)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/irrelevant/page/not/in/funnel", user_id: 999),
|
||||
build(:pageview, pathname: "/go/to/blog/foo", user_id: 123),
|
||||
build(:event, name: "Signup", user_id: 123),
|
||||
build(:pageview, pathname: "/checkout", user_id: 123),
|
||||
build(:pageview, pathname: "/go/to/blog/bar", user_id: 666),
|
||||
build(:event, name: "Signup", user_id: 666)
|
||||
])
|
||||
|
||||
query = Plausible.Stats.Query.from(site, %{"period" => "all"})
|
||||
|
||||
funnel_data = Stats.funnel(site, query, funnel_definition)
|
||||
|
||||
assert {:ok,
|
||||
%{
|
||||
all_visitors: 3,
|
||||
entering_visitors: 2,
|
||||
entering_visitors_percentage: "66.67",
|
||||
never_entering_visitors: 1,
|
||||
never_entering_visitors_percentage: "33.33",
|
||||
steps: [
|
||||
%{
|
||||
label: "Visit /go/to/blog/**",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Signup",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "100",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Visit /checkout",
|
||||
visitors: 1,
|
||||
conversion_rate: "50",
|
||||
conversion_rate_step: "50",
|
||||
dropoff: 1,
|
||||
dropoff_percentage: "50"
|
||||
}
|
||||
]
|
||||
}} = funnel_data
|
||||
end
|
||||
|
||||
test "funnels can be evaluated per site within a time range", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/go/to/blog/foo", user_id: 123),
|
||||
build(:event, name: "Signup", user_id: 123),
|
||||
build(:pageview, pathname: "/checkout", user_id: 123),
|
||||
build(:pageview, pathname: "/go/to/blog/bar", user_id: 666),
|
||||
build(:event, name: "Signup", user_id: 666)
|
||||
])
|
||||
|
||||
query = Plausible.Stats.Query.from(site, %{"period" => "all"})
|
||||
|
||||
funnel_data = Stats.funnel(site, query, funnel.id)
|
||||
|
||||
assert {:ok,
|
||||
%{
|
||||
all_visitors: 2,
|
||||
entering_visitors: 2,
|
||||
entering_visitors_percentage: "100",
|
||||
never_entering_visitors: 0,
|
||||
never_entering_visitors_percentage: "0",
|
||||
steps: [
|
||||
%{
|
||||
label: "Visit /go/to/blog/**",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0
|
||||
},
|
||||
%{
|
||||
label: "Signup",
|
||||
visitors: 2,
|
||||
conversion_rate: "100",
|
||||
conversion_rate_step: "100",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Visit /checkout",
|
||||
visitors: 1,
|
||||
conversion_rate: "50",
|
||||
conversion_rate_step: "50",
|
||||
dropoff: 1,
|
||||
dropoff_percentage: "50"
|
||||
}
|
||||
]
|
||||
}} = funnel_data
|
||||
end
|
||||
|
||||
test "funnels can be evaluated even where there are no visits yet", %{
|
||||
site: site,
|
||||
steps: [g1, g2, g3 | _]
|
||||
} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
query = Plausible.Stats.Query.from(site, %{"period" => "all"})
|
||||
|
||||
funnel_data = Stats.funnel(site, query, funnel.id)
|
||||
|
||||
assert {:ok,
|
||||
%{
|
||||
all_visitors: 0,
|
||||
entering_visitors: 0,
|
||||
entering_visitors_percentage: "0",
|
||||
never_entering_visitors: 0,
|
||||
never_entering_visitors_percentage: "0",
|
||||
steps: [
|
||||
%{
|
||||
label: "Visit /go/to/blog/**",
|
||||
visitors: 0,
|
||||
conversion_rate: "0",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Signup",
|
||||
visitors: 0,
|
||||
conversion_rate: "0",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
},
|
||||
%{
|
||||
label: "Visit /checkout",
|
||||
visitors: 0,
|
||||
conversion_rate: "0",
|
||||
conversion_rate_step: "0",
|
||||
dropoff: 0,
|
||||
dropoff_percentage: "0"
|
||||
}
|
||||
]
|
||||
}} = funnel_data
|
||||
end
|
||||
|
||||
@tag :slow
|
||||
test "sampling", %{site: site, steps: [g1, g2, g3 | _]} do
|
||||
{:ok, funnel} =
|
||||
Funnels.create(
|
||||
site,
|
||||
"From blog to signup and purchase",
|
||||
[g1, g2, g3]
|
||||
)
|
||||
|
||||
stats =
|
||||
1..50_000
|
||||
|> Enum.flat_map(fn _ ->
|
||||
user_id = SipHash.hash!("0123456789ABCDEF", :crypto.strong_rand_bytes(64))
|
||||
|
||||
[
|
||||
build(:pageview, pathname: "/go/to/blog/foo", user_id: user_id),
|
||||
build(:event, name: "Signup", user_id: user_id),
|
||||
build(:pageview, pathname: "/checkout", user_id: user_id)
|
||||
]
|
||||
end)
|
||||
|
||||
populate_stats(site, stats)
|
||||
|
||||
query =
|
||||
Plausible.Stats.Query.from(site, %{"period" => "all", "sample_threshold" => "10000"})
|
||||
|
||||
{:ok, funnel_data} = Stats.funnel(site, query, funnel.id)
|
||||
assert_in_delta funnel_data[:all_visitors], 50_000, 5000
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@ -1,308 +1,314 @@
|
||||
defmodule PlausibleWeb.Api.StatsController.FunnelsTest do
|
||||
use PlausibleWeb.ConnCase, async: true
|
||||
|
||||
@user_id 123
|
||||
@other_user_id 456
|
||||
|
||||
@build_funnel_with [
|
||||
{"page_path", "/blog/announcement"},
|
||||
{"event_name", "Signup"},
|
||||
{"page_path", "/cart/add/product"},
|
||||
{"event_name", "Purchase"}
|
||||
]
|
||||
|
||||
describe "GET /api/stats/funnel - default" do
|
||||
setup [:create_user, :log_in, :create_new_site]
|
||||
|
||||
test "computes funnel for a day", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/some/irrelevant", user_id: 9_999_999),
|
||||
build(:pageview, pathname: "/blog/announcement", user_id: @user_id),
|
||||
build(:pageview, pathname: "/blog/announcement", user_id: @other_user_id),
|
||||
build(:event, name: "Signup", user_id: @user_id),
|
||||
build(:event, name: "Signup", user_id: @other_user_id),
|
||||
build(:pageview, pathname: "/cart/add/product", user_id: @user_id),
|
||||
build(:event, name: "Purchase", user_id: @user_id)
|
||||
])
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day")
|
||||
|> json_response(200)
|
||||
|
||||
assert %{
|
||||
"name" => "Test funnel",
|
||||
"all_visitors" => 3,
|
||||
"entering_visitors" => 2,
|
||||
"entering_visitors_percentage" => "66.67",
|
||||
"never_entering_visitors" => 1,
|
||||
"never_entering_visitors_percentage" => "33.33",
|
||||
"steps" => [
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /blog/announcement",
|
||||
"visitors" => 2
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "100",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Signup",
|
||||
"visitors" => 2
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "50",
|
||||
"conversion_rate_step" => "50",
|
||||
"dropoff" => 1,
|
||||
"dropoff_percentage" => "50",
|
||||
"label" => "Visit /cart/add/product",
|
||||
"visitors" => 1
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "50",
|
||||
"conversion_rate_step" => "100",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Purchase",
|
||||
"visitors" => 1
|
||||
}
|
||||
]
|
||||
} = resp
|
||||
end
|
||||
|
||||
test "404 for unknown funnel", %{site: site, conn: conn} do
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/122873/?period=day")
|
||||
|> json_response(404)
|
||||
|
||||
assert resp == %{"error" => "Funnel not found"}
|
||||
end
|
||||
|
||||
test "400 for bad funnel ID", %{site: site, conn: conn} do
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/foobar/?period=day")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{"error" => "There was an error with your request"}
|
||||
use Plausible
|
||||
@moduletag :full_build_only
|
||||
|
||||
on_full_build do
|
||||
@user_id 123
|
||||
@other_user_id 456
|
||||
|
||||
@build_funnel_with [
|
||||
{"page_path", "/blog/announcement"},
|
||||
{"event_name", "Signup"},
|
||||
{"page_path", "/cart/add/product"},
|
||||
{"event_name", "Purchase"}
|
||||
]
|
||||
|
||||
describe "GET /api/stats/funnel - default" do
|
||||
setup [:create_user, :log_in, :create_new_site]
|
||||
|
||||
test "computes funnel for a day", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/some/irrelevant", user_id: 9_999_999),
|
||||
build(:pageview, pathname: "/blog/announcement", user_id: @user_id),
|
||||
build(:pageview, pathname: "/blog/announcement", user_id: @other_user_id),
|
||||
build(:event, name: "Signup", user_id: @user_id),
|
||||
build(:event, name: "Signup", user_id: @other_user_id),
|
||||
build(:pageview, pathname: "/cart/add/product", user_id: @user_id),
|
||||
build(:event, name: "Purchase", user_id: @user_id)
|
||||
])
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day")
|
||||
|> json_response(200)
|
||||
|
||||
assert %{
|
||||
"name" => "Test funnel",
|
||||
"all_visitors" => 3,
|
||||
"entering_visitors" => 2,
|
||||
"entering_visitors_percentage" => "66.67",
|
||||
"never_entering_visitors" => 1,
|
||||
"never_entering_visitors_percentage" => "33.33",
|
||||
"steps" => [
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /blog/announcement",
|
||||
"visitors" => 2
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "100",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Signup",
|
||||
"visitors" => 2
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "50",
|
||||
"conversion_rate_step" => "50",
|
||||
"dropoff" => 1,
|
||||
"dropoff_percentage" => "50",
|
||||
"label" => "Visit /cart/add/product",
|
||||
"visitors" => 1
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "50",
|
||||
"conversion_rate_step" => "100",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Purchase",
|
||||
"visitors" => 1
|
||||
}
|
||||
]
|
||||
} = resp
|
||||
end
|
||||
|
||||
test "404 for unknown funnel", %{site: site, conn: conn} do
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/122873/?period=day")
|
||||
|> json_response(404)
|
||||
|
||||
assert resp == %{"error" => "Funnel not found"}
|
||||
end
|
||||
|
||||
test "400 for bad funnel ID", %{site: site, conn: conn} do
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/foobar/?period=day")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{"error" => "There was an error with your request"}
|
||||
end
|
||||
|
||||
test "computes all-time funnel with filters", %{conn: conn, user: user} do
|
||||
site = insert(:site, stats_start_date: ~D[2020-01-01], members: [user])
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/blog/announcement", user_id: @user_id),
|
||||
build(:pageview,
|
||||
pathname: "/blog/announcement",
|
||||
user_id: @other_user_id,
|
||||
utm_medium: "social",
|
||||
timestamp: ~N[2021-01-01 12:00:00]
|
||||
),
|
||||
build(:event, name: "Signup", user_id: @user_id),
|
||||
build(:event,
|
||||
name: "Signup",
|
||||
user_id: @other_user_id,
|
||||
utm_medium: "social",
|
||||
timestamp: ~N[2021-01-01 12:01:00]
|
||||
),
|
||||
build(:pageview, pathname: "/cart/add/product", user_id: @user_id),
|
||||
build(:event, name: "Purchase", user_id: @user_id)
|
||||
])
|
||||
|
||||
filters = Jason.encode!(%{utm_medium: "social"})
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=all&filters=#{filters}")
|
||||
|> json_response(200)
|
||||
|
||||
assert %{
|
||||
"name" => "Test funnel",
|
||||
"all_visitors" => 1,
|
||||
"entering_visitors" => 1,
|
||||
"entering_visitors_percentage" => "100",
|
||||
"never_entering_visitors" => 0,
|
||||
"never_entering_visitors_percentage" => "0",
|
||||
"steps" => [
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /blog/announcement",
|
||||
"visitors" => 1
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "100",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Signup",
|
||||
"visitors" => 1
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 1,
|
||||
"dropoff_percentage" => "100",
|
||||
"label" => "Visit /cart/add/product",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Purchase",
|
||||
"visitors" => 0
|
||||
}
|
||||
]
|
||||
} = resp
|
||||
end
|
||||
|
||||
test "computes an empty funnel", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day")
|
||||
|> json_response(200)
|
||||
|
||||
assert %{
|
||||
"name" => "Test funnel",
|
||||
"all_visitors" => 0,
|
||||
"entering_visitors" => 0,
|
||||
"entering_visitors_percentage" => "0",
|
||||
"never_entering_visitors" => 0,
|
||||
"never_entering_visitors_percentage" => "0",
|
||||
"steps" => [
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /blog/announcement",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Signup",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /cart/add/product",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Purchase",
|
||||
"visitors" => 0
|
||||
}
|
||||
]
|
||||
} = resp
|
||||
end
|
||||
|
||||
test "returns HTTP 402 when site owner is on a growth plan", %{
|
||||
conn: conn,
|
||||
user: user,
|
||||
site: site
|
||||
} do
|
||||
insert(:growth_subscription, user: user)
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day")
|
||||
|> json_response(402)
|
||||
|
||||
assert %{
|
||||
"error" =>
|
||||
"Funnels is part of the Plausible Business plan. To get access to this feature, please upgrade your account."
|
||||
} == resp
|
||||
end
|
||||
end
|
||||
|
||||
test "computes all-time funnel with filters", %{conn: conn, user: user} do
|
||||
site = insert(:site, stats_start_date: ~D[2020-01-01], members: [user])
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, pathname: "/blog/announcement", user_id: @user_id),
|
||||
build(:pageview,
|
||||
pathname: "/blog/announcement",
|
||||
user_id: @other_user_id,
|
||||
utm_medium: "social",
|
||||
timestamp: ~N[2021-01-01 12:00:00]
|
||||
),
|
||||
build(:event, name: "Signup", user_id: @user_id),
|
||||
build(:event,
|
||||
name: "Signup",
|
||||
user_id: @other_user_id,
|
||||
utm_medium: "social",
|
||||
timestamp: ~N[2021-01-01 12:01:00]
|
||||
),
|
||||
build(:pageview, pathname: "/cart/add/product", user_id: @user_id),
|
||||
build(:event, name: "Purchase", user_id: @user_id)
|
||||
])
|
||||
|
||||
filters = Jason.encode!(%{utm_medium: "social"})
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=all&filters=#{filters}")
|
||||
|> json_response(200)
|
||||
|
||||
assert %{
|
||||
"name" => "Test funnel",
|
||||
"all_visitors" => 1,
|
||||
"entering_visitors" => 1,
|
||||
"entering_visitors_percentage" => "100",
|
||||
"never_entering_visitors" => 0,
|
||||
"never_entering_visitors_percentage" => "0",
|
||||
"steps" => [
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /blog/announcement",
|
||||
"visitors" => 1
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "100",
|
||||
"conversion_rate_step" => "100",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Signup",
|
||||
"visitors" => 1
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 1,
|
||||
"dropoff_percentage" => "100",
|
||||
"label" => "Visit /cart/add/product",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Purchase",
|
||||
"visitors" => 0
|
||||
}
|
||||
]
|
||||
} = resp
|
||||
describe "GET /api/stats/funnel - disallowed filters" do
|
||||
setup [:create_user, :log_in, :create_new_site]
|
||||
|
||||
test "event:page", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
filters = Jason.encode!(%{page: "/pageA"})
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day&filters=#{filters}")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{
|
||||
"error" =>
|
||||
"We are unable to show funnels when the dashboard is filtered by pages",
|
||||
"level" => "normal"
|
||||
}
|
||||
end
|
||||
|
||||
test "event:goal", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
filters = Jason.encode!(%{goal: "Signup", page: "/pageA"})
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day&filters=#{filters}")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{
|
||||
"error" =>
|
||||
"We are unable to show funnels when the dashboard is filtered by goals",
|
||||
"level" => "normal"
|
||||
}
|
||||
end
|
||||
|
||||
test "period: realtime", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=realtime")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{
|
||||
"error" =>
|
||||
"We are unable to show funnels when the dashboard is filtered by realtime period",
|
||||
"level" => "normal"
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
test "computes an empty funnel", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day")
|
||||
|> json_response(200)
|
||||
|
||||
assert %{
|
||||
"name" => "Test funnel",
|
||||
"all_visitors" => 0,
|
||||
"entering_visitors" => 0,
|
||||
"entering_visitors_percentage" => "0",
|
||||
"never_entering_visitors" => 0,
|
||||
"never_entering_visitors_percentage" => "0",
|
||||
"steps" => [
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /blog/announcement",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Signup",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Visit /cart/add/product",
|
||||
"visitors" => 0
|
||||
},
|
||||
%{
|
||||
"conversion_rate" => "0",
|
||||
"conversion_rate_step" => "0",
|
||||
"dropoff" => 0,
|
||||
"dropoff_percentage" => "0",
|
||||
"label" => "Purchase",
|
||||
"visitors" => 0
|
||||
}
|
||||
]
|
||||
} = resp
|
||||
end
|
||||
defp setup_goals(site, goals) when is_list(goals) do
|
||||
goals =
|
||||
Enum.map(goals, fn {type, value} ->
|
||||
{:ok, g} = Plausible.Goals.create(site, %{type => value})
|
||||
g
|
||||
end)
|
||||
|
||||
test "returns HTTP 402 when site owner is on a growth plan", %{
|
||||
conn: conn,
|
||||
user: user,
|
||||
site: site
|
||||
} do
|
||||
insert(:growth_subscription, user: user)
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day")
|
||||
|> json_response(402)
|
||||
|
||||
assert %{
|
||||
"error" =>
|
||||
"Funnels is part of the Plausible Business plan. To get access to this feature, please upgrade your account."
|
||||
} == resp
|
||||
{:ok, goals}
|
||||
end
|
||||
end
|
||||
|
||||
describe "GET /api/stats/funnel - disallowed filters" do
|
||||
setup [:create_user, :log_in, :create_new_site]
|
||||
|
||||
test "event:page", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
filters = Jason.encode!(%{page: "/pageA"})
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day&filters=#{filters}")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{
|
||||
"error" => "We are unable to show funnels when the dashboard is filtered by pages",
|
||||
"level" => "normal"
|
||||
}
|
||||
defp setup_funnel(site, goal_names) do
|
||||
{:ok, goals} = setup_goals(site, goal_names)
|
||||
Plausible.Funnels.create(site, "Test funnel", Enum.map(goals, &%{"goal_id" => &1.id}))
|
||||
end
|
||||
|
||||
test "event:goal", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
filters = Jason.encode!(%{goal: "Signup", page: "/pageA"})
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=day&filters=#{filters}")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{
|
||||
"error" => "We are unable to show funnels when the dashboard is filtered by goals",
|
||||
"level" => "normal"
|
||||
}
|
||||
end
|
||||
|
||||
test "period: realtime", %{conn: conn, site: site} do
|
||||
{:ok, funnel} = setup_funnel(site, @build_funnel_with)
|
||||
|
||||
resp =
|
||||
conn
|
||||
|> get("/api/stats/#{site.domain}/funnels/#{funnel.id}/?period=realtime")
|
||||
|> json_response(400)
|
||||
|
||||
assert resp == %{
|
||||
"error" =>
|
||||
"We are unable to show funnels when the dashboard is filtered by realtime period",
|
||||
"level" => "normal"
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
defp setup_goals(site, goals) when is_list(goals) do
|
||||
goals =
|
||||
Enum.map(goals, fn {type, value} ->
|
||||
{:ok, g} = Plausible.Goals.create(site, %{type => value})
|
||||
g
|
||||
end)
|
||||
|
||||
{:ok, goals}
|
||||
end
|
||||
|
||||
defp setup_funnel(site, goal_names) do
|
||||
{:ok, goals} = setup_goals(site, goal_names)
|
||||
Plausible.Funnels.create(site, "Test funnel", Enum.map(goals, &%{"goal_id" => &1.id}))
|
||||
end
|
||||
end
|
||||
|
||||
@ -1,328 +1,333 @@
|
||||
defmodule PlausibleWeb.Live.FunnelSettingsTest do
|
||||
use PlausibleWeb.ConnCase, async: true
|
||||
import Phoenix.LiveViewTest
|
||||
import Plausible.Test.Support.HTML
|
||||
|
||||
describe "GET /:website/settings/funnels" do
|
||||
setup [:create_user, :log_in, :create_site]
|
||||
|
||||
test "lists funnels for the site and renders help link", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
|
||||
resp = html_response(conn, 200)
|
||||
assert resp =~ "Compose Goals into Funnels"
|
||||
assert resp =~ "From blog to signup"
|
||||
assert resp =~ "From signup to blog"
|
||||
assert element_exists?(resp, "a[href=\"https://plausible.io/docs/funnel-analysis\"]")
|
||||
end
|
||||
|
||||
test "search funnels input is rendered", %{conn: conn, site: site} do
|
||||
setup_goals(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
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
|
||||
|
||||
test "lists funnels with delete actions", %{conn: conn, site: site} do
|
||||
{:ok, [f1_id, f2_id]} = setup_funnels(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
|
||||
resp = html_response(conn, 200)
|
||||
|
||||
assert element_exists?(
|
||||
resp,
|
||||
~s/button[phx-click="delete-funnel"][phx-value-funnel-id=#{f1_id}]#delete-funnel-#{f1_id}/
|
||||
)
|
||||
|
||||
assert element_exists?(
|
||||
resp,
|
||||
~s/button[phx-click="delete-funnel"][phx-value-funnel-id=#{f2_id}]#delete-funnel-#{f2_id}/
|
||||
)
|
||||
end
|
||||
|
||||
test "if goals are present, Add Funnel button is rendered", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
resp = conn |> html_response(200)
|
||||
assert element_exists?(resp, ~S/button[phx-click="add-funnel"]/)
|
||||
use Plausible
|
||||
@moduletag :full_build_only
|
||||
|
||||
on_full_build do
|
||||
import Phoenix.LiveViewTest
|
||||
import Plausible.Test.Support.HTML
|
||||
|
||||
describe "GET /:website/settings/funnels" do
|
||||
setup [:create_user, :log_in, :create_site]
|
||||
|
||||
test "lists funnels for the site and renders help link", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
|
||||
resp = html_response(conn, 200)
|
||||
assert resp =~ "Compose Goals into Funnels"
|
||||
assert resp =~ "From blog to signup"
|
||||
assert resp =~ "From signup to blog"
|
||||
assert element_exists?(resp, "a[href=\"https://plausible.io/docs/funnel-analysis\"]")
|
||||
end
|
||||
|
||||
test "search funnels input is rendered", %{conn: conn, site: site} do
|
||||
setup_goals(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
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
|
||||
|
||||
test "lists funnels with delete actions", %{conn: conn, site: site} do
|
||||
{:ok, [f1_id, f2_id]} = setup_funnels(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
|
||||
resp = html_response(conn, 200)
|
||||
|
||||
assert element_exists?(
|
||||
resp,
|
||||
~s/button[phx-click="delete-funnel"][phx-value-funnel-id=#{f1_id}]#delete-funnel-#{f1_id}/
|
||||
)
|
||||
|
||||
assert element_exists?(
|
||||
resp,
|
||||
~s/button[phx-click="delete-funnel"][phx-value-funnel-id=#{f2_id}]#delete-funnel-#{f2_id}/
|
||||
)
|
||||
end
|
||||
|
||||
test "if goals are present, Add Funnel button is rendered", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site)
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
resp = conn |> html_response(200)
|
||||
assert element_exists?(resp, ~S/button[phx-click="add-funnel"]/)
|
||||
end
|
||||
|
||||
test "if not enough goals are present, renders a hint to create goals + no search", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
{:ok, _} = Plausible.Goals.create(site, %{"page_path" => "/go/to/blog/**"})
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
|
||||
doc = conn |> html_response(200)
|
||||
assert Floki.text(doc) =~ "You need to define at least two goals to create a funnel."
|
||||
|
||||
add_goals_path = Routes.site_path(conn, :settings_goals, site.domain)
|
||||
assert element_exists?(doc, ~s/a[href="#{add_goals_path}"]/)
|
||||
|
||||
refute element_exists?(doc, ~s/input[type="text"]#filter-text/)
|
||||
refute element_exists?(doc, ~s/form[phx-change="filter"]#filter-form/)
|
||||
end
|
||||
end
|
||||
|
||||
test "if not enough goals are present, renders a hint to create goals + no search", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
{:ok, _} = Plausible.Goals.create(site, %{"page_path" => "/go/to/blog/**"})
|
||||
conn = get(conn, "/#{site.domain}/settings/funnels")
|
||||
|
||||
doc = conn |> html_response(200)
|
||||
assert Floki.text(doc) =~ "You need to define at least two goals to create a funnel."
|
||||
describe "FunnelSettings live view" do
|
||||
setup [:create_user, :log_in, :create_site]
|
||||
|
||||
add_goals_path = Routes.site_path(conn, :settings_goals, site.domain)
|
||||
assert element_exists?(doc, ~s/a[href="#{add_goals_path}"]/)
|
||||
test "allows list filtering / search", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site, ["Funnel One", "Search Me"])
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
|
||||
refute element_exists?(doc, ~s/input[type="text"]#filter-text/)
|
||||
refute element_exists?(doc, ~s/form[phx-change="filter"]#filter-form/)
|
||||
end
|
||||
end
|
||||
assert html =~ "Funnel One"
|
||||
assert html =~ "Search Me"
|
||||
|
||||
describe "FunnelSettings live view" do
|
||||
setup [:create_user, :log_in, :create_site]
|
||||
html = type_into_search(lv, "search")
|
||||
|
||||
test "allows list filtering / search", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site, ["Funnel One", "Search Me"])
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
refute html =~ "Funnel One"
|
||||
assert html =~ "Search Me"
|
||||
end
|
||||
|
||||
assert html =~ "Funnel One"
|
||||
assert html =~ "Search Me"
|
||||
test "allows resetting filter text via backspace icon", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site, ["Funnel One", "Another"])
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
|
||||
html = type_into_search(lv, "search")
|
||||
refute element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/)
|
||||
|
||||
refute html =~ "Funnel One"
|
||||
assert html =~ "Search Me"
|
||||
end
|
||||
html = type_into_search(lv, "one")
|
||||
refute html =~ "Another"
|
||||
|
||||
test "allows resetting filter text via backspace icon", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site, ["Funnel One", "Another"])
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
assert element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/)
|
||||
|
||||
refute element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/)
|
||||
html = lv |> element(~s/svg#reset-filter/) |> render_click()
|
||||
|
||||
html = type_into_search(lv, "one")
|
||||
refute html =~ "Another"
|
||||
assert html =~ "Funnel One"
|
||||
assert html =~ "Another"
|
||||
end
|
||||
|
||||
assert element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/)
|
||||
test "allows resetting filter text via no match link", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site)
|
||||
lv = get_liveview(conn, site)
|
||||
html = type_into_search(lv, "Definitely this is not going to render any matches")
|
||||
|
||||
html = lv |> element(~s/svg#reset-filter/) |> render_click()
|
||||
assert html =~ "No funnels found for this site. Please refine or"
|
||||
assert html =~ "reset your search"
|
||||
|
||||
assert html =~ "Funnel One"
|
||||
assert html =~ "Another"
|
||||
end
|
||||
|
||||
test "allows resetting filter text via no match link", %{conn: conn, site: site} do
|
||||
{:ok, _} = setup_funnels(site)
|
||||
lv = get_liveview(conn, site)
|
||||
html = type_into_search(lv, "Definitely this is not going to render any matches")
|
||||
|
||||
assert html =~ "No funnels found for this site. Please refine or"
|
||||
assert html =~ "reset your search"
|
||||
|
||||
assert element_exists?(html, ~s/a[phx-click="reset-filter-text"]#reset-filter-hint/)
|
||||
html = lv |> element(~s/a#reset-filter-hint/) |> render_click()
|
||||
|
||||
refute html =~ "No funnels found for this site. Please refine or"
|
||||
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 "allows to delete funnels", %{conn: conn, site: site} do
|
||||
{:ok, [f1_id, _f2_id]} = setup_funnels(site)
|
||||
refute html =~ "No funnels found for this site. Please refine or"
|
||||
end
|
||||
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
test "allows to delete funnels", %{conn: conn, site: site} do
|
||||
{:ok, [f1_id, _f2_id]} = setup_funnels(site)
|
||||
|
||||
assert html =~ "From blog to signup"
|
||||
assert html =~ "From signup to blog"
|
||||
{lv, html} = get_liveview(conn, site, with_html?: true)
|
||||
|
||||
html = lv |> element(~s/button#delete-funnel-#{f1_id}/) |> render_click()
|
||||
assert html =~ "From blog to signup"
|
||||
assert html =~ "From signup to blog"
|
||||
|
||||
refute html =~ "From blog to signup"
|
||||
assert html =~ "From signup to blog"
|
||||
html = lv |> element(~s/button#delete-funnel-#{f1_id}/) |> render_click()
|
||||
|
||||
html = get(conn, "/#{site.domain}/settings/funnels") |> html_response(200)
|
||||
refute html =~ "From blog to signup"
|
||||
assert html =~ "From signup to blog"
|
||||
|
||||
refute html =~ "From blog to signup"
|
||||
assert html =~ "From signup to blog"
|
||||
end
|
||||
html = get(conn, "/#{site.domain}/settings/funnels") |> html_response(200)
|
||||
|
||||
test "renders the funnel form on clicking 'Add Funnel' button", %{conn: conn, site: site} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
doc = render_click(lv, "add-funnel")
|
||||
refute html =~ "From blog to signup"
|
||||
assert html =~ "From signup to blog"
|
||||
end
|
||||
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/form[phx-change="validate"][phx-submit="save"][phx-click-away="cancel-add-funnel"]/
|
||||
)
|
||||
test "renders the funnel form on clicking 'Add Funnel' button", %{conn: conn, site: site} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
doc = render_click(lv, "add-funnel")
|
||||
|
||||
assert element_exists?(doc, ~s/form input[type="text"][name="funnel[name]"]/)
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/form[phx-change="validate"][phx-submit="save"][phx-click-away="cancel-add-funnel"]/
|
||||
)
|
||||
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-1/
|
||||
)
|
||||
assert element_exists?(doc, ~s/form input[type="text"][name="funnel[name]"]/)
|
||||
|
||||
step_setup_controls = [
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-1/,
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-2/,
|
||||
~s/input[type="text"][name="display-step-1"]#step-1/,
|
||||
~s/input[type="text"][name="display-step-2"]#step-2/,
|
||||
~s/a[phx-click="add-step"]/
|
||||
]
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-1/
|
||||
)
|
||||
|
||||
Enum.each(step_setup_controls, &assert(element_exists?(doc, &1)))
|
||||
end
|
||||
step_setup_controls = [
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-1/,
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-2/,
|
||||
~s/input[type="text"][name="display-step-1"]#step-1/,
|
||||
~s/input[type="text"][name="display-step-2"]#step-2/,
|
||||
~s/a[phx-click="add-step"]/
|
||||
]
|
||||
|
||||
test "clicking 'Add another step' adds a pair of inputs and renders remove step buttons", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
Enum.each(step_setup_controls, &assert(element_exists?(doc, &1)))
|
||||
end
|
||||
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
test "clicking 'Add another step' adds a pair of inputs and renders remove step buttons", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
lv |> element("form") |> render_change(%{funnel: %{name: "My test funnel"}})
|
||||
doc = lv |> element(~s/a[phx-click="add-step"]/) |> render_click()
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-3/
|
||||
)
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
lv |> element("form") |> render_change(%{funnel: %{name: "My test funnel"}})
|
||||
doc = lv |> element(~s/a[phx-click="add-step"]/) |> render_click()
|
||||
|
||||
assert element_exists?(doc, ~s/input[type="text"][name="display-step-1"]#step-1/)
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-3/
|
||||
)
|
||||
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/svg#remove-step-1[phx-click="remove-step"][phx-value-step-idx="1"]/
|
||||
)
|
||||
assert element_exists?(doc, ~s/input[type="text"][name="display-step-1"]#step-1/)
|
||||
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/svg#remove-step-2[phx-click="remove-step"][phx-value-step-idx="2"]/
|
||||
)
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/svg#remove-step-1[phx-click="remove-step"][phx-value-step-idx="1"]/
|
||||
)
|
||||
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/svg#remove-step-3[phx-click="remove-step"][phx-value-step-idx="3"]/
|
||||
)
|
||||
end
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/svg#remove-step-2[phx-click="remove-step"][phx-value-step-idx="2"]/
|
||||
)
|
||||
|
||||
test "clicking the 'remove step' button removes a step", %{site: site, conn: conn} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
assert element_exists?(
|
||||
doc,
|
||||
~s/svg#remove-step-3[phx-click="remove-step"][phx-value-step-idx="3"]/
|
||||
)
|
||||
end
|
||||
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
lv |> element("form") |> render_change(%{funnel: %{name: "My test funnel"}})
|
||||
lv |> element(~s/a[phx-click="add-step"]/) |> render_click()
|
||||
test "clicking the 'remove step' button removes a step", %{site: site, conn: conn} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
|
||||
doc = lv |> element(~s/#remove-step-2/) |> render_click()
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
lv |> element("form") |> render_change(%{funnel: %{name: "My test funnel"}})
|
||||
lv |> element(~s/a[phx-click="add-step"]/) |> render_click()
|
||||
|
||||
assert element_exists?(doc, ~s/input#step-1/)
|
||||
assert element_exists?(doc, ~s/input#step-3/)
|
||||
refute element_exists?(doc, ~s/input#step-2/)
|
||||
end
|
||||
doc = lv |> element(~s/#remove-step-2/) |> render_click()
|
||||
|
||||
test "save button becomes active once at least two steps are selected", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
assert element_exists?(doc, ~s/input#step-1/)
|
||||
assert element_exists?(doc, ~s/input#step-3/)
|
||||
refute element_exists?(doc, ~s/input#step-2/)
|
||||
end
|
||||
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
test "save button becomes active once at least two steps are selected", %{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
|
||||
lv
|
||||
|> element("li#dropdown-step-1-option-1 a")
|
||||
|> render_click()
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> element("li#dropdown-step-2-option-1 a")
|
||||
|> element("li#dropdown-step-1-option-1 a")
|
||||
|> render_click()
|
||||
|
||||
assert element_exists?(doc, ~s/form button#save:disabled/)
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> element("form")
|
||||
|> render_change(%{
|
||||
funnel: %{
|
||||
name: "My test funnel",
|
||||
steps: [
|
||||
%{goal_id: 1},
|
||||
%{goal_id: 2}
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
assert element_exists?(doc, ~s/form button#save/)
|
||||
refute element_exists?(doc, ~s/form button#save:disabled/)
|
||||
doc =
|
||||
lv
|
||||
|> element("li#dropdown-step-2-option-1 a")
|
||||
|> render_click()
|
||||
|
||||
assert element_exists?(doc, ~s/form button#save:disabled/)
|
||||
|
||||
doc =
|
||||
lv
|
||||
|> element("form")
|
||||
|> render_change(%{
|
||||
funnel: %{
|
||||
name: "My test funnel",
|
||||
steps: [
|
||||
%{goal_id: 1},
|
||||
%{goal_id: 2}
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
assert element_exists?(doc, ~s/form button#save/)
|
||||
refute element_exists?(doc, ~s/form button#save:disabled/)
|
||||
end
|
||||
|
||||
@tag :slow
|
||||
test "funnel gets evaluated on every select, assuming a second has passed between selections",
|
||||
%{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
|
||||
lv |> element("li#dropdown-step-1-option-1 a") |> render_click()
|
||||
|
||||
:timer.sleep(1001)
|
||||
|
||||
lv |> element("li#dropdown-step-2-option-1 a") |> render_click()
|
||||
|
||||
doc = lv |> element("#step-eval-0") |> render()
|
||||
assert text_of_element(doc, ~s/#step-eval-0/) =~ "Entering Visitors: 0"
|
||||
|
||||
doc = lv |> element("#step-eval-1") |> render()
|
||||
assert text_of_element(doc, ~s/#step-eval-1/) =~ "Dropoff: 0%"
|
||||
|
||||
doc = lv |> element("#funnel-eval") |> render()
|
||||
assert text_of_element(doc, ~s/#funnel-eval/) =~ "Last month conversion rate: 0%"
|
||||
end
|
||||
end
|
||||
|
||||
@tag :slow
|
||||
test "funnel gets evaluated on every select, assuming a second has passed between selections",
|
||||
%{
|
||||
conn: conn,
|
||||
site: site
|
||||
} do
|
||||
setup_goals(site)
|
||||
lv = get_liveview(conn, site)
|
||||
lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
|
||||
|
||||
assert lv = find_live_child(lv, "funnels-form")
|
||||
|
||||
lv |> element("li#dropdown-step-1-option-1 a") |> render_click()
|
||||
|
||||
:timer.sleep(1001)
|
||||
|
||||
lv |> element("li#dropdown-step-2-option-1 a") |> render_click()
|
||||
defp setup_funnels(site, names \\ []) do
|
||||
{:ok, [g1, g2]} = setup_goals(site)
|
||||
|
||||
doc = lv |> element("#step-eval-0") |> render()
|
||||
assert text_of_element(doc, ~s/#step-eval-0/) =~ "Entering Visitors: 0"
|
||||
{:ok, f1} =
|
||||
Plausible.Funnels.create(
|
||||
site,
|
||||
Enum.at(names, 0) || "From blog to signup",
|
||||
[%{"goal_id" => g1.id}, %{"goal_id" => g2.id}]
|
||||
)
|
||||
|
||||
doc = lv |> element("#step-eval-1") |> render()
|
||||
assert text_of_element(doc, ~s/#step-eval-1/) =~ "Dropoff: 0%"
|
||||
{:ok, f2} =
|
||||
Plausible.Funnels.create(
|
||||
site,
|
||||
Enum.at(names, 1) || "From signup to blog",
|
||||
[%{"goal_id" => g2.id}, %{"goal_id" => g1.id}]
|
||||
)
|
||||
|
||||
doc = lv |> element("#funnel-eval") |> render()
|
||||
assert text_of_element(doc, ~s/#funnel-eval/) =~ "Last month conversion rate: 0%"
|
||||
{:ok, [f1.id, f2.id]}
|
||||
end
|
||||
end
|
||||
|
||||
defp setup_funnels(site, names \\ []) do
|
||||
{:ok, [g1, g2]} = setup_goals(site)
|
||||
|
||||
{:ok, f1} =
|
||||
Plausible.Funnels.create(
|
||||
site,
|
||||
Enum.at(names, 0) || "From blog to signup",
|
||||
[%{"goal_id" => g1.id}, %{"goal_id" => g2.id}]
|
||||
)
|
||||
|
||||
{:ok, f2} =
|
||||
Plausible.Funnels.create(
|
||||
site,
|
||||
Enum.at(names, 1) || "From signup to blog",
|
||||
[%{"goal_id" => g2.id}, %{"goal_id" => g1.id}]
|
||||
)
|
||||
defp setup_goals(site) do
|
||||
{:ok, g1} = Plausible.Goals.create(site, %{"page_path" => "/go/to/blog/**"})
|
||||
{:ok, g2} = Plausible.Goals.create(site, %{"event_name" => "Signup"})
|
||||
{:ok, [g1, g2]}
|
||||
end
|
||||
|
||||
{:ok, [f1.id, f2.id]}
|
||||
end
|
||||
defp get_liveview(conn, site, opts \\ []) do
|
||||
conn = assign(conn, :live_module, PlausibleWeb.Live.FunnelSettings)
|
||||
{:ok, lv, html} = live(conn, "/#{site.domain}/settings/funnels")
|
||||
|
||||
defp setup_goals(site) do
|
||||
{:ok, g1} = Plausible.Goals.create(site, %{"page_path" => "/go/to/blog/**"})
|
||||
{:ok, g2} = Plausible.Goals.create(site, %{"event_name" => "Signup"})
|
||||
{:ok, [g1, g2]}
|
||||
end
|
||||
|
||||
defp get_liveview(conn, site, opts \\ []) do
|
||||
conn = assign(conn, :live_module, PlausibleWeb.Live.FunnelSettings)
|
||||
{:ok, lv, html} = live(conn, "/#{site.domain}/settings/funnels")
|
||||
if Keyword.get(opts, :with_html?) do
|
||||
{lv, html}
|
||||
else
|
||||
lv
|
||||
end
|
||||
end
|
||||
|
||||
if Keyword.get(opts, :with_html?) do
|
||||
{lv, html}
|
||||
else
|
||||
defp type_into_search(lv, text) do
|
||||
lv
|
||||
|> element("form#filter-form")
|
||||
|> render_change(%{
|
||||
"_target" => ["filter-text"],
|
||||
"filter-text" => "#{text}"
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
defp type_into_search(lv, text) do
|
||||
lv
|
||||
|> element("form#filter-form")
|
||||
|> render_change(%{
|
||||
"_target" => ["filter-text"],
|
||||
"filter-text" => "#{text}"
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
Loading…
Reference in New Issue