Add logging for payment failures during checkout

Now that ✨ Add logging for payment failures during checkout Fixed is in... Let's work on logging payment failures.

Let's reboot the work here taking into account the comment from Ryan ( https://www.drupal.org/project/commerce/issues/2845321#comment-14446796 ✨ Add payment logging to orders Fixed ) as a reference.

@tBKoT: This is a good start, but I believe we need to dispatch the event for manual gateways, and potentially for offsite gateways too? Also I noticed we only dispatch the event for decline exceptions. WHat about regular payment gateway exceptions?
Also, you should get the order from route match right before you need it, not straight from the constructor as this could cause issues.

For exceptions throwns by form plugins, we should catch them from PaymentGatewayForm::submitInlineForm().

Hiding the files as we've got an MR.

Discussed splitting this issue into 2 parts with @jsacksick - one issue to add the event and then another issue to concentrate on what data we add to commerce logging. This several benefits:

• We could get the non-controversial part in - any payment gateway exception will trigger an event.
• Contrib modules can use this event to record data in their own fashion
• We have an issue concentrating on what data we’re going to add to commerce_log. Getting this right is important because it would allow contrib modules to get historic data is commerce log was enabled before them.
• It would result in smaller MRs that are easier to review and rationalise about.

I propose we leave this issue to be about consuming the event and using commerce log and I'll open a new one to add the event. I will credit everyone here on that issue.

Opened ✨ Add an event for payment failures during checkout Needs work

The event issue has merged - thanks @jsacksick. The MR now only contains the logging stuff.

I gave the patch a manual test today, since the log template is also used for manual payments, the log template doesn't seem appropriate but at the same time, there's very little chance that payment gateway exceptions would be thrown from a manual gateway:
Here's the message I got:
Payment request failed at Manual for $10.60.

"Request" sounds like the API request itself failed... Perhaps we should say instead "Payment attempt failure"? Thoughts?

I discussed this with @alexpott on Slack and we agreed on the following template:

<p>Payment failed via <em>{{ gateway }}</em> for {{ amount|commerce_price_format }}{% if method %} using <em>{{ method }}</em>{% endif %}.<br/>Message: {{ error_message }}.{% if remote_id %}<br /> Transaction ID: {{ remote_id }}.{% endif %}</p>

Committed! Thanks everyone!!

@jacksick, do you have plans to do a release any time soon, please?

@Nigel Cunningham: Yes, by the end of the year hopefully.

Automatically closed - issue fixed for 2 weeks with no activity.