IBX-8784: Added AbstractExceptionVisitor template to allow fine-grained control of output

[Steveb-p]

🎫 Issue	IBX-8784

Description:

This PR enables child Exception visitors to more easily control exception message and description presented by REST endpoints.

For QA:

Documentation:

[alongosz]

What's an example response after the change?

[Steveb-p]

What's an example response after the change?

No changes for the built-in exceptions. It's used as a template visitor for external packages to re-use code for error handling data shape.

What I consider currently:

• Extract parts of this class into an abstract template, and move it into Contracts
• Current visitor design does not work for interfaces (only concrete classes) which limits external use a bit.

I'll provide a separate PR for relevant package in a few hours.

[alongosz]

What's an example response after the change?

No changes for the built-in exceptions. It's used as a template visitor for external packages to re-use code for error handling data shape.

What I consider currently:

• Extract parts of this class into an abstract template, and move it into Contracts
• Current visitor design does not work for interfaces (only concrete classes) which limits external use a bit.

I'll provide a separate PR for relevant package in a few hours.

Ok. +1 for now. I think when I see usage it will be more clear to me. Do you think this approach should replace #63 or is it rather more about "how" to display specific exception instead of translating one exception into another?

[Steveb-p]

@alongosz

Do you think this approach should replace #63 or is it rather more about "how" to display specific exception instead of translating one exception into another?

This PR doesn't change anything related to REST / pure API object handling.

As for the mapping provided by #63, I don't think it's the responsibility of the service that provides the response. As you noted, we have different practices within the same package.

The only reason you provide this mapping is because there is a chance that REST endpoint will forget to map it itself. So I'd just put your solution as a separate event listener with higher priority. This way it would have a separate purpose and clean responsibility.

Substantial changes to PR code

[sonarcloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

Substantial changes to PR code

[sonarcloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud