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
Average Scroll Depth Metric: extracted ingestion changes (#4828)
RobertJoonas7f783920f364
diff --git a/lib/plausible/clickhouse_event_v2.ex b/lib/plausible/clickhouse_event_v2.exindex eb5d309b9e..e8a0141d68 100644--- a/lib/plausible/clickhouse_event_v2.ex+++ b/lib/plausible/clickhouse_event_v2.ex@@ -17,6 +17,7 @@ defmodule Plausible.ClickhouseEventV2 dofield :"meta.key", {:array, :string}field :"meta.value", {:array, :string}+ field :scroll_depth, Ch, type: "UInt8"field :revenue_source_amount, Ch, type: "Nullable(Decimal64(3))"field :revenue_source_currency, Ch, type: "FixedString(3)"@@ -60,6 +61,7 @@ defmodule Plausible.ClickhouseEventV2 do:timestamp,:"meta.key",:"meta.value",+ :scroll_depth,:revenue_source_amount,:revenue_source_currency,:revenue_reporting_amount,diff --git a/lib/plausible/ingestion/event.ex b/lib/plausible/ingestion/event.exindex f94c81bc4b..ad04a639ad 100644--- a/lib/plausible/ingestion/event.ex+++ b/lib/plausible/ingestion/event.ex@@ -246,7 +246,8 @@ defmodule Plausible.Ingestion.Event dotimestamp: event.request.timestamp,name: event.request.event_name,hostname: event.request.hostname,- pathname: event.request.pathname+ pathname: event.request.pathname,+ scroll_depth: event.request.scroll_depth})enddiff --git a/lib/plausible/ingestion/request.ex b/lib/plausible/ingestion/request.exindex 407b4c0325..7e48ae7e52 100644--- a/lib/plausible/ingestion/request.ex+++ b/lib/plausible/ingestion/request.ex@@ -41,6 +41,7 @@ defmodule Plausible.Ingestion.Request dofield :hash_mode, :integerfield :pathname, :stringfield :props, :map+ field :scroll_depth, :integeron_ee dofield :revenue_source, :map@@ -77,6 +78,7 @@ defmodule Plausible.Ingestion.Request do|> put_request_params(request_body)|> put_referrer(request_body)|> put_props(request_body)+ |> put_scroll_depth(request_body)|> put_pathname()|> put_query_params()|> put_revenue_source(request_body)@@ -245,6 +247,21 @@ defmodule Plausible.Ingestion.Request doendend+ defp put_scroll_depth(changeset, %{} = request_body) do+ if Changeset.get_field(changeset, :event_name) == "pageleave" do+ scroll_depth =+ case request_body["sd"] do+ sd when is_integer(sd) and sd >= 0 and sd <= 100 -> sd+ sd when is_integer(sd) and sd > 100 -> 100+ _ -> 0+ end++ Changeset.put_change(changeset, :scroll_depth, scroll_depth)+ else+ changeset+ end+ end+defp put_query_params(changeset) docase Changeset.get_field(changeset, :uri) do%{query: query} when is_binary(query) ->diff --git a/test/plausible/ingestion/request_test.exs b/test/plausible/ingestion/request_test.exsindex cfe5929381..23fd6c4d18 100644--- a/test/plausible/ingestion/request_test.exs+++ b/test/plausible/ingestion/request_test.exs@@ -464,7 +464,8 @@ defmodule Plausible.Ingestion.RequestTest do"revenue_source" => %{"amount" => "12.3", "currency" => "USD"},"uri" => "https://dummy.site/pictures/index.html?foo=bar&baz=bam","user_agent" => "Mozilla",- "ip_classification" => nil+ "ip_classification" => nil,+ "scroll_depth" => nil}assert %NaiveDateTime{} = NaiveDateTime.from_iso8601!(request["timestamp"])diff --git a/test/plausible_web/controllers/api/external_controller_test.exs b/test/plausible_web/controllers/api/external_controller_test.exsindex a5244488ef..f866df67e1 100644--- a/test/plausible_web/controllers/api/external_controller_test.exs+++ b/test/plausible_web/controllers/api/external_controller_test.exs@@ -1253,6 +1253,64 @@ defmodule PlausibleWeb.Api.ExternalControllerTest doendend+ describe "scroll depth tests" do+ setup do+ site = insert(:site)+ {:ok, site: site}+ end++ test "ingests scroll_depth as 0 when sd not in params", %{conn: conn, site: site} do+ post(conn, "/api/event", %{n: "pageview", u: "https://test.com", d: site.domain})+ post(conn, "/api/event", %{n: "pageleave", u: "https://test.com", d: site.domain})+ post(conn, "/api/event", %{n: "custom", u: "https://test.com", d: site.domain})++ assert [%{scroll_depth: 0}, %{scroll_depth: 0}, %{scroll_depth: 0}] = get_events(site)+ end++ test "sd field is ignored if name is not pageleave", %{conn: conn, site: site} do+ post(conn, "/api/event", %{n: "pageview", u: "https://test.com", d: site.domain, sd: 10})+ post(conn, "/api/event", %{n: "custom_e", u: "https://test.com", d: site.domain, sd: 10})++ assert [%{scroll_depth: 0}, %{scroll_depth: 0}] = get_events(site)+ end++ test "ingests valid scroll_depth for a pageleave", %{conn: conn, site: site} do+ post(conn, "/api/event", %{n: "pageview", u: "https://test.com", d: site.domain})+ post(conn, "/api/event", %{n: "pageleave", u: "https://test.com", d: site.domain, sd: 25})++ pageleave = get_events(site) |> Enum.find(&(&1.name == "pageleave"))++ assert pageleave.scroll_depth == 25+ end++ test "ingests scroll_depth as 100 when sd > 100", %{conn: conn, site: site} do+ post(conn, "/api/event", %{n: "pageview", u: "https://test.com", d: site.domain})+ post(conn, "/api/event", %{n: "pageleave", u: "https://test.com", d: site.domain, sd: 101})++ pageleave = get_events(site) |> Enum.find(&(&1.name == "pageleave"))++ assert pageleave.scroll_depth == 100+ end++ test "ingests scroll_depth as 0 when sd is a string", %{conn: conn, site: site} do+ post(conn, "/api/event", %{n: "pageview", u: "https://test.com", d: site.domain})+ post(conn, "/api/event", %{n: "pageleave", u: "https://test.com", d: site.domain, sd: "1"})++ pageleave = get_events(site) |> Enum.find(&(&1.name == "pageleave"))++ assert pageleave.scroll_depth == 0+ end++ test "ingests scroll_depth as 0 when sd is a negative integer", %{conn: conn, site: site} do+ post(conn, "/api/event", %{n: "pageview", u: "https://test.com", d: site.domain})+ post(conn, "/api/event", %{n: "pageleave", u: "https://test.com", d: site.domain, sd: -1})++ pageleave = get_events(site) |> Enum.find(&(&1.name == "pageleave"))++ assert pageleave.scroll_depth == 0+ end+ end+describe "acquisition channel tests" dosetup dosite = insert(:site)