chore: update user agent string for better debugging #680
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.
This PR standardizes the format of our User-Agent string in twilio-node and provides the ability to pass additional information from upstream packages to be included. It follows the agreed pattern of:
<core-api-lib>/<core-api-lib-version> (<os-name> <os-arch>) node/<node-version> <extensions>
Where are being added space separated following:
<library>/<library-version>
or
<tag>
In this case the Twilio class allows you to pass in
userAgentExtensions
as an array to specify upstream libraries who use it to add their library name and version.This could possibly be described as a breaking change as it will update the underlying User-Agent used by the default HTTP Client and anything that relies on that will need an update. I have not marked this as breaking yet though, as I am unsure if that would be a problem and I am interested in other opinions on this.
Checklist
If you have questions, please file a support ticket, or create a GitHub Issue in this repository.