From 2f3bee800dd5a74879712df69f2fa49b43c7646a Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Fri, 24 Sep 2021 09:38:23 +0200 Subject: [PATCH] Return more information in /api/event response Fixes #1246 --- .../controllers/api/external_controller.ex | 16 ++++++-- .../api/external_controller_test.exs | 40 ++++++++++--------- 2 files changed, 34 insertions(+), 22 deletions(-) diff --git a/lib/plausible_web/controllers/api/external_controller.ex b/lib/plausible_web/controllers/api/external_controller.ex index a2e938acd..0632713b3 100644 --- a/lib/plausible_web/controllers/api/external_controller.ex +++ b/lib/plausible_web/controllers/api/external_controller.ex @@ -8,10 +8,10 @@ defmodule PlausibleWeb.Api.ExternalController do case create_event(conn, params) do :ok -> - conn |> send_resp(202, "") + conn |> put_status(202) |> text("ok") - :error -> - conn |> send_resp(400, "") + {:error, errors} -> + conn |> put_status(400) |> json(%{errors: errors}) end end @@ -122,12 +122,20 @@ defmodule PlausibleWeb.Api.ExternalController do {:cont, :ok} else - {:halt, :error} + errors = Ecto.Changeset.traverse_errors(changeset, &encode_error/1) + {:halt, {:error, errors}} end end) end end + # https://hexdocs.pm/ecto/Ecto.Changeset.html#traverse_errors/2-examples + defp encode_error({msg, opts}) do + Regex.replace(~r"%{(\w+)}", msg, fn _, key -> + opts |> Keyword.get(String.to_existing_atom(key), key) |> to_string() + end) + end + defp is_bot?(%UAInspector.Result.Bot{}), do: true defp is_bot?(%UAInspector.Result{client: %UAInspector.Result.Client{name: "Headless Chrome"}}), diff --git a/test/plausible_web/controllers/api/external_controller_test.exs b/test/plausible_web/controllers/api/external_controller_test.exs index 8837b31d4..93b85ef7d 100644 --- a/test/plausible_web/controllers/api/external_controller_test.exs +++ b/test/plausible_web/controllers/api/external_controller_test.exs @@ -41,7 +41,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-1.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.hostname == "gigride.live" assert pageview.domain == "external-controller-test-1.com" assert pageview.pathname == "/" @@ -62,7 +62,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-text-plain.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.hostname == "gigride.live" assert pageview.domain == "external-controller-test-text-plain.com" assert pageview.pathname == "/" @@ -82,7 +82,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do |> put_req_header("user-agent", @user_agent) |> post("/api/event", params) - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert get_event("test-domain1.com") assert get_event("test-domain2.com") end @@ -177,7 +177,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-6.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.operating_system == "Mac" assert pageview.operating_system_version == "10.13" assert pageview.browser == "Chrome" @@ -199,7 +199,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-7.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.referrer_source == "Facebook" end @@ -218,7 +218,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-8.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.referrer == "facebook.com/page" assert pageview.referrer_source == "Facebook" end @@ -238,7 +238,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-9.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.referrer_source == "" end @@ -257,7 +257,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-10.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.referrer_source == "" end @@ -276,7 +276,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-11.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.referrer_source == "blog.gigride.live" end @@ -345,7 +345,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-14.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.referrer_source == "indiehackers.com" end @@ -364,7 +364,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-15.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.referrer_source == "" end @@ -383,7 +383,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-16.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.screen_size == "Mobile" end @@ -401,7 +401,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("external-controller-test-17.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.screen_size == "" end @@ -419,7 +419,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do event = get_event("external-controller-test-18.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert event.name == "custom event" end @@ -476,7 +476,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do event = get_event("external-controller-test-19.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert event.referrer == "" end @@ -699,7 +699,11 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do |> put_req_header("user-agent", @user_agent) |> post("/api/event", params) - assert response(conn, 400) == "" + assert json_response(conn, 400) == %{ + "errors" => %{ + "hostname" => ["can't be blank"] + } + } end end @@ -854,7 +858,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("url-with-hostname-missing.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.hostname == "(none)" end @@ -872,7 +876,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do pageview = get_event("chrome-extension-url.com") - assert response(conn, 202) == "" + assert response(conn, 202) == "ok" assert pageview.hostname == "liipgellkffekalgefpjolodblggkmjg" end