Feature/163 global download upload limit

[chtrinh]

throttleDownload() and throttleUpload() helper methods for rate adjustments

#163

[BenmasterTM]

HI, I try this changes in the webtorrent client in the webtorrent-desktop client, and when I try to set the upload/download limit for Web Torrent, this changes dont work, the only way I found to slowdown the upload files from the webtorrent client in webtorrent-desktop is changing the webtorrent/node_modules/bittorrent-protocol/index.js changing the Wire.prototype.piece function, and encapsulating the code into a timeout:

 var self = this;
(function(self, index, offset, buffer) {
setTimeout(function() {
self._debug('piece index=%d offset=%d', index, offset)
self.uploaded += buffer.length
self.uploadSpeed(buffer.length)
self.emit('upload', buffer.length)
self._message(7, [index, offset], buffer)
}, 800)    
})(self, index, offset, buffer)

altering the timeout time change the upload speed to the web seeds, but cause many messages "start backpressure" from the simple-peer module, I know is not a fix, is only a test, but i think to limit the web seed upload/download speed is complicated due the bittorrent protocol itself... i dont know if is better/possible encapsulate the webtorrent client into some other throttle component.

[chtrinh]

How did you set upload/download limits for webtorrent-desktop client?
it should be something like this:

var torrent = new WebTorrent({downloadLimit: 10240, uploadLimit: 10240}); // (downstream/upsttream) bandwidth to 10 KB/s

This PR relies on https://www.npmjs.com/package/stream-throttle to throttle your bandwidth.
I believe this is using leaky bucket algorithm to perform rate limiting.

[BenmasterTM]

Yes I try that:

let client = window.client = new WebTorrent({downloadLimit: 10240, uploadLimit: 10240})

but the clients connected to the webtorrent client get 100% of my internet connection, i think is because im talking always about WebRTC clients (I dont test with regular uTPC clients, but in the code I see self.type === 'tcpOutgoing' and i think the web clients go for another point)

Edit: I test the if

  if (self.type === 'tcpOutgoing') {
    self.setThrottlePipes()
    console.log('LIMITED SPEED')
  } else {
    conn.pipe(wire).pipe(conn)
    console.log('NOOPE')
  }

And in my log appear only 2 "NOOPE"

EDIT 2: I test to remove the if and let only the self.setThrottlePipes() line.. and works, the WebPeer upload are locked to 10Kb/s... why this IF is here??

[chtrinh]

My initial use case was for TCP not WebRTC. IIRC, I encountered an edge case where you couldn't always set throttle pipes. You don't know what "tcpIncoming" are going to be use for.
https://github.com/chtrinh/webtorrent/blob/462a1916fc1736fa9ede2ce0240e1500efad51de/lib/peer.js#L32-L39

I would try something like so:

 if ((self.type === 'tcpOutgoing') || (self.type === 'webrtc')) {
    self.setThrottlePipes()
 } else {
    conn.pipe(wire).pipe(conn)
  }

HTH

[BenmasterTM]

The correct value in Web Peers is self.type === 'webrtc', but works correctly, thanks!

[TwoAbove]

Looks good!

But where are the tests for the new features?

I think it's a really good idea to add them

[BenmasterTM]

Hi, I found an error in specific case: If you change the upload or download speed while torrents are downloading/uploading, (with the helper function or directly in webtorrent.uploadSpeed / webtorrent.downloadSpeed), the webtorrent process crash:

Error: Uncaught, unspecified "error" event. (Requested tokens 2984254 exceeds bucket size 1049600)
    at Throttle.emit (events.js:163)
    at Throttle.onerror (D:\Escritorio\electro\node_modules\webtorrent\node_modules\readable-stream\lib\_stream_readable.js:562)
    at emitOne (events.js:96)
    at Throttle.emit (events.js:188)
    at onwriteError (_stream_writable.js:344)
    at onwrite (_stream_writable.js:362)
    at afterTransform (_stream_transform.js:79)
    at TransformState.afterTransform (_stream_transform.js:54)
    at D:\Escritorio\electro\node_modules\webtorrent\node_modules\stream-throttle\src\throttle.js:34
    at _combinedTickCallback (internal/process/next_tick.js:67)
    at process._tickCallback (internal/process/next_tick.js:98)

[rigelk]

@chtrinh do you still plan on finishing this ?

[quicoto]

Any updates on this? 🙏

[BenmasterTM]

Have webtorrent added some similar functionality, or we need to keep this "fix" added?
In my case I need limit download/upload speeds but I see no oficial support in the main branch.

[TwoAbove]

@BenmasterTM unfortunately, no news on that, but I can confirm that this fork works

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.