beenull/speedtest
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Convert speedtest.js, speedtest_worker.js to ES6

Browse source
This commit is contained in:
SCG82 2020-09-18 14:33:45 -07:00
parent 5cef820749
commit de7011b7b4
2 changed files with 635 additions and 574 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

531
speedtest.js
View file

@ -1,228 +1,279 @@
/*
LibreSpeed - Main
by Federico Dossena
https://github.com/librespeed/speedtest/
GNU LGPLv3 License
*/
/*
This is the main interface between your webpage and the speedtest.
It hides the speedtest web worker to the page, and provides many convenient functions to control the test.
The best way to learn how to use this is to look at the basic example, but here's some documentation.
To initialize the test, create a new Speedtest object:
var s=new Speedtest();
Now you can think of this as a finite state machine. These are the states (use getState() to see them):
- 0: here you can change the speedtest settings (such as test duration) with the setParameter("parameter",value) method. From here you can either start the test using start() (goes to state 3) or you can add multiple test points using addTestPoint(server) or addTestPoints(serverList) (goes to state 1). Additionally, this is the perfect moment to set up callbacks for the onupdate(data) and onend(aborted) events.
- 1: here you can add test points. You only need to do this if you want to use multiple test points.
A server is defined as an object like this:
{
name: "User friendly name",
server:"http://yourBackend.com/", <---- URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
dlURL:"garbage.php" <----- path to garbage.php or its replacement on the server
ulURL:"empty.php" <----- path to empty.php or its replacement on the server
pingURL:"empty.php" <----- path to empty.php or its replacement on the server. This is used to ping the server by this selector
getIpURL:"getIP.php" <----- path to getIP.php or its replacement on the server
}
While in state 1, you can only add test points, you cannot change the test settings. When you're done, use selectServer(callback) to select the test point with the lowest ping. This is asynchronous, when it's done, it will call your callback function and move to state 2. Calling setSelectedServer(server) will manually select a server and move to state 2.
- 2: test point selected, ready to start the test. Use start() to begin, this will move to state 3
- 3: test running. Here, your onupdate event calback will be called periodically, with data coming from the worker about speed and progress. A data object will be passed to your onupdate function, with the following items:
- dlStatus: download speed in mbps
- ulStatus: upload speed in mbps
- pingStatus: ping in ms
- jitterStatus: jitter in ms
- dlProgress: progress of the download test as a float 0-1
- ulProgress: progress of the upload test as a float 0-1
- pingProgress: progress of the ping/jitter test as a float 0-1
- testState: state of the test (-1=not started, 0=starting, 1=download test, 2=ping+jitter test, 3=upload test, 4=finished, 5=aborted)
- clientIp: IP address of the client performing the test (and optionally ISP and distance)
At the end of the test, the onend function will be called, with a boolean specifying whether the test was aborted or if it ended normally.
The test can be aborted at any time with abort().
At the end of the test, it will move to state 4
- 4: test finished. You can run it again by calling start() if you want.
/**
* @file LibreSpeed - Main
* @author Federico Dossena
* @license LGPL-3.0-only
* https://github.com/librespeed/speedtest/
*/
function Speedtest() {
/**
* This is the main interface between your webpage and the speedtest.
* It hides the speedtest web worker to the page, and provides many convenient functions to control the test.
*
* The best way to learn how to use this is to look at the basic example, but here's some documentation.
*
* - To initialize the test, create a new Speedtest object: `const s = new Speedtest();`.
*
* You can think of this as a finite state machine. These are the states (use getState() to see them):
* - __0__: here you can change the speedtest settings (such as test duration) with the setParameter("parameter",value)
* method. From here you can either start the test using start() (goes to state 3) or you can add multiple test
* points using addTestPoint(server) or addTestPoints(serverList) (goes to state 1). Additionally, this is the
* perfect moment to set up callbacks for the onupdate(data) and onend(aborted) events.
* - __1__: here you can add test points. You only need to do this if you want to use multiple test points.
* A server is defined as an object like this:
* ```
* {
* name: "User friendly name",
* server: "http://yourBackend.com/", // server URL. If both http & https are supported, just use // without protocol
* dlURL: "garbage.php", // path to garbage.php or its replacement on the server
* ulURL: "empty.php", // path to empty.php or its replacement on the server
* pingURL: "empty.php", // path to empty.php or its replacement on the server
* getIpURL: "getIP.php", // path to getIP.php or its replacement on the server
* }
* ```
* While in state 1, you can only add test points, you cannot change the test settings. When you're done, use
* selectServer(callback) to select the test point with the lowest ping. This is asynchronous, when it's done,
* it will call your callback function and move to state 2. Calling setSelectedServer(server) will manually
* select a server and move to state 2.
* - __2__: test point selected, ready to start the test. Use start() to begin, this will move to state 3.
* - __3__: test running. Here, your onupdate event calback will be called periodically, with data coming
* from the worker about speed and progress. A data object will be passed to your onupdate function,
* with the following items:
* ```
* {
* dlStatus: number, // download speed in mbps
* ulStatus: number, // upload speed in mbps
* pingStatus: number, // ping in ms
* jitterStatus: number, // jitter in ms
* dlProgress: number, // progress of the download test as a float 0-1
* ulProgress: number, // progress of the upload test as a float 0-1
* pingProgress: number, // progress of the ping/jitter test as a float 0-1
* testState: number, // -1: not started, 0: starting, 1: download, 2: ping+jitter, 3: upload, 4: finished, 5: aborted
* clientIp: string, // IP address of the client performing the test (and optionally ISP and distance)
* }
* ```
* At the end of the test, the onend function will be called, with a boolean specifying whether the test was
* aborted or if it ended normally. The test can be aborted at any time with abort().
* At the end of the test, it will move to state 4.
* - __4__: test finished. You can run it again by calling start() if you want.
*/
class Speedtest {
constructor() {
this._serverList = []; //when using multiple points of test, this is a list of test points
this._selectedServer = null; //when using multiple points of test, this is the selected server
this._settings = {}; //settings for the speedtest worker
this._state = 0; //0=adding settings, 1=adding servers, 2=server selection done, 3=test running, 4=done
console.log(
"LibreSpeed by Federico Dossena v5.2.1 - https://github.com/librespeed/speedtest"
);
}
this.onupdate = undefined;
this.onend = undefined;
console.log("LibreSpeed by Federico Dossena v5.2 - https://github.com/librespeed/speedtest");
}
Speedtest.prototype = {
constructor: Speedtest,
/**
* Returns the state of the test: 0=adding settings, 1=adding servers, 2=server selection done, 3=test running, 4=done
* @returns {number} 0=adding settings, 1=adding servers, 2=server selection done, 3=test running, 4=done
*/
getState: function() {
getState() {
return this._state;
},
}
/**
* Change one of the test settings from their defaults.
* - parameter: string with the name of the parameter that you want to set
* - value: new value for the parameter
*
* Invalid values or nonexistant parameters will be ignored by the speedtest worker.
* @param {string} parameter - string with the name of the parameter that you want to set
* @param value - new value for the parameter
*/
setParameter: function(parameter, value) {
if (this._state != 0)
throw "You cannot change the test settings after adding server or starting the test";
setParameter(parameter, value) {
if (this._state !== 0)
throw new Error("You cannot change the test settings after adding server or starting the test");
this._settings[parameter] = value;
if(parameter === "telemetry_extra"){
this._originalExtra=this._settings.telemetry_extra;
if (parameter === "telemetry_extra") {
this._originalExtra = this._settings.telemetry_extra;
}
},
}
/**
* Used internally to check if a server object contains all the required elements.
* Also fixes the server URL if needed.
* @param {Server} server
*/
_checkServerDefinition: function(server) {
_checkServerDefinition(server) {
try {
if (typeof server.name !== "string")
throw "Name string missing from server definition (name)";
throw new Error("Name string missing from server definition (name)");
if (typeof server.server !== "string")
throw "Server address string missing from server definition (server)";
if (server.server.charAt(server.server.length - 1) != "/")
throw new Error("Server address string missing from server definition (server)");
if (server.server.charAt(server.server.length - 1) !== "/")
server.server += "/";
if (server.server.indexOf("//") == 0)
if (server.server.indexOf("//") === 0)
server.server = location.protocol + server.server;
if (typeof server.dlURL !== "string")
throw "Download URL string missing from server definition (dlURL)";
throw new Error("Download URL string missing from server definition (dlURL)");
if (typeof server.ulURL !== "string")
throw "Upload URL string missing from server definition (ulURL)";
throw new Error("Upload URL string missing from server definition (ulURL)");
if (typeof server.pingURL !== "string")
throw "Ping URL string missing from server definition (pingURL)";
throw new Error("Ping URL string missing from server definition (pingURL)");
if (typeof server.getIpURL !== "string")
throw "GetIP URL string missing from server definition (getIpURL)";
throw new Error("GetIP URL string missing from server definition (getIpURL)");
} catch (e) {
throw "Invalid server definition";
throw new Error(`Invalid server definition: ${e.message}`);
}
},
}
/**
* Add a test point (multiple points of test)
* server: the server to be added as an object. Must contain the following elements:
* {
* name: "User friendly name",
* server:"http://yourBackend.com/", URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
* dlURL:"garbage.php" path to garbage.php or its replacement on the server
* ulURL:"empty.php" path to empty.php or its replacement on the server
* pingURL:"empty.php" path to empty.php or its replacement on the server. This is used to ping the server by this selector
* getIpURL:"getIP.php" path to getIP.php or its replacement on the server
* }
* @param {Server} server - the server to be added as an object. Must contain the following elements:
* ```
* name: "User friendly name"
* server: "http://yourBackend.com/" // server URL. If both http & https are supported, just use // without protocol
* dlURL: "garbage.php" // path to garbage.php or its replacement on the server
* ulURL: "empty.php" // path to empty.php or its replacement on the server
* pingURL: "empty.php" // path to empty.php or its replacement on the server
* getIpURL: "getIP.php" // path to getIP.php or its replacement on the server
* ```
*/
addTestPoint: function(server) {
addTestPoint(server) {
this._checkServerDefinition(server);
if (this._state == 0) this._state = 1;
if (this._state != 1) throw "You can't add a server after server selection";
if (this._state === 0) this._state = 1;
if (this._state !== 1) throw new Error("You can't add a server after server selection");
this._settings.mpot = true;
this._serverList.push(server);
},
}
/**
* Same as addTestPoint, but you can pass an array of servers
* Same as `addTestPoint`, but you can pass an array of servers
* @param {Server[]} list - array of server objects
*/
addTestPoints: function(list) {
for (var i = 0; i < list.length; i++) this.addTestPoint(list[i]);
},
addTestPoints(list) {
for (let i = 0; i < list.length; i++) {
this.addTestPoint(list[i]);
}
}
/**
* Load a JSON server list from URL (multiple points of test)
* url: the url where the server list can be fetched. Must be an array with objects containing the following elements:
* {
* "name": "User friendly name",
* "server":"http://yourBackend.com/", URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
* "dlURL":"garbage.php" path to garbage.php or its replacement on the server
* "ulURL":"empty.php" path to empty.php or its replacement on the server
* "pingURL":"empty.php" path to empty.php or its replacement on the server. This is used to ping the server by this selector
* "getIpURL":"getIP.php" path to getIP.php or its replacement on the server
* }
* result: callback to be called when the list is loaded correctly. An array with the loaded servers will be passed to this function, or null if it failed
* @param {string} url - the url where the server list can be fetched.
* Must be an array with objects containing the following elements:
* ```
* name: "User friendly name",
* server: "http://yourBackend.com/", // server URL. If both http & https are supported, just use // without protocol
* dlURL: "garbage.php", // path to garbage.php or its replacement on the server
* ulURL: "empty.php", // path to empty.php or its replacement on the server
* pingURL: "empty.php", // path to empty.php or its replacement on the server
* getIpURL: "getIP.php", // path to getIP.php or its replacement on the server
* ```
* @param {(x: Server[] | null) => void} result - callback to be called when the list is loaded correctly.
* An array with the loaded servers will be passed to this function, or null if it failed.
*/
loadServerList: function(url,result) {
if (this._state == 0) this._state = 1;
if (this._state != 1) throw "You can't add a server after server selection";
loadServerList(url, result) {
if (this._state === 0) this._state = 1;
if (this._state !== 1) throw new Error("You can't add a server after server selection");
this._settings.mpot = true;
var xhr = new XMLHttpRequest();
xhr.onload = function(){
try{
var servers=JSON.parse(xhr.responseText);
for(var i=0;i<servers.length;i++){
const xhr = new XMLHttpRequest();
xhr.onload = () => {
try {
/** @type {Server[]} */
const servers = JSON.parse(xhr.responseText);
for (let i = 0; i < servers.length; i++){
this._checkServerDefinition(servers[i]);
}
this.addTestPoints(servers);
result(servers);
}catch(e){
} catch (e) {
result(null);
}
}.bind(this);
xhr.onerror = function(){result(null);}
xhr.open("GET",url);
};
xhr.onerror = () => { result(null); };
xhr.open("GET", url);
xhr.send();
},
}
/**
* Returns the selected server (multiple points of test)
*/
getSelectedServer: function() {
if (this._state < 2 || this._selectedServer == null)
throw "No server is selected";
getSelectedServer() {
if (this._state < 2 || this._selectedServer == null) throw new Error("No server is selected");
return this._selectedServer;
},
}
/**
* @typedef {Object} Server
* @property {string} name user friendly name
* @property {string} server URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
* @property {string} dlURL path to __garbage.php__ or its replacement on the server
* @property {string} ulURL path to __empty.php__ or its replacement on the server
* @property {string} pingURL path to __empty.php__ or its replacement on the server. This is used to ping the server by this selector
* @property {string} getIpURL path to __getIP.php__ or its replacement on the server
* @property {number} pingT calculated (do not set). either the best ping we got from the server or -1 if something went wrong.
*/
/**
* Manually selects one of the test points (multiple points of test)
* @param {Server} server
*/
setSelectedServer: function(server) {
setSelectedServer(server) {
this._checkServerDefinition(server);
if (this._state == 3)
throw "You can't select a server while the test is running";
if (this._state === 3) throw new Error("You can't select a server while the test is running");
this._selectedServer = server;
this._state = 2;
},
/**
* Automatically selects a server from the list of added test points. The server with the lowest ping will be chosen. (multiple points of test)
* The process is asynchronous and the passed result callback function will be called when it's done, then the test can be started.
*/
selectServer: function(result) {
if (this._state != 1) {
if (this._state == 0) throw "No test points added";
if (this._state == 2) throw "Server already selected";
if (this._state >= 3)
throw "You can't select a server while the test is running";
}
if (this._selectServerCalled) throw "selectServer already called"; else this._selectServerCalled=true;
/*this function goes through a list of servers. For each server, the ping is measured, then the server with the function result is called with the best server, or null if all the servers were down.
/**
* Automatically selects a server from the list of added test points.
* The server with the lowest ping will be chosen (multiple points of test).
* The process is asynchronous and the passed result callback function will
* be called when it's done, then the test can be started.
* @param {(x: Server) => void} result
*/
var select = function(serverList, result) {
//pings the specified URL, then calls the function result. Result will receive a parameter which is either the time it took to ping the URL, or -1 if something went wrong.
var PING_TIMEOUT = 2000;
var USE_PING_TIMEOUT = true; //will be disabled on unsupported browsers
selectServer(result) {
if (this._state !== 1) {
if (this._state === 0) throw new Error("No test points added");
if (this._state === 2) throw new Error("Server already selected");
if (this._state >= 3) throw new Error("You can't select a server while the test is running");
}
if (this._selectServerCalled) throw new Error("selectServer already called");
else this._selectServerCalled = true;
/**
* This function goes through a list of servers. For each server, the ping is measured,
* then the server with the function result is called with the best server,
* or null if all the servers were down.
* @param {Server[]} serverList
* @param {(x: Server | null) => void} result parameter is either the best server or null if all servers were down
*/
const select = (serverList, result) => {
const PING_TIMEOUT = 2000;
// will be disabled on unsupported browsers
let USE_PING_TIMEOUT = true;
if (/MSIE.(\d+\.\d+)/i.test(navigator.userAgent)) {
//IE11 doesn't support XHR timeout
// IE11 doesn't support XHR timeout
USE_PING_TIMEOUT = false;
}
var ping = function(url, result) {
/**
* Pings the specified URL, then calls the function result. Result will receive a parameter
* which is either the time it took to ping the URL, or -1 if something went wrong.
* @param {string} url
* @param {(pingMs: number) => void} result parameter is either the time it took to ping the URL, or -1 if something went wrong
*/
const ping = (url, result) => {
url += (url.match(/\?/) ? "&" : "?") + "cors=true";
var xhr = new XMLHttpRequest();
var t = new Date().getTime();
xhr.onload = function() {
if (xhr.responseText.length == 0) {
//we expect an empty response
var instspd = new Date().getTime() - t; //rough timing estimate
const xhr = new XMLHttpRequest();
const t = new Date().getTime();
xhr.onload = () => {
// We expect an empty response
if (xhr.responseText.length === 0) {
// Rough timing estimate
let instspd = new Date().getTime() - t;
try {
//try to get more accurate timing using performance API
var p = performance.getEntriesByName(url);
p = p[p.length - 1];
var d = p.responseStart - p.requestStart;
// Try to get more accurate timing using Performance API
const pArr = performance.getEntriesByName(url);
const p = pArr[pArr.length - 1];
let d = p.responseStart - p.requestStart;
if (d <= 0) d = p.duration;
if (d > 0 && d < instspd) instspd = d;
} catch (e) {}
result(instspd);
} else result(-1);
}.bind(this);
xhr.onerror = function() {
} else {
result(-1);
}.bind(this);
}
};
xhr.onerror = () => { result(-1); };
xhr.open("GET", url);
if (USE_PING_TIMEOUT) {
try {
@ -231,149 +282,139 @@ Speedtest.prototype = {
} catch (e) {}
}
xhr.send();
}.bind(this);
//this function repeatedly pings a server to get a good estimate of the ping. When it's done, it calls the done function without parameters. At the end of the execution, the server will have a new parameter called pingT, which is either the best ping we got from the server or -1 if something went wrong.
var PINGS = 3, //up to 3 pings are performed, unless the server is down...
SLOW_THRESHOLD = 500; //...or one of the pings is above this threshold
var checkServer = function(server, done) {
var i = 0;
};
const PINGS = 3; // up to 3 pings are performed, unless the server is down...
const SLOW_THRESHOLD = 500; // ...or one of the pings is above this threshold
/**
* This function repeatedly pings a server to get a good estimate of the ping.
* When it's done, it calls the done function without parameters.
* At the end of the execution, the server will have a new parameter called pingT,
* which is either the best ping we got from the server or -1 if something went wrong.
* @param {Server} server
* @param {() => void} done
*/
const checkServer = (server, done) => {
let i = 0;
server.pingT = -1;
if (server.server.indexOf(location.protocol) == -1) done();
else {
var nextPing = function() {
if (i++ == PINGS) {
done();
return;
}
if (server.server.indexOf(location.protocol) === -1) return void done();
const nextPing = () => {
if (i++ === PINGS) return void done();
ping(
server.server + server.pingURL,
function(t) {
(t) => {
if (t >= 0) {
if (t < server.pingT || server.pingT == -1) server.pingT = t;
if (t < server.pingT || server.pingT === -1) server.pingT = t;
if (t < SLOW_THRESHOLD) nextPing();
else done();
} else done();
}.bind(this)
);
}.bind(this);
nextPing();
} else {
done();
}
}.bind(this);
//check servers in list, one by one
var i = 0;
var done = function() {
var bestServer = null;
for (var i = 0; i < serverList.length; i++) {
if (
serverList[i].pingT != -1 &&
(bestServer == null || serverList[i].pingT < bestServer.pingT)
)
}
);
};
nextPing();
};
let index = 0;
/**
* Check servers in list, one by one
*/
const done = () => {
let bestServer = null;
for (let i = 0; i < serverList.length; i++) {
if (serverList[i].pingT !== -1 && (!bestServer || serverList[i].pingT < bestServer.pingT)) {
bestServer = serverList[i];
}
result(bestServer);
}.bind(this);
var nextServer = function() {
if (i == serverList.length) {
done();
return;
index++;
}
checkServer(serverList[i++], nextServer);
}.bind(this);
result(bestServer);
};
const nextServer = () => {
if (index === serverList.length) return void done();
checkServer(serverList[index++], nextServer);
};
nextServer();
}.bind(this);
//parallel server selection
var CONCURRENCY = 6;
var serverLists = [];
for (var i = 0; i < CONCURRENCY; i++) {
};
// Parallel server selection
const CONCURRENCY = 6;
const serverLists = [];
for (let i = 0; i < CONCURRENCY; i++) {
serverLists[i] = [];
}
for (var i = 0; i < this._serverList.length; i++) {
for (let i = 0; i < this._serverList.length; i++) {
serverLists[i % CONCURRENCY].push(this._serverList[i]);
}
var completed = 0;
var bestServer = null;
for (var i = 0; i < CONCURRENCY; i++) {
let completed = 0;
/** @type {Server} */
let bestServer = null;
for (let i = 0; i < CONCURRENCY; i++) {
select(
serverLists[i],
function(server) {
if (server != null) {
if (bestServer == null || server.pingT < bestServer.pingT)
(server) => {
if (server && (!bestServer || server.pingT < bestServer.pingT)) {
bestServer = server;
}
completed++;
if (completed == CONCURRENCY) {
if (completed === CONCURRENCY) {
this._selectedServer = bestServer;
this._state = 2;
if (result) result(bestServer);
}
}.bind(this)
}
);
}
},
}
/**
* Starts the test.
* During the test, the onupdate(data) callback function will be called periodically with data from the worker.
* At the end of the test, the onend(aborted) function will be called with a boolean telling you if the test was aborted or if it ended normally.
* During the test, the onupdate(data) callback function will be called periodically
* with data from the worker. At the end of the test, the onend(aborted) function will
* be called with a boolean telling you if the test was aborted or if it ended normally.
*/
start: function() {
if (this._state == 3) throw "Test already running";
start() {
if (this._state === 3) throw new Error("Test already running");
this.worker = new Worker("speedtest_worker.js?r=" + Math.random());
this.worker.onmessage = function(e) {
this.worker.onmessage = (e) => {
if (e.data === this._prevData) return;
else this._prevData = e.data;
var data = JSON.parse(e.data);
this._prevData = e.data;
const data = JSON.parse(e.data);
try {
if (this.onupdate) this.onupdate(data);
} catch (e) {
console.error("Speedtest onupdate event threw exception: " + e);
}
if (data.testState >= 4) {
clearInterval(this.updater);
this._state = 4;
try {
if (this.onend) this.onend(data.testState == 5);
if (this.onend) this.onend(data.testState === 5);
} catch (e) {
console.error("Speedtest onend event threw exception: " + e);
}
clearInterval(this.updater);
this._state = 4;
}
}.bind(this);
this.updater = setInterval(
function() {
this.worker.postMessage("status");
}.bind(this),
200
);
if (this._state == 1)
throw "When using multiple points of test, you must call selectServer before starting the test";
if (this._state == 2) {
this._settings.url_dl =
this._selectedServer.server + this._selectedServer.dlURL;
this._settings.url_ul =
this._selectedServer.server + this._selectedServer.ulURL;
this._settings.url_ping =
this._selectedServer.server + this._selectedServer.pingURL;
this._settings.url_getIp =
this._selectedServer.server + this._selectedServer.getIpURL;
if (typeof this._originalExtra !== "undefined") {
};
this.updater = setInterval(() => { this.worker.postMessage("status"); }, 200);
if (this._state === 1) {
throw new Error("When using multiple points of test, you must call selectServer before starting the test");
}
if (this._state === 2) {
this._settings.url_dl = this._selectedServer.server + this._selectedServer.dlURL;
this._settings.url_ul = this._selectedServer.server + this._selectedServer.ulURL;
this._settings.url_ping = this._selectedServer.server + this._selectedServer.pingURL;
this._settings.url_getIp = this._selectedServer.server + this._selectedServer.getIpURL;
this._settings.telemetry_extra = JSON.stringify({
server: this._selectedServer.name,
extra: this._originalExtra
});
} else
this._settings.telemetry_extra = JSON.stringify({
server: this._selectedServer.name
extra: this._originalExtra ? this._originalExtra : undefined
});
}
this._state = 3;
this.worker.postMessage("start " + JSON.stringify(this._settings));
},
}
/**
* Aborts the test while it's running.
*/
abort: function() {
if (this._state < 3) throw "You cannot abort a test that's not started yet";
abort() {
if (this._state < 3) throw new Error("You cannot abort a test that's not started yet");
if (this._state < 4) this.worker.postMessage("abort");
}
};
}

624
speedtest_worker.js
View file

@ -1,33 +1,42 @@
/*
LibreSpeed - Worker
by Federico Dossena
https://github.com/librespeed/speedtest/
GNU LGPLv3 License
*/
/**
* @file LibreSpeed - Worker
* @author Federico Dossena
* @license LGPL-3.0-only
* @see https://github.com/librespeed/speedtest/
*/
// data reported to main thread
var testState = -1; // -1=not started, 0=starting, 1=download test, 2=ping+jitter test, 3=upload test, 4=finished, 5=abort
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 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 testId = null; //test ID (sent back by telemetry if used, null otherwise)
let testState = -1; // -1=not started, 0=starting, 1=download test, 2=ping+jitter test, 3=upload test, 4=finished, 5=abort
let dlStatus = 0; // download speed in megabit/s with 2 decimal digits
let ulStatus = 0; // upload speed in megabit/s with 2 decimal digits
let pingStatus = 0; // ping in milliseconds with 2 decimal digits
let jitterStatus = 0; // jitter in milliseconds with 2 decimal digits
let clientIp = ""; // client's IP address as reported by getIP.php
let dlProgress = 0; // progress of download test 0-1
let ulProgress = 0; // progress of upload test 0-1
let pingProgress = 0; // progress of ping+jitter test 0-1
let testId = null; // test ID (sent back by telemetry if used, null otherwise)
var log = ""; //telemetry log
let log = ""; // telemetry log
/**
* @param {string} s
*/
function tlog(s) {
if (settings.telemetry_level >= 2) {
log += Date.now() + ": " + s + "\n";
}
}
/**
* @param {string} s
*/
function tverb(s) {
if (settings.telemetry_level >= 3) {
log += Date.now() + ": " + s + "\n";
}
}
/**
* @param {string} s
*/
function twarn(s) {
if (settings.telemetry_level >= 2) {
log += Date.now() + " WARN: " + s + "\n";
@ -35,59 +44,57 @@ function twarn(s) {
console.warn(s);
}
// test settings. can be overridden by sending specific values with the start command
var settings = {
mpot: false, //set to true when in MPOT mode
test_order: "IP_D_U", //order in which tests will be performed as a string. D=Download, U=Upload, P=Ping+Jitter, I=IP, _=1 second delay
/**
* Test settings - can be overridden by sending specific values with the start command
*/
const settings = {
mpot: false, // set to true when in MPOT mode
test_order: "IP_D_U", // 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)
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
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_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)
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
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
telemetry_extra: "" // extra data that can be passed to the telemetry through the settings
};
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
/** @type {XMLHttpRequest[]} */
let xhr = null; // array of currently active xhr requests
/** @type {number} */
let interval = null; // timer used in tests
let 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(/\?/) ? "&" : "?";
}
/*
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(" ");
/**
* 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"}
*/
self.addEventListener("message", (e) => {
const params = e.data.split(" ");
if (params[0] === "status") {
// return status
postMessage(
@ -110,21 +117,21 @@ this.addEventListener("message", function(e) {
testState = 0;
try {
// parse settings, if present
var s = {};
let s = {};
try {
var ss = e.data.substring(5);
const 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) {
// copy custom settings
for (const key in s) {
if (typeof settings[key] !== "undefined") settings[key] = s[key];
else twarn("Unknown setting ignored: " + key);
}
var ua = navigator.userAgent;
const 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 (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
@ -145,25 +152,27 @@ this.addEventListener("message", function(e) {
}
}
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
// 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
// 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
// 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
// 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
if (typeof s.telemetry_level !== "undefined") {
// telemetry_level has to be parsed and not just copied
settings.telemetry_level = s.telemetry_level === "basic" ? 1 : s.telemetry_level === "full" ? 2 : s.telemetry_level === "debug" ? 3 : 0;
}
// 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);
@ -171,71 +180,55 @@ this.addEventListener("message", function(e) {
// run the tests
tverb(JSON.stringify(settings));
test_pointer = 0;
var iRun = false,
dRun = false,
uRun = false,
pRun = false;
var runNextTest = function() {
if (testState == 5) return;
let iRun = false;
let dRun = false;
let uRun = false;
let pRun = false;
const runNextTest = () => {
if (testState === 5) return;
if (test_pointer >= settings.test_order.length) {
//test is finished
if (settings.telemetry_level > 0)
sendTelemetry(function(id) {
// test is finished
if (settings.telemetry_level > 0) {
sendTelemetry((id) => {
testState = 4;
if (id != null) testId = id;
});
else testState = 4;
} else {
testState = 4;
}
return;
}
switch (settings.test_order.charAt(test_pointer)) {
case "I":
{
test_pointer++;
if (iRun) {
runNextTest();
return;
} else iRun = true;
if (iRun) return void runNextTest();
iRun = true;
getIp(runNextTest);
}
break;
case "D":
{
test_pointer++;
if (dRun) {
runNextTest();
return;
} else dRun = true;
if (dRun) return void runNextTest();
dRun = true;
testState = 1;
dlTest(runNextTest);
}
break;
case "U":
{
test_pointer++;
if (uRun) {
runNextTest();
return;
} else uRun = true;
if (uRun) return void runNextTest();
uRun = true;
testState = 3;
ulTest(runNextTest);
}
break;
case "P":
{
test_pointer++;
if (pRun) {
runNextTest();
return;
} else pRun = true;
if (pRun) return void runNextTest();
pRun = true;
testState = 2;
pingTest(runNextTest);
}
break;
case "_":
{
test_pointer++;
setTimeout(runNextTest, 1000);
}
break;
default:
test_pointer++;
@ -245,28 +238,30 @@ this.addEventListener("message", function(e) {
}
if (params[0] === "abort") {
// abort command
if (testState >= 4) return;
if (testState >= 4) return; // test finished
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 = 5; //set test as aborted
dlStatus = "";
ulStatus = "";
pingStatus = "";
jitterStatus = "";
if (settings.telemetry_level > 1) sendTelemetry(() => {});
testState = 5; // set test as aborted
dlStatus = 0;
ulStatus = 0;
pingStatus = 0;
jitterStatus = 0;
clientIp = "";
dlProgress = 0;
ulProgress = 0;
pingProgress = 0;
}
});
// stops all XHR activity, aggressively
/**
* stops all XHR activity, aggressively
*/
function clearRequests() {
tverb("stopping pending XHRs");
if (xhr) {
for (var i = 0; i < xhr.length; i++) {
for (let i = 0; i < xhr.length; i++) {
try {
xhr[i].onprogress = null;
xhr[i].onload = null;
@ -277,29 +272,29 @@ function clearRequests() {
xhr[i].upload.onload = null;
xhr[i].upload.onerror = null;
} catch (e) {}
try {
xhr[i].abort();
} catch (e) {}
try {
delete xhr[i];
} 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
let ipCalled = false; // used to prevent multiple accidental calls to getIp
let ispInfo = ""; // used for telemetry
/**
* gets client's IP using `url_getIp`, then calls the `done()` function
* @param {() => void} done
*/
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() {
ipCalled = true; // getIp already called?
const startT = new Date().getTime();
const xhr = new XMLHttpRequest();
xhr.onload = () => {
tlog("IP: " + xhr.responseText + ", took " + (new Date().getTime() - startT) + "ms");
try {
var data = JSON.parse(xhr.responseText);
const data = JSON.parse(xhr.responseText);
clientIp = data.processedString;
ispInfo = data.rawIspInfo;
} catch (e) {
@ -308,65 +303,66 @@ function getIp(done) {
}
done();
};
xhr.onerror = function() {
xhr.onerror = () => {
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
let dlCalled = false; // used to prevent multiple accidental calls to dlTest
/**
* download test, calls done function when it's over
* @param {() => void} done
*/
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
dlCalled = true; // dlTest already called?
let totLoaded = 0.0; // total number of loaded bytes
let startT = new Date().getTime(); // timestamp when test was started
let bonusT = 0; // how many milliseconds the test has been shortened by (higher on faster connections)
let graceTimeDone = false; // set to true after the grace time is past
let 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) {
/**
* function to create a download stream. streams are slightly delayed so that they will not end at the same time
* @param {number} i
* @param {number} delay
*/
const testStream = (i, delay) => {
setTimeout(
function() {
() => {
if (testState !== 1) 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();
let prevLoaded = 0; // number of bytes loaded last time onprogress was called
const x = new XMLHttpRequest();
xhr[i] = x;
xhr[i].onprogress = function(event) {
xhr[i].onprogress = (event) => {
tverb("dl stream progress event " + i + " " + event.loaded);
if (testState !== 1) {
try {
x.abort();
} catch (e) {}
} // just in case this XHR is still running after the download test
// just in case this XHR is still running after the download test
if (testState !== 1) try { x.abort(); } catch (e) {}
// progress event, add number of new loaded bytes to totLoaded
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevLoaded;
const 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() {
};
xhr[i].onload = () => {
// 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
try { xhr[i].abort(); } catch (e) {} // reset the stream data to empty ram
testStream(i, 0);
}.bind(this);
xhr[i].onerror = function() {
};
xhr[i].onerror = () => {
// error
tverb("dl stream failed " + i);
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
try {
xhr[i].abort();
} catch (e) {}
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);
if (settings.xhr_ignoreErrors === 1) testStream(i, 0); // restart stream
};
// send xhr
try {
if (settings.xhr_dlUseBlob) xhr[i].responseType = "blob";
@ -374,19 +370,19 @@ function dlTest(done) {
} 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++) {
for (let 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;
const t = new Date().getTime() - startT;
if (graceTimeDone) dlProgress = (t + bonusT) / (settings.time_dl_max * 1000);
if (t < 200) return;
if (!graceTimeDone) {
@ -400,71 +396,86 @@ function dlTest(done) {
graceTimeDone = true;
}
} else {
var speed = totLoaded / (t / 1000.0);
const 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 = (6.4 * speed) / 100000;
// decide how much to shorten the test. Every 200ms, the test is shortened by the bonusT calculated here
const bonus = 6.4 * speed / 100000;
bonusT += bonus > 800 ? 800 : 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
// update status
dlStatus = Number((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";
if (failed || isNaN(dlStatus)) dlStatus = -1;
clearRequests();
clearInterval(interval);
dlProgress = 1;
tlog("dlTest: " + dlStatus + ", took " + (new Date().getTime() - startT) + "ms");
tlog(`dlTest: ${dlStatus < 0 ? "Fail" : 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
let ulCalled = false; // used to prevent multiple accidental calls to ulTest
/**
* upload test, calls done function when it's over
* @param {() => void} done
*/
function ulTest(done) {
tverb("ulTest");
if (ulCalled) return;
else ulCalled = true; // ulTest already called?
ulCalled = true; // ulTest already called?
// garbage data for upload test
var r = new ArrayBuffer(1048576);
var maxInt = Math.pow(2, 32) - 1;
let r = new ArrayBuffer(1048576);
const maxInt = Math.pow(2, 32) - 1;
try {
r = new Uint32Array(r);
for (var i = 0; i < r.length; i++) r[i] = Math.random() * maxInt;
for (let 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);
const req = [];
const reqsmall = [];
for (let i = 0; i < settings.xhr_ul_blob_megabytes; i++) {
req.push(r);
}
const request = 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;
for (let 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
const requestS = new Blob(reqsmall);
const testFunction = () => {
let totLoaded = 0.0; // total number of transmitted bytes
let startT = new Date().getTime(); // timestamp when test was started
let bonusT = 0; // how many milliseconds the test has been shortened by (higher on faster connections)
let graceTimeDone = false; // set to true after the grace time is past
let 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) {
/**
* function to create an upload stream. streams are slightly delayed so that they will not end at the same time
* @param {number} i
* @param {number} delay
*/
const testStream = (i, delay) => {
setTimeout(
function() {
() => {
if (testState !== 3) 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();
let prevLoaded = 0; // number of bytes transmitted last time onprogress was called
const x = new XMLHttpRequest();
xhr[i] = x;
var ie11workaround;
if (settings.forceIE11Workaround) ie11workaround = true;
else {
let ie11workaround;
if (settings.forceIE11Workaround) {
ie11workaround = true;
} else {
try {
xhr[i].upload.onprogress;
ie11workaround = false;
@ -474,67 +485,62 @@ function ulTest(done) {
}
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() {
xhr[i].onload = xhr[i].onerror = () => {
tverb("ul stream progress event (ie11wa)");
totLoaded += reqsmall.size;
totLoaded += requestS.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);
// No Content-Type header in MPOT branch because it triggers bugs in some browsers
xhr[i].send(requestS);
} else {
// REGULAR version, no workaround
xhr[i].upload.onprogress = function(event) {
xhr[i].upload.onprogress = (event) => {
tverb("ul stream progress event " + i + " " + event.loaded);
if (testState !== 3) {
try {
x.abort();
} catch (e) {}
} // just in case this XHR is still running after the upload test
// just in case this XHR is still running after the upload test
if (testState !== 3) try { x.abort(); } catch (e) {}
// progress event, add number of new loaded bytes to totLoaded
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevLoaded;
const 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() {
};
xhr[i].upload.onload = () => {
// this stream sent all the garbage data, start again
tverb("ul stream finished " + i);
testStream(i, 0);
}.bind(this);
xhr[i].upload.onerror = function() {
};
xhr[i].upload.onerror = () => {
tverb("ul stream failed " + i);
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
try {
xhr[i].abort();
} catch (e) {}
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);
if (settings.xhr_ignoreErrors === 1) testStream(i, 0); // restart stream
};
// 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);
// No Content-Type header in MPOT branch because it triggers bugs in some browsers
xhr[i].send(request);
}
}.bind(this),
},
delay
);
}.bind(this);
};
// open streams
for (var i = 0; i < settings.xhr_ulMultistream; i++) {
for (let 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;
const t = new Date().getTime() - startT;
if (graceTimeDone) ulProgress = (t + bonusT) / (settings.time_ul_max * 1000);
if (t < 200) return;
if (!graceTimeDone) {
@ -548,176 +554,190 @@ function ulTest(done) {
graceTimeDone = true;
}
} else {
var speed = totLoaded / (t / 1000.0);
const 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 = (6.4 * speed) / 100000;
// decide how much to shorten the test. Every 200ms, the test is shortened by the bonusT calculated here
const bonus = 6.4 * speed / 100000;
bonusT += bonus > 800 ? 800 : 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
// update status
ulStatus = Number((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";
if (failed || isNaN(ulStatus)) ulStatus = -1;
clearRequests();
clearInterval(interval);
ulProgress = 1;
tlog("ulTest: " + ulStatus + ", took " + (new Date().getTime() - startT) + "ms");
tlog(`ulTest: ${ulStatus < 0 ? "Fail" : 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() {
xhr[0].onload = xhr[0].onerror = () => {
tverb("POST request sent, starting upload test");
testFunction();
}.bind(this);
};
xhr[0].open("POST", settings.url_ul);
xhr[0].send();
} else testFunction();
} else {
testFunction();
}
}
// ping+jitter test, function done is called when it's over
var ptCalled = false; // used to prevent multiple accidental calls to pingTest
let ptCalled = false; // used to prevent multiple accidental calls to pingTest
/**
* ping+jitter test, function done is called when it's over
* @param {() => void} done
*/
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
ptCalled = true; // pingTest already called?
const startT = new Date().getTime(); // when the test was started
let prevT = null; // last time a pong was received
let ping = 0.0; // current ping value
let jitter = 0.0; // current jitter value
let i = 0; // counter of pongs received
let prevInstspd = 0; // last ping time, used for jitter calculation
xhr = [];
// ping function
var doPing = function() {
const doPing = () => {
tverb("ping");
pingProgress = i / settings.count_ping;
prevT = new Date().getTime();
xhr[0] = new XMLHttpRequest();
xhr[0].onload = function() {
xhr[0].onload = () => {
// pong
tverb("pong");
if (i === 0) {
prevT = new Date().getTime(); // first pong
} else {
var instspd = new Date().getTime() - prevT;
let 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;
// try to get accurate performance timing using performance api
const pl = performance.getEntries();
/** @type {PerformanceResourceTiming} */
const p = pl[pl.length - 1];
let 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
// if not possible, keep the estimate
tverb("Performance API not supported, using estimate");
}
}
//noticed that some browsers randomly have 0ms ping
// 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 {
const 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
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);
pingStatus = Number(ping.toFixed(2));
jitterStatus = Number(jitter.toFixed(2));
i++;
tverb("ping: " + pingStatus + " jitter: " + jitterStatus);
if (i < settings.count_ping) doPing();
else {
if (i < settings.count_ping) {
doPing();
} else {
// more pings to do?
pingProgress = 1;
tlog("ping: " + pingStatus + " jitter: " + jitterStatus + ", took " + (new Date().getTime() - startT) + "ms");
tlog(`ping: ${pingStatus < 0 ? "Fail" : pingStatus} jitter: ${jitterStatus < 0 ? "Fail" : jitterStatus}, took ${new Date().getTime() - startT}ms`);
done();
}
}.bind(this);
xhr[0].onerror = function() {
};
xhr[0].onerror = () => {
// a ping failed, cancel test
tverb("ping failed");
if (settings.xhr_ignoreErrors === 0) {
//abort
pingStatus = "Fail";
jitterStatus = "Fail";
// abort
pingStatus = -1;
jitterStatus = -1;
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
} else if (settings.xhr_ignoreErrors === 1) {
doPing(); // retry ping
} else if (settings.xhr_ignoreErrors === 2) {
// ignore failed ping
i++;
if (i < settings.count_ping) doPing();
else {
if (i < settings.count_ping) {
doPing();
} else {
// more pings to do?
pingProgress = 1;
tlog("ping: " + pingStatus + " jitter: " + jitterStatus + ", took " + (new Date().getTime() - startT) + "ms");
tlog(`ping: ${pingStatus < 0 ? "Fail" : pingStatus} jitter: ${jitterStatus < 0 ? "Fail" : 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
}
// telemetry
/**
* @param {(id?: string) => void} done
*/
function sendTelemetry(done) {
if (settings.telemetry_level < 1) return;
xhr = new XMLHttpRequest();
xhr.onload = function() {
const xhr = new XMLHttpRequest();
xhr.onload = () => {
try {
var parts = xhr.responseText.split(" ");
if (parts[0] == "id") {
const parts = xhr.responseText.split(" ");
if (parts[0] === "id")
try {
var id = parts[1];
const id = parts[1];
done(id);
} catch (e) {
} catch (e) { done(null); }
else
done(null);
}
} else done(null);
} catch (e) {
done(null);
}
} catch (e) { done(null); }
};
xhr.onerror = function() {
xhr.onerror = () => {
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 : ""
};
const telemetryIspInfo = { processedString: clientIp, rawIspInfo: typeof ispInfo === "object" ? ispInfo : "" };
try {
var fd = new FormData();
const 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("dl", dlStatus.toString());
fd.append("ul", ulStatus.toString());
fd.append("ping", pingStatus.toString());
fd.append("jitter", jitterStatus.toString());
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 : "");
const 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);
}
}
/**
* this function is used on URLs passed in the settings to determine whether we need a '?' or an '&' as a separator
* @param {string} url
*/
function url_sep(url) {
return url.match(/\?/) ? "&" : "?";
}