2023-10-03 19:51:30 +00:00
/ *
sitestat . js is meant to be included in the < head > like so :
< script src = "path/to/sitestat.js" async > < / s c r i p t >
See test - site / index . html for an example .
* /
/ * *
* The global websocket singleton . It ' s initialized at the bottom of this script .
* @ type { WebSocket | null }
* /
let WS = null ;
2023-10-04 17:30:00 +00:00
let REMOTE _URL = null ;
const RETRY _TIMEOUT = 1000 ;
2023-10-03 19:51:30 +00:00
/ * *
* Sends some JSON object to sitestat .
* @ param { object } data The data to send .
* /
function sendStat ( data ) {
2023-10-04 17:30:00 +00:00
if ( WS !== null && WS . readyState === WebSocket . OPEN ) {
2023-10-03 19:51:30 +00:00
WS . send ( JSON . stringify ( data ) ) ;
} else {
2023-10-04 17:30:00 +00:00
console . warn ( "Couldn't send sitestat data because websocket is not open: " , data ) ;
2023-10-03 19:51:30 +00:00
}
}
/ * *
* Handles any event encountered , and sends a small message to sitestat about it .
* @ param { Event } event The event that occurred .
* /
function handleEvent ( event ) {
sendStat ( {
type : "event" ,
event : event . type
} ) ;
}
/ * *
* Gets the remote URL that sitestat is running at , from the query params of
* the script ' s ` src ` attribute . Throws an error if such a URL could not be
* found .
* @ returns { string } The remote URL to connect to .
* /
function getRemoteUrl ( ) {
const scriptUrl = document . currentScript . src ;
const paramsIdx = scriptUrl . indexOf ( "?" ) ;
if ( paramsIdx !== - 1 ) {
const paramsStr = scriptUrl . substring ( paramsIdx ) ;
const params = new URLSearchParams ( paramsStr ) ;
const remoteUrl = params . get ( "remote-url" ) ;
if ( remoteUrl !== null ) {
return remoteUrl ;
}
}
throw new Error ( "Missing `remote-url=...` query parameter on script src attribute." )
}
2023-10-04 17:30:00 +00:00
function initWS ( ) {
console . info ( "Trying to open a connection to sitestat..." ) ;
WS = new WebSocket ( ` ws:// ${ REMOTE _URL } /ws ` ) ;
WS . onopen = ( ) => {
console . info (
"📈 Established a connection to %csitestat%c for %cnon-intrusive, non-identifiable%csite analytics.\nLearn more here: https://github.com/andrewlalis/sitestat or check your browser's network tab to see what's being sent." ,
"font-weight: bold; font-style: italic; font-size: large; color: #32a852; background-color: #2e2e2e; padding: 5px;" ,
"" ,
"font-style: italic;"
) ;
sendStat ( {
type : "ident" ,
href : window . location . href ,
userAgent : window . navigator . userAgent ,
viewport : {
width : window . innerWidth ,
height : window . innerHeight
}
} ) ;
}
// WS.onerror = console.error;
WS . onclose = ( closeEvent ) => {
if ( closeEvent . code > 1001 ) {
console . warn ( "sitestat connection closed unexpectedly with code " + closeEvent . code + ". Trying to reestablish the connection in " + RETRY _TIMEOUT + "ms." ) ;
window . setTimeout ( initWS , RETRY _TIMEOUT ) ;
}
}
}
2023-10-03 19:51:30 +00:00
// The main script starts below:
if ( window . navigator . webdriver ) {
throw new Error ( "sitestat disabled for automated user agents." ) ;
}
2023-10-04 17:30:00 +00:00
REMOTE _URL = getRemoteUrl ( ) ;
initWS ( ) ;
2023-10-03 19:51:30 +00:00
// Register various event listeners.
2023-10-04 17:30:00 +00:00
const events = [ "click" , "keyup" , "keydown" , "copy" ] ;
2023-10-03 19:51:30 +00:00
for ( let i = 0 ; i < events . length ; i ++ ) {
document . addEventListener ( events [ i ] , handleEvent ) ;
}
