feat: Output full URL path in error messages

[ericboucher]

Output actual full path in response_error_message instead of "{self.path}"

[codecov]

Codecov Report

Merging #785 (ce6a52e) into main (6fc504b) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #785      +/-   ##
==========================================
+ Coverage   80.28%   80.29%   +0.01%     
==========================================
  Files          34       34              
  Lines        3408     3410       +2     
  Branches      679      679              
==========================================
+ Hits         2736     2738       +2     
  Misses        499      499              
  Partials      173      173              

Impacted Files	Coverage Δ
singer_sdk/streams/rest.py	82.16% <100.00%> (+0.23%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6fc504b...ce6a52e. Read the comment docs.

[edgarrmondragon]

Hi @ericboucher, I'm generally in favor of this change, but do you know if there are any security concerns with logging the formatted path, which may contain contextual information (entity IDs, etc.)?

[ericboucher]

I was thinking about this. I think it's generally fine since it is not logging URL parameters where you could have a token or sensitive data. An option could be to add a line to obfuscate secrets but I am not sure it's necessary.

[edgarrmondragon]

I was thinking about this. I think it's generally fine since it is not logging URL parameters where you could have a token or sensitive data. An option could be to add a line to obfuscate secrets but I am not sure it's necessary.

@ericboucher alright 👍. Can you then just add a note to the method's docstring indicating the cases in which it may be desirable to override the method (e.g. when the URL path contains secrets or PII)? That'll render in the docs page.

[edgarrmondragon]

@ericboucher lgtm, thanks!