feat: add keep alive support #1226
Closed
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
thinkingserious
added
the
status: code review request
added 2 commits
December 4, 2020 17:12
eshanholtz
reviewed
Dec 7, 2020
| */ | ||
| setKeepAlive(keepAlive) { | ||
| if (keepAlive === false) { | ||
| return; |
There was a problem hiding this comment.
What about turning off keep alive? If this just returns, you can never "unset" it.
There was a problem hiding this comment.
keepAlive is already false by default, its an opt-in feature
| return; | ||
| } | ||
|
|
||
| this.client.setDefaultRequest('agent', new Agent({ keepAlive: true })); |
There was a problem hiding this comment.
I think the key needs to be httpsAgent, according to the documentation. This logic should be moved to the underlying Client with a separate helper method that we can call from here, similar to calling this.client.setApiKey from setApiKey.
|
Closing until PR feedback is addressed. |
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.
Resolves: #950
Description
This fix enables consumers to reuse connections by supporting keep-alive.
When
keepAliveis set to true, SendGrid will use forever-agent (HTTP Agent that keeps socket connections alive between keep-alive requests).This has been tested in a simple node request. End users do not have to provide any additional information when calling SendGrid for a client or to send mail and as such has no breaking change.
Linked issue includes examples of similar changes made in Stripe and Twilio apis.
Checklist
If you have questions, please file a support ticket, or create a GitHub Issue in this repository.