Do not reject events from headless Chrome on staging environment

Author: rdk08

config/runtime.exs

@@ -189,6 +189,7 @@ config :plausible,
   admin_email: admin_email,
   admin_pwd: admin_pwd,
   environment: env,
+  system_environment: env,
   mailer_email: mailer_email,
   super_admin_user_ids: super_admin_user_ids,
   site_limit: site_limit,

lib/plausible_web/controllers/api/external_controller.ex

@@ -167,8 +167,13 @@ defmodule PlausibleWeb.Api.ExternalController do
 
   defp is_bot?(%UAInspector.Result.Bot{}), do: true
 
-  defp is_bot?(%UAInspector.Result{client: %UAInspector.Result.Client{name: "Headless Chrome"}}),
-    do: true
+  defp is_bot?(%UAInspector.Result{client: %UAInspector.Result.Client{name: "Headless Chrome"}}) do
+    if Application.get_env(:plausible, :system_environment) == "staging" do
+      false
+    else
+      true
+    end
+  end
 
   defp is_bot?(_), do: false
 

test/plausible_web/controllers/api/external_controller_test.exs

@@ -169,7 +169,29 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do
       )
       |> post("/api/event", params)
 
-      assert get_event("headless-chrome-test.com") == nil
+      refute get_event("headless-chrome-test.com")
+    end
+
+    test "Headless Chrome is not ignored on staging environment", %{conn: conn} do
+      initial_env = Application.get_env(:plausible, :system_environment)
+      Application.put_env(:plausible, :system_environment, "staging")
+
+      params = %{
+        name: "pageview",
+        url: "http://www.example.com/",
+        domain: "headless-chrome-stg-test.com"
+      }
+
+      conn
+      |> put_req_header(
+        "user-agent",
+        "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/85.0.4183.83 Safari/537.36"
+      )
+      |> post("/api/event", params)
+
+      assert get_event("headless-chrome-stg-test.com")
+
+      Application.put_env(:plausible, :system_environment, initial_env)
     end
 
     test "parses user_agent", %{conn: conn} do