Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use fetch over XMLHttpRequest in plausible.js #5025

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use fetch over XMLHttpRequest in plausible.js #5025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,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.

### Fixed

Expand Down
1 change: 0 additions & 1 deletion lib/plausible_web/templates/layout/_tracking.html.heex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
32 changes: 14 additions & 18 deletions tracker/src/plausible.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -223,8 +222,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: {
Expand All @@ -235,23 +246,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) || []
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/pageleave-hash-exclusions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/pageleave-hash-pageview-props.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/pageleave-hash.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/pageleave-manual.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/pageleave-pageview-props.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/pageleave.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/scroll-depth-content-onscroll.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/scroll-depth-dynamic-content-load.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/scroll-depth-hash.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/scroll-depth-slow-window-load.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion tracker/test/fixtures/scroll-depth.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading