Skip to content

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

Stop storing internal referrer (#4965)

Uku Taht01979452cd35
diff --git a/lib/plausible/ingestion/event.ex b/lib/plausible/ingestion/event.ex
index c235e567e5..e113ae8047 100644
--- a/lib/plausible/ingestion/event.ex
+++ b/lib/plausible/ingestion/event.ex
@@ -265,7 +265,7 @@ defmodule Plausible.Ingestion.Event do
update_session_attrs(event, %{
referrer_source: Plausible.Ingestion.Source.resolve(event.request),
- referrer: Plausible.Ingestion.Source.format_referrer(event.request.referrer),
+ referrer: Plausible.Ingestion.Source.format_referrer(event.request),
click_id_param: get_click_id_param(event.request.query_params),
utm_source: tagged_source,
utm_medium: query_params["utm_medium"],
diff --git a/lib/plausible/ingestion/source.ex b/lib/plausible/ingestion/source.ex
index c23728b0dc..dd474a79be 100644
--- a/lib/plausible/ingestion/source.ex
+++ b/lib/plausible/ingestion/source.ex
@@ -86,7 +86,7 @@ defmodule Plausible.Ingestion.Source do
source =
cond do
tagged_source -> tagged_source
- has_referral?(request) -> parse(request.referrer)
+ has_valid_referral?(request) -> parse(request.referrer)
true -> nil
end
@@ -97,10 +97,7 @@ defmodule Plausible.Ingestion.Source do
case RefInspector.parse(ref).source do
:unknown ->
uri = URI.parse(String.trim(ref))
-
- if valid_referrer?(uri) do
- format_referrer_host(uri)
- end
+ format_referrer_host(uri)
source ->
source
@@ -116,30 +113,28 @@ defmodule Plausible.Ingestion.Source do
end
end
- def format_referrer(nil), do: nil
-
- def format_referrer(referrer) do
- referrer_uri = URI.parse(referrer)
-
- if valid_referrer?(referrer_uri) do
+ def format_referrer(request) do
+ if has_valid_referral?(request) do
+ referrer_uri = URI.parse(request.referrer)
path = String.trim_trailing(referrer_uri.path || "", "/")
format_referrer_host(referrer_uri) <> path
end
end
- defp valid_referrer?(%URI{host: host, scheme: scheme})
- when scheme in ["http", "https", "android-app"] and byte_size(host) > 0,
- do: true
+ defp has_valid_referral?(%Request{referrer: nil}), do: false
- defp valid_referrer?(_), do: false
+ defp has_valid_referral?(%Request{referrer: referrer, uri: uri}) do
+ referrer_uri = URI.parse(referrer)
- defp has_referral?(%Request{referrer: nil}), do: false
+ valid_scheme? = referrer_uri.scheme in ["http", "https", "android-app"]
+ valid_host? = !is_nil(referrer_uri.host) && byte_size(referrer_uri.host) > 0
- defp has_referral?(%Request{referrer: referrer, uri: uri}) do
- referrer_uri = URI.parse(referrer)
+ internal? =
+ Request.sanitize_hostname(referrer_uri.host) == Request.sanitize_hostname(uri.host)
+
+ local? = referrer_uri.host == "localhost"
- Request.sanitize_hostname(referrer_uri.host) !== Request.sanitize_hostname(uri.host) and
- referrer_uri.host !== "localhost"
+ valid_scheme? and valid_host? and not internal? and not local?
end
defp format_referrer_host(uri) do
diff --git a/test/plausible_web/controllers/api/external_controller_test.exs b/test/plausible_web/controllers/api/external_controller_test.exs
index 868adb31aa..fdd391ef05 100644
--- a/test/plausible_web/controllers/api/external_controller_test.exs
+++ b/test/plausible_web/controllers/api/external_controller_test.exs
@@ -337,6 +337,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do
assert response(conn, 202) == "ok"
assert session.referrer_source == ""
+ assert session.referrer == ""
end
test "ignores localhost referrer", %{conn: conn, site: site} do