diff --git a/assets/js/dashboard/stats/bar.js b/assets/js/dashboard/stats/bar.js index 1acb6f977..7ab44bda7 100644 --- a/assets/js/dashboard/stats/bar.js +++ b/assets/js/dashboard/stats/bar.js @@ -10,13 +10,12 @@ function barWidth(count, all, plot) { return count / maxVal * 100 } -export default function Bar({count, all, bg, maxWidthDeduction, children, plot = "visitors"}) { +export default function Bar({count, all, bg, children, plot = "visitors"}) { const width = barWidth(count, all, plot) return (
MOBILE_UPPER_WIDTH ? "16rem" : "10rem"; - } - fetchConversions() { api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/conversions`, this.props.query) .then((res) => this.setState({loading: false, goals: res, prevHeight: null})) } - renderGoal(goal) { + renderGoal(goal, renderRevenueColumn) { const { viewport } = this.state; const renderProps = this.props.query.filters['goal'] == goal.name && goal.prop_names @@ -77,7 +72,6 @@ export default class Conversions extends React.Component { count={goal.unique_conversions} all={this.state.goals} bg="bg-red-50 dark:bg-gray-500 dark:bg-opacity-15" - maxWidthDeduction={this.getBarMaxWidth()} plot="unique_conversions" > {goal.name} @@ -86,18 +80,33 @@ export default class Conversions extends React.Component { {numberFormatter(goal.unique_conversions)} {viewport > MOBILE_UPPER_WIDTH && {numberFormatter(goal.total_conversions)}} {goal.conversion_rate}% + {viewport > MOBILE_UPPER_WIDTH && renderRevenueColumn && {this.renderMoney(goal.average_revenue)}} + {viewport > MOBILE_UPPER_WIDTH && renderRevenueColumn && {this.renderMoney(goal.total_revenue)}} +
- { renderProps && } + { renderProps && !goal.total_revenue && } ) } + renderMoney(moneyObject) { + if (moneyObject) { + return ( + {moneyObject.short} + ) + } else { + return '-' + } + } + renderInner() { const { viewport } = this.state; if (this.state.loading) { return
} else if (this.state.goals) { + const hasRevenue = this.state.goals.some((goal) => typeof goal.total_revenue == 'object') + return (

{this.props.title || "Goal Conversions"}

@@ -107,10 +116,12 @@ export default class Conversions extends React.Component { Uniques {viewport > MOBILE_UPPER_WIDTH && Total} CR + {viewport > MOBILE_UPPER_WIDTH && hasRevenue && Average} + {viewport > MOBILE_UPPER_WIDTH && hasRevenue && Total} - { this.state.goals.map(this.renderGoal.bind(this)) } + { this.state.goals.map((goal) => this.renderGoal.bind(this)(goal, hasRevenue) ) }
) diff --git a/config/.env.dev b/config/.env.dev index 771e90163..6412d2e19 100644 --- a/config/.env.dev +++ b/config/.env.dev @@ -17,3 +17,5 @@ GOOGLE_CLIENT_SECRET=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 PROMEX_DISABLED=false SITE_DEFAULT_INGEST_THRESHOLD=1000000 + +OPEN_EXCHANGE_RATES_APP_ID=31b49b5eca3845e0bee848b84a93b848 diff --git a/config/config.exs b/config/config.exs index 62c1064ff..b4689c9c8 100644 --- a/config/config.exs +++ b/config/config.exs @@ -54,4 +54,8 @@ config :plausible, config :plausible, Plausible.Ingestion.Counters, enabled: true +config :ex_cldr, + default_locale: "en", + default_backend: Plausible.Cldr + import_config "#{config_env()}.exs" diff --git a/config/runtime.exs b/config/runtime.exs index 0a7594372..155a8d1e1 100644 --- a/config/runtime.exs +++ b/config/runtime.exs @@ -320,6 +320,9 @@ config :plausible, Plausible.ImportDeletionRepo, transport_opts: ch_transport_opts, pool_size: 1 +config :ex_money, + open_exchange_rates_app_id: get_var_from_path_or_env(config_dir, "OPEN_EXCHANGE_RATES_APP_ID") + case mailer_adapter do "Bamboo.PostmarkAdapter" -> config :plausible, Plausible.Mailer, diff --git a/config/test.exs b/config/test.exs index 02fdfef5e..5717ca71f 100644 --- a/config/test.exs +++ b/config/test.exs @@ -29,4 +29,6 @@ config :plausible, http_impl: Plausible.HTTPClient.Mock, sites_by_domain_cache_enabled: false +config :ex_money, api_module: Plausible.ExchangeRateMock + config :plausible, Plausible.Ingestion.Counters, enabled: false diff --git a/lib/mix/tasks/send_pageview.ex b/lib/mix/tasks/send_pageview.ex index 89a4e6fe6..6277ec7f9 100644 --- a/lib/mix/tasks/send_pageview.ex +++ b/lib/mix/tasks/send_pageview.ex @@ -25,7 +25,9 @@ defmodule Mix.Tasks.SendPageview do referrer: :string, host: :string, event: :string, - props: :string + props: :string, + revenue_currency: :string, + revenue_amount: :string ] def run(opts) do @@ -85,12 +87,21 @@ defmodule Mix.Tasks.SendPageview do event = Keyword.get(opts, :event, @default_event) props = Keyword.get(opts, :props, @default_props) + revenue = + if Keyword.get(opts, :revenue_currency) do + %{ + currency: Keyword.get(opts, :revenue_currency), + amount: Keyword.get(opts, :revenue_amount) + } + end + %{ name: event, url: "http://#{domain}#{page}", domain: domain, referrer: referrer, - props: props + props: props, + revenue: revenue } end diff --git a/lib/plausible/cldr.ex b/lib/plausible/cldr.ex new file mode 100644 index 000000000..0a04142a5 --- /dev/null +++ b/lib/plausible/cldr.ex @@ -0,0 +1,5 @@ +defmodule Plausible.Cldr do + @moduledoc false + + use Cldr, locales: ["en"], providers: [Cldr.Number] +end diff --git a/lib/plausible/clickhouse_event_v2.ex b/lib/plausible/clickhouse_event_v2.ex index a404d5e43..f52822327 100644 --- a/lib/plausible/clickhouse_event_v2.ex +++ b/lib/plausible/clickhouse_event_v2.ex @@ -36,6 +36,12 @@ defmodule Plausible.ClickhouseEventV2 do field :"meta.key", {:array, :string} field :"meta.value", {:array, :string} + + field :revenue_source_amount, Ch.Types.Decimal64, scale: 4 + field :revenue_source_currency, Ch.Types.FixedString, size: 3 + field :revenue_reporting_amount, Ch.Types.Decimal64, scale: 4 + field :revenue_reporting_currency, Ch.Types.FixedString, size: 3 + field :transferred_from, :string end @@ -67,7 +73,11 @@ defmodule Plausible.ClickhouseEventV2 do :city_geoname_id, :screen_size, :"meta.key", - :"meta.value" + :"meta.value", + :revenue_source_amount, + :revenue_source_currency, + :revenue_reporting_amount, + :revenue_reporting_currency ], empty_values: [nil, ""] ) diff --git a/lib/plausible/goal/schema.ex b/lib/plausible/goal/schema.ex index 7530807d5..02a58ad1d 100644 --- a/lib/plausible/goal/schema.ex +++ b/lib/plausible/goal/schema.ex @@ -24,20 +24,40 @@ defmodule Plausible.Goal do field :event_name, :string field :page_path, :string + field :currency, Ecto.Enum, values: Money.Currency.known_current_currencies() + belongs_to :site, Plausible.Site timestamps() end + def revenue?(%__MODULE__{currency: currency}) do + !!currency + end + + def valid_currencies do + Ecto.Enum.dump_values(__MODULE__, :currency) + end + + def currency_options do + options = + for code <- valid_currencies() do + {"#{code} - #{Cldr.Currency.display_name!(code)}", code} + end + + [{"", nil}] ++ options + end + def changeset(goal, attrs \\ %{}) do goal - |> cast(attrs, [:site_id, :event_name, :page_path]) + |> cast(attrs, [:site_id, :event_name, :page_path, :currency]) |> validate_required([:site_id]) |> cast_assoc(:site) |> validate_event_name_and_page_path() |> update_change(:event_name, &String.trim/1) |> update_change(:page_path, &String.trim/1) |> validate_length(:event_name, max: 120) + |> maybe_drop_currency() end defp validate_event_name_and_page_path(changeset) do @@ -59,4 +79,12 @@ defmodule Plausible.Goal do value = get_field(changeset, :event_name) value && String.match?(value, ~r/^.+/) end + + defp maybe_drop_currency(changeset) do + if get_field(changeset, :page_path) do + delete_change(changeset, :currency) + else + changeset + end + end end diff --git a/lib/plausible/ingestion/event.ex b/lib/plausible/ingestion/event.ex index c96902731..5fa9d0bfa 100644 --- a/lib/plausible/ingestion/event.ex +++ b/lib/plausible/ingestion/event.ex @@ -98,6 +98,7 @@ defmodule Plausible.Ingestion.Event do &put_utm_tags/1, &put_geolocation/1, &put_props/1, + &put_revenue/1, &put_salts/1, &put_user_id/1, &validate_clickhouse_event/1, @@ -206,6 +207,29 @@ defmodule Plausible.Ingestion.Event do defp put_props(%__MODULE__{} = event), do: event + defp put_revenue(%__MODULE__{request: %{revenue_source: %Money{} = revenue_source}} = event) do + matching_goal = + event.domain + |> Plausible.Site.Cache.get() + |> Map.get(:revenue_goals) + |> Kernel.||([]) + |> Enum.find(&(&1.event_name == event.clickhouse_event_attrs.name)) + + with %Plausible.Goal{currency: currency} <- matching_goal, + {:ok, %Money{} = revenue_reporting} <- Money.to_currency(revenue_source, currency) do + update_attrs(event, %{ + revenue_source_amount: revenue_source.amount, + revenue_source_currency: to_string(revenue_source.currency), + revenue_reporting_amount: revenue_reporting.amount, + revenue_reporting_currency: to_string(revenue_reporting.currency) + }) + else + _ -> event + end + end + + defp put_revenue(event), do: event + defp put_salts(%__MODULE__{} = event) do %{event | salts: Plausible.Session.Salts.fetch()} end diff --git a/lib/plausible/ingestion/request.ex b/lib/plausible/ingestion/request.ex index ccf322571..f23d90ca2 100644 --- a/lib/plausible/ingestion/request.ex +++ b/lib/plausible/ingestion/request.ex @@ -21,6 +21,7 @@ defmodule Plausible.Ingestion.Request do field :hash_mode, :string field :pathname, :string field :props, :map + field :revenue_source, :map field :query_params, :map field :timestamp, :naive_datetime @@ -53,6 +54,7 @@ defmodule Plausible.Ingestion.Request do |> put_props(request_body) |> put_pathname() |> put_query_params() + |> put_revenue_source(request_body) |> map_domains(request_body) |> Changeset.validate_required([ :event_name, @@ -166,7 +168,7 @@ defmodule Plausible.Ingestion.Request do defp put_props(changeset, %{} = request_body) do props = (request_body["m"] || request_body["meta"] || request_body["p"] || request_body["props"]) - |> decode_props_or_fallback() + |> decode_json_or_fallback() |> Enum.reject(fn {_k, v} -> is_nil(v) || is_list(v) || is_map(v) || v == "" end) |> Map.new() @@ -175,18 +177,6 @@ defmodule Plausible.Ingestion.Request do |> validate_props() end - defp decode_props_or_fallback(raw) do - with raw when is_binary(raw) <- raw, - {:ok, %{} = decoded} <- Jason.decode(raw) do - decoded - else - already_a_map when is_map(already_a_map) -> already_a_map - {:ok, _list_or_other} -> %{} - {:error, _decode_error} -> %{} - _any -> %{} - end - end - @max_prop_key_length 300 @max_prop_value_length 2000 defp validate_props(changeset) do @@ -209,6 +199,52 @@ defmodule Plausible.Ingestion.Request do end end + defp put_revenue_source(%Ecto.Changeset{} = changeset, %{} = request_body) do + with revenue_source <- request_body["revenue"] || request_body["$"], + %{"amount" => _, "currency" => _} = revenue_source <- + decode_json_or_fallback(revenue_source) do + parse_revenue_source(changeset, revenue_source) + else + _any -> changeset + end + end + + @valid_currencies Plausible.Goal.valid_currencies() + defp parse_revenue_source(changeset, %{"amount" => amount, "currency" => currency}) do + with true <- currency in @valid_currencies, + {%Decimal{} = amount, _rest} <- parse_decimal(amount), + %Money{} = amount <- Money.new(currency, amount) do + Changeset.put_change(changeset, :revenue_source, amount) + else + false -> + Changeset.add_error(changeset, :revenue_source, "currency is not supported or invalid") + + _parse_error -> + Changeset.add_error(changeset, :revenue_source, "must be a valid number") + end + end + + defp decode_json_or_fallback(raw) do + with raw when is_binary(raw) <- raw, + {:ok, %{} = decoded} <- Jason.decode(raw) do + decoded + else + already_a_map when is_map(already_a_map) -> already_a_map + {:ok, _list_or_other} -> %{} + {:error, _decode_error} -> %{} + _any -> %{} + end + end + + defp parse_decimal(value) do + case value do + value when is_binary(value) -> Decimal.parse(value) + value when is_float(value) -> {Decimal.from_float(value), nil} + value when is_integer(value) -> {Decimal.new(value), nil} + _any -> :error + end + end + defp put_query_params(changeset) do case Changeset.get_field(changeset, :uri) do %{query: query} when is_binary(query) -> diff --git a/lib/plausible/site.ex b/lib/plausible/site.ex index 661e83312..513a20fd8 100644 --- a/lib/plausible/site.ex +++ b/lib/plausible/site.ex @@ -31,6 +31,7 @@ defmodule Plausible.Site do many_to_many :members, User, join_through: Plausible.Site.Membership has_many :memberships, Plausible.Site.Membership has_many :invitations, Plausible.Auth.Invitation + has_many :revenue_goals, Plausible.Goal, where: [currency: {:not, nil}] has_one :google_auth, GoogleAuth has_one :weekly_report, Plausible.Site.WeeklyReport has_one :monthly_report, Plausible.Site.MonthlyReport diff --git a/lib/plausible/site/cache.ex b/lib/plausible/site/cache.ex index 0be5e894f..d4108eccf 100644 --- a/lib/plausible/site/cache.ex +++ b/lib/plausible/site/cache.ex @@ -51,11 +51,11 @@ defmodule Plausible.Site.Cache do @modes [:all, :updated_recently] @cached_schema_fields ~w( - id - domain - domain_changed_from - ingest_rate_limit_scale_seconds - ingest_rate_limit_threshold + id + domain + domain_changed_from + ingest_rate_limit_scale_seconds + ingest_rate_limit_threshold )a @type t() :: Site.t() @@ -92,17 +92,9 @@ defmodule Plausible.Site.Cache do @spec refresh_all(Keyword.t()) :: :ok def refresh_all(opts \\ []) do - sites_by_domain_query = - from s in Site, - select: { - s.domain, - s.domain_changed_from, - %{struct(s, ^@cached_schema_fields) | from_cache?: true} - } - refresh( :all, - sites_by_domain_query, + sites_by_domain_query(), Keyword.put(opts, :delete_stale_items?, true) ) end @@ -110,14 +102,9 @@ defmodule Plausible.Site.Cache do @spec refresh_updated_recently(Keyword.t()) :: :ok def refresh_updated_recently(opts \\ []) do recently_updated_sites_query = - from s in Site, + from [s, mg] in sites_by_domain_query(), order_by: [asc: s.updated_at], - where: s.updated_at > ago(^15, "minute"), - select: { - s.domain, - s.domain_changed_from, - %{struct(s, ^@cached_schema_fields) | from_cache?: true} - } + where: s.updated_at > ago(^15, "minute") or mg.updated_at > ago(^15, "minute") refresh( :updated_recently, @@ -126,6 +113,17 @@ defmodule Plausible.Site.Cache do ) end + defp sites_by_domain_query do + from s in Site, + left_join: mg in assoc(s, :revenue_goals), + select: { + s.domain, + s.domain_changed_from, + %{struct(s, ^@cached_schema_fields) | from_cache?: true} + }, + preload: [revenue_goals: mg] + end + @spec merge(new_items :: [Site.t()], opts :: Keyword.t()) :: :ok def merge(new_items, opts \\ []) def merge([], _), do: :ok @@ -182,7 +180,16 @@ defmodule Plausible.Site.Cache do nil end else - Plausible.Sites.get_by_domain(domain) + get_from_source(domain) + end + end + + defp get_from_source(domain) do + query = from s in sites_by_domain_query(), where: s.domain == ^domain + + case Plausible.Repo.one(query) do + {_, _, site} -> %Site{site | from_cache?: false} + _any -> nil end end diff --git a/lib/plausible/stats/base.ex b/lib/plausible/stats/base.ex index 901428888..6d994f160 100644 --- a/lib/plausible/stats/base.ex +++ b/lib/plausible/stats/base.ex @@ -277,6 +277,31 @@ defmodule Plausible.Stats.Base do |> select_event_metrics(rest) end + def select_event_metrics(q, [:total_revenue | rest]) do + from(e in q, + select_merge: %{ + total_revenue: fragment("sum(?) * any(_sample_factor)", e.revenue_reporting_amount) + } + ) + |> select_event_metrics(rest) + end + + def select_event_metrics(q, [:average_revenue | rest]) do + from(e in q, + select_merge: %{ + average_revenue: + fragment( + "if(isNaN(avgIf(?, ? > 0.0)), 0.0, avgIf(?, ? > 0.0)) * any(_sample_factor)", + e.revenue_reporting_amount, + e.revenue_reporting_amount, + e.revenue_reporting_amount, + e.revenue_reporting_amount + ) + } + ) + |> select_event_metrics(rest) + end + def select_event_metrics(q, [:sample_percent | rest]) do from(e in q, select_merge: %{ diff --git a/lib/plausible/stats/breakdown.ex b/lib/plausible/stats/breakdown.ex index a33823e29..563aecb9b 100644 --- a/lib/plausible/stats/breakdown.ex +++ b/lib/plausible/stats/breakdown.ex @@ -17,11 +17,20 @@ defmodule Plausible.Stats.Breakdown do |> Goals.for_site() |> Enum.split_with(fn goal -> goal.event_name end) + revenue_goals = Enum.filter(event_goals, &Plausible.Goal.revenue?/1) + events = Enum.map(event_goals, & &1.event_name) event_query = %Query{query | filters: Map.put(query.filters, "event:name", {:member, events})} trace(query, property, metrics) + metrics = + if Enum.empty?(revenue_goals) do + metrics + else + metrics ++ [:average_revenue, :total_revenue] + end + event_results = if Enum.any?(event_goals) do breakdown(site, event_query, "event:name", metrics, pagination) @@ -30,6 +39,13 @@ defmodule Plausible.Stats.Breakdown do [] end + event_results = + if Enum.empty?(revenue_goals) do + event_results + else + cast_revenue_metrics_to_money(event_results, revenue_goals) + end + {limit, page} = pagination offset = (page - 1) * limit @@ -156,6 +172,22 @@ defmodule Plausible.Stats.Breakdown do breakdown_sessions(site, query, property, metrics, pagination) end + defp cast_revenue_metrics_to_money(event_results, revenue_goals) do + for result <- event_results do + if matching_goal = Enum.find(revenue_goals, &(&1.event_name == result.goal)) do + total_revenue = + Money.new!(matching_goal.currency, Decimal.from_float(result.total_revenue)) + + average_revenue = + Money.new!(matching_goal.currency, Decimal.from_float(result.average_revenue)) + + %{result | total_revenue: total_revenue, average_revenue: average_revenue} + else + %{result | average_revenue: nil, total_revenue: nil} + end + end + end + defp zip_results(event_result, session_result, property, metrics) do null_row = Enum.map(metrics, fn metric -> {metric, nil} end) |> Enum.into(%{}) diff --git a/lib/plausible/stats/timeseries.ex b/lib/plausible/stats/timeseries.ex index 6a95f5d38..ec886016a 100644 --- a/lib/plausible/stats/timeseries.ex +++ b/lib/plausible/stats/timeseries.ex @@ -8,7 +8,7 @@ defmodule Plausible.Stats.Timeseries do @typep value :: nil | integer() | float() @type results :: nonempty_list(%{required(:date) => Date.t(), required(metric()) => value()}) - @event_metrics [:visitors, :pageviews] + @event_metrics [:visitors, :pageviews, :average_revenue, :total_revenue] @session_metrics [:visits, :bounce_rate, :visit_duration, :views_per_visit] def timeseries(site, query, metrics) do steps = buckets(query) @@ -217,6 +217,8 @@ defmodule Plausible.Stats.Timeseries do :views_per_visit -> Map.merge(row, %{views_per_visit: 0.0}) :bounce_rate -> Map.merge(row, %{bounce_rate: nil}) :visit_duration -> Map.merge(row, %{:visit_duration => nil}) + :average_revenue -> Map.merge(row, %{average_revenue: 0.0}) + :total_revenue -> Map.merge(row, %{total_revenue: 0.0}) end end) end diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index bba59a5f2..5c2fdc2d2 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -1058,6 +1058,7 @@ defmodule PlausibleWeb.Api.StatsController do goal |> Map.put(:prop_names, CustomProps.props_for_goal(site, query)) |> Map.put(:conversion_rate, calculate_cr(total_visitors, goal[:unique_conversions])) + |> format_revenue_metrics() end) if params["csv"] do @@ -1067,6 +1068,22 @@ defmodule PlausibleWeb.Api.StatsController do end end + defp format_revenue_metrics(%{average_revenue: %Money{}, total_revenue: %Money{}} = results) do + %{ + results + | average_revenue: %{ + short: Money.to_string!(results.average_revenue, format: :short, fractional_digits: 1), + long: Money.to_string!(results.average_revenue) + }, + total_revenue: %{ + short: Money.to_string!(results.total_revenue, format: :short, fractional_digits: 1), + long: Money.to_string!(results.total_revenue) + } + } + end + + defp format_revenue_metrics(results), do: results + def prop_breakdown(conn, params) do site = conn.assigns[:site] query = Query.from(site, params) |> Filters.add_prefix() diff --git a/lib/plausible_web/templates/site/new_goal.html.eex b/lib/plausible_web/templates/site/new_goal.html.eex index 70d35fba8..7d4804b39 100644 --- a/lib/plausible_web/templates/site/new_goal.html.eex +++ b/lib/plausible_web/templates/site/new_goal.html.eex @@ -7,9 +7,17 @@
- <%= label f, :event_name, class: "block text-sm font-bold dark:text-gray-100" %> - <%= text_input f, :event_name, class: "transition mt-3 bg-gray-100 dark:bg-gray-900 outline-none appearance-none border border-transparent rounded w-full p-2 text-gray-700 dark:text-gray-300 leading-normal focus:outline-none focus:bg-white dark:focus:bg-gray-800 focus:border-gray-300 dark:focus:border-gray-500", placeholder: "Signup" %> - <%= error_tag f, :event_name %> +
+ <%= label f, :event_name, class: "block text-sm font-bold dark:text-gray-100" %> + <%= text_input f, :event_name, class: "transition mt-3 bg-gray-100 dark:bg-gray-900 outline-none appearance-none border border-transparent rounded w-full p-2 text-gray-700 dark:text-gray-300 leading-normal focus:outline-none focus:bg-white dark:focus:bg-gray-800 focus:border-gray-300 dark:focus:border-gray-500", placeholder: "Signup" %> + <%= error_tag f, :event_name %> +
+ +
+ <%= label f, :currency, "Reporting currency for revenue tracking (optional)", class: "block text-sm font-bold dark:text-gray-100" %> + <%= select f, :currency, Plausible.Goal.currency_options(), class: "transition mt-3 bg-gray-100 dark:bg-gray-900 outline-none appearance-none border border-transparent rounded w-full p-2 text-gray-700 dark:text-gray-300 leading-normal focus:outline-none focus:bg-white dark:focus:bg-gray-800 focus:border-gray-300 dark:focus:border-gray-500" %> + <%= error_tag f, :currency %> +