Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
defmodule PlausibleWeb.FaviconTest do
use Plausible.DataCase, async: true
import Plug.Test
alias PlausibleWeb.Favicon
import Mox
setup :verify_on_exit!
setup_all do
opts = PlausibleWeb.Favicon.init(nil)
%{plug_opts: opts}
end
test "ignores request on a URL it does not need to handle", %{plug_opts: plug_opts} do
old_conn = conn(:get, "/irrelevant")
new_conn = Favicon.call(old_conn, plug_opts)
refute new_conn.halted
assert old_conn == new_conn
end
test "proxies request on favicon URL to duckduckgo", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:ok, %Finch.Response{status: 200, body: "favicon response body"}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == "favicon response body"
end
test "requests favicon from DDG by hostname only (strips pathname)", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/site.com.ico" ->
{:ok, %Finch.Response{status: 200, body: "favicon response body"}}
end
)
conn =
conn(:get, "/favicon/sources/site.com/subfolder")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == "favicon response body"
end
test "sets content-disposition and content-security-policy", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:ok, %Finch.Response{status: 200, body: "favicon response body"}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == "favicon response body"
assert Plug.Conn.get_resp_header(conn, "content-security-policy") == ["script-src 'none'"]
assert Plug.Conn.get_resp_header(conn, "content-disposition") == ["attachment"]
end
test "maps a categorized source to URL for favicon", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/facebook.com.ico" ->
{:ok, %Finch.Response{status: 200, body: "favicon response body"}}
end
)
conn =
conn(:get, "/favicon/sources/Facebook")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == "favicon response body"
end
for {source, domain} <- %{
"Linktree" => "linktr.ee",
"Bluesky" => "bsky.app",
"Mastodon" => "mastodon.social",
"X (Twitter)" => "x.com",
"Kagi" => "kagi.com",
"Microsoft 365" => "office.com"
} do
test "maps custom source #{source} to #{domain} for favicon", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/#{unquote(domain)}.ico" ->
{:ok, %Finch.Response{status: 200, body: "favicon response body"}}
end
)
conn =
conn(:get, "/favicon/sources/#{URI.encode_www_form(unquote(source))}")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == "favicon response body"
end
end
test "copies content-type header from the proxied response", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:ok,
%Finch.Response{
status: 200,
body: "favicon response body",
headers: [
{"transfer-encoding", "chunked"},
{"content-type", "should-pass-through"}
]
}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert Plug.Conn.get_resp_header(conn, "content-type") == ["should-pass-through"]
end
test "overrides content-type header if proxied response starts with <svg", %{
plug_opts: plug_opts
} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:ok,
%Finch.Response{
status: 200,
body: "<svg>icon</svg>",
headers: [{"content-type", "image/x-icon"}]
}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io")
|> Favicon.call(plug_opts)
assert conn.halted
assert Plug.Conn.get_resp_header(conn, "content-type") == ["image/svg+xml; charset=utf-8"]
end
describe "Fallback to placeholder icon" do
@source_placeholder_icon File.read!("priv/link_favicon.svg")
@source_dark_placeholder_icon File.read!("priv/link_favicon_dark.svg")
@site_placeholder_icon File.read!("priv/site_favicon_placeholder.svg")
@site_dark_placeholder_icon File.read!("priv/site_favicon_placeholder_dark.svg")
test "falls back to placeholder when DDG returns a non-2xx response", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
res = %Finch.Response{status: 503, body: "bad gateway"}
{:error, Plausible.HTTPClient.Non200Error.new(res)}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @source_placeholder_icon
end
test "falls back to placeholder in case of a network error", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:error, %Finch.TransportError{reason: :closed}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @source_placeholder_icon
end
test "falls back to placeholder when DDG returns a broken image response", %{
plug_opts: plug_opts
} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:ok, %Finch.Response{status: 200, body: <<137, 80, 78, 71, 13, 10, 26, 10>>}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @source_placeholder_icon
end
test "falls back to the dark source placeholder when requested", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:error, %Finch.TransportError{reason: :closed}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io?ui-mode=dark")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @source_dark_placeholder_icon
end
test "falls back to the site placeholder when requested", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:error, %Finch.TransportError{reason: :closed}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io?placeholder=site")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @site_placeholder_icon
end
test "falls back to the dark site placeholder when requested", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/plausible.io.ico" ->
{:error, %Finch.TransportError{reason: :closed}}
end
)
conn =
conn(:get, "/favicon/sources/plausible.io?placeholder=site&ui-mode=dark")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @site_dark_placeholder_icon
end
test "serves the site placeholder on its own URL", %{plug_opts: plug_opts} do
conn =
conn(:get, "/favicon/placeholders/site")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @site_placeholder_icon
end
test "serves the dark site placeholder on its own URL", %{plug_opts: plug_opts} do
conn =
conn(:get, "/favicon/placeholders/site?ui-mode=dark")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @site_dark_placeholder_icon
end
test "serves the source placeholder on its own URL", %{plug_opts: plug_opts} do
conn =
conn(:get, "/favicon/placeholders/source")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @source_placeholder_icon
end
test "serves the dark source placeholder on its own URL", %{plug_opts: plug_opts} do
conn =
conn(:get, "/favicon/placeholders/source?ui-mode=dark")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == @source_dark_placeholder_icon
end
test "serves a favicon for a source named placeholder", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,
:get,
fn "https://icons.duckduckgo.com/ip3/placeholder.ico" ->
{:ok, %Finch.Response{status: 200, body: "favicon", headers: []}}
end
)
conn =
conn(:get, "/favicon/sources/placeholder")
|> Favicon.call(plug_opts)
assert conn.halted
assert conn.status == 200
assert conn.resp_body == "favicon"
end
end
end