Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Acquisition channels: Functions to calculate channels in clickhouse (#4701)

Karl-Aksel Puulmanndbf7a099a362
diff --git a/lib/plausible/data_migration.ex b/lib/plausible/data_migration.ex
index e33d553706..d99e2e6527 100644
--- a/lib/plausible/data_migration.ex
+++ b/lib/plausible/data_migration.ex
@@ -12,13 +12,10 @@ defmodule Plausible.DataMigration do
@dir dir
@repo repo
- def run_sql_confirm(name, options \\ []) do
- {prompt_options, assigns} =
- Keyword.split(options, [:prompt_message, :prompt_default_choice])
-
+ def run_sql_confirm(name, assigns \\ [], options \\ []) do
query = unwrap_with_io(name, assigns)
- message = prompt_options[:prompt_message] || "Execute?"
- default_choice = Keyword.get(prompt_options, :prompt_default_choice, :yes)
+ message = Keyword.get(options, :prompt_message, "Execute?")
+ default_choice = Keyword.get(options, :prompt_default_choice, :yes)
confirm(message, fn -> do_run(name, query) end, default_choice)
end
@@ -52,7 +49,7 @@ defmodule Plausible.DataMigration do
end
end
- defp unwrap(name, assigns) do
+ def unwrap(name, assigns \\ []) do
:plausible
|> :code.priv_dir()
|> Path.join("data_migrations")
@@ -62,16 +59,52 @@ defmodule Plausible.DataMigration do
|> EEx.eval_file(assigns: assigns)
end
+ @doc """
+ Runs a single SQL query in a file.
+
+ Valid options:
+ - `quiet` - reduces output from running the SQL
+ - `params` - List of query parameters.
+ - `query_options` - passed to Repo.query
+ """
def run_sql(name, assigns \\ [], options \\ []) do
query = unwrap(name, assigns)
+
do_run(name, query, options)
end
- defp do_run(name, query, options \\ []) do
- case @repo.query(query, [], [timeout: :infinity] ++ options) do
+ @doc """
+ Runs multiple SQL queries from a single file.
+
+ Note that each query must be separated by semicolons.
+ """
+ def run_sql_multi(name, assigns \\ [], options \\ []) do
+ unwrap(name, assigns)
+ |> String.trim()
+ |> String.split(";", trim: true)
+ |> Enum.with_index(1)
+ |> Enum.reduce_while(:ok, fn {query, index}, _ ->
+ case do_run("name-#{index}", query, options) do
+ {:ok, _} -> {:cont, :ok}
+ error -> {:halt, error}
+ end
+ end)
+ end
+
+ def do_run(name, query, options \\ []) do
+ params = Keyword.get(options, :params, [])
+ query_options = Keyword.get(options, :query_options, [])
+
+ case @repo.query(query, params, [timeout: :infinity] ++ query_options) do
{:ok, res} ->
- IO.puts(" #{IO.ANSI.yellow()}#{name} #{IO.ANSI.green()}Done!#{IO.ANSI.reset()}\n")
- IO.puts(String.duplicate("-", 78))
+ if not Keyword.get(options, :quiet, false) do
+ IO.puts(
+ " #{IO.ANSI.yellow()}#{name} #{IO.ANSI.green()}Done!#{IO.ANSI.reset()}\n"
+ )
+
+ IO.puts(String.duplicate("-", 78))
+ end
+
{:ok, res}
result ->
diff --git a/lib/plausible/data_migration/acquisition_channel.ex b/lib/plausible/data_migration/acquisition_channel.ex
new file mode 100644
index 0000000000..efd6e91ec8
--- /dev/null
+++ b/lib/plausible/data_migration/acquisition_channel.ex
@@ -0,0 +1,40 @@
+defmodule Plausible.DataMigration.AcquisitionChannel do
+ @moduledoc """
+ Creates functions to calculate acquisition channel in ClickHouse
+
+ SQL files available at: priv/data_migrations/AcquisitionChannel/sql
+ """
+ use Plausible.DataMigration, dir: "AcquisitionChannel", repo: Plausible.IngestRepo
+
+ def run(opts \\ []) do
+ source_categories =
+ Plausible.Ingestion.Acquisition.source_categories()
+ |> invert_map()
+
+ on_cluster_statement = Plausible.MigrationUtils.on_cluster_statement("sessions_v2")
+
+ run_sql_multi(
+ "acquisition_channel_functions",
+ [
+ on_cluster_statement: on_cluster_statement
+ ],
+ params: %{
+ "source_category_shopping" => source_categories["SOURCE_CATEGORY_SHOPPING"],
+ "source_category_social" => source_categories["SOURCE_CATEGORY_SOCIAL"],
+ "source_category_video" => source_categories["SOURCE_CATEGORY_VIDEO"],
+ "source_category_search" => source_categories["SOURCE_CATEGORY_SEARCH"],
+ "source_category_email" => source_categories["SOURCE_CATEGORY_EMAIL"],
+ "paid_sources" => Plausible.Ingestion.Source.paid_sources()
+ },
+ quiet: Keyword.get(opts, :quiet, false)
+ )
+ end
+
+ defp invert_map(source_categories) do
+ source_categories
+ |> Enum.group_by(
+ fn {_source, category} -> category end,
+ fn {source, _category} -> source end
+ )
+ end
+end
diff --git a/lib/plausible/data_migration/numeric_ids.ex b/lib/plausible/data_migration/numeric_ids.ex
index e4b76e1486..1980709ad8 100644
--- a/lib/plausible/data_migration/numeric_ids.ex
+++ b/lib/plausible/data_migration/numeric_ids.ex
@@ -70,9 +70,9 @@ defmodule Plausible.DataMigration.NumericIDs do
run_sql_fn =
if interactive? do
- &run_sql_confirm/2
+ &run_sql_confirm/3
else
- &run_sql/2
+ &run_sql/3
end
confirm_fn =
@@ -101,24 +101,25 @@ defmodule Plausible.DataMigration.NumericIDs do
end
{:ok, _} =
- run_sql_fn.("drop-events-v2", [cluster?: cluster?] ++ drop_v2_extra_opts.("events_v2"))
+ run_sql_fn.("drop-events-v2", [cluster?: cluster?], drop_v2_extra_opts.("events_v2"))
{:ok, _} =
- run_sql_fn.("drop-sessions-v2", [cluster?: cluster?] ++ drop_v2_extra_opts.("sessions_v2"))
+ run_sql_fn.("drop-sessions-v2", [cluster?: cluster?], drop_v2_extra_opts.("sessions_v2"))
- {:ok, _} = run_sql_fn.("drop-tmp-events-v2", [])
- {:ok, _} = run_sql_fn.("drop-tmp-sessions-v2", [])
- {:ok, _} = run_sql_fn.("drop-domains-lookup", [])
+ {:ok, _} = run_sql_fn.("drop-tmp-events-v2", [], [])
+ {:ok, _} = run_sql_fn.("drop-tmp-sessions-v2", [], [])
+ {:ok, _} = run_sql_fn.("drop-domains-lookup", [], [])
- {:ok, _} = run_sql_fn.("create-events-v2", table_settings: table_settings, cluster?: cluster?)
+ {:ok, _} =
+ run_sql_fn.("create-events-v2", [table_settings: table_settings, cluster?: cluster?], [])
{:ok, _} =
- run_sql_fn.("create-sessions-v2", table_settings: table_settings, cluster?: cluster?)
+ run_sql_fn.("create-sessions-v2", [table_settings: table_settings, cluster?: cluster?], [])
- {:ok, _} = run_sql_fn.("create-tmp-events-v2", table_settings: table_settings)
- {:ok, _} = run_sql_fn.("create-tmp-sessions-v2", table_settings: table_settings)
+ {:ok, _} = run_sql_fn.("create-tmp-events-v2", [table_settings: table_settings], [])
+ {:ok, _} = run_sql_fn.("create-tmp-sessions-v2", [table_settings: table_settings], [])
- case run_sql_fn.("create-domains-lookup", table_settings: table_settings) do
+ case run_sql_fn.("create-domains-lookup", [table_settings: table_settings], []) do
{:ok, _} ->
confirm_fn.("Populate domains-lookup with postgres sites", fn ->
mappings =
diff --git a/lib/plausible/data_migration/populate_event_session_columns.ex b/lib/plausible/data_migration/populate_event_session_columns.ex
index ab445a8709..3f911e96a0 100644
--- a/lib/plausible/data_migration/populate_event_session_columns.ex
+++ b/lib/plausible/data_migration/populate_event_session_columns.ex
@@ -43,7 +43,7 @@ defmodule Plausible.DataMigration.PopulateEventSessionColumns do
for partition <- partitions do
{:ok, _} =
run_sql("update-table", [cluster?: cluster?, partition: partition],
- settings: [allow_nondeterministic_mutations: 1]
+ query_options: [settings: [allow_nondeterministic_mutations: 1]]
)
end
diff --git a/lib/plausible/ingestion/acquisition.ex b/lib/plausible/ingestion/acquisition.ex
index c65a09cbff..ef57be580a 100644
--- a/lib/plausible/ingestion/acquisition.ex
+++ b/lib/plausible/ingestion/acquisition.ex
@@ -45,6 +45,8 @@ defmodule Plausible.Ingestion.Acquisition do
|> then(&(@custom_source_categories ++ &1))
|> Enum.into(%{})
+ def source_categories(), do: @source_categories
+
def get_channel(source, utm_medium, utm_campaign, utm_source, click_id_param) do
get_channel_lowered(
String.downcase(source || ""),
diff --git a/lib/plausible/ingestion/source.ex b/lib/plausible/ingestion/source.ex
index 2866db1914..c23728b0dc 100644
--- a/lib/plausible/ingestion/source.ex
+++ b/lib/plausible/ingestion/source.ex
@@ -37,6 +37,10 @@ defmodule Plausible.Ingestion.Source do
end)
end
+ def paid_sources() do
+ @paid_sources |> MapSet.to_list()
+ end
+
def paid_source?(source) do
MapSet.member?(@paid_sources, source)
end
@@ -129,7 +133,7 @@ defmodule Plausible.Ingestion.Source do
defp valid_referrer?(_), do: false
- defp has_referral?(%Request{referrer: nil}), do: nil
+ defp has_referral?(%Request{referrer: nil}), do: false
defp has_referral?(%Request{referrer: referrer, uri: uri}) do
referrer_uri = URI.parse(referrer)
diff --git a/priv/data_migrations/AcquisitionChannel/sql/acquisition_channel_functions.sql.eex b/priv/data_migrations/AcquisitionChannel/sql/acquisition_channel_functions.sql.eex
new file mode 100644
index 0000000000..439b5cf097
--- /dev/null
+++ b/priv/data_migrations/AcquisitionChannel/sql/acquisition_channel_functions.sql.eex
@@ -0,0 +1,167 @@
+CREATE OR REPLACE FUNCTION acquisition_channel_has_category_shopping <%= @on_cluster_statement %> AS
+(referrer_source) ->
+ has({source_category_shopping:Array(String)}, referrer_source);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_has_category_social <%= @on_cluster_statement %> AS
+(referrer_source) ->
+ has({source_category_social:Array(String)}, referrer_source);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_has_category_video <%= @on_cluster_statement %> AS
+(referrer_source) ->
+ has({source_category_video:Array(String)}, referrer_source);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_has_category_search <%= @on_cluster_statement %> AS
+(referrer_source) ->
+ has({source_category_search:Array(String)}, referrer_source);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_has_category_email <%= @on_cluster_statement %> AS
+(referrer_source) ->
+ has({source_category_email:Array(String)}, referrer_source);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_paid_utm_source <%= @on_cluster_statement %> AS
+(referrer_source) ->
+ has({paid_sources:Array(String)}, referrer_source);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_cross_network <%= @on_cluster_statement %> AS
+(utm_campaign) ->
+ position(utm_campaign, 'cross-network') > 0;
+
+CREATE OR REPLACE FUNCTION acquisition_channel_paid_shopping <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium, utm_campaign) ->
+ acquisition_channel_paid_medium(utm_medium) AND
+ (
+ acquisition_channel_has_category_shopping(referrer_source)
+ OR acquisition_channel_shopping_campaign(utm_campaign)
+ );
+
+CREATE OR REPLACE FUNCTION acquisition_channel_paid_search <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium, utm_source, click_id_param) ->
+ (
+ acquisition_channel_has_category_search(referrer_source)
+ AND (
+ acquisition_channel_paid_medium(utm_medium)
+ OR acquisition_channel_paid_utm_source(utm_source)
+ )
+ ) OR (
+ referrer_source == 'google'
+ AND click_id_param == 'gclid'
+ ) OR (
+ referrer_source == 'bing'
+ AND click_id_param == 'msclkid'
+ );
+
+CREATE OR REPLACE FUNCTION acquisition_channel_paid_social <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium, utm_source) ->
+ acquisition_channel_has_category_social(referrer_source)
+ AND (
+ acquisition_channel_paid_medium(utm_medium)
+ OR acquisition_channel_paid_utm_source(utm_source)
+ );
+
+CREATE OR REPLACE FUNCTION acquisition_channel_paid_video <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium, utm_source) ->
+ acquisition_channel_has_category_video(referrer_source)
+ AND (
+ acquisition_channel_paid_medium(utm_medium)
+ OR acquisition_channel_paid_utm_source(utm_source)
+ );
+
+CREATE OR REPLACE FUNCTION acquisition_channel_display <%= @on_cluster_statement %> AS
+(utm_medium) ->
+ utm_medium IN ('display', 'banner', 'expandable', 'interstitial', 'cpm');
+
+CREATE OR REPLACE FUNCTION acquisition_channel_paid_medium <%= @on_cluster_statement %> AS
+(utm_medium) ->
+ match(utm_medium, '^(.*cp.*|ppc|retargeting|paid.*)$');
+
+CREATE OR REPLACE FUNCTION acquisition_channel_shopping_campaign <%= @on_cluster_statement %> AS
+(utm_campaign) ->
+ match(utm_campaign, '^(.*(([^a-df-z]|^)shop|shopping).*)$');
+
+CREATE OR REPLACE FUNCTION acquisition_channel_organic_shopping <%= @on_cluster_statement %> AS
+(referrer_source, utm_campaign) ->
+ acquisition_channel_has_category_shopping(referrer_source)
+ OR acquisition_channel_shopping_campaign(utm_campaign);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_organic_social <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium) ->
+ acquisition_channel_has_category_social(referrer_source)
+ OR utm_medium IN (
+ 'social',
+ 'social-network',
+ 'social-media',
+ 'sm',
+ 'social network',
+ 'social media'
+ );
+
+CREATE OR REPLACE FUNCTION acquisition_channel_organic_video <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium) ->
+ acquisition_channel_has_category_video(referrer_source) OR position(utm_medium, 'video') > 0;
+
+CREATE OR REPLACE FUNCTION acquisition_channel_email <%= @on_cluster_statement %> AS
+(referrer_source, utm_source, utm_medium) ->
+ acquisition_channel_has_category_email(referrer_source)
+ OR acquisition_channel_contains_email(utm_source)
+ OR acquisition_channel_contains_email(utm_medium);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_affiliates <%= @on_cluster_statement %> AS
+(utm_medium) ->
+ utm_medium == 'affiliate';
+
+CREATE OR REPLACE FUNCTION acquisition_channel_audio <%= @on_cluster_statement %> AS
+(utm_medium) ->
+ utm_medium == 'audio';
+
+CREATE OR REPLACE FUNCTION acquisition_channel_sms <%= @on_cluster_statement %> AS
+(column) ->
+ column == 'sms';
+
+CREATE OR REPLACE FUNCTION acquisition_channel_mobile_push_notifications <%= @on_cluster_statement %> AS
+(utm_medium, referrer_source) ->
+ endsWith(utm_medium, 'push') OR
+ multiSearchAny(utm_medium, ['mobile', 'notification']) OR
+ referrer_source == 'firebase';
+
+CREATE OR REPLACE FUNCTION acquisition_channel_referral <%= @on_cluster_statement %> AS
+(utm_medium, referrer_source) ->
+ utm_medium IN ('referral', 'app', 'link') OR
+ not empty(referrer_source);
+
+CREATE OR REPLACE FUNCTION acquisition_channel_contains_email <%= @on_cluster_statement %> AS
+(column) ->
+ match(column, 'e[-_ ]?mail|newsletter');
+
+CREATE OR REPLACE FUNCTION acquisition_channel <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium, utm_campaign, utm_source, click_id_param) ->
+ acquisition_channel_lowered(
+ lower(referrer_source),
+ lower(utm_medium),
+ lower(utm_campaign),
+ lower(utm_source),
+ click_id_param
+ );
+
+CREATE OR REPLACE FUNCTION acquisition_channel_lowered <%= @on_cluster_statement %> AS
+(referrer_source, utm_medium, utm_campaign, utm_source, click_id_param) ->
+ multiIf(
+ acquisition_channel_cross_network(utm_campaign), 'Cross-network',
+ acquisition_channel_paid_shopping(referrer_source, utm_medium, utm_campaign), 'Paid Shopping',
+ acquisition_channel_paid_search(referrer_source, utm_medium, utm_source, click_id_param), 'Paid Search',
+ acquisition_channel_paid_social(referrer_source, utm_medium, utm_source), 'Paid Social',
+ acquisition_channel_paid_video(referrer_source, utm_medium, utm_source), 'Paid Video',
+ acquisition_channel_display(utm_medium), 'Display',
+ acquisition_channel_paid_medium(utm_medium), 'Paid Other',
+ acquisition_channel_organic_shopping(referrer_source, utm_campaign), 'Organic Shopping',
+ acquisition_channel_organic_social(referrer_source, utm_medium), 'Organic Social',
+ acquisition_channel_organic_video(referrer_source, utm_medium), 'Organic Video',
+ acquisition_channel_has_category_search(referrer_source), 'Organic Search',
+ acquisition_channel_email(referrer_source, utm_source, utm_medium), 'Email',
+ acquisition_channel_affiliates(utm_medium), 'Affiliates',
+ acquisition_channel_audio(utm_medium), 'Audio',
+ acquisition_channel_sms(utm_source), 'SMS',
+ acquisition_channel_sms(utm_medium), 'SMS',
+ acquisition_channel_mobile_push_notifications(utm_medium, referrer_source), 'Mobile Push Notifications',
+ acquisition_channel_referral(utm_medium, referrer_source), 'Referral',
+ 'Direct'
+ );
diff --git a/test/plausible/ingestion/acquisition_test.exs b/test/plausible/ingestion/acquisition_test.exs
new file mode 100644
index 0000000000..77ada66fd3
--- /dev/null
+++ b/test/plausible/ingestion/acquisition_test.exs
@@ -0,0 +1,142 @@
+defmodule Plausible.Ingestion.AcquisitionTest do
+ use Plausible.DataCase
+
+ setup_all do
+ Plausible.DataMigration.AcquisitionChannel.run(quiet: true)
+ end
+
+ @static_tests [
+ %{expected: "Direct"},
+ %{utm_campaign: "cross-network", expected: "Cross-network"},
+ %{utm_campaign: "shopping", utm_medium: "paid", expected: "Paid Shopping"},
+ %{referrer_source: "shopify.com", utm_medium: "paid", expected: "Paid Shopping"},
+ %{
+ referrer_source: "shopify",
+ utm_source: "shopify",
+ utm_medium: "paid",
+ expected: "Paid Shopping"
+ },
+ %{referrer_source: "DuckDuckGo", utm_medium: "paid", expected: "Paid Search"},
+ %{referrer_source: "Google", click_id_param: "gclid", expected: "Paid Search"},
+ %{referrer_source: "DuckDuckGo", click_id_param: "gclid", expected: "Organic Search"},
+ %{referrer_source: "Bing", click_id_param: "msclkid", expected: "Paid Search"},
+ %{referrer_source: "DuckDuckGo", click_id_param: "msclkid", expected: "Organic Search"},
+ %{
+ referrer_source: "google",
+ utm_source: "google",
+ utm_medium: "paid",
+ expected: "Paid Search"
+ },
+ %{referrer_source: "TikTok", utm_medium: "paid", expected: "Paid Social"},
+ %{
+ referrer_source: "tiktok",
+ utm_source: "tiktok",
+ utm_medium: "paid",
+ expected: "Paid Social"
+ },
+ %{referrer_source: "Youtube", utm_medium: "paid", expected: "Paid Video"},
+ %{
+ referrer_source: "youtube",
+ utm_source: "youtube",
+ utm_medium: "paid",
+ expected: "Paid Video"
+ },
+ %{utm_medium: "banner", expected: "Display"},
+ %{utm_medium: "cpc", expected: "Paid Other"},
+ %{referrer_source: "walmart.com", expected: "Organic Shopping"},
+ %{referrer_source: "walmart", utm_source: "walmart", expected: "Organic Shopping"},
+ %{utm_campaign: "shop", expected: "Organic Shopping"},
+ %{referrer_source: "Facebook", expected: "Organic Social"},
+ %{referrer_source: "twitter", utm_source: "twitter", expected: "Organic Social"},
+ %{utm_medium: "social", expected: "Organic Social"},
+ %{referrer_source: "Vimeo", expected: "Organic Video"},
+ %{referrer_source: "vimeo", utm_source: "vimeo", expected: "Organic Video"},
+ %{utm_medium: "video", expected: "Organic Video"},
+ %{referrer_source: "DuckDuckGo", expected: "Organic Search"},
+ %{referrer_source: "duckduckgo", utm_source: "duckduckgo", expected: "Organic Search"},
+ %{utm_medium: "referral", expected: "Referral"},
+ %{referrer_source: "email", utm_source: "email", expected: "Email"},
+ %{utm_medium: "email", expected: "Email"},
+ %{utm_medium: "affiliate", expected: "Affiliates"},
+ %{utm_medium: "audio", expected: "Audio"},
+ %{referrer_source: "sms", utm_source: "sms", expected: "SMS"},
+ %{utm_medium: "sms", expected: "SMS"},
+ %{utm_medium: "app-push", expected: "Mobile Push Notifications"},
+ %{utm_medium: "example-mobile", expected: "Mobile Push Notifications"},
+ %{referrer_source: "othersite.com", expected: "Referral"},
+ %{referrer_source: "Threads", utm_source: "threads", expected: "Organic Social"},
+ %{referrer_source: "Instagram", utm_source: "ig", expected: "Organic Social"},
+ %{referrer_source: "Youtube", utm_source: "yt", expected: "Organic Video"},
+ %{referrer_source: "Youtube", utm_source: "yt-ads", expected: "Paid Video"},
+ %{referrer_source: "Facebook", utm_source: "fb", expected: "Organic Social"},
+ %{referrer_source: "Facebook", utm_source: "fb-ads", expected: "Paid Social"},
+ %{referrer_source: "Facebook", utm_source: "fbad", expected: "Paid Social"},
+ %{referrer_source: "Facebook", utm_source: "facebook-ads", expected: "Paid Social"},
+ %{referrer_source: "Reddit", utm_source: "Reddit-ads", expected: "Paid Social"},
+ %{referrer_source: "Google", utm_source: "google_ads", expected: "Paid Search"},
+ %{referrer_source: "Google", utm_source: "Google-ads", expected: "Paid Search"},
+ %{referrer_source: "Google", utm_source: "Adwords", expected: "Paid Search"},
+ %{referrer_source: "Twitter", utm_source: "twitter-ads", expected: "Paid Social"},
+ %{referrer_source: "Reddit", expected: "Organic Social"},
+ %{referrer_source: "Perplexity", expected: "Organic Search"},
+ %{referrer_source: "Microsoft Teams", expected: "Organic Social"},
+ %{referrer_source: "Wikipedia", expected: "Referral"},
+ %{referrer_source: "Bing", expected: "Organic Search"},
+ %{referrer_source: "Brave", expected: "Organic Search"},
+ %{referrer_source: "Yandex", expected: "Organic Search"},
+ %{referrer_source: "Discord", expected: "Organic Social"},
+ %{referrer_source: "Baidu", expected: "Organic Search"},
+ %{referrer_source: "Telegram", expected: "Organic Social"},
+ %{referrer_source: "Sogou", expected: "Organic Search"},
+ %{referrer_source: "Linktree", expected: "Referral"},
+ %{referrer_source: "Linktree", utm_source: "linktree", expected: "Referral"},
+ %{referrer_source: "Hacker News", expected: "Organic Social"},
+ %{referrer_source: "Yahoo!", expected: "Organic Search"},
+ %{referrer_source: "Gmail", expected: "Email"},
+ %{referrer_source: "Newsletter-UK", utm_source: "Newsletter-UK", expected: "Email"},
+ %{referrer_source: "temu.com", expected: "Organic Shopping"},
+ %{referrer_source: "Telegram", utm_source: "Telegram", expected: "Organic Social"},
+ %{referrer_source: "chatgpt.com", expected: "Organic Search"},
+ %{referrer_source: "Slack", expected: "Organic Social"},
+ %{referrer_source: "producthunt", expected: "Organic Social"},
+ %{referrer_source: "GitHub", expected: "Organic Social"},
+ %{referrer_source: "steamcommunity.com", expected: "Organic Social"},
+ %{referrer_source: "Vkontakte", expected: "Organic Social"},
+ %{referrer_source: "Threads", expected: "Organic Social"},
+ %{referrer_source: "Ecosia", expected: "Organic Search"}
+ ]
+
+ for {test_data, index} <- Enum.with_index(@static_tests, 1) do
+ @tag test_data: test_data
+ test "static test #{index} - #{Jason.encode!(test_data)}", %{test_data: test_data} do
+ assert reference_channel(test_data) == test_data.expected
+ assert clickhouse_channel(test_data) == test_data.expected
+ end
+ end
+
+ def reference_channel(test_data) do
+ Plausible.Ingestion.Acquisition.get_channel(
+ test_data[:referrer_source],
+ test_data[:utm_medium],
+ test_data[:utm_campaign],
+ test_data[:utm_source],
+ test_data[:click_id_param]
+ )
+ end
+
+ def clickhouse_channel(test_data) do
+ %{rows: [[channel]]} =
+ Plausible.IngestRepo.query!(
+ "SELECT acquisition_channel({$0:String}, {$1:String}, {$2:String}, {$3:String}, {$4:String})",
+ [
+ test_data[:referrer_source] || "",
+ test_data[:utm_medium] || "",
+ test_data[:utm_campaign] || "",
+ test_data[:utm_source] || "",
+ test_data[:click_id_param] || ""
+ ]
+ )
+
+ channel
+ end
+end