File size: 6,874 Bytes
6778ee0 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | defmodule PlausibleWeb.TrackerTest do
use Plausible.DataCase
use Oban.Testing, repo: Plausible.Repo
alias Plausible.Site.TrackerScriptConfiguration
alias PlausibleWeb.Tracker
@example_config %{
installation_type: :manual,
track_404_pages: true,
hash_based_routing: true,
file_downloads: false,
outbound_links: false,
pageview_props: false,
tagged_events: true,
revenue_tracking: false,
form_submissions: true
}
test "plausible_main_config/1" do
site = new_site()
tracker_script_configuration = create_config(site)
assert Tracker.plausible_main_config(tracker_script_configuration) == %{
domain: site.domain,
endpoint: "#{PlausibleWeb.Endpoint.url()}/api/event",
outboundLinks: false,
fileDownloads: false,
formSubmissions: true
}
end
describe "get_or_create_tracker_script_configuration!/1 and update_script_configuration!/3" do
test "can create config with params" do
site = new_site()
tracker_script_configuration =
Tracker.get_or_create_tracker_script_configuration!(site, %{
outbound_links: true,
form_submissions: true,
installation_type: :manual
})
assert tracker_script_configuration.outbound_links
assert tracker_script_configuration.form_submissions
refute tracker_script_configuration.file_downloads
assert tracker_script_configuration.installation_type == :manual
end
test "goals are created when config is created" do
site = new_site()
Tracker.get_or_create_tracker_script_configuration!(site, %{
outbound_links: true,
installation_type: :manual
})
assert Repo.get_by(Plausible.Goal, site_id: site.id, display_name: "Outbound Link: Click")
refute Repo.get_by(Plausible.Goal, site_id: site.id, display_name: "File Download")
end
test "can update config" do
site = new_site()
tracker_script_configuration = create_config(site)
assert tracker_script_configuration.installation_type == :manual
Tracker.update_script_configuration!(
site,
%{installation_type: :wordpress, outbound_links: true},
:installation
)
tracker_script_configuration = Repo.reload!(tracker_script_configuration)
assert tracker_script_configuration.installation_type == :wordpress
assert tracker_script_configuration.outbound_links == true
end
on_ee do
test "CDN purge is scheduled when config is updated" do
site = new_site()
tracker_script_configuration =
Tracker.get_or_create_tracker_script_configuration!(site)
Tracker.update_script_configuration!(
site,
%{installation_type: :wordpress, outbound_links: true},
:installation
)
assert_enqueued(
worker: Plausible.Workers.PurgeCDNCache,
args: %{id: tracker_script_configuration.id}
)
end
test "CDN purge is not scheduled when only installation type is updated" do
site = new_site()
tracker_script_configuration =
Tracker.get_or_create_tracker_script_configuration!(site)
Tracker.update_script_configuration!(
site,
%{installation_type: :wordpress},
:installation
)
refute_enqueued(
worker: Plausible.Workers.PurgeCDNCache,
args: %{id: tracker_script_configuration.id}
)
end
end
end
describe "build_script/1" do
test "can turn config into a script tag" do
site = new_site()
tracker_script_configuration = create_config(site)
script_tag = PlausibleWeb.Tracker.build_script(tracker_script_configuration)
assert script_tag =~
~s(={endpoint:"#{PlausibleWeb.Endpoint.url()}/api/event",domain:"#{site.domain}",formSubmissions:!0})
end
test "script tag escapes problematic characters as expected" do
site = new_site(domain: "naughty domain &<> \"\'\nfoo ")
tracker_script_configuration = create_config(site)
script_tag = PlausibleWeb.Tracker.build_script(tracker_script_configuration)
assert script_tag =~ ~s(domain:"naughty domain &<> \\"'\\nfoo ")
end
end
describe "get_plausible_main_script/1" do
setup %{test: test} do
site = new_site()
tracker_script_configuration = create_config(site)
opts = start_test_cache(test)
{:ok, %{opts: opts, site: site, tracker_script_configuration: tracker_script_configuration}}
end
test "does 0 database queries on non-existing config", %{opts: opts} do
query_count = attach_query_counter()
script = Tracker.get_plausible_main_script("non-existing-id", opts)
assert is_nil(script)
assert query_count.() == 0
end
test "does minimal database queries on existing config", %{
opts: opts,
tracker_script_configuration: tracker_script_configuration
} do
query_count = attach_query_counter()
script = Tracker.get_plausible_main_script(tracker_script_configuration.id, opts)
assert is_binary(script)
on_ee do
assert query_count.() == 1
else
# On self-hosted, we have a pre-warmed cache for the script
assert query_count.() == 0
end
end
end
def create_config(site) do
Tracker.update_script_configuration!(
site,
Map.put(@example_config, :site_id, site.id),
:installation
)
Plausible.Repo.one(
from(c in TrackerScriptConfiguration, where: c.site_id == ^site.id, preload: [:site])
)
end
on_ee do
defp start_test_cache(cache_name) do
opts = [cache_name: cache_name, force?: true]
%{start: {m, f, a}} =
Plausible.Site.TrackerScriptIdCache.child_spec(
cache_name: cache_name,
ets_options: [read_concurrency: true]
)
{:ok, _} = apply(m, f, a)
Plausible.Site.TrackerScriptIdCache.refresh_all(opts)
opts
end
else
defp start_test_cache(cache_name) do
opts = [cache_name: cache_name, force?: true]
%{start: {m, f, a}} =
Plausible.Site.TrackerScriptCache.child_spec(
cache_name: cache_name,
ets_options: [read_concurrency: true]
)
{:ok, _} = apply(m, f, a)
Plausible.Site.TrackerScriptCache.refresh_all(opts)
opts
end
end
defp attach_query_counter() do
query_count = :counters.new(1, [])
:telemetry.attach(
"test-query-counter",
[:plausible, :repo, :query],
fn _event, _measurements, _metadata, _config ->
:counters.add(query_count, 1, 1)
end,
%{}
)
on_exit(fn ->
:telemetry.detach("test-query-counter")
end)
fn -> :counters.get(query_count, 1) end
end
end
|