Skip to content

refactor(serverless-api): update user-agent string for better debugging #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 9, 2021

Conversation

dkundel
Copy link
Contributor

@dkundel dkundel commented Jun 30, 2021

This PR standardizes the format of our User-Agent string in @twilio-labs/serverless-api and provide 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>) <extensions>

Where <extensions> are being added space separated following:

<library>/<library-version>

or

<tag>

In this case the TwilioServerlessApiClient offers to pass in userAgentExtensions as an array to specify upstream libraries who use it to add their library name and version.

Contributing to Twilio

All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.

  • I acknowledge that all my contributions will be made under the project's license.

@dkundel dkundel requested a review from philnash June 30, 2021 21:08
Copy link
Contributor

@philnash philnash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks good, added some ideas about simplifying a couple of bits.

@dkundel dkundel marked this pull request as ready for review July 7, 2021 22:04
@dkundel
Copy link
Contributor Author

dkundel commented Jul 7, 2021

I want to add at least one nock test specifically for the user-agent string before merging this but it's ready for review.

Copy link
Contributor

@philnash philnash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now!

@dkundel dkundel changed the title chore(serverless-api): update user-agent string for better debugging refactor(serverless-api): update user-agent string for better debugging Jul 9, 2021
@dkundel dkundel merged commit 87cca3c into main Jul 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants