Skip to content

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

Ensure `conn` from `Plug.Conn.read_body` is always passed down the pipeline (#5814)

Adrian Gruntkowski3d1f1eca8e97
diff --git a/lib/plausible/ingestion/request.ex b/lib/plausible/ingestion/request.ex
index a8cb3e86f3..cd58d26b8f 100644
--- a/lib/plausible/ingestion/request.ex
+++ b/lib/plausible/ingestion/request.ex
@@ -68,7 +68,8 @@ defmodule Plausible.Ingestion.Request do
@type t() :: %__MODULE__{}
- @spec build(Plug.Conn.t(), NaiveDateTime.t()) :: {:ok, t()} | {:error, Changeset.t()}
+ @spec build(Plug.Conn.t(), NaiveDateTime.t()) ::
+ {:ok, t(), Plug.Conn.t()} | {:error, Changeset.t()}
@doc """
Builds and initially validates %Plausible.Ingestion.Request{} struct from %Plug.Conn{}.
"""
@@ -82,31 +83,40 @@ defmodule Plausible.Ingestion.Request do
)
case parse_body(conn) do
- {:ok, request_body} ->
- changeset
- |> put_ip_classification(conn)
- |> put_remote_ip(conn)
- |> put_uri(request_body)
- |> put_hostname()
- |> put_user_agent(conn)
- |> put_request_params(request_body)
- |> put_referrer(request_body)
- |> put_pathname()
- |> put_props(request_body)
- |> put_engagement_fields(request_body)
- |> put_query_params()
- |> put_revenue_source(request_body)
- |> put_interactive(request_body)
- |> put_tracker_script_version(request_body)
- |> map_domains(request_body)
- |> Changeset.validate_required([
- :event_name,
- :hostname,
- :pathname,
- :timestamp
- ])
- |> Changeset.validate_length(:event_name, max: 120)
- |> Changeset.apply_action(nil)
+ {:ok, request_body, conn} ->
+ request =
+ changeset
+ |> put_ip_classification(conn)
+ |> put_remote_ip(conn)
+ |> put_uri(request_body)
+ |> put_hostname()
+ |> put_user_agent(conn)
+ |> put_request_params(request_body)
+ |> put_referrer(request_body)
+ |> put_pathname()
+ |> put_props(request_body)
+ |> put_engagement_fields(request_body)
+ |> put_query_params()
+ |> put_revenue_source(request_body)
+ |> put_interactive(request_body)
+ |> put_tracker_script_version(request_body)
+ |> map_domains(request_body)
+ |> Changeset.validate_required([
+ :event_name,
+ :hostname,
+ :pathname,
+ :timestamp
+ ])
+ |> Changeset.validate_length(:event_name, max: 120)
+ |> Changeset.apply_action(nil)
+
+ case request do
+ {:ok, request} ->
+ {:ok, request, conn}
+
+ {:error, _} = error ->
+ error
+ end
{:error, :invalid_json} ->
{:error, Changeset.add_error(changeset, :request, "Unable to parse request body as json")}
@@ -129,16 +139,16 @@ defmodule Plausible.Ingestion.Request do
case conn.body_params do
%Plug.Conn.Unfetched{} ->
with max_length <- conn.assigns[:read_body_limit] || 1_000_000,
- {:ok, body, _conn} <-
+ {:ok, body, conn} <-
Plug.Conn.read_body(conn, length: max_length, read_length: max_length),
{:ok, params} when is_map(params) <- Jason.decode(body) do
- {:ok, params}
+ {:ok, params, conn}
else
_ -> {:error, :invalid_json}
end
params ->
- {:ok, params}
+ {:ok, params, conn}
end
end
diff --git a/lib/plausible/telemetry/plausible_metrics.ex b/lib/plausible/telemetry/plausible_metrics.ex
index ea3d543ae5..8a5fff4dbb 100644
--- a/lib/plausible/telemetry/plausible_metrics.ex
+++ b/lib/plausible/telemetry/plausible_metrics.ex
@@ -271,7 +271,7 @@ defmodule Plausible.PromEx.Plugins.PlausibleMetrics do
metric_prefix ++ [:persistor, :remote, :request, :total_duration, :millisecond],
event_name: Persistor.Remote.telemetry_request_duration(),
reporter_options: [
- buckets: [10, 100, 500, 1_000, 5_000, 10_000, 30_000]
+ buckets: [1, 10, 25, 50, 75, 100, 250, 350, 500, 750, 1_000, 5_000, 10_000, 30_000]
],
unit: {:native, :millisecond},
measurement: :duration
@@ -280,7 +280,7 @@ defmodule Plausible.PromEx.Plugins.PlausibleMetrics do
metric_prefix ++ [:persistor, :remote, :request, :duration, :millisecond],
event_name: Persistor.TelemetryHandler.request_event(),
reporter_options: [
- buckets: [10, 100, 500, 1_000, 5_000, 10_000, 30_000]
+ buckets: [1, 10, 25, 50, 75, 100, 250, 350, 500, 750, 1_000, 5_000, 10_000, 30_000]
],
unit: {:native, :millisecond},
measurement: :duration,
@@ -310,7 +310,7 @@ defmodule Plausible.PromEx.Plugins.PlausibleMetrics do
metric_prefix ++ [:persistor, :remote, :receive, :duration, :millisecond],
event_name: Persistor.TelemetryHandler.receive_event(),
reporter_options: [
- buckets: [10, 100, 500, 1_000, 5_000, 10_000, 30_000]
+ buckets: [1, 10, 25, 50, 75, 100, 250, 350, 500, 750, 1_000, 5_000, 10_000, 30_000]
],
unit: {:native, :millisecond},
measurement: :duration,
diff --git a/lib/plausible_web/controllers/api/external_controller.ex b/lib/plausible_web/controllers/api/external_controller.ex
index 0966501500..87faf17df1 100644
--- a/lib/plausible_web/controllers/api/external_controller.ex
+++ b/lib/plausible_web/controllers/api/external_controller.ex
@@ -11,7 +11,7 @@ defmodule PlausibleWeb.Api.ExternalController do
alias Plausible.Ingestion
def event(conn, _params) do
- with {:ok, request} <- Ingestion.Request.build(conn),
+ with {:ok, request, conn} <- Ingestion.Request.build(conn),
_ <- Sentry.Context.set_extra_context(%{request: request}) do
case Ingestion.Event.build_and_buffer(request) do
{:ok, %{dropped: [], buffered: _buffered}} ->
diff --git a/test/plausible/ingestion/counters_test.exs b/test/plausible/ingestion/counters_test.exs
index e60d091a25..bbb0d2398c 100644
--- a/test/plausible/ingestion/counters_test.exs
+++ b/test/plausible/ingestion/counters_test.exs
@@ -121,7 +121,7 @@ defmodule Plausible.Ingestion.CountersTest do
}
conn = build_conn(:post, "/api/event", payload)
- assert {:ok, request} = Request.build(conn, at)
+ assert {:ok, request, _conn} = Request.build(conn, at)
assert {:ok, %{dropped: [dropped]}} = Event.build_and_buffer(request)
{:ok, dropped}
end
@@ -139,7 +139,7 @@ defmodule Plausible.Ingestion.CountersTest do
}
conn = build_conn(:post, "/api/event", payload)
- assert {:ok, request} = Request.build(conn, at)
+ assert {:ok, request, _conn} = Request.build(conn, at)
assert {:ok, %{buffered: [buffered]}} = Event.build_and_buffer(request)
{:ok, buffered}
diff --git a/test/plausible/ingestion/event_telemetry_test.exs b/test/plausible/ingestion/event_telemetry_test.exs
index 5dbf138dfb..9cf145856e 100644
--- a/test/plausible/ingestion/event_telemetry_test.exs
+++ b/test/plausible/ingestion/event_telemetry_test.exs
@@ -34,7 +34,7 @@ defmodule Plausible.Ingestion.EventTelemetryTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
for _ <- 1..3, do: Event.build_and_buffer(request)
diff --git a/test/plausible/ingestion/event_test.exs b/test/plausible/ingestion/event_test.exs
index e4ced7d96a..47caa43fe2 100644
--- a/test/plausible/ingestion/event_test.exs
+++ b/test/plausible/ingestion/event_test.exs
@@ -16,7 +16,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [_], dropped: []}} = Event.build_and_buffer(request)
end
@@ -39,7 +39,7 @@ defmodule Plausible.Ingestion.EventTest do
build_conn(:post, "/api/events", payload)
|> Plug.Conn.put_req_header("user-agent", unquote(user_agent))
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [_], dropped: []}} = Event.build_and_buffer(request)
end
@@ -74,7 +74,7 @@ defmodule Plausible.Ingestion.EventTest do
|> build_conn("/api/events", payload)
|> Plug.Conn.put_req_header("user-agent", :binary.copy("a", 1024 * 8))
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [_], dropped: []}} = Event.build_and_buffer(request)
assert_receive :telemetry_handled
@@ -93,7 +93,7 @@ defmodule Plausible.Ingestion.EventTest do
build_conn(:post, "/api/events", payload)
|> Plug.Conn.put_req_header("user-agent", Plausible.InstallationSupport.user_agent())
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :verification_agent
@@ -107,7 +107,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :not_found
@@ -124,7 +124,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :spam_referrer
@@ -141,7 +141,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{dropped: [dropped, dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :spam_referrer
@@ -157,7 +157,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [_], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :not_found
@@ -173,7 +173,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [_], dropped: []}} = Event.build_and_buffer(request)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
@@ -191,7 +191,7 @@ defmodule Plausible.Ingestion.EventTest do
conn = build_conn(:post, "/api/events", payload)
conn = Plug.Conn.put_req_header(conn, "x-plausible-ip-type", "dc_ip")
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :dc_ip
@@ -208,7 +208,7 @@ defmodule Plausible.Ingestion.EventTest do
conn = build_conn(:post, "/api/events", payload)
conn = Plug.Conn.put_req_header(conn, "x-plausible-ip-type", "threat_ip")
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :threat_ip
@@ -228,7 +228,7 @@ defmodule Plausible.Ingestion.EventTest do
{:ok, _} = Plausible.Shields.add_ip_rule(site, %{"inet" => "127.7.7.7"})
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :site_ip_blocklist
@@ -249,7 +249,7 @@ defmodule Plausible.Ingestion.EventTest do
%{country_code: cc} = Plausible.Ingestion.Geolocation.lookup("216.160.83.56")
{:ok, _} = Plausible.Shields.add_country_rule(site, %{"country_code" => cc})
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :site_country_blocklist
@@ -268,7 +268,7 @@ defmodule Plausible.Ingestion.EventTest do
{:ok, _} = Plausible.Shields.add_page_rule(site, %{"page_path" => "/blocked/**"})
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :site_page_blocklist
@@ -287,7 +287,7 @@ defmodule Plausible.Ingestion.EventTest do
{:ok, _} = Plausible.Shields.add_hostname_rule(site, %{"hostname" => "subdomain.dummy.site"})
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :site_hostname_allowlist
@@ -306,7 +306,7 @@ defmodule Plausible.Ingestion.EventTest do
{:ok, _} = Plausible.Shields.add_hostname_rule(site, %{"hostname" => "subdomain.dummy.site"})
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [_], dropped: []}} = Event.build_and_buffer(request)
end
@@ -324,7 +324,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :payment_required
@@ -348,7 +348,7 @@ defmodule Plausible.Ingestion.EventTest do
d: "#{site.domain}"
})
- assert {:ok, first_request} = Request.build(first_conn)
+ assert {:ok, first_request, _conn} = Request.build(first_conn)
second_conn =
build_conn(:post, "/api/events", %{
@@ -357,7 +357,7 @@ defmodule Plausible.Ingestion.EventTest do
d: "#{site.domain}"
})
- assert {:ok, second_request} = Request.build(second_conn)
+ assert {:ok, second_request, _conn} = Request.build(second_conn)
Task.start(fn ->
assert {:ok, %{buffered: [_event], dropped: []}} =
@@ -390,7 +390,7 @@ defmodule Plausible.Ingestion.EventTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [], dropped: [dropped]}} = Event.build_and_buffer(request)
assert dropped.drop_reason == :no_session_for_engagement
end
@@ -407,7 +407,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [event], dropped: []}} = Event.build_and_buffer(request)
assert Decimal.eq?(event.clickhouse_event.revenue_source_amount, Decimal.new("10.2"))
@@ -423,7 +423,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [event], dropped: []}} = Event.build_and_buffer(request)
assert event.clickhouse_event.revenue_source_amount == nil
@@ -438,7 +438,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [event]}} = Event.build_and_buffer(request)
assert event.clickhouse_event.hostname == "192.168.0.1"
@@ -453,7 +453,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [event]}} = Event.build_and_buffer(request)
assert event.clickhouse_event.hostname == "foo.netlify.app"
@@ -469,7 +469,7 @@ defmodule Plausible.Ingestion.EventTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert {:ok, %{buffered: [event]}} = Event.build_and_buffer(request)
assert event.clickhouse_event.hostname == "(none)"
diff --git a/test/plausible/ingestion/persistor_test.exs b/test/plausible/ingestion/persistor_test.exs
index e9886cd7b2..0f1787c4eb 100644
--- a/test/plausible/ingestion/persistor_test.exs
+++ b/test/plausible/ingestion/persistor_test.exs
@@ -64,7 +64,7 @@ defmodule Plausible.Ingestion.PersistorTest do
url: "http://dummy.site"
})
- {:ok, request} = Plausible.Ingestion.Request.build(conn)
+ {:ok, request, _conn} = Plausible.Ingestion.Request.build(conn)
event = build(:event, name: "pageview")
diff --git a/test/plausible/ingestion/request_test.exs b/test/plausible/ingestion/request_test.exs
index f2c90e036e..7df7261d4e 100644
--- a/test/plausible/ingestion/request_test.exs
+++ b/test/plausible/ingestion/request_test.exs
@@ -29,7 +29,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, %Plug.Conn{}} = Request.build(conn)
assert request.domains == ["dummy.site"]
assert request.event_name == "pageview"
@@ -52,9 +52,9 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request1} = Request.build(conn)
+ assert {:ok, request1, _conn} = Request.build(conn)
:timer.sleep(1500)
- assert {:ok, request2} = Request.build(conn)
+ assert {:ok, request2, _conn} = Request.build(conn)
ts1 = request1.timestamp
ts2 = request2.timestamp
@@ -70,7 +70,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.domains == ["dummy.site"]
assert request.uri.host == "dummy.site"
end
@@ -83,7 +83,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.domains == ["dummy.site"]
assert request.uri.host == "dummy.site"
end
@@ -96,7 +96,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.domains == ["dummy.site", "crash.site"]
assert request.uri.host == "dummy.site"
end
@@ -109,7 +109,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.event_name == "404"
end
@@ -121,7 +121,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.hostname == "(none)"
end
@@ -133,7 +133,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.hostname == "dummy.site"
end
@@ -145,7 +145,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload) |> put_req_header("user-agent", "Mozilla")
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.user_agent == "Mozilla"
end
@@ -165,7 +165,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.referrer == "https://example.com"
assert request.hash_mode == 1
assert request.props["custom1"] == "property1"
@@ -184,7 +184,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert %Money{amount: amount, currency: :EUR} = request.revenue_source
assert Decimal.new("20.2") == amount
end
@@ -203,7 +203,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert %Money{amount: amount, currency: :USD} = request.revenue_source
assert Decimal.equal?(amount, Decimal.new("20.0"))
end
@@ -222,7 +222,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert %Money{amount: amount, currency: :USD} = request.revenue_source
assert Decimal.equal?(amount, Decimal.new("20.1"))
end
@@ -241,7 +241,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert %Money{amount: amount, currency: :USD} = request.revenue_source
assert Decimal.equal?(amount, Decimal.new("12.3"))
end
@@ -259,7 +259,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert is_nil(request.revenue_source)
end
@@ -272,7 +272,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.pathname == "/pictures/index.html"
end
@@ -287,7 +287,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.pathname == "/pictures/index.html#foo"
end
@@ -302,7 +302,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.pathname == "/pictures/index.html"
assert request.props == %{"path" => "/pictures/index.html"}
@@ -318,7 +318,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.pathname == "/pictures/index.html#foo"
assert request.props == %{"path" => "/pictures/index.html#foo"}
@@ -334,7 +334,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.pathname == "/pictures/index.html"
assert request.props == %{"path" => "/album"}
@@ -350,7 +350,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.query_params["foo"] == "bar"
assert request.query_params["baz"] == "bam"
end
@@ -424,7 +424,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert request.referrer == String.duplicate("a", 2000)
end
@@ -470,7 +470,7 @@ defmodule Plausible.Ingestion.RequestTest do
conn = build_conn(:post, "/api/events", payload)
- assert {:ok, request} = Request.build(conn)
+ assert {:ok, request, _conn} = Request.build(conn)
assert map_size(request.props) == 30
end
@@ -494,7 +494,7 @@ defmodule Plausible.Ingestion.RequestTest do
|> build_conn("/api/events", payload)
|> Request.build()
- assert {:ok, _} = within_read_limit
+ assert {:ok, _, _} = within_read_limit
exceeding_read_limit =
:post
@@ -513,7 +513,7 @@ defmodule Plausible.Ingestion.RequestTest do
interactive: false
}
- assert {:ok, request} =
+ assert {:ok, request, _conn} =
build_conn(:post, "/api/events", params)
|> put_req_header("user-agent", "Mozilla")
|> Request.build()
@@ -536,7 +536,7 @@ defmodule Plausible.Ingestion.RequestTest do
}
}
- assert {:ok, request} =
+ assert {:ok, request, _conn} =
build_conn(:post, "/api/events", params)
|> put_req_header("user-agent", "Mozilla")
|> Request.build()
@@ -577,52 +577,58 @@ defmodule Plausible.Ingestion.RequestTest do
end
test "sets valid scroll_depth" do
- assert {:ok, %Request{scroll_depth: 0}} = build_engagement_request(%{sd: 0})
- assert {:ok, %Request{scroll_depth: 25}} = build_engagement_request(%{sd: 25})
- assert {:ok, %Request{scroll_depth: 25}} = build_engagement_request(%{sd: "25"})
+ assert {:ok, %Request{scroll_depth: 0}, _conn} = build_engagement_request(%{sd: 0})
+ assert {:ok, %Request{scroll_depth: 25}, _conn} = build_engagement_request(%{sd: 25})
+ assert {:ok, %Request{scroll_depth: 25}, _conn} = build_engagement_request(%{sd: "25"})
end
test "scroll_depth defaults to 100 when given integer is greater than 100" do
- assert {:ok, %Request{scroll_depth: 100}} = build_engagement_request(%{sd: 101})
- assert {:ok, %Request{scroll_depth: 100}} = build_engagement_request(%{sd: "101"})
+ assert {:ok, %Request{scroll_depth: 100}, _conn} = build_engagement_request(%{sd: 101})
+ assert {:ok, %Request{scroll_depth: 100}, _conn} = build_engagement_request(%{sd: "101"})
end
test "scroll_depth defaults to 255 when given value is invalid or missing" do
- assert {:ok, %Request{scroll_depth: 255}} = build_engagement_request(%{sd: -1, e: 1})
- assert {:ok, %Request{scroll_depth: 255}} = build_engagement_request(%{sd: "abc", e: 1})
- assert {:ok, %Request{scroll_depth: 255}} = build_engagement_request(%{e: 1})
+ assert {:ok, %Request{scroll_depth: 255}, _conn} = build_engagement_request(%{sd: -1, e: 1})
+
+ assert {:ok, %Request{scroll_depth: 255}, _conn} =
+ build_engagement_request(%{sd: "abc", e: 1})
+
+ assert {:ok, %Request{scroll_depth: 255}, _conn} = build_engagement_request(%{e: 1})
end
test "sets valid engagement_time" do
- assert {:ok, %Request{engagement_time: 123}} = build_engagement_request(%{e: 123})
- assert {:ok, %Request{engagement_time: 123}} = build_engagement_request(%{e: "123"})
+ assert {:ok, %Request{engagement_time: 123}, _conn} = build_engagement_request(%{e: 123})
+ assert {:ok, %Request{engagement_time: 123}, _conn} = build_engagement_request(%{e: "123"})
end
test "engagement_time defaults to 0 when given value is invalid or missing" do
- assert {:ok, %Request{engagement_time: 0}} = build_engagement_request(%{sd: 1, e: -1})
- assert {:ok, %Request{engagement_time: 0}} = build_engagement_request(%{sd: 1, e: "abc"})
+ assert {:ok, %Request{engagement_time: 0}, _conn} =
+ build_engagement_request(%{sd: 1, e: -1})
+
+ assert {:ok, %Request{engagement_time: 0}, _conn} =
+ build_engagement_request(%{sd: 1, e: "abc"})
- assert {:ok, %Request{engagement_time: 0}} =
+ assert {:ok, %Request{engagement_time: 0}, _conn} =
build_engagement_request(%{sd: 1, e: Request.too_large_engagement_time()})
end
test "sd and e fields are ignored if name is not engagement" do
params = %{name: "pageview", domain: "site.com", url: "https://site.com", sd: 25, e: 1000}
- assert {:ok, %Request{engagement_time: nil, scroll_depth: nil}} =
+ assert {:ok, %Request{engagement_time: nil, scroll_depth: nil}, _conn} =
build_conn(:post, "/api/events", params)
|> Request.build()
- assert {:ok, %Request{engagement_time: nil, scroll_depth: nil}} =
+ assert {:ok, %Request{engagement_time: nil, scroll_depth: nil}, _conn} =
build_conn(:post, "/api/events", Map.put(params, :name, "Custom Event"))
|> Request.build()
end
test "ingests valid scroll_depth and engagement_time for the same request" do
- assert {:ok, %Request{scroll_depth: 23, engagement_time: 100}} =
+ assert {:ok, %Request{scroll_depth: 23, engagement_time: 100}, _conn} =
build_engagement_request(%{sd: 23, e: 100})
- assert {:ok, %Request{scroll_depth: 23, engagement_time: 100}} =
+ assert {:ok, %Request{scroll_depth: 23, engagement_time: 100}, _conn} =
build_engagement_request(%{sd: "23", e: "100"})
end
end