Use ThrottleGroup to throttle proxy throughput

[nerdbeere]

Me again with another feature request. :)
I'd like to implement a throttling feature in james (which is basically a frontend for hoxy) as mentioned here. But currently request.slow and response.slow only throttle per request.
What I would need is throttling on proxy level, something like proxy.slowUpstream(rate) and proxy.slowDownstream.

After looking into the source I found out that stream-throttle is used in hoxy which has a feature called ThrottleGroup. This might make it easy to implement slowing on proxy level.

[greim]

Thanks. I hadn't thought of this before, but now that you mention it it seems obvious :)

[greim]

Hmm. Should uploads and downloads be independent throttle groups? Presumably yes since most internet connections (in the US at least) are faster down than up. Maybe like this?

new hoxy.Proxy({
  slow: {
    up: { rate: 10000, latency: 30 },
    down: { rate: 100000, latency: 20 },
  }
})

[greim]

I'm thinking maybe rather something like this:

new hoxy.Proxy({
  slow: {

    // bottlenecks all throughput to this speed
    rate: 10000,

    // delays responses by a certain amount
    latency: 30,

    // bottlenecks all uploads to this speed
    // overrides "rate" above
    up: 10000,

    // bottlenecks all downloads to this speed
    // overrides "rate" above
    down: 100000,
  }
})

[greim]

Published as 2.0.0. Let me know how it works.

[nerdbeere]

Awesome, thanks!
But I think it would make sense to have getters and setters for both up and downstream.
If you point me in the right direction, maybe I an come up with a pull request.

[greim]

I see. Would it be helpful to have setSlow(opts) and getSlow() methods, which set and get an object having the same structure as the one passed to the constructor? (e.g. { rate, latency, up, down })

[nerdbeere]

That'd be perfect

[greim]

Added and published in v2.3.0.