REST: Add property for configuring user agent in http client #13234
Conversation
| .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.
|
|
||
| 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.
There was a problem hiding this comment.
I was thinking about adding this constant to class HTTPClient, but if it's only used by test, we might not do that.
There was a problem hiding this comment.
btw, I didn't find the constant in the class org.apache.iceberg.rest.HttpHeaders. Are you referring to another class with the same name?
flyrain
left a comment
There was a problem hiding this comment.
LGTM. Thanks for adding this @singhpk234 !
amogh-jahagirdar
left a comment
There was a problem hiding this comment.
I think this looks good, I'll go ahead and merge. Thanks @singhpk234 and @nastra @HonahX @ebyhr @flyrain for reviewing!
…13234) Co-authored-by: Prashant Singh <prashant.singh@snowflake.com>
…13234) Co-authored-by: Prashant Singh <prashant.singh@snowflake.com>
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