spotify / styx

"The path to execution", Styx is a service that schedules batch data processing jobs in Docker containers on Kubernetes.

Apache License 2.0

267 stars 50 forks source link

Rename X-Request-Id #1088

Closed andresgomezfrr closed 1 year ago

andresgomezfrr commented 1 year ago

Hey, I just made a Pull Request!

Description

Rename X-Request-Id header to X-Styx-Request-Id

Motivation and Context

Currently, the proxy could override the header X-Request-Id using its own one and this produce a warning in the clients:

com.spotify.styx.client.StyxOkHttpClient - Request ID mismatch: '1f872480b8494988a4676bd967062a24' != '28d50a8faa45427fb6a6ad0f5ebd855c'

So, we decided to use a custom styx request-id header to avoid conflicts with the proxy one.

Checklist for PR author(s)

[ ] Changes are covered by unit test
[ ] All tests pass
[ ] Code coverage check passes
[ ] Error handling is tested
[ ] Errors are handled at the appropriate layer
[ ] Errors that cannot be handled where they occur are propagated
[ ] (optional) Changes are covered by system test
[ ] Relevant documentation updated
[ ] This PR has NO breaking change to public API
[ ] This PR has breaking change to public API and it is documented

Checklist for PR reviewer(s)

[ ] This PR has been incorporated in release note for the coming version
[ ] Risky changes introduced by this PR have been all considered

codecov[bot] commented 1 year ago

Codecov Report

Merging #1088 (5cf3926) into master (f9664ab) will increase coverage by 0.10%. The diff coverage is 100.00%.

@@             Coverage Diff              @@
##             master    #1088      +/-   ##
============================================
+ Coverage     92.28%   92.39%   +0.10%     
- Complexity     2149     2150       +1     
============================================
  Files           200      200              
  Lines          8321     8321              
  Branches        503      503              
============================================
+ Hits           7679     7688       +9     
+ Misses          527      519       -8     
+ Partials        115      114       -1