[DXEX-455] Allow custom headers to be set in Management/Auth Clients. #460
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
|
One note/question about this PR: we only need the user agent header to be exposed, but should we just expose the entire headers object instead so that the consumer can add whatever additional headers they like? |
|
Closed this PR by mistake! :derp: |
|
Thanks for updating this branch @damieng! I just realized that my original commit is not properly signed. Let me know if you want me to amend it and force push a new commit that is signed (and has my auth0 email instead of my personal one). |
In order to better determine what version of the Deploy CLI tool is being used by our customers, we would like to include the Deploy CLI's version in the User-agent header as opposed to the current behavior (the version of node under which the CLI is running). The Deploy CLI uses ManagementClient to do its work, but the User-agent header was not configurable before this change. This commit provides a new option called `headers` that will allow the caller to provide an optional set of additional headers to outgoing requests. In the case of the `User-agent` header, if it is not provided by the caller, the original User-agent string will be used (e.g. `node.js/13.1.2`).
seejee
force-pushed
the
dxex-455-expose-user-agent
branch
from
cfdbf25
to
d56756a
Compare
seejee
changed the title
davidpatrick
approved these changes
Feb 21, 2020
|
Tests passed but status check got stuck. |
Merged
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Changes
In order to better determine what version of the Deploy CLI tool is being used
by our customers, we would like to include the Deploy CLI's version in the
User-agent header as opposed to the current behavior (the version of node under
which the CLI is running).
The Deploy CLI uses ManagementClient to do its work, but the User-agent header
was not configurable before this change. This commit provides a new option
called
userAgentthat will override the User-agent header if it is provided.If it is not provided, the original User-agent will be used (e.g.
node.js/13.1.2).References
Testing
Unit tests were added for the new behavior as well as ones to ensure the original behavior works when
userAgentis not provided.Checklist