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
derive jason encoder for request (#3182)
ruslandogaf3a1a9d599c5
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 0e67551963..1fb45aede6 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.### Fixed- Fixed weekly/monthly e-mail report [rendering issues](https://github.com/plausible/analytics/issues/284)- Fixed [long URLs display](https://github.com/plausible/analytics/issues/3158) in Outbound Link breakdown view+- Fixed [Sentry reports](https://github.com/plausible/analytics/discussions/3166) for ingestion requests plausible/analytics#3182## v2.0.0 - 2023-07-12diff --git a/lib/plausible/ingestion/request.ex b/lib/plausible/ingestion/request.exindex 150635f468..1ef7a7c20f 100644--- a/lib/plausible/ingestion/request.ex+++ b/lib/plausible/ingestion/request.ex@@ -27,6 +27,7 @@ defmodule Plausible.Ingestion.Request do@max_url_size 2_000+ @primary_key falseembedded_schema dofield :remote_ip, :stringfield :user_agent, :string@@ -312,3 +313,16 @@ defmodule Plausible.Ingestion.Request donilendend++defimpl Jason.Encoder, for: URI do+ def encode(uri, _opts), do: [?", URI.to_string(uri), ?"]+end++defimpl Jason.Encoder, for: Plausible.Ingestion.Request do+ @fields Plausible.Ingestion.Request.__schema__(:fields)+ def encode(request, opts) do+ request+ |> Map.take(@fields)+ |> Jason.Encode.map(opts)+ end+enddiff --git a/lib/plausible_web/controllers/api/external_controller.ex b/lib/plausible_web/controllers/api/external_controller.exindex cbd1358392..7ba9fbe781 100644--- a/lib/plausible_web/controllers/api/external_controller.ex+++ b/lib/plausible_web/controllers/api/external_controller.ex@@ -12,7 +12,7 @@ defmodule PlausibleWeb.Api.ExternalController dodef event(conn, _params) dowith {:ok, request} <- Ingestion.Request.build(conn),- _ <- Sentry.Context.set_extra_context(%{request: inspect(request)}) do+ _ <- Sentry.Context.set_extra_context(%{request: request}) docase Ingestion.Event.build_and_buffer(request) do{:ok, %{dropped: [], buffered: _buffered}} ->conndiff --git a/lib/sentry_filter.ex b/lib/sentry_filter.exindex be9c81ba75..68fe4a2ddd 100644--- a/lib/sentry_filter.ex+++ b/lib/sentry_filter.ex@@ -36,6 +36,10 @@ defmodule Plausible.SentryFilter do%{event | fingerprint: ["db_connection", reason]}end+ def before_send(%{extra: %{request: %Plausible.Ingestion.Request{}}} = event) do+ %{event | fingerprint: ["ingestion_request"]}+ end+def before_send(event) doeventenddiff --git a/test/plausible/ingestion/request_test.exs b/test/plausible/ingestion/request_test.exsindex 538c1fe3ec..552d159140 100644--- a/test/plausible/ingestion/request_test.exs+++ b/test/plausible/ingestion/request_test.exs@@ -422,4 +422,43 @@ defmodule Plausible.Ingestion.RequestTest doassert {:error, changeset} = Request.build(conn)assert changeset.errors[:request]end++ test "encodable" do+ params = %{+ name: "pageview",+ domain: "dummy.site",+ url: "https://dummy.site/pictures/index.html?foo=bar&baz=bam",+ referrer: "https://example.com",+ props: %{"abc" => "qwerty", "hello" => "world"},+ hashMode: 1,+ revenue: %{+ "amount" => "12.3",+ "currency" => "USD"+ }+ }++ assert {:ok, request} =+ build_conn(:post, "/api/events", params)+ |> put_req_header("user-agent", "Mozilla")+ |> Request.build()++ request = request |> Jason.encode!() |> Jason.decode!()++ assert Map.drop(request, ["timestamp"]) == %{+ "domains" => ["dummy.site"],+ "event_name" => "pageview",+ "hash_mode" => 1,+ "hostname" => "dummy.site",+ "pathname" => "/pictures/index.html",+ "props" => %{"abc" => "qwerty", "hello" => "world"},+ "query_params" => %{"baz" => "bam", "foo" => "bar"},+ "referrer" => "https://example.com",+ "remote_ip" => "127.0.0.1",+ "revenue_source" => %{"amount" => "12.3", "currency" => "USD"},+ "uri" => "https://dummy.site/pictures/index.html?foo=bar&baz=bam",+ "user_agent" => "Mozilla"+ }++ assert %NaiveDateTime{} = NaiveDateTime.from_iso8601!(request["timestamp"])+ endenddiff --git a/test/plausible/sentry_filter_test.exs b/test/plausible/sentry_filter_test.exsnew file mode 100644index 0000000000..d71e839f9c--- /dev/null+++ b/test/plausible/sentry_filter_test.exs@@ -0,0 +1,15 @@+defmodule Plausible.SentryFilterTest do+ use ExUnit.Case++ test "enforces fingerprint for ingestion request" do+ event =+ Sentry.Event.create_event(+ message: "oof",+ fingerprint: ["to be", " replaced"],+ extra: %{request: %Plausible.Ingestion.Request{}}+ )++ assert %Sentry.Event{fingerprint: ["ingestion_request"]} =+ Plausible.SentryFilter.before_send(event)+ end+end