From 21bbd3835afbae984e1af6f16b1cec68e3d0a66b Mon Sep 17 00:00:00 2001 From: hq1 Date: Tue, 2 Jan 2024 14:38:02 +0100 Subject: [PATCH] Disallow funny business on timezone entry (#3662) * Disallow funny business on timezone entry * Add external API test --- lib/plausible/site.ex | 11 +++++++++++ test/plausible/site/sites_test.exs | 9 +++++++++ .../api/external_sites_controller_test.exs | 12 ++++++++++++ 3 files changed, 32 insertions(+) diff --git a/lib/plausible/site.ex b/lib/plausible/site.ex index c571619ab..789c3877e 100644 --- a/lib/plausible/site.ex +++ b/lib/plausible/site.ex @@ -68,6 +68,7 @@ defmodule Plausible.Site do |> cast(attrs, [:domain, :timezone]) |> clean_domain() |> validate_required([:domain, :timezone]) + |> validate_timezone() |> validate_domain_format() |> validate_domain_reserved_characters() |> unique_constraint(:domain, @@ -265,4 +266,14 @@ defmodule Plausible.Site do changeset end end + + defp validate_timezone(changeset) do + tz = get_field(changeset, :timezone) + + if Timex.is_valid_timezone?(tz) do + changeset + else + add_error(changeset, :timezone, "is invalid") + end + end end diff --git a/test/plausible/site/sites_test.exs b/test/plausible/site/sites_test.exs index bc70c1696..4898dbfcf 100644 --- a/test/plausible/site/sites_test.exs +++ b/test/plausible/site/sites_test.exs @@ -12,6 +12,15 @@ defmodule Plausible.SitesTest do assert {:ok, %{site: %{domain: "example.com", timezone: "Europe/London"}}} = Sites.create(user, params) end + + test "fails on invalid timezone" do + user = insert(:user) + + params = %{"domain" => "example.com", "timezone" => "blah"} + + assert {:error, :site, %{errors: [timezone: {"is invalid", []}]}, %{}} = + Sites.create(user, params) + end end describe "is_member?" do diff --git a/test/plausible_web/controllers/api/external_sites_controller_test.exs b/test/plausible_web/controllers/api/external_sites_controller_test.exs index 7bc8744d5..1eb9650d3 100644 --- a/test/plausible_web/controllers/api/external_sites_controller_test.exs +++ b/test/plausible_web/controllers/api/external_sites_controller_test.exs @@ -26,6 +26,18 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do } end + test "timezone is validated", %{conn: conn} do + conn = + post(conn, "/api/v1/sites", %{ + "domain" => "some-site.domain", + "timezone" => "d" + }) + + assert json_response(conn, 400) == %{ + "error" => "timezone: is invalid" + } + end + test "timezone defaults to Etc/UTC", %{conn: conn} do conn = post(conn, "/api/v1/sites", %{