Consider Renaming request-id [SPR-15501]

[spring-projects-issues]

Rob Winch opened SPR-15501 and commented

It might be good to rename the request-id header used by WebTestClient to something that is more obviously used for testing purposes only. This will be useful when users see the output of their request / response for failed tests. It will also help users when they google for what it is.

---

Issue Links:

• Use a more descriptive name for WiretapConnector's request ID header [SPR-15574] #20133 Use a more descriptive name for WiretapConnector's request ID header ("is duplicated by")

Referenced from: commits 5ac7955

[spring-projects-issues]

Rossen Stoyanchev commented

Sure, any suggestions or examples if you've seen such from others?

[spring-projects-issues]

Rob Winch commented

Maybe something like webtestclient-trace-id ?

[spring-projects-issues]

Rossen Stoyanchev commented

"webtestclient" also seems rather general (matches on .net and android) but this is unlikely to come up in the context of a production server. Most likely someone may wonder what that header is and seeing "webtestclient" in the context of using the WebTestClient answers it immediately.

[spring-projects-issues]

Rob Winch commented

Another option that I considered was to be slightly more verbose and use spring-webtestclient-trace-id.

For what it's worth...I really like webtestclient (I'm not particular on the case so WebTestClient would also be fine to me) in the name because as you mentioned it should help the user to relate to the WebTestClient that they are using.

[spring-projects-issues]

Rob Winch commented

Thanks for the quick changes!