Allow configuring RequestHandler to use HTTP instead of HTTPS #1193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Should we not just take the protocol from the rest URL provided? |
|
The domain doesn't have a protocol prefixed. Using it would probably be neater, but it would break backwards compat. |
DonovanDMC
added a commit
to DonovanArchive/ErisPRUpdateBot
that referenced
this pull request
Feb 10, 2022
DonovanDMC
reviewed
Jun 8, 2022
| @@ -109,11 +109,12 @@ class Client extends EventEmitter { | |||
| * @arg {Function} [options.reconnectDelay] A function which returns how long the bot should wait until reconnecting to Discord. | |||
| * @arg {Number} [options.requestTimeout=15000] A number of milliseconds before requests are considered timed out. This option will stop affecting REST in a future release; that behavior is [DEPRECATED] and replaced by `options.rest.requestTimeout` | |||
| * @arg {Object} [options.rest] Options for the REST request handler | |||
| * @arg {Object} [options.rest.agent] A HTTPS Agent used to proxy requests | |||
| * @arg {Object} [options.rest.agent] A HTTPS Agent (if https: true, default) or an HTTP agent (if https: false) used to proxy requests | |||
There was a problem hiding this comment.
Suggested change
| * @arg {Object} [options.rest.agent] A HTTPS Agent (if https: true, default) or an HTTP agent (if https: false) used to proxy requests | |
| * @arg {Object} [options.rest.agent] An HTTP Agent used to proxy requests |
this would probably be better said as HTTP Agent, noting that difference doesn't seem that important (and if you want to argue for it, HTTP/S could be used instead of those distinctions)
There was a problem hiding this comment.
Suggested change
| * @arg {Object} [options.rest.agent] A HTTPS Agent (if https: true, default) or an HTTP agent (if https: false) used to proxy requests | |
| * @arg {Object} [options.rest.agent] A HTTP/S Agent used to proxy requests |
DonovanDMC
added a commit
to DonovanArchive/ErisPRUpdateBot
that referenced
this pull request
Jul 18, 2022
Removals: - abalabahaha/eris#1283 - abalabahaha/eris#1285 - abalabahaha/eris#1369 Additions: - abalabahaha/eris#494 - abalabahaha/eris#1193 - abalabahaha/eris#1338 - abalabahaha/eris#1386
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
My use case was to tunnel all Eris traffic through a central rate limiter (Twilight's http-proxy), which uses HTTP instead of HTTPS. Given that we can already configure the domain and base URL, being able to configure whether to use HTTPS or HTTP seemed logical.
I've named it
httpsand enabled it by default, to ensure concious opt-out by doinghttps: false. A name likeuseHttpsmight be more appropriate.Could also consider storing the request method (
httpsorhttpmodule) as an instance variable on RequestHandler instead of doing the ternary on each request, but I figured this'd be fine.JSDoc and TypeScript typings should be good.