Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
defmodule PlausibleWeb.Api.StatsController.DebugMetadataTest do
use PlausibleWeb.ConnCase
describe "Debug metadata for logged in requests" do
setup [:create_user, :log_in]
test "for /api/stats/:domain/query", %{conn: conn, user: user} do
domain = :rand.bytes(20) |> Base.url_encode64()
site = new_site(domain: domain, owner: user)
conn =
post(conn, "/api/stats/#{site.domain}/query", %{
"date_range" => "day",
"metrics" => ["visitors"]
})
assert json_response(conn, 200)
assert [r1, r2] =
eventually(fn ->
rows = get_entries_from_query_log(site.domain)
{length(rows) == 2, rows}
end)
for [unparsed_log_comment] <- [r1, r2] do
decoded = Jason.decode!(unparsed_log_comment)
assert_matches ^strict_map(%{
"params" =>
^strict_map(%{
"domain" => ^site.domain,
"date_range" => "day",
"metrics" => ["visitors"]
}),
"phoenix_action" => "query",
"phoenix_controller" => "Elixir.PlausibleWeb.Api.StatsController",
"request_method" => "POST",
"request_path" => ^"/api/stats/#{site.domain}/query",
"site_domain" => ^site.domain,
"site_id" => ^site.id,
"team_id" => ^team_of(user).id,
"trace_id" => _,
"user_id" => ^user.id
}) = decoded
end
end
end
defp setup_dashboard_case(domain, type) do
site_owner = new_user()
case type do
"public" ->
site = new_site(domain: domain, owner: site_owner, public: true)
{site, "", %{"domain" => domain}}
"shared" ->
site = new_site(domain: domain, owner: site_owner)
link = insert(:shared_link, site: site)
{site, "?auth=#{link.slug}", %{"domain" => domain, "auth" => link.slug}}
end
end
describe "Debug metadata for non-private dashboard requests" do
setup [:create_user, :log_in]
for type <- ["public", "shared"] do
test "for /query request (#{type})", %{
conn: conn,
user: user
} do
domain = :rand.bytes(20) |> Base.url_encode64()
{site, query_string, expected_params} = setup_dashboard_case(domain, unquote(type))
query_params = %{
"date_range" => "day",
"dimensions" => ["event:page"],
"metrics" => ["visitors"]
}
expected_params = Map.merge(expected_params, query_params)
conn =
post(conn, "/api/stats/#{site.domain}/query#{query_string}", query_params)
assert json_response(conn, 200)
assert [r1, r2] =
eventually(fn ->
rows = get_entries_from_query_log(site.domain)
{length(rows) == 2, rows}
end)
for [unparsed_log_comment] <- [r1, r2] do
decoded = Jason.decode!(unparsed_log_comment)
assert_matches ^strict_map(%{
# params are asserted below
"params" => %{},
"phoenix_action" => "query",
"phoenix_controller" => "Elixir.PlausibleWeb.Api.StatsController",
"request_method" => "POST",
"request_path" => ^"/api/stats/#{site.domain}/query",
"site_domain" => ^site.domain,
"site_id" => ^site.id,
# nil team_id because viewing a public/shared dashboard
"team_id" => nil,
"trace_id" => _,
# the logged in user ID is included even when viewing a random public dashboard
"user_id" => ^user.id
}) = decoded
assert decoded["params"] == expected_params
end
end
end
end
end