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
Use `fetch` over `XMLHttpRequest` in plausible.js (#5025)
Karl-Aksel Puulmannde62f8056461
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 59d7b2ca71..b3bea9a34a 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -19,6 +19,7 @@ All notable changes to this project will be documented in this file.- Filters appear in the search bar as ?f=is,page,/docs,/blog&f=... instead of ?filters=((is,page,(/docs,/blog)),...) for Plausible links sent on various platforms to work reliably.- Details modal search inputs are now case-insensitive.- Improved report performance in cases where site has a lot of unique pathnames+- Plausible script now uses `fetch` with keepalive flag as default over `XMLHttpRequest`. This will ensure more reliable tracking. Reminder to use `compat` script variant if tracking Internet Explorer is required.### Fixeddiff --git a/lib/plausible_web/templates/layout/_tracking.html.heex b/lib/plausible_web/templates/layout/_tracking.html.heexindex 9401e064eb..4db5c84388 100644--- a/lib/plausible_web/templates/layout/_tracking.html.heex+++ b/lib/plausible_web/templates/layout/_tracking.html.heex@@ -5,7 +5,6 @@data-api={PlausibleWeb.Dogfood.api_destination()}data-domain={PlausibleWeb.Dogfood.domain(@conn)}src={PlausibleWeb.Dogfood.script_url()}- data-allow-fetch></script><script>diff --git a/tracker/src/plausible.js b/tracker/src/plausible.jsindex 80ff4eca9c..3fc4a40c87 100644--- a/tracker/src/plausible.js+++ b/tracker/src/plausible.js@@ -11,7 +11,6 @@{{/if}}var endpoint = scriptEl.getAttribute('data-api') || defaultEndpoint(scriptEl)var dataDomain = scriptEl.getAttribute('data-domain')- var allowFetch = scriptEl.hasAttribute('data-allow-fetch')function onIgnoredEvent(eventName, reason, options) {if (reason) console.warn('Ignoring Event: ' + reason);@@ -248,8 +247,20 @@}function sendRequest(endpoint, payload, options) {- {{#if pageleave}}- if (allowFetch && window.fetch) {+ {{#if compat}}+ var request = new XMLHttpRequest();+ request.open('POST', endpoint, true);+ request.setRequestHeader('Content-Type', 'text/plain');++ request.send(JSON.stringify(payload));++ request.onreadystatechange = function() {+ if (request.readyState === 4) {+ options && options.callback && options.callback({status: request.status})+ }+ }+ {{else}}+ if (window.fetch) {fetch(endpoint, {method: 'POST',headers: {@@ -260,23 +271,8 @@}).then(function(response) {options && options.callback && options.callback({status: response.status})})-- return}{{/if}}-- var request = new XMLHttpRequest();- request.open('POST', endpoint, true);- request.setRequestHeader('Content-Type', 'text/plain');-- request.send(JSON.stringify(payload));-- request.onreadystatechange = function() {- if (request.readyState === 4) {- options && options.callback && options.callback({status: request.status})- }- }-}var queue = (window.plausible && window.plausible.q) || []diff --git a/tracker/test/fixtures/pageleave-hash-exclusions.html b/tracker/test/fixtures/pageleave-hash-exclusions.htmlindex 267ee43b68..aecca154e9 100644--- a/tracker/test/fixtures/pageleave-hash-exclusions.html+++ b/tracker/test/fixtures/pageleave-hash-exclusions.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script defer data-exclude='/*#*/hash/**/ignored' src="/tracker/js/plausible.exclusions.hash.local.pageleave.js" data-allow-fetch></script>+ <script defer data-exclude='/*#*/hash/**/ignored' src="/tracker/js/plausible.exclusions.hash.local.pageleave.js"></script></head><body>diff --git a/tracker/test/fixtures/pageleave-hash-pageview-props.html b/tracker/test/fixtures/pageleave-hash-pageview-props.htmlindex 1d4da17ed8..651acdb034 100644--- a/tracker/test/fixtures/pageleave-hash-pageview-props.html+++ b/tracker/test/fixtures/pageleave-hash-pageview-props.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script id="plausible-script" defer src="/tracker/js/plausible.hash.local.pageleave.pageview-props.js" data-allow-fetch></script>+ <script id="plausible-script" defer src="/tracker/js/plausible.hash.local.pageleave.pageview-props.js"></script></head><body>diff --git a/tracker/test/fixtures/pageleave-hash.html b/tracker/test/fixtures/pageleave-hash.htmlindex a0a5965898..e164362ccf 100644--- a/tracker/test/fixtures/pageleave-hash.html+++ b/tracker/test/fixtures/pageleave-hash.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script defer src="/tracker/js/plausible.hash.local.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.hash.local.pageleave.js"></script><script></script>diff --git a/tracker/test/fixtures/pageleave-manual.html b/tracker/test/fixtures/pageleave-manual.htmlindex e730c6d0e6..f87f00b322 100644--- a/tracker/test/fixtures/pageleave-manual.html+++ b/tracker/test/fixtures/pageleave-manual.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script defer src="/tracker/js/plausible.local.manual.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.local.manual.pageleave.js"></script><script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script></head>diff --git a/tracker/test/fixtures/pageleave-pageview-props.html b/tracker/test/fixtures/pageleave-pageview-props.htmlindex 256f7e8e13..c2c9cd11e3 100644--- a/tracker/test/fixtures/pageleave-pageview-props.html+++ b/tracker/test/fixtures/pageleave-pageview-props.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script defer event-author="John" src="/tracker/js/plausible.local.pageleave.pageview-props.js" data-allow-fetch></script>+ <script defer event-author="John" src="/tracker/js/plausible.local.pageleave.pageview-props.js"></script></head><body>diff --git a/tracker/test/fixtures/pageleave.html b/tracker/test/fixtures/pageleave.htmlindex d7abc10369..a8d415e62f 100644--- a/tracker/test/fixtures/pageleave.html+++ b/tracker/test/fixtures/pageleave.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script defer src="/tracker/js/plausible.local.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.local.pageleave.js"></script></head><body>diff --git a/tracker/test/fixtures/scroll-depth-content-onscroll.html b/tracker/test/fixtures/scroll-depth-content-onscroll.htmlindex 2849ed23dc..588776c2cf 100644--- a/tracker/test/fixtures/scroll-depth-content-onscroll.html+++ b/tracker/test/fixtures/scroll-depth-content-onscroll.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script defer src="/tracker/js/plausible.local.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.local.pageleave.js"></script></head><body>diff --git a/tracker/test/fixtures/scroll-depth-dynamic-content-load.html b/tracker/test/fixtures/scroll-depth-dynamic-content-load.htmlindex 5edeeea9df..6cd3a77185 100644--- a/tracker/test/fixtures/scroll-depth-dynamic-content-load.html+++ b/tracker/test/fixtures/scroll-depth-dynamic-content-load.html@@ -4,7 +4,7 @@<meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Document</title>- <script defer src="/tracker/js/plausible.local.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.local.pageleave.js"></script></head><body><br>diff --git a/tracker/test/fixtures/scroll-depth-hash.html b/tracker/test/fixtures/scroll-depth-hash.htmlindex 62f62d401b..359ba5548c 100644--- a/tracker/test/fixtures/scroll-depth-hash.html+++ b/tracker/test/fixtures/scroll-depth-hash.html@@ -6,7 +6,7 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Plausible Playwright tests</title>- <script defer src="/tracker/js/plausible.hash.local.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.hash.local.pageleave.js"></script></head><body>diff --git a/tracker/test/fixtures/scroll-depth-slow-window-load.html b/tracker/test/fixtures/scroll-depth-slow-window-load.htmlindex 1638f06278..eea2a5fa29 100644--- a/tracker/test/fixtures/scroll-depth-slow-window-load.html+++ b/tracker/test/fixtures/scroll-depth-slow-window-load.html@@ -4,7 +4,7 @@<meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Document</title>- <script defer src="/tracker/js/plausible.local.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.local.pageleave.js"></script></head><body><a id="navigate-away" href="/manual.html">diff --git a/tracker/test/fixtures/scroll-depth.html b/tracker/test/fixtures/scroll-depth.htmlindex 2800bf016c..23aad7c4aa 100644--- a/tracker/test/fixtures/scroll-depth.html+++ b/tracker/test/fixtures/scroll-depth.html@@ -3,7 +3,7 @@<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0">- <script defer src="/tracker/js/plausible.local.pageleave.js" data-allow-fetch></script>+ <script defer src="/tracker/js/plausible.local.pageleave.js"></script><title>Document</title></head><body>