node-turbotest

A quick and easy speed tester for uWebSockets and WS.

Note: Look at the example for help. You can probably figure it out from there.

Usage

var turbotest = require('node-turbotest'); and call turbotest on connection.

wss.on('connection', function (ws) {
    turbotest.test(ws);
    // do some unrelated stuff down here...
});

Listen for any non-specific test with data.

// m is megabit per second, one-eighth of a megabyte
turbo.on('complete', function (m) {
    console.log("The clients' speed is " + m + " mbps.");
})

~~Test a specific client.~~ I guess gone, until a pull request comes or someone answers this.

Why did I build it?

I'm building a real-time engine that requires knowledge of all clients' mbps speed. Through this, Kitten will have better and more consistent streaming. And this might be grounds for machine learning, too!

Fun fact

A megabit is not a megabyte. When an ISP says, "You get 10 mbps for this plan," it does NOT mean an average sized app download (50 MB) in 5 seconds; it would be 40 seconds. A megabit is one-eighth of a megabyte. Thus, the library emits just a megabit to avoid confusion. Multiply that times 8, and you have megabyte.

Notes

This library only supports measuring download speed of the client. Trying upload resulted in NaN (Not a Number) mbps. This is all I really need, so if you need it, you can implement it, and I would be more than happy to get a pull request!

The Internet is not magic and follows physics; the farther away the datacenter; the worse off the results will be. This is why you should probably test with a device that is not your computer, as localhost is local, and you'll be amazed at the speeds to get a crappier one later.

The client must wait for a message, and respond with "recieved". This speed test does not work otherwise. A quick Swift implementation can be seen below.

import Starscream

// ...

socket.onText = { (text: String) in
    // do some validation if needed to just get the speed test
    socket.write(string: "received")
}