From 5c77ec3f5d7ac471ec9cdc43d1ba195377f7d751 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Tue, 27 Apr 2021 10:26:44 +0300 Subject: [PATCH] Support multiple `data-domain` values (#968) * Support multiple `data-domain` values * Add changelog entry --- CHANGELOG.md | 1 + .../controllers/api/external_controller.ex | 44 ++++++++++++------- .../api/external_controller_test.exs | 20 +++++++++ 3 files changed, 50 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b8fbaa2d9..dbdce7889 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file. ### Added - New parameter `metrics` for the `/api/v1/stats/timeseries` endpoint plausible/analytics#952 - CSV export now includes pageviews, bounce rate and visit duration in addition to visitors plausible/analytics#952 +- Send stats to multiple dashboards by configuring a comma-separated list of domains plausible/analytics#968 ### Fixed - Fix weekly report time range plausible/analytics#951 diff --git a/lib/plausible_web/controllers/api/external_controller.ex b/lib/plausible_web/controllers/api/external_controller.ex index 9bef1527f..4b5d04616 100644 --- a/lib/plausible_web/controllers/api/external_controller.ex +++ b/lib/plausible_web/controllers/api/external_controller.ex @@ -7,11 +7,10 @@ defmodule PlausibleWeb.Api.ExternalController do Sentry.Context.set_extra_context(%{request: params}) case create_event(conn, params) do - {:ok, _} -> + :ok -> conn |> send_resp(202, "") - {:error, changeset} -> - Logger.info("Error processing event: #{inspect(changeset)}") + :error -> conn |> send_resp(400, "") end end @@ -71,7 +70,7 @@ defmodule PlausibleWeb.Api.ExternalController do ua = parse_user_agent(conn) if is_bot?(ua) do - {:ok, nil} + :ok else uri = params["url"] && URI.parse(params["url"]) query = if uri && uri.query, do: URI.decode_query(uri.query), else: %{} @@ -84,7 +83,6 @@ defmodule PlausibleWeb.Api.ExternalController do timestamp: NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second), name: params["name"], hostname: strip_www(uri && uri.host), - domain: strip_www(params["domain"]) || strip_www(uri && uri.host), pathname: get_pathname(uri, params["hash_mode"]), user_id: generate_user_id(conn, params, salts[:current]), referrer_source: get_referrer_source(query, ref) || "", @@ -102,18 +100,24 @@ defmodule PlausibleWeb.Api.ExternalController do "meta.value": Map.values(params["meta"]) |> Enum.map(&Kernel.to_string/1) } - changeset = Plausible.ClickhouseEvent.changeset(%Plausible.ClickhouseEvent{}, event_attrs) + Enum.reduce_while(get_domains(params, uri), :error, fn domain, _res -> + attrs = Map.put(event_attrs, :domain, domain) + changeset = Plausible.ClickhouseEvent.changeset(%Plausible.ClickhouseEvent{}, attrs) - if changeset.valid? do - previous_user_id = salts[:previous] && generate_user_id(conn, params, salts[:previous]) - event = struct(Plausible.ClickhouseEvent, event_attrs) - session_id = Plausible.Session.Store.on_event(event, previous_user_id) + if changeset.valid? do + previous_user_id = salts[:previous] && generate_user_id(conn, params, salts[:previous]) + event = struct(Plausible.ClickhouseEvent, attrs) + session_id = Plausible.Session.Store.on_event(event, previous_user_id) - Map.put(event, :session_id, session_id) - |> Plausible.Event.WriteBuffer.insert() - else - {:error, changeset} - end + event + |> Map.put(:session_id, session_id) + |> Plausible.Event.WriteBuffer.insert() + + {:cont, :ok} + else + {:halt, :error} + end + end) end end @@ -137,6 +141,16 @@ defmodule PlausibleWeb.Api.ExternalController do end end + defp get_domains(params, uri) do + if params["domain"] do + String.split(params["domain"], ",") + |> Enum.map(&String.trim/1) + |> Enum.map(&strip_www/1) + else + List.wrap(strip_www(uri && uri.host)) + end + end + defp get_pathname(nil, _), do: "/" defp get_pathname(uri, hash_mode) do diff --git a/test/plausible_web/controllers/api/external_controller_test.exs b/test/plausible_web/controllers/api/external_controller_test.exs index 6cae5141e..638728528 100644 --- a/test/plausible_web/controllers/api/external_controller_test.exs +++ b/test/plausible_web/controllers/api/external_controller_test.exs @@ -38,6 +38,26 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do assert pageview.pathname == "/" end + test "can send to multiple dashboards by listing multiple domains", %{conn: conn} do + params = %{ + name: "pageview", + url: "http://gigride.live/", + referrer: "http://m.facebook.com/", + domain: "test-domain1.com,test-domain2.com", + screen_width: 1440 + } + + conn = + conn + |> put_req_header("content-type", "text/plain") + |> put_req_header("user-agent", @user_agent) + |> post("/api/event", Jason.encode!(params)) + + assert response(conn, 202) == "" + assert get_event("test-domain1.com") + assert get_event("test-domain2.com") + end + test "www. is stripped from domain", %{conn: conn} do params = %{ name: "custom event",