REST: Add property for configuring user agent in http client #13234
Conversation
This file contains hidden or 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
nastra
approved these changes
Jun 4, 2025
amogh-jahagirdar
changed the title
| @@ -461,7 +466,8 @@ private static String addRequestTestCaseAndGetPath(HttpMethod method, Item body, | |||
| .withMethod(method.name().toUpperCase(Locale.ROOT)) | |||
| .withHeader("Authorization", "Bearer " + BEARER_AUTH_TOKEN) | |||
| .withHeader(HTTPClient.CLIENT_VERSION_HEADER, icebergBuildFullVersion) | |||
| .withHeader(HTTPClient.CLIENT_GIT_COMMIT_SHORT_HEADER, icebergBuildGitCommitShort); | |||
| .withHeader(HTTPClient.CLIENT_GIT_COMMIT_SHORT_HEADER, icebergBuildGitCommitShort) | |||
| .withHeader(USER_AGENT, TEST_USER_AGENT); | |||
There was a problem hiding this comment.
Just for my understanding, if I have a HTTP client configured to "my-user-agent" and then I later set it to "some-new-agent" on the request level, it will override it at the request level right? Just wanted to double check the order of precedence (not that I expect it to be used in practice that way)
There was a problem hiding this comment.
precisely, request level override always wins over the client level override.
amogh-jahagirdar
changed the title
ebyhr
approved these changes
Jun 6, 2025
| @@ -71,6 +71,8 @@ public class TestHTTPClient { | |||
|
|
|||
| private static final int PORT = 1080; | |||
| private static final String BEARER_AUTH_TOKEN = "auth_token"; | |||
| private static final String USER_AGENT = "User-Agent"; | |||
There was a problem hiding this comment.
nit: USER_AGENT constant exists in HttpHeaders class.
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.
About the change
This change attempts to add UA so that clients can set this at their end and it can supplement the server for audit and debugging purpose, we do have
X-Client-Versionwhich helps solve most of the cases as this helps server understand that what version of the client the server is interacted, but in a world where we want to see the logs at server end and identify what happened to a client will be very hard.Putting this change out to see if folks are interested in this !
Testing
Added a new UT