From 7a02aae2a562efd39f11fa405c0f084c4d59e8cc Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Wed, 10 Nov 2021 15:51:43 +0200 Subject: [PATCH] Accept custom props in expected format --- .../controllers/api/external_controller.ex | 17 +++++++++-- .../api/external_controller_test.exs | 30 ++++++++++++++----- 2 files changed, 38 insertions(+), 9 deletions(-) diff --git a/lib/plausible_web/controllers/api/external_controller.ex b/lib/plausible_web/controllers/api/external_controller.ex index 68345bc01..65cec40c7 100644 --- a/lib/plausible_web/controllers/api/external_controller.ex +++ b/lib/plausible_web/controllers/api/external_controller.ex @@ -157,8 +157,7 @@ defmodule PlausibleWeb.Api.ExternalController do defp parse_meta(params) do raw_meta = params["m"] || params["meta"] || params["p"] || params["props"] - with raw_json when not is_nil(raw_meta) <- raw_meta, - {:ok, parsed_json} when is_map(parsed_json) <- Jason.decode(raw_json), + with {:ok, parsed_json} <- decode_raw_props(raw_meta), :ok <- validate_custom_props(parsed_json) do parsed_json else @@ -175,6 +174,20 @@ defmodule PlausibleWeb.Api.ExternalController do if is_valid, do: :ok, else: :invalid_props end + defp decode_raw_props(props) when is_map(props), do: {:ok, props} + + defp decode_raw_props(raw_json) when is_binary(raw_json) do + case Jason.decode(raw_json) do + {:ok, parsed_props} when is_map(parsed_props) -> + {:ok, parsed_props} + + _ -> + :not_a_map + end + end + + defp decode_raw_props(_), do: :bad_format + defp get_domains(params, uri) do if params["domain"] do String.split(params["domain"], ",") diff --git a/test/plausible_web/controllers/api/external_controller_test.exs b/test/plausible_web/controllers/api/external_controller_test.exs index bcd187621..a1089d02f 100644 --- a/test/plausible_web/controllers/api/external_controller_test.exs +++ b/test/plausible_web/controllers/api/external_controller_test.exs @@ -428,11 +428,10 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do name: "Signup", url: "http://gigride.live/", domain: "custom-prop-test.com", - props: - Jason.encode!(%{ - bool_test: true, - number_test: 12 - }) + props: %{ + bool_test: true, + number_test: 12 + } } conn @@ -461,11 +460,28 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do assert Map.get(event, :"meta.value") == [] end - test "ignores custom prop with array value", %{conn: conn} do + test "can send props stringified", %{conn: conn} do params = %{ name: "Signup", url: "http://gigride.live/", domain: "custom-prop-test-3.com", + props: Jason.encode!(%{number_test: 12}) + } + + conn + |> post("/api/event", params) + + event = get_event("custom-prop-test-3.com") + + assert Map.get(event, :"meta.key") == ["number_test"] + assert Map.get(event, :"meta.value") == ["12"] + end + + test "ignores custom prop with array value", %{conn: conn} do + params = %{ + name: "Signup", + url: "http://gigride.live/", + domain: "custom-prop-test-4.com", props: Jason.encode!(%{wat: ["some-thing"]}) } @@ -473,7 +489,7 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do assert conn.status == 202 - event = get_event("custom-prop-test-3.com") + event = get_event("custom-prop-test-4.com") assert Map.get(event, :"meta.key") == [] assert Map.get(event, :"meta.value") == []