Change name/symbol of custom RaiseError class

[ryan-mcneil]

Summary

• In preparation for monkeypatching the Faraday gem, in which we are changing the default value of the Faraday::Response::RaiseError option include_request to false, we need to Change the name of the custom RaiseError class for a couple of reasons:

• By having our RaiseError class registered as :raise_error, it can be confusing for devs as that is the syntax for the Faraday::Response::RaiseError class. In some cases our custom class has clearly been confused for the standard
• In many cases we use BOTH RaiseError classes (which I think is problematic, but will be tackled later):

          conn.use Faraday::Response::RaiseError
          conn.response :raise_error, error_prefix: service_name

To be able to use some of the extended options of the Faraday class (include_request and potential future options), we need to change from the explicit (former) to the more concise (latter) syntax. With the current custom class's naming convention, these would conflict. This will allow us to do something like the following, when necessary:

          conn.response :raise_error, include_request: true
          conn.response :raise_custom_va_error, error_prefix: service_name

Related issue(s)

• Monkeypatch Faraday::Response::RaiseError to change default behavior va.gov-team#84394
• https://github.com/department-of-veterans-affairs/va.gov-team-sensitive/issues/1658

Testing done

• Test suite is passing after class change

What areas of the site does it impact?

• Affects use of middleware going forward. Included documentation is updated, and a message will be sent out to #vfs-all-teams

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: lib/common/client/middleware/response/raise_custom_va_error.rb

[ryan-mcneil]

@kjduensing I'm including you (as a data point, not to cast blame) as an example of why this poorly named class is confusing. Can I assume that when I next update the default value of include_request to false, you'll want me to add raise_error, include_request: true to the new chain? I'll keep you in the loop on that PR.

Note: To be clear, the current inclusion of include_request: true, isn't actually doing anything, as it's a default option of the Faraday class, not our class

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: lib/common/client/configuration/rest.rb

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: lib/common/client/middleware/response/raise_custom_va_error.rb

[rmtolmach]

Name changes LGTM. After deploy, are you able to validate that this is working as designed? Check Datadog logs or something?