From 6dd9b0bb2f85e56d85761c7b64b36337fa4de1f3 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Fri, 22 Oct 2021 15:48:59 +0200 Subject: [PATCH] Do not error when bad custom prop value is supplied --- .../controllers/api/external_controller.ex | 20 +++++++++++++------ .../api/external_controller_test.exs | 18 +++++++++++++++++ 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/lib/plausible_web/controllers/api/external_controller.ex b/lib/plausible_web/controllers/api/external_controller.ex index 900bad93b..e58f6e65d 100644 --- a/lib/plausible_web/controllers/api/external_controller.ex +++ b/lib/plausible_web/controllers/api/external_controller.ex @@ -155,16 +155,24 @@ defmodule PlausibleWeb.Api.ExternalController do defp parse_meta(params) do raw_meta = params["m"] || params["meta"] || params["p"] || params["props"] - if raw_meta do - case Jason.decode(raw_meta) do - {:ok, props} when is_map(props) -> props - _ -> %{} - end + with raw_json when not is_nil(raw_meta) <- raw_meta, + {:ok, parsed_json} when is_map(parsed_json) <- Jason.decode(raw_json), + :ok <- validate_custom_props(parsed_json) do + parsed_json else - %{} + _ -> %{} end end + defp validate_custom_props(props) do + is_valid = + Enum.all?(props, fn {_key, val} -> + !is_list(val) + end) + + if is_valid, do: :ok, else: :invalid_props + end + 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 3627015a0..3274851b1 100644 --- a/test/plausible_web/controllers/api/external_controller_test.exs +++ b/test/plausible_web/controllers/api/external_controller_test.exs @@ -461,6 +461,24 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do assert Map.get(event, :"meta.value") == [] end + test "ignores custom prop with array value", %{conn: conn} do + params = %{ + name: "Signup", + url: "http://gigride.live/", + domain: "custom-prop-test-3.com", + props: Jason.encode!(%{wat: ["some-thing"]}) + } + + conn = post(conn, "/api/event", params) + + assert conn.status == 202 + + event = get_event("custom-prop-test-3.com") + + assert Map.get(event, :"meta.key") == [] + assert Map.get(event, :"meta.value") == [] + end + test "ignores a malformed referrer URL", %{conn: conn} do params = %{ name: "pageview",