beenull/speedtest
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
speedtest/speedtest_worker.js
Felix 938dd49610 factor of latency increase inversed
2023-05-04 15:39:04 +02:00

1239 lines
46 KiB
JavaScript
Executable file
Raw Blame History

/*
LibreSpeed - Worker
by Federico Dossena
https://github.com/librespeed/speedtest/
GNU LGPLv3 License
*/
// data reported to main thread
const NOT_STARTED_STATE = -1, // not started
STARTING_STATE = 0, // starting
DOWNLOAD_TEST_STATE = 1, // download test
PING_JITTER_TEST_STATE = 2, // ping + jitter
UPLOAD_TEST_STATE = 3, // upload test
RPM_UPLOAD_TEST_STATE = 4, // RPM upload
RPM_DOWNLOAD_TEST_STATE = 5, // RPM download
FINISHED_STATE = 6, // finished
ABORT_STATE = 7; // abort
var testState = NOT_STARTED_STATE;
var dlStatus = ""; // download speed in megabit/s with 2 decimal digits
var ulStatus = ""; // upload speed in megabit/s with 2 decimal digits
var pingStatus = ""; // ping in milliseconds with 2 decimal digits
var jitterStatus = ""; // jitter in milliseconds with 2 decimal digits
var clientIp = ""; // client's IP address as reported by getIP.php
var rpmUlStatus = ""; // number of RPM in upload way
var rpmUlRatioStatus = ""; // number of RPM lost in upload way
var rpmDlStatus = ""; // number of RPM in download way
var rpmDlRatioStatus = ""; // number of RPM lost in download way
var dlProgress = 0; //progress of download test 0-1
var ulProgress = 0; //progress of upload test 0-1
var pingProgress = 0; //progress of ping+jitter test 0-1
var rpmUlProgress = 0; // progress of RPM Upload test 0-1
var rpmDlProgress = 0; // progress of RPM Download test 0-1
var testId = null; //test ID (sent back by telemetry if used, null otherwise)
var log = ""; //telemetry log
function tlog(s) {
if (settings.telemetry_level >= 2) {
log += Date.now() + ": " + s + "\n";
}
}
function tverb(s) {
if (settings.telemetry_level >= 3) {
log += Date.now() + ": " + s + "\n";
}
}
function twarn(s) {
if (settings.telemetry_level >= 2) {
log += Date.now() + " WARN: " + s + "\n";
}
console.warn(s);
}
// test settings. can be overridden by sending specific values with the start command
var settings = {
mpot: true, //set to true when in MPOT mode
test_order: "IP_S_R", //order in which tests will be performed as a string. D=Download, U=Upload, P=Ping+Jitter, I=IP, _=1 second delay
time_ul_max: 15, // max duration of upload test in seconds
time_dl_max: 15, // max duration of download test in seconds
time_auto: true, // if set to true, tests will take less time on faster connections
time_ulGraceTime: 3, //time to wait in seconds before actually measuring ul speed (wait for buffers to fill)
time_dlGraceTime: 1.5, //time to wait in seconds before actually measuring dl speed (wait for TCP window to increase)
count_ping: 10, // number of pings to perform in ping test
url_dl: "backend/garbage.php", // path to a large file or garbage.php, used for download test. must be relative to this js file
url_ul: "backend/empty.php", // path to an empty file, used for upload test. must be relative to this js file
url_ping: "backend/empty.php", // path to an empty file, used for ping test. must be relative to this js file
url_getIp: "backend/getIP.php", // path to getIP.php relative to this js file, or a similar thing that outputs the client's ip
getIp_ispInfo: true, //if set to true, the server will include ISP info with the IP address
getIp_ispInfo_distance: "km", //km or mi=estimate distance from server in km/mi; set to false to disable distance estimation. getIp_ispInfo must be enabled in order for this to work
xhr_dlMultistream: 6, // number of download streams to use (can be different if enable_quirks is active)
xhr_ulMultistream: 3, // number of upload streams to use (can be different if enable_quirks is active)
xhr_multistreamDelay: 300, //how much concurrent requests should be delayed
xhr_ignoreErrors: 1, // 0=fail on errors, 1=attempt to restart a stream if it fails, 2=ignore all errors
xhr_dlUseBlob: false, // if set to true, it reduces ram usage but uses the hard drive (useful with large garbagePhp_chunkSize and/or high xhr_dlMultistream)
xhr_ul_blob_megabytes: 20, //size in megabytes of the upload blobs sent in the upload test (forced to 4 on chrome mobile)
garbagePhp_chunkSize: 100, // size of chunks sent by garbage.php (can be different if enable_quirks is active)
enable_quirks: true, // enable quirks for specific browsers. currently it overrides settings to optimize for specific browsers, unless they are already being overridden with the start command
ping_allowPerformanceApi: true, // if enabled, the ping test will attempt to calculate the ping more precisely using the Performance API. Currently works perfectly in Chrome, badly in Edge, and not at all in Firefox. If Performance API is not supported or the result is obviously wrong, a fallback is provided.
overheadCompensationFactor: 1.06, //can be changed to compensatie for transport overhead. (see doc.md for some other values)
useMebibits: false, //if set to true, speed will be reported in mebibits/s instead of megabits/s
telemetry_level: 0, // 0=disabled, 1=basic (results only), 2=full (results and timing) 3=debug (results+log)
url_telemetry: "results/telemetry.php", // path to the script that adds telemetry data to the database
telemetry_extra: "", //extra data that can be passed to the telemetry through the settings
forceIE11Workaround: false, //when set to true, it will foce the IE11 upload test on all browsers. Debug only
rpm : { // RPM parameters
MAD: 4, // Moving Average Distance (number of intervals to take into account for the moving average)
ID: 1, // Interval duration at which the algorithm reevaluates stability
TMP: 0.95, // Trimmed Mean Percentage to be trimmed
SDT: 0.05, // Standard Deviation Tolerance for stability detection
MNP: 16, // Maximum number of parallel transport-layer connections
MPS: 20, // Maximum responsiveness probes per second
PTC: 0.05, // Percentage of Total Capacity the probes are allowed to consume
MaxTime: 20, // Maximum Time in second
},
useWildcard : false // Use wildcard link for connexions
};
var xhr = null; // array of currently active xhr requests
var interval = null; // timer used in tests
var test_pointer = 0; //pointer to the next test to run inside settings.test_order
/*
this function is used on URLs passed in the settings to determine whether we need a ? or an & as a separator
*/
function url_sep(url) {
return url.match(/\?/) ? "&" : "?";
}
function useWildcard(url, subdomain) {
let domain = ""
try {
domain = new URL(url).hostname;
} catch {
// url is a route e.g. "/empty.php"
// returns default route
twarn(`Couldn't create wildcard subdomain for ${url}`);
return url;
}
let parts = domain.split('.');
parts.splice(0, 0, subdomain);
let newDomain = parts.join('.');
return url.replace(domain, newDomain)
}
/*
listener for commands from main thread to this worker.
commands:
-status: returns the current status as a JSON string containing testState, dlStatus, ulStatus, pingStatus, clientIp, jitterStatus, dlProgress, ulProgress, pingProgress
-abort: aborts the current test
-start: starts the test. optionally, settings can be passed as JSON.
example: start {"time_ul_max":"10", "time_dl_max":"10", "count_ping":"50"}
*/
this.addEventListener("message", function(e) {
var params = e.data.split(" ");
if (params[0] === "status") {
// return status
postMessage(
JSON.stringify({
testState: testState,
dlStatus: dlStatus,
ulStatus: ulStatus,
pingStatus: pingStatus,
clientIp: clientIp,
jitterStatus: jitterStatus,
dlProgress: dlProgress,
ulProgress: ulProgress,
pingProgress: pingProgress,
testId: testId,
rpmDlProgress: rpmDlProgress,
rpmDlStatus: rpmDlStatus,
rpmDlRatioStatus: rpmDlRatioStatus,
rpmUlProgress: rpmUlProgress,
rpmUlStatus: rpmUlStatus,
rpmUlRatioStatus: rpmUlRatioStatus,
})
);
}
if (params[0] === "start" && testState === NOT_STARTED_STATE) {
// start new test
testState = STARTING_STATE;
try {
// parse settings, if present
var s = {};
try {
var ss = e.data.substring(5);
if (ss) s = JSON.parse(ss);
} catch (e) {
twarn("Error parsing custom settings JSON. Please check your syntax");
}
//copy custom settings
for (var key in s) {
if (typeof settings[key] !== "undefined") settings[key] = s[key];
else twarn("Unknown setting ignored: " + key);
}
var ua = navigator.userAgent;
// quirks for specific browsers. apply only if not overridden. more may be added in future releases
if (settings.enable_quirks || (typeof s.enable_quirks !== "undefined" && s.enable_quirks)) {
if (/Firefox.(\d+\.\d+)/i.test(ua)) {
if (typeof s.ping_allowPerformanceApi === "undefined") {
// ff performance API sucks
settings.ping_allowPerformanceApi = false;
}
}
if (/Edge.(\d+\.\d+)/i.test(ua)) {
if (typeof s.xhr_dlMultistream === "undefined") {
// edge more precise with 3 download streams
settings.xhr_dlMultistream = 3;
}
}
if (/Chrome.(\d+)/i.test(ua) && !!self.fetch) {
if (typeof s.xhr_dlMultistream === "undefined") {
// chrome more precise with 5 streams
settings.xhr_dlMultistream = 5;
}
}
}
if (/Edge.(\d+\.\d+)/i.test(ua)) {
//Edge 15 introduced a bug that causes onprogress events to not get fired, we have to use the "small chunks" workaround that reduces accuracy
settings.forceIE11Workaround = true;
}
if (/PlayStation 4.(\d+\.\d+)/i.test(ua)) {
//PS4 browser has the same bug as IE11/Edge
settings.forceIE11Workaround = true;
}
if (/Chrome.(\d+)/i.test(ua) && /Android|iPhone|iPad|iPod|Windows Phone/i.test(ua)) {
//cheap af
//Chrome mobile introduced a limitation somewhere around version 65, we have to limit XHR upload size to 4 megabytes
settings.xhr_ul_blob_megabytes = 4;
}
if (/^((?!chrome|android|crios|fxios).)*safari/i.test(ua)) {
//Safari also needs the IE11 workaround but only for the MPOT version
settings.forceIE11Workaround = true;
}
//telemetry_level has to be parsed and not just copied
if (typeof s.telemetry_level !== "undefined") settings.telemetry_level = s.telemetry_level === "basic" ? 1 : s.telemetry_level === "full" ? 2 : s.telemetry_level === "debug" ? 3 : 0; // telemetry level
//transform test_order to uppercase, just in case
settings.test_order = settings.test_order.toUpperCase();
} catch (e) {
twarn("Possible error in custom test settings. Some settings might not have been applied. Exception: " + e);
}
// run the tests
tverb(JSON.stringify(settings));
test_pointer = 0;
var iRun = false,
dRun = false,
uRun = false,
pRun = false;
rRun = false;
sRun = false;
var runNextTest = function() {
if (testState == ABORT_STATE) return;
if (test_pointer >= settings.test_order.length) {
//test is finished
if (settings.telemetry_level > 0)
sendTelemetry(function(id) {
testState = FINISHED_STATE;
if (id != null) testId = id;
});
else {testState = FINISHED_STATE;}
return;
}
switch (settings.test_order.charAt(test_pointer)) {
case "I":
{
test_pointer++;
if (iRun) {
runNextTest();
return;
} else iRun = true;
getIp(runNextTest);
}
break;
case "D":
{
test_pointer++;
if (dRun) {
runNextTest();
return;
} else dRun = true;
testState = DOWNLOAD_TEST_STATE;
dlTest(runNextTest);
}
break;
case "U":
{
test_pointer++;
if (uRun) {
runNextTest();
return;
} else uRun = true;
testState = UPLOAD_TEST_STATE;
ulTest(runNextTest);
}
break;
case "P":
{
test_pointer++;
if (pRun) {
runNextTest();
return;
} else pRun = true;
testState = PING_JITTER_TEST_STATE;
pingTest(runNextTest);
}
break;
case "R":
{
test_pointer++;
if (rRun) {
runNextTest();
return;
} else rRun = true;
testState = RPM_UPLOAD_TEST_STATE;
rpmUlTest(runNextTest);
}
break;
case "S":
{
test_pointer++;
if (sRun) {
runNextTest();
return;
} else sRun = true;
testState = RPM_DOWNLOAD_TEST_STATE;
rpmDlTest(runNextTest)
}
break;
case "_":
{
test_pointer++;
setTimeout(runNextTest, 1000);
}
break;
default:
test_pointer++;
}
};
runNextTest();
}
if (params[0] === "abort") {
// abort command
if (testState >= FINISHED_STATE) return;
tlog("manually aborted");
clearRequests(); // stop all xhr activity
runNextTest = null;
if (interval) clearInterval(interval); // clear timer if present
if (settings.telemetry_level > 1) sendTelemetry(function() {});
testState = ABORT_STATE; //set test as aborted
dlStatus = "";
ulStatus = "";
pingStatus = "";
jitterStatus = "";
clientIp = "";
dlProgress = 0;
ulProgress = 0;
pingProgress = 0;
rpmUlProgress = 0;
rpmDlProgress = 0;
}
});
// stops all XHR activity, aggressively
function clearRequests() {
tverb("stopping pending XHRs");
if (xhr) {
for (var i = 0; i < xhr.length; i++) {
try {
xhr[i].onprogress = null;
xhr[i].onload = null;
xhr[i].onerror = null;
} catch (e) {}
try {
xhr[i].upload.onprogress = null;
xhr[i].upload.onload = null;
xhr[i].upload.onerror = null;
} catch (e) {}
try {
xhr[i].abort();
} catch (e) {}
try {
delete xhr[i];
} catch (e) {}
}
xhr = null;
}
}
// gets client's IP using url_getIp, then calls the done function
var ipCalled = false; // used to prevent multiple accidental calls to getIp
var ispInfo = ""; //used for telemetry
function getIp(done) {
tverb("getIp");
if (ipCalled) return;
else ipCalled = true; // getIp already called?
var startT = new Date().getTime();
xhr = new XMLHttpRequest();
xhr.onload = function() {
tlog("IP: " + xhr.responseText + ", took " + (new Date().getTime() - startT) + "ms");
try {
var data = JSON.parse(xhr.responseText);
clientIp = data.processedString;
ispInfo = data.rawIspInfo;
} catch (e) {
clientIp = xhr.responseText;
ispInfo = "";
}
done();
};
xhr.onerror = function() {
tlog("getIp failed, took " + (new Date().getTime() - startT) + "ms");
done();
};
xhr.open("GET", settings.url_getIp + url_sep(settings.url_getIp) + (settings.mpot ? "cors=true&" : "") + (settings.getIp_ispInfo ? "isp=true" + (settings.getIp_ispInfo_distance ? "&distance=" + settings.getIp_ispInfo_distance + "&" : "&") : "&") + "r=" + Math.random(), true);
xhr.send();
}
// download test, calls done function when it's over
var dlCalled = false; // used to prevent multiple accidental calls to dlTest
function dlTest(done) {
tverb("dlTest");
if (dlCalled) return;
else dlCalled = true; // dlTest already called?
var totLoaded = 0.0, // total number of loaded bytes
startT = new Date().getTime(), // timestamp when test was started
bonusT = 0, //how many milliseconds the test has been shortened by (higher on faster connections)
graceTimeDone = false, //set to true after the grace time is past
failed = false; // set to true if a stream fails
xhr = [];
// function to create a download stream. streams are slightly delayed so that they will not end at the same time
var testStream = function(i, delay) {
setTimeout(
function() {
if (testState !== DOWNLOAD_TEST_STATE) return; // delayed stream ended up starting after the end of the download test
tverb("dl test stream started " + i + " " + delay);
var prevLoaded = 0; // number of bytes loaded last time onprogress was called
var x = new XMLHttpRequest();
xhr[i] = x;
xhr[i].onprogress = function(event) {
tverb("dl stream progress event " + i + " " + event.loaded);
if (testState !== DOWNLOAD_TEST_STATE) {
try {
x.abort();
} catch (e) {}
} // just in case this XHR is still running after the download test
// progress event, add number of new loaded bytes to totLoaded
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevLoaded;
if (isNaN(loadDiff) || !isFinite(loadDiff) || loadDiff < 0) return; // just in case
totLoaded += loadDiff;
prevLoaded = event.loaded;
}.bind(this);
xhr[i].onload = function() {
// the large file has been loaded entirely, start again
tverb("dl stream finished " + i);
try {
xhr[i].abort();
} catch (e) {} // reset the stream data to empty ram
testStream(i, 0);
}.bind(this);
xhr[i].onerror = function() {
// error
tverb("dl stream failed " + i);
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
try {
xhr[i].abort();
} catch (e) {}
delete xhr[i];
if (settings.xhr_ignoreErrors === 1) testStream(i, 0); //restart stream
}.bind(this);
// send xhr
try {
if (settings.xhr_dlUseBlob) xhr[i].responseType = "blob";
else xhr[i].responseType = "arraybuffer";
} catch (e) {}
xhr[i].open("GET", settings.url_dl + url_sep(settings.url_dl) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random() + "&ckSize=" + settings.garbagePhp_chunkSize, true); // random string to prevent caching
xhr[i].send();
}.bind(this),
1 + delay
);
}.bind(this);
// open streams
for (var i = 0; i < settings.xhr_dlMultistream; i++) {
testStream(i, settings.xhr_multistreamDelay * i);
}
// every 200ms, update dlStatus
interval = setInterval(
function() {
tverb("DL: " + dlStatus + (graceTimeDone ? "" : " (in grace time)"));
var t = new Date().getTime() - startT;
if (graceTimeDone) dlProgress = (t + bonusT) / (settings.time_dl_max * 1000);
if (t < 200) return;
if (!graceTimeDone) {
if (t > 1000 * settings.time_dlGraceTime) {
if (totLoaded > 0) {
// if the connection is so slow that we didn't get a single chunk yet, do not reset
startT = new Date().getTime();
bonusT = 0;
totLoaded = 0.0;
}
graceTimeDone = true;
}
} else {
var speed = totLoaded / (t / 1000.0);
if (settings.time_auto) {
//decide how much to shorten the test. Every 200ms, the test is shortened by the bonusT calculated here
var bonus = (5.0 * speed) / 100000;
bonusT += bonus > 400 ? 400 : bonus;
}
//update status
dlStatus = ((speed * 8 * settings.overheadCompensationFactor) / (settings.useMebibits ? 1048576 : 1000000)).toFixed(2); // speed is multiplied by 8 to go from bytes to bits, overhead compensation is applied, then everything is divided by 1048576 or 1000000 to go to megabits/mebibits
if ((t + bonusT) / 1000.0 > settings.time_dl_max || failed) {
// test is over, stop streams and timer
if (failed || isNaN(dlStatus)) dlStatus = "Fail";
clearRequests();
clearInterval(interval);
dlProgress = 1;
tlog("dlTest: " + dlStatus + ", took " + (new Date().getTime() - startT) + "ms");
done();
}
}
}.bind(this),
200
);
}
// upload test, calls done function whent it's over
var ulCalled = false; // used to prevent multiple accidental calls to ulTest
function ulTest(done) {
tverb("ulTest");
if (ulCalled) return;
else ulCalled = true; // ulTest already called?
// garbage data for upload test
var r = new ArrayBuffer(1048576);
var maxInt = Math.pow(2, 32) - 1;
try {
r = new Uint32Array(r);
for (var i = 0; i < r.length; i++) r[i] = Math.random() * maxInt;
} catch (e) {}
var req = [];
var reqsmall = [];
for (var i = 0; i < settings.xhr_ul_blob_megabytes; i++) req.push(r);
req = new Blob(req);
r = new ArrayBuffer(262144);
try {
r = new Uint32Array(r);
for (var i = 0; i < r.length; i++) r[i] = Math.random() * maxInt;
} catch (e) {}
reqsmall.push(r);
reqsmall = new Blob(reqsmall);
var testFunction = function() {
var totLoaded = 0.0, // total number of transmitted bytes
startT = new Date().getTime(), // timestamp when test was started
bonusT = 0, //how many milliseconds the test has been shortened by (higher on faster connections)
graceTimeDone = false, //set to true after the grace time is past
failed = false; // set to true if a stream fails
xhr = [];
// function to create an upload stream. streams are slightly delayed so that they will not end at the same time
var testStream = function(i, delay) {
setTimeout(
function() {
if (testState !== UPLOAD_TEST_STATE) return; // delayed stream ended up starting after the end of the upload test
tverb("ul test stream started " + i + " " + delay);
var prevLoaded = 0; // number of bytes transmitted last time onprogress was called
var x = new XMLHttpRequest();
xhr[i] = x;
var ie11workaround;
if (settings.forceIE11Workaround) ie11workaround = true;
else {
try {
xhr[i].upload.onprogress;
ie11workaround = false;
} catch (e) {
ie11workaround = true;
}
}
if (ie11workaround) {
// IE11 workarond: xhr.upload does not work properly, therefore we send a bunch of small 256k requests and use the onload event as progress. This is not precise, especially on fast connections
xhr[i].onload = xhr[i].onerror = function() {
tverb("ul stream progress event (ie11wa)");
totLoaded += reqsmall.size;
testStream(i, 0);
};
xhr[i].open("POST", settings.url_ul + url_sep(settings.url_ul) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
try {
xhr[i].setRequestHeader("Content-Encoding", "identity"); // disable compression (some browsers may refuse it, but data is incompressible anyway)
} catch (e) {}
//No Content-Type header in MPOT branch because it triggers bugs in some browsers
xhr[i].send(reqsmall);
} else {
// REGULAR version, no workaround
xhr[i].upload.onprogress = function(event) {
tverb("ul stream progress event " + i + " " + event.loaded);
if (testState !== UPLOAD_TEST_STATE) {
try {
x.abort();
} catch (e) {}
} // just in case this XHR is still running after the upload test
// progress event, add number of new loaded bytes to totLoaded
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevLoaded;
if (isNaN(loadDiff) || !isFinite(loadDiff) || loadDiff < 0) return; // just in case
totLoaded += loadDiff;
prevLoaded = event.loaded;
}.bind(this);
xhr[i].upload.onload = function() {
// this stream sent all the garbage data, start again
tverb("ul stream finished " + i);
testStream(i, 0);
}.bind(this);
xhr[i].upload.onerror = function() {
tverb("ul stream failed " + i);
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
try {
xhr[i].abort();
} catch (e) {}
delete xhr[i];
if (settings.xhr_ignoreErrors === 1) testStream(i, 0); //restart stream
}.bind(this);
// send xhr
xhr[i].open("POST", settings.url_ul + url_sep(settings.url_ul) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
try {
xhr[i].setRequestHeader("Content-Encoding", "identity"); // disable compression (some browsers may refuse it, but data is incompressible anyway)
} catch (e) {}
//No Content-Type header in MPOT branch because it triggers bugs in some browsers
xhr[i].send(req);
}
}.bind(this),
delay
);
}.bind(this);
// open streams
for (var i = 0; i < settings.xhr_ulMultistream; i++) {
testStream(i, settings.xhr_multistreamDelay * i);
}
// every 200ms, update ulStatus
interval = setInterval(
function() {
tverb("UL: " + ulStatus + (graceTimeDone ? "" : " (in grace time)"));
var t = new Date().getTime() - startT;
if (graceTimeDone) ulProgress = (t + bonusT) / (settings.time_ul_max * 1000);
if (t < 200) return;
if (!graceTimeDone) {
if (t > 1000 * settings.time_ulGraceTime) {
if (totLoaded > 0) {
// if the connection is so slow that we didn't get a single chunk yet, do not reset
startT = new Date().getTime();
bonusT = 0;
totLoaded = 0.0;
}
graceTimeDone = true;
}
} else {
var speed = totLoaded / (t / 1000.0);
if (settings.time_auto) {
//decide how much to shorten the test. Every 200ms, the test is shortened by the bonusT calculated here
var bonus = (5.0 * speed) / 100000;
bonusT += bonus > 400 ? 400 : bonus;
}
//update status
ulStatus = ((speed * 8 * settings.overheadCompensationFactor) / (settings.useMebibits ? 1048576 : 1000000)).toFixed(2); // speed is multiplied by 8 to go from bytes to bits, overhead compensation is applied, then everything is divided by 1048576 or 1000000 to go to megabits/mebibits
if ((t + bonusT) / 1000.0 > settings.time_ul_max || failed) {
// test is over, stop streams and timer
if (failed || isNaN(ulStatus)) ulStatus = "Fail";
clearRequests();
clearInterval(interval);
ulProgress = 1;
tlog("ulTest: " + ulStatus + ", took " + (new Date().getTime() - startT) + "ms");
done();
}
}
}.bind(this),
200
);
}.bind(this);
if (settings.mpot) {
tverb("Sending POST request before performing upload test");
xhr = [];
xhr[0] = new XMLHttpRequest();
xhr[0].onload = xhr[0].onerror = function() {
tverb("POST request sent, starting upload test");
testFunction();
}.bind(this);
xhr[0].open("POST", settings.url_ul);
xhr[0].send();
} else testFunction();
}
// ping+jitter test, function done is called when it's over
var ptCalled = false; // used to prevent multiple accidental calls to pingTest
function pingTest(done) {
tverb("pingTest");
if (ptCalled) return;
else ptCalled = true; // pingTest already called?
var startT = new Date().getTime(); //when the test was started
var prevT = null; // last time a pong was received
var ping = 0.0; // current ping value
var jitter = 0.0; // current jitter value
var i = 0; // counter of pongs received
var prevInstspd = 0; // last ping time, used for jitter calculation
xhr = [];
// ping function
var doPing = function() {
tverb("ping");
pingProgress = i / settings.count_ping;
prevT = new Date().getTime();
xhr[0] = new XMLHttpRequest();
xhr[0].onload = function() {
// pong
tverb("pong");
if (i === 0) {
prevT = new Date().getTime(); // first pong
} else {
var instspd = new Date().getTime() - prevT;
if (settings.ping_allowPerformanceApi) {
try {
//try to get accurate performance timing using performance api
var p = performance.getEntries();
p = p[p.length - 1];
var d = p.responseStart - p.requestStart;
if (d <= 0) d = p.duration;
if (d > 0 && d < instspd) instspd = d;
} catch (e) {
//if not possible, keep the estimate
tverb("Performance API not supported, using estimate");
}
}
//noticed that some browsers randomly have 0ms ping
if (instspd < 1) instspd = prevInstspd;
if (instspd < 1) instspd = 1;
var instjitter = Math.abs(instspd - prevInstspd);
if (i === 1) ping = instspd;
/* first ping, can't tell jitter yet*/ else {
if (instspd < ping) ping = instspd; // update ping, if the instant ping is lower
if (i === 2) jitter = instjitter;
//discard the first jitter measurement because it might be much higher than it should be
else jitter = instjitter > jitter ? jitter * 0.3 + instjitter * 0.7 : jitter * 0.8 + instjitter * 0.2; // update jitter, weighted average. spikes in ping values are given more weight.
}
prevInstspd = instspd;
}
pingStatus = ping.toFixed(2);
jitterStatus = jitter.toFixed(2);
i++;
tverb("ping: " + pingStatus + " jitter: " + jitterStatus);
if (i < settings.count_ping) doPing();
else {
// more pings to do?
pingProgress = 1;
tlog("ping: " + pingStatus + " jitter: " + jitterStatus + ", took " + (new Date().getTime() - startT) + "ms");
done();
}
}.bind(this);
xhr[0].onerror = function() {
// a ping failed, cancel test
tverb("ping failed");
if (settings.xhr_ignoreErrors === 0) {
//abort
pingStatus = "Fail";
jitterStatus = "Fail";
clearRequests();
tlog("ping test failed, took " + (new Date().getTime() - startT) + "ms");
pingProgress = 1;
done();
}
if (settings.xhr_ignoreErrors === 1) doPing(); //retry ping
if (settings.xhr_ignoreErrors === 2) {
//ignore failed ping
i++;
if (i < settings.count_ping) doPing();
else {
// more pings to do?
pingProgress = 1;
tlog("ping: " + pingStatus + " jitter: " + jitterStatus + ", took " + (new Date().getTime() - startT) + "ms");
done();
}
}
}.bind(this);
// send xhr
xhr[0].open("GET", settings.url_ping + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
xhr[0].send();
}.bind(this);
doPing(); // start first ping
}
// RPM function
function rpm(way, createLoadGeneratingConnexions, doPing, done, updateTotalLoaded, updateIsFailed) {
let pings = []
let totLoaded = updateTotalLoaded();
let failed = updateIsFailed();
var currentConnexionsNumber = 0;
let i = 0;
let rpm = 0;
// data transfered at interval i
let checkpoints = [];
let checkpointTimes = []
let instantGoodputs = []
let movigAvgGoodputs = []
let responsivenesses = []
let loadGenerationAdded = []
function instantaneousAgreegateGoodput(i) {
return Math.max((checkpoints[i] - checkpoints[i - 1]) / ((checkpointTimes[i] - checkpointTimes[i - 1]) / 1000), 0);
}
// Util functions for the loop
function hasGoodputSaturate() {
let MADinstantGoodputs = instantGoodputs.slice(-settings.rpm.MAD);
const n = MADinstantGoodputs.length;
const mean = MADinstantGoodputs.reduce((acc, val) => acc + val, 0) / n;
const stdDev = Math.sqrt(MADinstantGoodputs.reduce((acc, val) => acc + (val - mean) ** 2, 0) / n);
const stdDevPercentage = (stdDev / mean) * 100;
return stdDevPercentage <= settings.rpm.SDT;
}
function getStdDev(list) {
list = list.slice(-settings.rpm.MAD);
const n = list.length;
const mean = list.reduce((acc, val) => acc + val, 0) / n;
const stdDev = Math.sqrt(list.reduce((acc, val) => acc + (val - mean) ** 2, 0) / n);
return stdDev;
}
function movingAverageAgreegateGoodput(i) {
let nPrev = Math.min(settings.rpm.MAD, i); // if i < 4
let totalData = checkpoints[i] - checkpoints[i - nPrev];
let totalTime = (checkpointTimes[i] - checkpointTimes[i - nPrev]) / 1000;
return totalData / totalTime;
}
const startTime = new Date().getTime();
let onLoadedConnection = true;
// Pings
let pingInterval = setInterval(function() {
doPing((ping) => {
if ((testState !== RPM_DOWNLOAD_TEST_STATE && way === "download") || (testState !== RPM_UPLOAD_TEST_STATE && way === "upload")) {return}
pings.push(ping);
}, onLoadedConnection);
onLoadedConnection = !onLoadedConnection
}.bind(this), Math.round(1000/settings.rpm.MPS))
// Init connections
createLoadGeneratingConnexions(currentConnexionsNumber);
currentConnexionsNumber++;
loadGenerationAdded[i] = currentConnexionsNumber;
checkpoints[0] = 0
checkpointTimes[0] = 0;
i = 1
let interval = setInterval(function () {
if ((testState !== RPM_DOWNLOAD_TEST_STATE && way === "download") || (testState !== RPM_UPLOAD_TEST_STATE && way === "upload")) {
// test change
clearRequests();
clearInterval(pingInterval)
clearInterval(interval)
}
totLoaded = updateTotalLoaded();
// elapsedTime in ms
let elapsedTime = new Date().getTime() - startTime;
if (i > settings.rpm.MaxTime) {
// Timeout ending
tlog(`Rpm ${way} timeout end`);
let status = failed ? "failed" : rpm;
clearInterval(pingInterval)
clearInterval(interval)
clearRequests();
rpmDlProgress = 1;
tlog("rpmTest: " + status + ", took " + (elapsedTime) + "ms");
done();
} else {
// Updates
checkpoints[i] = totLoaded;
checkpointTimes[i] = elapsedTime;
instantGoodputs[i] = instantaneousAgreegateGoodput(i);
movigAvgGoodputs[i] = movingAverageAgreegateGoodput(i);
// Compute trimmed mean for responsiveness
let sortedValues = pings.sort();
let trimCount = Math.floor(sortedValues.length * ((1 - settings.rpm.TMP) / 2));
let trimmedValues = sortedValues.slice(trimCount, sortedValues.length - trimCount);
if (trimmedValues.length > 0) {
let mean = trimmedValues.reduce((a, v) => a + v, 0) / trimmedValues.length
rpm = 60_000 / mean;
// Update results
let pingAsRPM = parseFloat(pingStatus);
let ratioRPM = "";
if (pingAsRPM) {
pingAsRPM = Math.round(60_000 / pingAsRPM);
ratioRPM = pingAsRPM / rpm;
ratioRPM = ratioRPM.toFixed(2);
};
if (way === "upload") {
rpmUlStatus = rpm.toFixed(0);
rpmUlRatioStatus = ratioRPM;
rpmUlProgress = 1;
} else if (way === "download") {
rpmDlStatus = rpm.toFixed(0);
rpmDlRatioStatus = ratioRPM;
rpmDlProgress = 1;
}
}
responsivenesses[i] = rpm;
let bandwidth = ((movingAverageAgreegateGoodput(i) * 8 * settings.overheadCompensationFactor) / (settings.useMebibits ? 1048576 : 1000000)).toFixed(2); // speed is multiplied by 8 to go from bytes to bits, overhead compensation is applied, then everything is divided by 1048576 or 1000000 to go to megabits/mebibits
if (way == "download") {
dlStatus = bandwidth;
} else if (way == "upload") {
ulStatus = bandwidth;
}
// Following pseudo code
// Create an additional load-generating connection
if (currentConnexionsNumber < settings.rpm.MNP) {
createLoadGeneratingConnexions(currentConnexionsNumber);
currentConnexionsNumber++;
loadGenerationAdded[i] = currentConnexionsNumber;
}
// Check if goodput has saturated
let currentAvg = movigAvgGoodputs[i]
let stdDevAvgGoodput = getStdDev(movigAvgGoodputs)
if (hasGoodputSaturate() || (stdDevAvgGoodput < settings.rpm.SDT * currentAvg)) {
// Goodput has staturated
let currentResponsiveness = responsivenesses[i];
if (getStdDev(responsivenesses) < settings.rpm.SDT * currentResponsiveness) {
tlog(`Rpm ${way} gracefull end`);
let status = failed ? "failed" : rpm;
clearInterval(pingInterval)
clearInterval(interval)
clearRequests();
if (way === "upload") {
rpmUlStatus = currentResponsiveness.toFixed(0);
rpmUlProgress = 1;
} else if (way === "download") {
rpmDlStatus = currentResponsiveness.toFixed(0);
rpmDlProgress = 1;
}
rpmDlProgress = 1;
tlog("rpmTest: " + status + ", took " + (elapsedTime) + "ms");
done();
}
}
}
tlog(`RPM ${way} round ${i}, ${movingAverageAgreegateGoodput(i) * 8}bps, ${rpm} RPM`)
i++;
}.bind(this), settings.rpm.ID*1000)
}
// RPM Upload test
var rpmUlCalled = false;
function rpmUlTest(done) {
tverb("rpmUlTest");
if (rpmUlCalled) return;
else rpmUlCalled = true;
xhr = [];
// Buffer for upload tasks
var r = new ArrayBuffer(1048576);
var maxInt = Math.pow(2, 32) - 1;
try {
r = new Uint32Array(r);
for (var i = 0; i < r.length; i++) r[i] = Math.random() * maxInt;
} catch (e) { }
var req = [];
var reqsmall = [];
for (var i = 0; i < settings.xhr_ul_blob_megabytes; i++) req.push(r);
req = new Blob(req);
r = new ArrayBuffer(262144);
try {
r = new Uint32Array(r);
for (var i = 0; i < r.length; i++) r[i] = Math.random() * maxInt;
} catch (e) { }
reqsmall.push(r);
reqsmall = new Blob(reqsmall);
var testFunction = function() {
var totLoaded = 0;
var failed = false; // set to true if a stream fails
createLoadGeneratingConnexions = function(i) {
if (testState !== RPM_UPLOAD_TEST_STATE || xhr === null) { return }
i += 2; // xhr[0 and 1] for pings
var prevUlLoaded = 0;
var ul = new XMLHttpRequest();
xhr[i] = ul;
var ie11workaround = false;
if (settings.forceIE11Workaround) ie11workaround = true;
else {
try {
xhr[i].upload.onprogress;
ie11workaround = false;
} catch (e) {
ie11workaround = true;
}
}
if (ie11workaround) {
// IE11 workarond: xhr.upload does not work properly, therefore we send a bunch of small 256k requests and use the onload event as progress. This is not precise, especially on fast connections
xhr[i].onload = xhr[i].onerror = function () {
tverb("RPM ul stream progress event (ie11wa)");
totLoaded += reqsmall.size;
createLoadGeneratingConnexions(i, {download : false});
};
xhr[i].open("POST", settings.url_ul + url_sep(settings.url_ul) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
try {
xhr[i].setRequestHeader("Content-Encoding", "identity"); // disable compression (some browsers may refuse it, but data is incompressible anyway)
} catch (e) { }
//No Content-Type header in MPOT branch because it triggers bugs in some browsers
xhr[i].send(reqsmall);
} else {
// REGULAR version, no workaround
xhr[i].upload.onprogress = function (event) {
tverb("RPM ul stream progress event " + (i) + " " + event.loaded);
if (testState !== RPM_UPLOAD_TEST_STATE) {
try {
xhr[i].abort();
} catch (e) { }
} // just in case this XHR is still running after the upload test
// progress event, add number of new loaded bytes to totLoaded
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevUlLoaded;
if (isNaN(loadDiff) || !isFinite(loadDiff) || loadDiff < 0) return; // just in case
totLoaded += loadDiff;
prevUlLoaded = event.loaded;
}.bind(this);
xhr[i].upload.onload = function () {
// this stream sent all the garbage data, start again
tverb("RPM ul stream finished " + (i));
createLoadGeneratingConnexions(i);
}.bind(this);
xhr[i].upload.onerror = function () {
tverb("RPM ul stream failed " + (i));
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
try {
xhr[i].abort();
} catch (e) { }
delete xhr[i];
if (settings.xhr_ignoreErrors === 1) createLoadGeneratingConnexions(i); //restart stream
}.bind(this);
if (settings.useWildcard) {
// WILDCARD
xhr[i].open("POST", useWildcard(settings.url_ul, `con${i}`) + url_sep(settings.url_ul) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
} else {
xhr[i].open("POST", settings.url_ul + url_sep(settings.url_ul) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
}
try {
xhr[i].setRequestHeader("Content-Encoding", "identity"); // disable compression (some browsers may refuse it, but data is incompressible anyway)
} catch (e) { }
//No Content-Type header in MPOT branch because it triggers bugs in some browsers
xhr[i].send(req);
}
}.bind(this)
var doPing = function (callback, onLoadedConnection) {
if (testState !== RPM_UPLOAD_TEST_STATE) {
return
}
tverb("RPM dl ping");
let idx = onLoadedConnection ? 1 : 0;
let prevT = new Date().getTime();
xhr[idx] = new XMLHttpRequest();
xhr[idx].onload = function () {
// pong
var instspd = new Date().getTime() - prevT;
if (settings.ping_allowPerformanceApi) {
try {
//try to get accurate performance timing using performance api
var p = performance.getEntries();
p = p[p.length - 1];
var d = p.responseStart - p.requestStart;
if (d <= 0) d = p.duration;
if (d > 0 && d < instspd) instspd = d;
} catch (e) {
//if not possible, keep the estimate
tverb("Performance API not supported, using estimate");
}
}
callback(instspd)
}.bind(this);
xhr[idx].onerror = function () {
// a ping failed, cancel test
tverb("RPM dl ping failed");
callback(undefined)
}.bind(this);
// send xhr
if (settings.useWildcard) {
// WILDCARD
if (onLoadedConnection) {
xhr[idx].open("POST", useWildcard(settings.url_ping, "con2") + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
} else {
xhr[idx].open("POST", useWildcard(settings.url_ping, `ping${Math.floor(Math.random() * 1000)}`) + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
}
} else {
xhr[idx].open("POST", settings.url_ping + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
}
xhr[idx].send();
}.bind(this);
rpm(
"upload",
createLoadGeneratingConnexions,
doPing,
done,
() => { return totLoaded },
() => { return failed }
)
}.bind(this);
testFunction();
}
// RPM Download test
var rpmDlCalled = false;
function rpmDlTest(done) {
tverb("rpmDlTest");
if (rpmDlCalled) return;
else rpmDlCalled = true;
xhr = [];
var testFunction = function () {
var totLoaded = 0;
var failed = false; // set to true if a stream fails
createLoadGeneratingConnexions = function (i) {
if (testState !== RPM_DOWNLOAD_TEST_STATE || xhr === null) {return}
i += 2; // xhr[0 and 1] for pings
var prevDlLoaded = 0;
var dl = new XMLHttpRequest();
xhr[i] = dl;
xhr[i].onprogress = function (event) {
tverb("RPM dl stream progress event " + i + " " + event.loaded);
if (testState !== RPM_DOWNLOAD_TEST_STATE) {
try {
dl.abort();
} catch (e) { }
} // just in case this XHR is still running after the download test
// progress event, add number of new loaded bytes to totLoaded
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevDlLoaded;
if (isNaN(loadDiff) || !isFinite(loadDiff) || loadDiff < 0) return; // just in case
totLoaded += loadDiff;
prevDlLoaded = event.loaded;
}.bind(this)
xhr[i].onload = function () {
// the large file has been loaded entirely, start again
tverb("RPM dl stream finished " + i);
try {
xhr[i].abort();
} catch (e) { } // reset the stream data to empty ram
createLoadGeneratingConnexions(i);
}.bind(this)
xhr[i].onerror = function () {
// error
tverb("RPM dl stream failed " + i);
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
try {
xhr[i].abort();
} catch (e) { }
delete xhr[i];
if (settings.xhr_ignoreErrors === 1) createLoadGeneratingConnexions(i, 0); //restart stream
}.bind(this)
// LAUNCH STREAMS
try {
if (settings.xhr_dlUseBlob) xhr[i].responseType = "blob";
else xhr[i].responseType = "arraybuffer";
} catch (e) { }
if (settings.useWildcard) {
// Wildcard
xhr[i].open("GET", useWildcard(settings.url_dl, `con${i}`) + url_sep(settings.url_dl) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random() + "&ckSize=" + settings.garbagePhp_chunkSize, true); // random string to prevent caching
} else {
xhr[i].open("GET", settings.url_dl + url_sep(settings.url_dl) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random() + "&ckSize=" + settings.garbagePhp_chunkSize, true); // random string to prevent caching
}
xhr[i].send();
}.bind(this)
var doPing = function (callback, onLoadedConnection) {
if (testState !== RPM_DOWNLOAD_TEST_STATE) {
return
}
tverb("RPM ul ping");
let idx = onLoadedConnection ? 1 : 0;
let prevT = new Date().getTime();
xhr[idx] = new XMLHttpRequest();
xhr[idx].onload = function () {
// pong
var instspd = new Date().getTime() - prevT;
if (settings.ping_allowPerformanceApi) {
try {
//try to get accurate performance timing using performance api
var p = performance.getEntries();
p = p[p.length - 1];
var d = p.responseStart - p.requestStart;
if (d <= 0) d = p.duration;
if (d > 0 && d < instspd) instspd = d;
} catch (e) {
//if not possible, keep the estimate
tverb("Performance API not supported, using estimate");
}
}
callback(instspd)
}.bind(this);
xhr[idx].onerror = function () {
// a ping failed, cancel test
tverb("RPM ul ping failed");
callback(undefined)
}.bind(this);
// send xhr
if (settings.useWildcard) {
// WILDCARD
if (onLoadedConnection) {
xhr[idx].open("GET", useWildcard(settings.url_ping , "con2") + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
} else {
xhr[idx].open("GET", useWildcard(settings.url_ping, `ping${Math.floor(Math.random() * 1000)}`) + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
}
} else {
xhr[idx].open("GET", settings.url_ping + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
}
xhr[idx].send();
}.bind(this);
rpm(
"download",
createLoadGeneratingConnexions,
doPing,
done,
() => { return totLoaded },
() => { return failed}
)
}.bind(this);
testFunction();
}
// telemetry
function sendTelemetry(done) {
if (settings.telemetry_level < 1) return;
xhr = new XMLHttpRequest();
xhr.onload = function() {
try {
var parts = xhr.responseText.split(" ");
if (parts[0] == "id") {
try {
var id = parts[1];
done(id);
} catch (e) {
done(null);
}
} else done(null);
} catch (e) {
done(null);
}
};
xhr.onerror = function() {
console.log("TELEMETRY ERROR " + xhr.status);
done(null);
};
xhr.open("POST", settings.url_telemetry + url_sep(settings.url_telemetry) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true);
var telemetryIspInfo = {
processedString: clientIp,
rawIspInfo: typeof ispInfo === "object" ? ispInfo : ""
};
try {
var fd = new FormData();
fd.append("ispinfo", JSON.stringify(telemetryIspInfo));
fd.append("dl", dlStatus);
fd.append("ul", ulStatus);
fd.append("ping", pingStatus);
fd.append("jitter", jitterStatus);
fd.append("log", settings.telemetry_level > 1 ? log : "");
fd.append("extra", settings.telemetry_extra);
xhr.send(fd);
} catch (ex) {
var postData = "extra=" + encodeURIComponent(settings.telemetry_extra) + "&ispinfo=" + encodeURIComponent(JSON.stringify(telemetryIspInfo)) + "&dl=" + encodeURIComponent(dlStatus) + "&ul=" + encodeURIComponent(ulStatus) + "&ping=" + encodeURIComponent(pingStatus) + "&jitter=" + encodeURIComponent(jitterStatus) + "&log=" + encodeURIComponent(settings.telemetry_level > 1 ? log : "");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.send(postData);
}
}
Reference in a new issue View git blame Copy permalink