You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
analytics/test/plausible_web/controllers/api/stats_controller/conversions_test.exs

705 lines
21 KiB
Elixir

defmodule PlausibleWeb.Api.StatsController.ConversionsTest do
use PlausibleWeb.ConnCase
@user_id 123
describe "GET /api/stats/:domain/conversions" do
setup [:create_user, :log_in, :create_new_site]
test "returns mixed conversions in ordered by count", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/"),
build(:pageview, pathname: "/"),
build(:pageview, pathname: "/register"),
build(:pageview, pathname: "/register"),
build(:event, name: "Signup", "meta.key": ["variant"], "meta.value": ["A"]),
build(:event,
user_id: @user_id,
name: "Signup",
"meta.key": ["variant"],
"meta.value": ["A"]
),
build(:event,
user_id: @user_id,
name: "Signup",
"meta.key": ["variant"],
"meta.value": ["B"]
)
])
insert(:goal, %{site: site, page_path: "/register"})
insert(:goal, %{site: site, event_name: "Signup"})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day")
assert json_response(conn, 200) == [
6 years ago
%{
"name" => "Signup",
"visitors" => 2,
"events" => 3,
"conversion_rate" => 33.3
6 years ago
},
%{
"name" => "Visit /register",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 33.3
6 years ago
}
Formatting only changes - No code change (#75) * first commit with test and compile job Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding 'prepare' stage Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated ci script to include "test" compile phase Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding environment variables for connecting to postgresql Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated ci config for postgres Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using non-alpine version of elixir Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * re-using the 'compile' artifacts and added explict env variables for testing Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removing redundant deps fetching from common code Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * formatting using mix.format -- beware no-code changes! Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * added release config Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding consistent env variable for Database Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * more cleaning up of environment variables Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding releases config for enabling releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * cleaning up env configs Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Cleaned up config and prepared config for releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated CI script with new config for test Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added Dockerfile for creating production docker image Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding "docker" build job yay! Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using non-slim version of debian and installing webpack Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding overlays for migrations on releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * restricting the docker built to master branch only Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * typo fix Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding "Hosting.md" to explain hosting instructions Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removed the default comments Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added documentation related to env variables * updated documentation and fixed typo Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated documentation * Bumping up elixir version as `overlays` are only supported in latest version read release notes: https://github.com/elixir-lang/elixir/releases/tag/v1.10.0 Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding tarball assembly during release Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated HOSTING.md Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added support for db migration Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * minor corrections Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * initializing admin user Admin user has been added in the "migration" phase. A default user is automatically created in the process. One can provide the related env variables, else a new one will be automatically created for you. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Initial base domain update - phase#1 These changes are only meant for correct operating it under self-hosting. There are many other cosmetic changes, that require updates to email, site and other places where the original website and author is used. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Using dedicated config variable `base_domain` instead Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding base_domain to releases config Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removing the dedicated config "base_domain", relying on endpoint host Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Removed the usage of "Mix" in code! It is bad practice to use "mix" module inside the code as in actual release this module is unavailable. Replacing this with a config environment variable Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added support for SMTP via Bamboo Smtp Adapter Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Capturing SMTP errors via Sentry Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Minor updates Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding junit formatter -- useful for generating test reports Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding documentation for default user * Resolve "Gitlab Adoption: Add supported services in "Security & Compliance"" * bumping up the debian version to fix issues fixing some vulnerabilities identified by the scanning tools * More updates for self-hosting Changes in most of the places to suit self-hosting. Although, there are some which have been left-off. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * quick-dirty-fix! * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up timeout - skipping MRs :-/ * removing restrictions on watching for changes this stuff isn't working * Update HOSTING.md * renamed the module name * reverting formatting-whitespace changes Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * reverting the name to release Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding docker-compose.yml and related instructions Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using `plausible_url` instead of assuming `https` this is because, it is much to test in local dev machines and in most cases there's already a layer above which is capable for `https` termination and http -> https upgrade Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * WIP: merging changes from upstream Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * wip: more changes * Pushing in changes from upstream Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * changes to ci for testing Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * cleaning up and finishing clickhouse integration Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updating readme with hosting details * removing deleted files from upstream * minor config adjustments Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * formatting changes Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me>
7 years ago
]
end
test "returns conversions when a direct :is filter on event prop", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
user_id: @user_id,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["100", "true"]
),
build(:event,
user_id: @user_id,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["500", "true"]
),
build(:event,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["100", "false"]
),
build(:event,
name: "Payment",
"meta.key": ["amount"],
"meta.value": ["200"]
)
])
insert(:goal, %{site: site, event_name: "Payment"})
filters = Jason.encode!(%{props: %{"logged_in" => "true"}})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")
assert json_response(conn, 200) == [
%{
"name" => "Payment",
"visitors" => 1,
"events" => 2,
"conversion_rate" => 33.3
}
]
end
test "returns conversions when a direct :is_not filter on event prop", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event,
user_id: @user_id,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["100", "true"]
),
build(:event,
user_id: @user_id,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["500", "true"]
),
build(:event,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["100", "false"]
),
build(:event, name: "Payment")
])
insert(:goal, %{site: site, event_name: "Payment"})
filters = Jason.encode!(%{props: %{"logged_in" => "!true"}})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")
assert json_response(conn, 200) == [
%{
"name" => "Payment",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 66.7
}
]
end
test "returns conversions when a direct :is (none) filter on event prop", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event,
user_id: @user_id,
name: "Payment"
),
build(:event,
user_id: @user_id,
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")
])
insert(:goal, %{site: site, event_name: "Payment"})
filters = Jason.encode!(%{props: %{"logged_in" => "(none)"}})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")
assert json_response(conn, 200) == [
%{
"name" => "Payment",
"visitors" => 2,
"events" => 3,
"conversion_rate" => 66.7
}
]
end
test "returns conversions when a direct :is_not (none) filter on event prop", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event,
user_id: @user_id,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["500", "false"]
),
build(:event,
user_id: @user_id,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["500", "true"]
),
build(:event,
name: "Payment",
"meta.key": ["amount", "logged_in"],
"meta.value": ["100", "false"]
),
build(:event, name: "Payment")
])
insert(:goal, %{site: site, event_name: "Payment"})
filters = Jason.encode!(%{props: %{"logged_in" => "!(none)"}})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")
assert json_response(conn, 200) == [
%{
"name" => "Payment",
"visitors" => 2,
"events" => 3,
"conversion_rate" => 66.7
}
]
end
test "garbage filters don't crash the call", %{conn: conn, site: site} do
filters =
"{\"source\":\"Direct / None\",\"screen\":\"Desktop\",\"browser\":\"Chrome\",\"os\":\"Mac\",\"os_version\":\"10.15\",\"country\":\"DE\",\"city\":\"2950159\"}%' AND 2*3*8=6*8 AND 'L9sv'!='L9sv%"
resp =
conn
|> get("/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")
|> json_response(200)
assert resp == []
end
@tag :full_build_only
test "returns formatted average and total values for a conversion with revenue value", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event,
name: "Payment",
revenue_reporting_amount: Decimal.new("200100300.123"),
revenue_reporting_currency: "USD"
),
build(:event,
name: "Payment",
revenue_reporting_amount: Decimal.new("300100400.123"),
revenue_reporting_currency: "USD"
),
build(:event,
name: "Payment",
revenue_reporting_amount: Decimal.new("0"),
revenue_reporting_currency: "USD"
),
build(:event, name: "Payment", revenue_reporting_amount: nil),
build(:event, name: "Payment", revenue_reporting_amount: nil)
])
insert(:goal, %{site: site, event_name: "Payment", currency: :EUR})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day")
assert json_response(conn, 200) == [
%{
"name" => "Payment",
"visitors" => 5,
"events" => 5,
"conversion_rate" => 100.0,
"average_revenue" => %{"short" => "€166.7M", "long" => "€166,733,566.75"},
"total_revenue" => %{"short" => "€500.2M", "long" => "€500,200,700.25"}
}
]
end
@tag :full_build_only
test "returns revenue goals as custom events if the plan doesn't cover the feature", %{
conn: conn,
site: site,
user: user
} do
user
|> Plausible.Auth.User.end_trial()
|> Plausible.Repo.update!()
populate_stats(site, [
build(:event,
name: "Payment",
revenue_reporting_amount: Decimal.new("200100300.123"),
revenue_reporting_currency: "USD"
),
build(:event,
name: "Payment",
revenue_reporting_amount: Decimal.new("300100400.123"),
revenue_reporting_currency: "USD"
),
build(:event,
name: "Payment",
revenue_reporting_amount: Decimal.new("0"),
revenue_reporting_currency: "USD"
),
build(:event, name: "Payment", revenue_reporting_amount: nil),
build(:event, name: "Payment", revenue_reporting_amount: nil)
])
insert(:goal, %{site: site, event_name: "Payment", currency: :EUR})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day")
assert json_response(conn, 200) == [
%{
"name" => "Payment",
"visitors" => 5,
"events" => 5,
"conversion_rate" => 100.0
}
]
end
@tag :full_build_only
test "returns revenue metrics as nil for non-revenue goals", %{
conn: conn,
site: site
} do
[
build(:event,
name: "Payment",
pathname: "/checkout",
revenue_reporting_amount: Decimal.new("10.00"),
revenue_reporting_currency: "EUR"
)
]
|> Enum.concat(build_list(2, :event, name: "Signup"))
|> Enum.concat(build_list(3, :pageview, pathname: "/checkout"))
|> then(fn events -> populate_stats(site, events) end)
insert(:goal, %{site: site, event_name: "Signup"})
insert(:goal, %{site: site, page_path: "/checkout"})
insert(:goal, %{site: site, event_name: "Payment", currency: :EUR})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day")
response = json_response(conn, 200)
assert [
%{
"average_revenue" => %{"long" => "€10.00", "short" => "€10.0"},
"conversion_rate" => 16.7,
"name" => "Payment",
"events" => 1,
"total_revenue" => %{"long" => "€10.00", "short" => "€10.0"},
"visitors" => 1
},
%{
"average_revenue" => nil,
"conversion_rate" => 33.3,
"name" => "Signup",
"events" => 2,
"total_revenue" => nil,
"visitors" => 2
},
%{
"average_revenue" => nil,
"conversion_rate" => 50.0,
"name" => "Visit /checkout",
"events" => 3,
"total_revenue" => nil,
"visitors" => 3
}
] == Enum.sort_by(response, & &1["name"])
end
test "does not return revenue metrics if no revenue goals are returned", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event, name: "Signup")
])
insert(:goal, %{site: site, event_name: "Signup"})
conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day")
assert json_response(conn, 200) == [
%{
"name" => "Signup",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 100.0
}
]
end
end
describe "GET /api/stats/:domain/conversions - with goal filter" do
setup [:create_user, :log_in, :create_new_site]
test "does not consider custom event pathname as a pageview goal completion", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, pathname: "/"),
build(:pageview, pathname: "/register"),
build(:event, pathname: "/register", name: "Signup")
])
insert(:goal, %{site: site, page_path: "/register"})
insert(:goal, %{site: site, event_name: "Signup"})
get_with_filter = fn filters ->
path = "/api/stats/#{site.domain}/conversions"
query = "?period=day&filters=#{Jason.encode!(filters)}"
Formatting only changes - No code change (#75) * first commit with test and compile job Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding 'prepare' stage Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated ci script to include "test" compile phase Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding environment variables for connecting to postgresql Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated ci config for postgres Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using non-alpine version of elixir Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * re-using the 'compile' artifacts and added explict env variables for testing Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removing redundant deps fetching from common code Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * formatting using mix.format -- beware no-code changes! Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * added release config Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding consistent env variable for Database Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * more cleaning up of environment variables Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding releases config for enabling releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * cleaning up env configs Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Cleaned up config and prepared config for releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated CI script with new config for test Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added Dockerfile for creating production docker image Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding "docker" build job yay! Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using non-slim version of debian and installing webpack Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding overlays for migrations on releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * restricting the docker built to master branch only Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * typo fix Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding "Hosting.md" to explain hosting instructions Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removed the default comments Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added documentation related to env variables * updated documentation and fixed typo Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated documentation * Bumping up elixir version as `overlays` are only supported in latest version read release notes: https://github.com/elixir-lang/elixir/releases/tag/v1.10.0 Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding tarball assembly during release Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated HOSTING.md Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added support for db migration Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * minor corrections Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * initializing admin user Admin user has been added in the "migration" phase. A default user is automatically created in the process. One can provide the related env variables, else a new one will be automatically created for you. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Initial base domain update - phase#1 These changes are only meant for correct operating it under self-hosting. There are many other cosmetic changes, that require updates to email, site and other places where the original website and author is used. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Using dedicated config variable `base_domain` instead Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding base_domain to releases config Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removing the dedicated config "base_domain", relying on endpoint host Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Removed the usage of "Mix" in code! It is bad practice to use "mix" module inside the code as in actual release this module is unavailable. Replacing this with a config environment variable Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added support for SMTP via Bamboo Smtp Adapter Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Capturing SMTP errors via Sentry Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Minor updates Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding junit formatter -- useful for generating test reports Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding documentation for default user * Resolve "Gitlab Adoption: Add supported services in "Security & Compliance"" * bumping up the debian version to fix issues fixing some vulnerabilities identified by the scanning tools * More updates for self-hosting Changes in most of the places to suit self-hosting. Although, there are some which have been left-off. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * quick-dirty-fix! * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up timeout - skipping MRs :-/ * removing restrictions on watching for changes this stuff isn't working * Update HOSTING.md * renamed the module name * reverting formatting-whitespace changes Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * reverting the name to release Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding docker-compose.yml and related instructions Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using `plausible_url` instead of assuming `https` this is because, it is much to test in local dev machines and in most cases there's already a layer above which is capable for `https` termination and http -> https upgrade Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * WIP: merging changes from upstream Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * wip: more changes * Pushing in changes from upstream Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * changes to ci for testing Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * cleaning up and finishing clickhouse integration Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updating readme with hosting details * removing deleted files from upstream * minor config adjustments Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * formatting changes Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me>
7 years ago
get(conn, path <> query)
|> json_response(200)
end
expected = [
%{
"name" => "Signup",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 33.3
}
]
# {:is, {:event, event}} filter type
assert get_with_filter.(%{goal: "Signup"}) == expected
# {:member, clauses} filter type
assert get_with_filter.(%{goal: "Signup|Whatever"}) == expected
# {:matches_member, clauses} filter type
assert get_with_filter.(%{goal: "Signup|Visit /whatever*"}) == expected
end
test "does not return custom events with the filtered pageview goal pathname", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, pathname: "/"),
build(:pageview, pathname: "/register"),
build(:event, pathname: "/register", name: "Signup")
])
insert(:goal, %{site: site, page_path: "/register"})
insert(:goal, %{site: site, page_path: "/regi**"})
insert(:goal, %{site: site, event_name: "Signup"})
get_with_filter = fn filters ->
path = "/api/stats/#{site.domain}/conversions"
query = "?period=day&filters=#{Jason.encode!(filters)}"
get(conn, path <> query)
|> json_response(200)
end
expected = [
%{
"name" => "Visit /register",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 33.3
},
%{
"name" => "Visit /regi**",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 33.3
}
]
# {:is, {:page, path}} filter type
assert get_with_filter.(%{goal: "Visit+/register"}) == expected
# {:matches, {:page, expr}} filter type
assert get_with_filter.(%{goal: "Visit+/regi**"}) == expected
# {:member, clauses} filter type
assert get_with_filter.(%{goal: "Visit+/register|Whatever"}) == expected
# {:matches_member, clauses} filter type
assert get_with_filter.(%{goal: "Visit+/register|Visit+/regi**"}) == expected
end
test "can filter by multiple mixed goals", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/"),
build(:pageview, pathname: "/"),
build(:pageview, pathname: "/another"),
build(:pageview, pathname: "/register"),
build(:event, name: "Signup"),
build(:event, name: "Signup")
])
insert(:goal, %{site: site, page_path: "/register"})
insert(:goal, %{site: site, event_name: "Signup"})
filters = Jason.encode!(%{goal: "Signup|Visit /register"})
conn =
get(
conn,
"/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}"
)
assert json_response(conn, 200) == [
%{
"name" => "Signup",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 33.3
},
%{
"name" => "Visit /register",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 16.7
}
]
end
test "can combine wildcard and no wildcard in matches_member", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/blog/post-1"),
build(:pageview, pathname: "/blog/post-2"),
build(:pageview, pathname: "/billing/upgrade")
])
insert(:goal, %{site: site, page_path: "/blog/**"})
insert(:goal, %{site: site, page_path: "/billing/upgrade"})
filters = Jason.encode!(%{goal: "Visit /blog/**|Visit /billing/upgrade"})
conn =
get(
conn,
"/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}"
)
assert json_response(conn, 200) == [
%{
"name" => "Visit /blog/**",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 66.7
},
%{
"name" => "Visit /billing/upgrade",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 33.3
}
]
end
test "can filter by matches_member filter type on goals", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/"),
build(:pageview, pathname: "/another"),
build(:pageview, pathname: "/blog/post-1"),
build(:pageview, pathname: "/blog/post-2"),
build(:event, name: "CTA"),
build(:event, name: "Signup")
])
insert(:goal, %{site: site, page_path: "/blog**"})
insert(:goal, %{site: site, event_name: "CTA"})
insert(:goal, %{site: site, event_name: "Signup"})
filters = Jason.encode!(%{goal: "Signup|Visit /blog**"})
conn =
get(
conn,
"/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}"
)
assert json_response(conn, 200) == [
%{
"name" => "Visit /blog**",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 33.3
},
%{
"name" => "Signup",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 16.7
}
]
end
end
describe "GET /api/stats/:domain/conversions - with goal and prop=(none) filter" do
setup [:create_user, :log_in, :create_new_site]
test "returns only the conversion that is filtered for", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/", user_id: 1),
build(:pageview, pathname: "/", user_id: 2),
build(:event, name: "Signup", user_id: 1, "meta.key": ["variant"], "meta.value": ["A"]),
build(:event, name: "Signup", user_id: 2)
])
insert(:goal, %{site: site, event_name: "Signup"})
filters = Jason.encode!(%{goal: "Signup", props: %{variant: "(none)"}})
conn =
get(
conn,
"/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}"
)
assert json_response(conn, 200) == [
%{
"name" => "Signup",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 50
}
]
end
end
describe "GET /api/stats/:domain/conversions - with glob goals" do
setup [:create_user, :log_in, :create_site]
test "returns correct and sorted glob goal counts", %{conn: conn, site: site} do
insert(:goal, %{site: site, page_path: "/register"})
insert(:goal, %{site: site, page_path: "/reg*"})
insert(:goal, %{site: site, page_path: "/*/register"})
insert(:goal, %{site: site, page_path: "/billing*/success"})
insert(:goal, %{site: site, page_path: "/signup"})
insert(:goal, %{site: site, page_path: "/signup/*"})
insert(:goal, %{site: site, page_path: "/*"})
Conditionally support switching between v1 and v2 clickhouse schemas (#2780) * Remove ClickhouseSetup module This has been an implicit point of contact to many tests. From now on the goal is for each test to maintain its own, isolated setup so that no accidental clashes and implicit assumptions are relied upon. * Implement v2 schema check An environment variable V2_MIGRATION_DONE acts like a feature flag, switching plausible from using old events/sessions schemas to v2 schemas introduced by NumericIDs migration. * Run both test suites sequentially While the code for v1 and v2 schemas must be kept still, we will from now on run tests against both code paths. Secondary test run will set V2_MIGRATION_DONE=1 variable, thus making all `Plausible.v2?()` checks return `true'. * Remove unused function This is a remnant from the short period when we would check for existing events before allowing creating a new site. * Update test setups/factories with v2 migration check * Make GateKeeper return site id along with :allow * Make Billing module check for v2 schema * Make ingestion aware of v2 schema * Disable site transfers for when v2 is live In a separate changeset we will implement simplified site transfer for when v2 migration is complete. The new transfer will only rename the site domain in postgres and keep track of the original site prior to the transfer so we keep an ingestion grace period until the customers redeploy their scripting. * Make Stats base queries aware of v2 schema switch * Update breakdown with v2 conditionals * Update pageview local start with v2 check * Update current visitoris with v2 check * Update stats controller with v2 checks * Update external controller with v2 checks * Update remaining tests with proper fixtures * Rewrite redundant assignment * Remove unused alias * Mute credo, this is not the right time * Add test_helper prompt * Fetch priv dir so it works with a release * Fetch distinct partitions only * Don't limit inspect output for partitions * Ensure SQL is printed to IO * Remove redundant domain fixture
4 years ago
populate_stats(site, [
build(:pageview,
pathname: "/hum",
timestamp: ~N[2019-07-01 23:00:00]
),
build(:pageview,
pathname: "/register",
timestamp: ~N[2019-07-01 23:00:00]
),
build(:pageview,
pathname: "/reg",
timestamp: ~N[2019-07-01 23:00:00]
),
build(:pageview,
pathname: "/billing/success",
timestamp: ~N[2019-07-01 23:00:00]
),
build(:pageview,
pathname: "/billing/upgrade/success",
timestamp: ~N[2019-07-01 23:00:00]
),
build(:pageview,
pathname: "/signup/new",
timestamp: ~N[2019-07-01 23:00:00]
),
build(:pageview,
pathname: "/signup/new/2",
timestamp: ~N[2019-07-01 23:00:00]
),
build(:pageview,
pathname: "/signup/new/3",
timestamp: ~N[2019-07-01 23:00:00]
)
])
conn =
get(
conn,
"/api/stats/#{site.domain}/conversions?period=day&date=2019-07-01"
)
assert json_response(conn, 200) == [
%{
"conversion_rate" => 100.0,
"visitors" => 8,
"name" => "Visit /*",
"events" => 8
},
%{
"conversion_rate" => 37.5,
"visitors" => 3,
"name" => "Visit /signup/*",
"events" => 3
},
%{
"conversion_rate" => 25.0,
"visitors" => 2,
"name" => "Visit /billing*/success",
"events" => 2
},
%{
"conversion_rate" => 25.0,
"visitors" => 2,
"name" => "Visit /reg*",
"events" => 2
},
%{
"conversion_rate" => 12.5,
"visitors" => 1,
Implement backend core for funnels (#3023) * Implement Funnel schema * Implement Funnels context module lib/plausible/funnels.ex - restored from: dca93621 Mark Vini's suggestion applied 7d1eec75 Update lib/plausible/funnels.ex 028036ad Review comments b694ccd5 Express the guard nicely acd9c4f2 Prepare ephemeral funnel definitions so that users can test funnels aea4ebc4 Access Funnel min/max steps via the __using__/1 macro 51f0397d Implement deleting funnels cf228630 wip 1f6fe25d Add number of steps to funnels list 89f10ecb wip 950a18d9 Dirty funnel save e62bfce5 Refactor funnel result evaluation 88e38a33 Update funnel tests bf47f654 Calculate conversion rate/dropoff in the backend 9e62ffb1 Make existing tests pass 7a88fe44 Outline basic error handling c8ae3eaf Move Funnels to StatsController and use base query 2929bfd4 Minor rework b490403b !ifxup ae44db77 Add Funnels.list/1 function 4f3216b3 Unique steps 6e0c3efc Ensure step ordering works cea93ba1 It works I think c50ac0c2 WIP a466ec4c Dirty wip fbd14e23 Absolute dirty wip 3ddd15ad wip 34ceb3f5 dirty wip test/plausible_web/controllers/api/stats_controller/funnels_test.exs - restored from: 9b532273 Test funnel stats controller Co-authored-by: Uku Taht <uku.taht@gmail.com> * Update Goals implementation lib/plausible/goal/schema.ex - restored from: 028036ad Review comments acd9c4f2 Prepare ephemeral funnel definitions so that users can test funnels 4a4ddbdc Optionally preload funnels for goals and stub funnel-goal deletion fbd14e23 Absolute dirty wip lib/plausible/goals.ex - restored from: aea4ebc4 Access Funnel min/max steps via the __using__/1 macro a418c039 Implement funnel reduction logic on goal deletion 4a4ddbdc Optionally preload funnels for goals and stub funnel-goal deletion ebdc4333 Extend the prompt in case of funnel-goal deletion 950a18d9 Dirty funnel save f06c3fcf wip test/plausible/goals_test.exs - restored from: a418c039 Implement funnel reduction logic on goal deletion 4a4ddbdc Optionally preload funnels for goals and stub funnel-goal deletion dee5bc9e Fixup tests * Update seeds * Split funnel schema modules * Add moduledoc to Funnel schema * Update Funnel.Step moduledoc * Add typespecs to Plausible.Funnels * Implement Phoenix.HTML.Safe for Funnel schema * Fixup a test after ordering goals by desc:id test/plausible_web/controllers/api/stats_controller/conversions_test.exs - restored from: 26a493cb Fixup a test after ordering goals by desc:id * Annotate Goal schema with type t() * Reword schema module docs * Fix up typespecs * Stop tagging Funnels.get/2 result * Nuke Goals.by_id!/2 * Test Funnels module test/plausible/funnels_test.exs - restored from: b7a6d3ad ya, rly 028036ad Review comments acd9c4f2 Prepare ephemeral funnel definitions so that users can test funnels 51f0397d Implement deleting funnels 1f6fe25d Add number of steps to funnels list dee5bc9e Fixup tests 950a18d9 Dirty funnel save 88e38a33 Update funnel tests bf47f654 Calculate conversion rate/dropoff in the backend 9e62ffb1 Make existing tests pass 2929bfd4 Minor rework b490403b !ifxup ae44db77 Add Funnels.list/1 function 4f3216b3 Unique steps 6e0c3efc Ensure step ordering works cea93ba1 It works I think c50ac0c2 WIP a466ec4c Dirty wip 34ceb3f5 dirty wip Co-authored-by: Uku Taht <uku.taht@gmail.com> * Apply changes related to 242081e5 * Evaluate funnels through `Stats.funnel/3` entry point --------- Co-authored-by: Uku Taht <uku.taht@gmail.com>
3 years ago
"name" => "Visit /register",
"events" => 1
}
]
end
end
end