[Reporting] Refactor error messages with human-friendly version of message

[jloleysens]

Summary

Adds a new method to ReportingError to retrieve the human-friendly version of an error message. Currently the code for doing this is a bit convoluted and this refactor attempts to make this functionality more explicit and simpler.

[elasticmachine]

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

[kellyemurphy]

Some small text changes and a couple questions.

When we write error messages, it's helpful to let the users know what to do to solve the issue.

[dokmic]

I am just curious why you decided not to go with the built-in toString() method? That seems like it can very well fit into our use case.

[jloleysens]

Good question!

In most cases on the server-side we will be using the default toString behaviour. But when storing this as a message on the Reporting document (where it is seen by users) sometimes we want to have a special human-friendlier version of the stringified error. Does that make sense? Is there another way to achieve this? Perhaps toString('humanFriendly')?

[dokmic]

Thanks, @jloleysens. That makes total sense now 👍

No need to overcomplicate this. The current solution is clear enough.

[jloleysens]

@elasticmachine merge upstream

[dokmic]

LGTM 👍

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 5c8ed5d
• Storybooks Preview

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
reporting	42.5KB	42.4KB	-144.0B

History

• 💚 Build #58128 succeeded a397d5d

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream