Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Scroll depth: Engagement events should refresh in-memory session cache (#5063)

Karl-Aksel Puulmannecae780750d8
diff --git a/lib/plausible/ingestion/event.ex b/lib/plausible/ingestion/event.ex
index e113ae8047..c9a52edd1f 100644
--- a/lib/plausible/ingestion/event.ex
+++ b/lib/plausible/ingestion/event.ex
@@ -385,17 +385,17 @@ defmodule Plausible.Ingestion.Event do
)
case session_result do
+ {:ok, :no_session_for_pageleave} ->
+ drop(event, :no_session_for_pageleave)
+
+ {:error, :timeout} ->
+ drop(event, :lock_timeout)
+
{:ok, session} ->
%{
event
| clickhouse_event: ClickhouseEventV2.merge_session(event.clickhouse_event, session)
}
-
- {:error, :no_session_for_pageleave} ->
- drop(event, :no_session_for_pageleave)
-
- {:error, :timeout} ->
- drop(event, :lock_timeout)
end
end
diff --git a/lib/plausible/session/cache_store.ex b/lib/plausible/session/cache_store.ex
index 7f89870df5..5e0a1eaf6f 100644
--- a/lib/plausible/session/cache_store.ex
+++ b/lib/plausible/session/cache_store.ex
@@ -8,27 +8,7 @@ defmodule Plausible.Session.CacheStore do
def lock_telemetry_event, do: @lock_telemetry_event
- def on_event(event, session_attributes, prev_user_id, buffer_insert \\ &WriteBuffer.insert/1)
-
- def on_event(%{name: name} = event, _, prev_user_id, _)
- when name in ["pageleave", "engagement"] do
- # The `pageleave` event is currently experimental. In a real use case we would
- # probably want to update the session as well (e.g. `is_bounce` or `duration`).
-
- # However, for now we're only interested in finding out the success rate of
- # pageleave events. So these events will simply be inserted into the events
- # table with the session ID found from the cache. If there's no session, the
- # event will be dropped.
- found_session = find_session(event, event.user_id) || find_session(event, prev_user_id)
-
- if found_session do
- {:ok, found_session}
- else
- {:error, :no_session_for_pageleave}
- end
- end
-
- def on_event(event, session_attributes, prev_user_id, buffer_insert) do
+ def on_event(event, session_attributes, prev_user_id, buffer_insert \\ &WriteBuffer.insert/1) do
lock_requested_at = System.monotonic_time()
Plausible.Cache.Adapter.with_lock(
@@ -40,19 +20,35 @@ defmodule Plausible.Session.CacheStore do
:telemetry.execute(@lock_telemetry_event, %{duration: lock_duration}, %{})
found_session = find_session(event, event.user_id) || find_session(event, prev_user_id)
- if found_session do
- updated_session = update_session(found_session, event)
- buffer_insert.([%{found_session | sign: -1}, %{updated_session | sign: 1}])
- persist_session(updated_session)
- else
- new_session = new_session_from_event(event, session_attributes)
- buffer_insert.([new_session])
- persist_session(new_session)
- end
+ handle_event(event, found_session, session_attributes, buffer_insert)
end
)
end
+ defp handle_event(%{name: name} = event, found_session, _, _)
+ when name in ["pageleave", "engagement"] do
+ if found_session do
+ # Make sure the session is kept active in the in-memory session cache
+ refresh_session_cache(found_session, event.timestamp)
+
+ found_session
+ else
+ :no_session_for_pageleave
+ end
+ end
+
+ defp handle_event(event, found_session, session_attributes, buffer_insert) do
+ if found_session do
+ updated_session = update_session(found_session, event)
+ buffer_insert.([%{found_session | sign: -1}, %{updated_session | sign: 1}])
+ update_session_cache(updated_session)
+ else
+ new_session = new_session_from_event(event, session_attributes)
+ buffer_insert.([new_session])
+ update_session_cache(new_session)
+ end
+ end
+
defp find_session(_domain, nil), do: nil
defp find_session(event, user_id) do
@@ -69,12 +65,18 @@ defmodule Plausible.Session.CacheStore do
end
end
- defp persist_session(session) do
+ defp update_session_cache(session) do
key = {session.site_id, session.user_id}
Plausible.Cache.Adapter.put(:sessions, key, session, dirty?: true)
session
end
+ defp refresh_session_cache(session, timestamp) do
+ session
+ |> Map.put(:timestamp, timestamp)
+ |> update_session_cache()
+ end
+
defp update_session(session, event) do
%{
session
diff --git a/test/plausible/session/cache_store_test.exs b/test/plausible/session/cache_store_test.exs
index 33f3ef6386..1bf2a45fc0 100644
--- a/test/plausible/session/cache_store_test.exs
+++ b/test/plausible/session/cache_store_test.exs
@@ -262,13 +262,13 @@ defmodule Plausible.Session.CacheStoreTest do
assert session.events == 2
end
- test "does not update session counters on pageleave event", %{buffer: buffer} do
- now = Timex.now()
- pageview = build(:pageview, timestamp: Timex.shift(now, seconds: -10))
- pageleave = %{pageview | name: "pageleave", timestamp: now}
+ test "does not update session counters on engagement event", %{buffer: buffer} do
+ now = NaiveDateTime.utc_now(:second)
+ pageview = build(:pageview, timestamp: NaiveDateTime.shift(now, second: -10))
+ engagement = %{pageview | name: "engagement", timestamp: now}
CacheStore.on_event(pageview, %{}, nil, buffer)
- CacheStore.on_event(pageleave, %{}, nil, buffer)
+ CacheStore.on_event(engagement, %{}, nil, buffer)
assert_receive({:buffer, :insert, [[session]]})
assert session.is_bounce == true
@@ -277,6 +277,35 @@ defmodule Plausible.Session.CacheStoreTest do
assert session.events == 1
end
+ test "keeps session in cache after engagement events", %{buffer: buffer} do
+ start = NaiveDateTime.utc_now(:second) |> NaiveDateTime.shift(day: -1)
+
+ pageview1 = build(:event, name: "pageview", timestamp: start)
+
+ CacheStore.on_event(pageview1, %{}, nil, buffer)
+ assert_receive({:buffer, :insert, [[start_session]]})
+
+ for delta <- [20, 40, 60] do
+ engagement =
+ Map.merge(pageview1, %{
+ name: "engagement",
+ timestamp: start |> NaiveDateTime.shift(minute: delta)
+ })
+
+ CacheStore.on_event(engagement, %{}, nil, buffer)
+ end
+
+ pageview2 = Map.put(pageview1, :timestamp, start |> NaiveDateTime.shift(minute: 80))
+ CacheStore.on_event(pageview2, %{}, nil, buffer)
+ assert_receive({:buffer, :insert, [[_negative_record, updated_session]]})
+
+ assert updated_session.session_id == start_session.session_id
+ assert updated_session.is_bounce == false
+ assert updated_session.duration == 80 * 60
+ assert updated_session.pageviews == 2
+ assert updated_session.events == 2
+ end
+
describe "hostname-related attributes" do
test "initial for non-pageview" do
site_id = new_site_id()