Set User-Agent header in client #256
Merged
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
danstn
force-pushed
the
user-agent-setup
branch
2 times, most recently
from
3ece3d4 to
bd95cd9
Compare
jradtilbrook
previously approved these changes
Apr 18, 2023
|
Yesterday we had an acceptance spec failure caused by the test org not being cleaned properly, and I manually deleted a lingering pipeline. It's possible rebasing this on main (to get the merged GET body fix) and triggering a new build might Just Work. |
mcncl
previously approved these changes
Apr 18, 2023
danstn
force-pushed
the
user-agent-setup
branch
from
bd95cd9 to
74f3e01
Compare
yob
reviewed
Apr 18, 2023
danstn
force-pushed
the
user-agent-setup
branch
from
18a51bd to
a98f3ca
Compare
jradtilbrook
approved these changes
Apr 18, 2023
mcncl
approved these changes
Apr 18, 2023
|
I don't think it's a deal breaker in the short term, but looking at the user agents we're logging in production now it seems like maybe this only sets it for REST API calls, and not for graphql ones? |
|
Actually yes @yob that is correct. I'll create another task to do this for graphql as well |
yob
added a commit
that referenced
this pull request
Apr 18, 2023
In #256 we starting setting a custom User-Agent header on REST API calls, to help us understand the ways our API is used. It looks like this: Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.0.3 buildkite/0.15.0 This builds on that work and sets the same User-Agent on graphql API requests as well. It drops the unnescary use of golang.org/x/oauth2 to set a static bearer token header, and uses the tripperware pattern [1] to set both headers we care about: 1. the static bearer token for auth 2. the user agent The same http.Client is used for both REST and graphql, so we'll get identical behaviour on both APIs. [1] https://dev.to/stevenacoffman/tripperwares-http-client-middleware-chaining-roundtrippers-3o00
yob
added a commit
that referenced
this pull request
Apr 18, 2023
In #256 we starting setting a custom User-Agent header on REST API calls, to help us understand the ways our API is used. It looks like this: Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.0.3 buildkite/0.15.0 This builds on that work and sets the same User-Agent on graphql API requests as well. It drops the unnecessary use of golang.org/x/oauth2 to set a static bearer token header, and uses the tripperware pattern [1] to set both headers we care about: 1. the static bearer token for auth 2. the user agent The same http.Client is used for both REST and graphql, so we'll get identical behaviour on both APIs. [1] https://dev.to/stevenacoffman/tripperwares-http-client-middleware-chaining-roundtrippers-3o00
yob
added a commit
that referenced
this pull request
Apr 20, 2023
In #256 we starting setting a custom User-Agent header on REST API calls, to help us understand the ways our API is used. It looks like this: Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.0.3 buildkite/0.15.0 This builds on that work and sets the same User-Agent on graphql API requests as well. It drops the unnecessary use of golang.org/x/oauth2 to set a static bearer token header, and uses the tripperware pattern [1] to set both headers we care about: 1. the static bearer token for auth 2. the user agent The same http.Client is used for both REST and graphql, so we'll get identical behaviour on both APIs. [1] https://dev.to/stevenacoffman/tripperwares-http-client-middleware-chaining-roundtrippers-3o00
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.
This sets the user agent for api client.
Using Provider.UserAgent to set the header.
Also, this can now take a
versioncoming from ldflags which is added as a suffix.Rendered example: