defmodule PlausibleWeb.StatsControllerTest do use PlausibleWeb.ConnCase, async: false use Plausible.Repo import Plausible.Test.Support.HTML @react_container "div#stats-react-container" describe "GET /:website - anonymous user" do test "public site - shows site stats", %{conn: conn} do site = insert(:site, public: true) populate_stats(site, [build(:pageview)]) conn = get(conn, "/#{site.domain}") resp = html_response(conn, 200) assert element_exists?(resp, @react_container) assert text_of_attr(resp, @react_container, "data-domain") == site.domain assert text_of_attr(resp, @react_container, "data-is-dbip") == "false" assert ["noindex, nofollow"] == resp |> find("meta[name=robots]") |> Floki.attribute("content") assert text_of_element(resp, "title") == "Plausible ยท #{site.domain}" end test "plausible.io live demo - shows site stats", %{conn: conn} do site = insert(:site, domain: "plausible.io", public: true) populate_stats(site, [build(:pageview)]) conn = get(conn, "/#{site.domain}") resp = html_response(conn, 200) assert element_exists?(resp, @react_container) assert ["index, nofollow"] == resp |> find("meta[name=robots]") |> Floki.attribute("content") assert text_of_element(resp, "title") == "Plausible Analytics: Live Demo" end test "public site - shows waiting for first pageview", %{conn: conn} do insert(:site, domain: "some-other-public-site.io", public: true) conn = get(conn, "/some-other-public-site.io") assert html_response(conn, 200) =~ "Need to see the snippet again?" end test "can not view stats of a private website", %{conn: conn} do _ = insert(:user) conn = get(conn, "/test-site.com") assert html_response(conn, 404) =~ "There's nothing here" end end describe "GET /:website - as a logged in user" do setup [:create_user, :log_in, :create_site] test "can view stats of a website I've created", %{conn: conn, site: site} do populate_stats(site, [build(:pageview)]) conn = get(conn, "/" <> site.domain) assert html_response(conn, 200) =~ "stats-react-container" end test "shows locked page if page is locked", %{conn: conn, user: user} do locked_site = insert(:site, locked: true, members: [user]) conn = get(conn, "/" <> locked_site.domain) assert html_response(conn, 200) =~ "Dashboard locked" end test "can not view stats of someone else's website", %{conn: conn} do site = insert(:site) conn = get(conn, "/" <> site.domain) assert html_response(conn, 404) =~ "There's nothing here" end end describe "GET /:website - as a super admin" do @describetag :full_build_only setup [:create_user, :make_user_super_admin, :log_in] test "can view a private dashboard with stats", %{conn: conn} do site = insert(:site) populate_stats(site, [build(:pageview)]) conn = get(conn, "/" <> site.domain) assert html_response(conn, 200) =~ "stats-react-container" end test "can view a private dashboard without stats", %{conn: conn} do site = insert(:site) conn = get(conn, "/" <> site.domain) assert html_response(conn, 200) =~ "Need to see the snippet again?" end test "can view a private locked dashboard with stats", %{conn: conn} do user = insert(:user) site = insert(:site, locked: true, members: [user]) populate_stats(site, [build(:pageview)]) conn = get(conn, "/" <> site.domain) assert html_response(conn, 200) =~ "stats-react-container" assert html_response(conn, 200) =~ "This dashboard is actually locked" end test "can view a private locked dashboard without stats", %{conn: conn} do user = insert(:user) site = insert(:site, locked: true, members: [user]) conn = get(conn, "/" <> site.domain) assert html_response(conn, 200) =~ "Need to see the snippet again?" assert html_response(conn, 200) =~ "This dashboard is actually locked" end test "can view a locked public dashboard", %{conn: conn} do site = insert(:site, locked: true, public: true) populate_stats(site, [build(:pageview)]) conn = get(conn, "/" <> site.domain) assert html_response(conn, 200) =~ "stats-react-container" end end defp make_user_super_admin(%{user: user}) do Application.put_env(:plausible, :super_admin_user_ids, [user.id]) end describe "GET /:website/export" do setup [:create_user, :create_new_site, :log_in] test "exports all the necessary CSV files", %{conn: conn, site: site} do conn = get(conn, "/" <> site.domain <> "/export") assert {"content-type", "application/zip; charset=utf-8"} = List.keyfind(conn.resp_headers, "content-type", 0) {:ok, zip} = :zip.unzip(response(conn, 200), [:memory]) zip = Enum.map(zip, fn {filename, _} -> filename end) assert ~c"visitors.csv" in zip assert ~c"browsers.csv" in zip assert ~c"browser_versions.csv" in zip assert ~c"cities.csv" in zip assert ~c"conversions.csv" in zip assert ~c"countries.csv" in zip assert ~c"devices.csv" in zip assert ~c"entry_pages.csv" in zip assert ~c"exit_pages.csv" in zip assert ~c"operating_systems.csv" in zip assert ~c"operating_system_versions.csv" in zip assert ~c"pages.csv" in zip assert ~c"regions.csv" in zip assert ~c"sources.csv" in zip assert ~c"utm_campaigns.csv" in zip assert ~c"utm_contents.csv" in zip assert ~c"utm_mediums.csv" in zip assert ~c"utm_sources.csv" in zip assert ~c"utm_terms.csv" in zip end test "exports only internally used props in custom_props.csv for a growth plan", %{ conn: conn, site: site } do {:ok, site} = Plausible.Props.allow(site, ["author"]) site = Repo.preload(site, :owner) insert(:growth_subscription, user: site.owner) populate_stats(site, [ build(:pageview, "meta.key": ["author"], "meta.value": ["a"]), build(:event, name: "File Download", "meta.key": ["url"], "meta.value": ["b"]) ]) conn = get(conn, "/" <> site.domain <> "/export?period=day") assert response = response(conn, 200) {:ok, zip} = :zip.unzip(response, [:memory]) {_filename, result} = Enum.find(zip, fn {filename, _data} -> filename == ~c"custom_props.csv" end) assert parse_csv(result) == [ ["property", "value", "visitors", "events", "percentage"], ["url", "b", "1", "1", "50.0"], ["url", "(none)", "1", "1", "50.0"], [""] ] end test "does not include custom_props.csv for a growth plan if no internal props used", %{ conn: conn, site: site } do {:ok, site} = Plausible.Props.allow(site, ["author"]) site = Repo.preload(site, :owner) insert(:growth_subscription, user: site.owner) populate_stats(site, [ build(:pageview, "meta.key": ["author"], "meta.value": ["a"]) ]) {:ok, zip} = conn |> get("/#{site.domain}/export?period=day") |> response(200) |> :zip.unzip([:memory]) files = Map.new(zip) refute Map.has_key?(files, ~c"custom_props.csv") end test "exports data in zipped csvs", %{conn: conn, site: site} do populate_exported_stats(site) conn = get(conn, "/" <> site.domain <> "/export?date=2021-10-20") assert_zip(conn, "30d") end test "fails to export with interval=undefined, looking at you, spiders", %{ conn: conn, site: site } do assert conn |> get("/" <> site.domain <> "/export?date=2021-10-20&interval=undefined") |> response(400) end test "exports allowed event props for a trial account", %{conn: conn, site: site} do {:ok, site} = Plausible.Props.allow(site, ["author", "logged_in"]) populate_stats(site, [ build(:pageview, "meta.key": ["author"], "meta.value": ["uku"]), build(:pageview, "meta.key": ["author"], "meta.value": ["uku"]), build(:event, "meta.key": ["author"], "meta.value": ["marko"], name: "Newsletter Signup"), build(:pageview, user_id: 999, "meta.key": ["logged_in"], "meta.value": ["true"]), build(:pageview, user_id: 999, "meta.key": ["logged_in"], "meta.value": ["true"]), build(:pageview, "meta.key": ["disallowed"], "meta.value": ["whatever"]), build(:pageview) ]) conn = get(conn, "/" <> site.domain <> "/export?period=day") assert response = response(conn, 200) {:ok, zip} = :zip.unzip(response, [:memory]) {_filename, result} = Enum.find(zip, fn {filename, _data} -> filename == ~c"custom_props.csv" end) assert parse_csv(result) == [ ["property", "value", "visitors", "events", "percentage"], ["author", "(none)", "3", "4", "50.0"], ["author", "uku", "2", "2", "33.3"], ["author", "marko", "1", "1", "16.7"], ["logged_in", "(none)", "5", "5", "83.3"], ["logged_in", "true", "1", "2", "16.7"], [""] ] end test "exports data grouped by interval", %{conn: conn, site: site} do populate_exported_stats(site) conn = get(conn, "/" <> site.domain <> "/export?date=2021-10-20&period=30d&interval=week") assert response = response(conn, 200) {:ok, zip} = :zip.unzip(response, [:memory]) {_filename, visitors} = Enum.find(zip, fn {filename, _data} -> filename == ~c"visitors.csv" end) assert parse_csv(visitors) == [ [ "date", "visitors", "pageviews", "visits", "views_per_visit", "bounce_rate", "visit_duration" ], ["2021-09-20", "1", "1", "1", "1.0", "100", "0"], ["2021-09-27", "0", "0", "0", "0.0", "", ""], ["2021-10-04", "0", "0", "0", "0.0", "", ""], ["2021-10-11", "0", "0", "0", "0.0", "", ""], ["2021-10-18", "3", "3", "3", "1.0", "67", "20"], [""] ] end test "exports operating system versions", %{conn: conn, site: site} do populate_stats(site, [ build(:pageview, operating_system: "Mac", operating_system_version: "14"), build(:pageview, operating_system: "Mac", operating_system_version: "14"), build(:pageview, operating_system: "Mac", operating_system_version: "14"), build(:pageview, operating_system: "Ubuntu", operating_system_version: "20.04" ), build(:pageview, operating_system: "Ubuntu", operating_system_version: "20.04" ), build(:pageview, operating_system: "Mac", operating_system_version: "13") ]) conn = get(conn, "/#{site.domain}/export") assert response = response(conn, 200) {:ok, zip} = :zip.unzip(response, [:memory]) {_filename, os_versions} = Enum.find(zip, fn {filename, _data} -> filename == ~c"operating_system_versions.csv" end) assert parse_csv(os_versions) == [ ["name", "version", "visitors"], ["Mac", "14", "3"], ["Ubuntu", "20.04", "2"], ["Mac", "13", "1"], [""] ] end end defp parse_csv(file_content) when is_binary(file_content) do file_content |> String.split("\r\n") |> Enum.map(&String.split(&1, ",")) end describe "GET /:website/export - via shared link" do test "exports data in zipped csvs", %{conn: conn} do site = insert(:site, domain: "new-site.com") link = insert(:shared_link, site: site) populate_exported_stats(site) conn = get(conn, "/" <> site.domain <> "/export?auth=#{link.slug}&date=2021-10-20") assert_zip(conn, "30d") end end describe "GET /:website/export - for past 6 months" do setup [:create_user, :create_new_site, :log_in] test "exports 6 months of data in zipped csvs", %{conn: conn, site: site} do populate_exported_stats(site) conn = get(conn, "/" <> site.domain <> "/export?period=6mo&date=2021-10-20") assert_zip(conn, "6m") end end describe "GET /:website/export - with path filter" do setup [:create_user, :create_new_site, :log_in] test "exports filtered data in zipped csvs", %{conn: conn, site: site} do populate_exported_stats(site) filters = Jason.encode!(%{page: "/some-other-page"}) conn = get(conn, "/#{site.domain}/export?date=2021-10-20&filters=#{filters}") assert_zip(conn, "30d-filter-path") end end describe "GET /:website/export - with a custom prop filter" do setup [:create_user, :create_new_site, :log_in] test "custom-props.csv only returns the prop and its value in filter", %{ conn: conn, site: site } do {:ok, site} = Plausible.Props.allow(site, ["author", "logged_in"]) populate_stats(site, [ build(:pageview, "meta.key": ["author"], "meta.value": ["uku"]), build(:pageview, "meta.key": ["author"], "meta.value": ["marko"]), build(:pageview, "meta.key": ["logged_in"], "meta.value": ["true"]) ]) filters = Jason.encode!(%{props: %{author: "marko"}}) conn = get(conn, "/" <> site.domain <> "/export?period=day&filters=#{filters}") {:ok, zip} = :zip.unzip(response(conn, 200), [:memory]) {_filename, result} = Enum.find(zip, fn {filename, _data} -> filename == ~c"custom_props.csv" end) assert parse_csv(result) == [ ["property", "value", "visitors", "events", "percentage"], ["author", "marko", "1", "1", "100.0"], [""] ] end end defp assert_zip(conn, folder) do assert conn.status == 200 assert {"content-type", "application/zip; charset=utf-8"} = List.keyfind(conn.resp_headers, "content-type", 0) {:ok, zip} = :zip.unzip(response(conn, 200), [:memory]) folder = Path.expand(folder, "test/plausible_web/controllers/CSVs") Enum.map(zip, &assert_csv(&1, folder)) end defp assert_csv({file, downloaded}, folder) do file = Path.expand(file, folder) {:ok, content} = File.read(file) msg = "CSV file comparison failed (#{file})" assert downloaded == content, message: msg, left: downloaded, right: content end defp populate_exported_stats(site) do populate_stats(site, [ build(:pageview, user_id: 123, pathname: "/", timestamp: Timex.shift(~N[2021-10-20 12:00:00], minutes: -1) |> NaiveDateTime.truncate(:second), country_code: "EE", subdivision1_code: "EE-37", city_geoname_id: 588_409, referrer_source: "Google" ), build(:pageview, user_id: 123, pathname: "/some-other-page", timestamp: Timex.shift(~N[2021-10-20 12:00:00], minutes: -2) |> NaiveDateTime.truncate(:second), country_code: "EE", subdivision1_code: "EE-37", city_geoname_id: 588_409, referrer_source: "Google" ), build(:pageview, pathname: "/", timestamp: Timex.shift(~N[2021-10-20 12:00:00], days: -1) |> NaiveDateTime.truncate(:second), utm_medium: "search", utm_campaign: "ads", utm_source: "google", utm_content: "content", utm_term: "term", browser: "Firefox", browser_version: "120", operating_system: "Mac", operating_system_version: "14" ), build(:pageview, timestamp: Timex.shift(~N[2021-10-20 12:00:00], months: -1) |> NaiveDateTime.truncate(:second), country_code: "EE", browser: "Firefox", browser_version: "120", operating_system: "Mac", operating_system_version: "14" ), build(:pageview, timestamp: Timex.shift(~N[2021-10-20 12:00:00], months: -5) |> NaiveDateTime.truncate(:second), utm_campaign: "ads", country_code: "EE", referrer_source: "Google", browser: "FirefoxNoVersion", operating_system: "MacNoVersion" ), build(:event, timestamp: Timex.shift(~N[2021-10-20 12:00:00], days: -1) |> NaiveDateTime.truncate(:second), name: "Signup", "meta.key": ["variant"], "meta.value": ["A"] ) ]) insert(:goal, %{site: site, event_name: "Signup"}) end describe "GET /:website/export - with goal filter" do setup [:create_user, :create_new_site, :log_in] test "exports goal-filtered data in zipped csvs", %{conn: conn, site: site} do populate_exported_stats(site) filters = Jason.encode!(%{goal: "Signup"}) conn = get(conn, "/#{site.domain}/export?date=2021-10-20&filters=#{filters}") assert_zip(conn, "30d-filter-goal") end test "custom-props.csv only returns the prop names for the goal in filter", %{ conn: conn, site: site } do {:ok, site} = Plausible.Props.allow(site, ["author", "logged_in"]) populate_stats(site, [ build(:event, name: "Newsletter Signup", "meta.key": ["author"], "meta.value": ["uku"]), build(:event, name: "Newsletter Signup", "meta.key": ["author"], "meta.value": ["marko"]), build(:event, name: "Newsletter Signup", "meta.key": ["author"], "meta.value": ["marko"]), build(:pageview, "meta.key": ["logged_in"], "meta.value": ["true"]) ]) filters = Jason.encode!(%{goal: "Newsletter Signup"}) conn = get(conn, "/" <> site.domain <> "/export?period=day&filters=#{filters}") {:ok, zip} = :zip.unzip(response(conn, 200), [:memory]) {_filename, result} = Enum.find(zip, fn {filename, _data} -> filename == ~c"custom_props.csv" end) assert parse_csv(result) == [ ["property", "value", "visitors", "events", "conversion_rate"], ["author", "marko", "2", "2", "50.0"], ["author", "uku", "1", "1", "25.0"], [""] ] end test "exports conversions and conversion rate for operating system versions", %{ conn: conn, site: site } do populate_stats(site, [ build(:pageview, operating_system: "Mac", operating_system_version: "14"), build(:event, name: "Signup", operating_system: "Mac", operating_system_version: "14" ), build(:event, name: "Signup", operating_system: "Mac", operating_system_version: "14" ), build(:event, name: "Signup", operating_system: "Mac", operating_system_version: "14" ), build(:event, name: "Signup", operating_system: "Ubuntu", operating_system_version: "20.04" ), build(:event, name: "Signup", operating_system: "Ubuntu", operating_system_version: "20.04" ), build(:event, name: "Signup", operating_system: "Lubuntu", operating_system_version: "20.04" ) ]) insert(:goal, site: site, event_name: "Signup") conn = get(conn, "/#{site.domain}/export?filters=#{Jason.encode!(%{goal: "Signup"})}") assert response = response(conn, 200) {:ok, zip} = :zip.unzip(response, [:memory]) {_filename, os_versions} = Enum.find(zip, fn {filename, _data} -> filename == ~c"operating_system_versions.csv" end) assert parse_csv(os_versions) == [ ["name", "version", "conversions", "conversion_rate"], ["Mac", "14", "3", "75.0"], ["Ubuntu", "20.04", "2", "100.0"], ["Lubuntu", "20.04", "1", "100.0"], [""] ] end end describe "GET /share/:domain?auth=:auth" do test "prompts a password for a password-protected link", %{conn: conn} do site = insert(:site) link = insert(:shared_link, site: site, password_hash: Plausible.Auth.Password.hash("password")) conn = get(conn, "/share/#{site.domain}?auth=#{link.slug}") assert response(conn, 200) =~ "Enter password" end test "logs anonymous user in straight away if the link is not password-protected", %{ conn: conn } do site = insert(:site, domain: "test-site.com") link = insert(:shared_link, site: site) conn = get(conn, "/share/test-site.com/?auth=#{link.slug}") assert html_response(conn, 200) =~ "stats-react-container" end test "returns page with X-Frame-Options disabled so it can be embedded in an iframe", %{ conn: conn } do site = insert(:site, domain: "test-site.com") link = insert(:shared_link, site: site) conn = get(conn, "/share/test-site.com/?auth=#{link.slug}") assert Plug.Conn.get_resp_header(conn, "x-frame-options") == [] end test "shows locked page if page is locked", %{conn: conn} do site = insert(:site, domain: "test-site.com", locked: true) link = insert(:shared_link, site: site) conn = get(conn, "/share/test-site.com/?auth=#{link.slug}") assert html_response(conn, 200) =~ "Dashboard locked" refute String.contains?(html_response(conn, 200), "Back to my sites") end test "renders 404 not found when no auth parameter supplied", %{conn: conn} do conn = get(conn, "/share/example.com") assert response(conn, 404) =~ "nothing here" end test "renders 404 not found when non-existent auth parameter is supplied", %{conn: conn} do conn = get(conn, "/share/example.com?auth=bad-token") assert response(conn, 404) =~ "nothing here" end test "renders 404 not found when auth parameter for another site is supplied", %{conn: conn} do site1 = insert(:site, domain: "test-site-1.com") site2 = insert(:site, domain: "test-site-2.com") site1_link = insert(:shared_link, site: site1) conn = get(conn, "/share/#{site2.domain}/?auth=#{site1_link.slug}") assert response(conn, 404) =~ "nothing here" end end describe "GET /share/:slug - backwards compatibility" do test "it redirects to new shared link format for historical links", %{conn: conn} do site = insert(:site, domain: "test-site.com") site_link = insert(:shared_link, site: site, inserted_at: ~N[2021-12-31 00:00:00]) conn = get(conn, "/share/#{site_link.slug}") assert redirected_to(conn, 302) == "/share/#{site.domain}?auth=#{site_link.slug}" end test "it does nothing for newer links", %{conn: conn} do site = insert(:site, domain: "test-site.com") site_link = insert(:shared_link, site: site, inserted_at: ~N[2022-01-01 00:00:00]) conn = get(conn, "/share/#{site_link.slug}") assert response(conn, 404) =~ "nothing here" end end describe "POST /share/:slug/authenticate" do test "logs anonymous user in with correct password", %{conn: conn} do site = insert(:site, domain: "test-site.com") link = insert(:shared_link, site: site, password_hash: Plausible.Auth.Password.hash("password")) conn = post(conn, "/share/#{link.slug}/authenticate", %{password: "password"}) assert redirected_to(conn, 302) == "/share/#{site.domain}?auth=#{link.slug}" conn = get(conn, "/share/#{site.domain}?auth=#{link.slug}") assert html_response(conn, 200) =~ "stats-react-container" end test "shows form again with wrong password", %{conn: conn} do site = insert(:site, domain: "test-site.com") link = insert(:shared_link, site: site, password_hash: Plausible.Auth.Password.hash("password")) conn = post(conn, "/share/#{link.slug}/authenticate", %{password: "WRONG!"}) assert html_response(conn, 200) =~ "Enter password" end test "only gives access to the correct dashboard", %{conn: conn} do site = insert(:site, domain: "test-site.com") site2 = insert(:site, domain: "test-site2.com") link = insert(:shared_link, site: site, password_hash: Plausible.Auth.Password.hash("password")) link2 = insert(:shared_link, site: site2, password_hash: Plausible.Auth.Password.hash("password1") ) conn = post(conn, "/share/#{link.slug}/authenticate", %{password: "password"}) assert redirected_to(conn, 302) == "/share/#{site.domain}?auth=#{link.slug}" conn = get(conn, "/share/#{site2.domain}?auth=#{link2.slug}") assert html_response(conn, 200) =~ "Enter password" end end end