Allow the locale to be altered when API requests are made

vmarchuk → made their first commit to this issue’s fork.

Opened MR with fixes.

Committed!

I think the getter was previously correct to return exactly what was in the configuration. That is indeed the default.

The altering of the locale should happen at the point the JavaScript setting for the Affirm locale is being set. I see you opted for the event based approach, which is fine vs. an alter, though I think an alter would've been sufficient. Let's move that event dispatch to commerce_affirm_preprocess() and commerce_affirm_page_attachments() instead, though.

@rszrama

We also need to alter the settings in RedirectForm::buildConfigurationForm() so we need to use the event dispatcher in 3 places, but the idea was to use it in one place (as long as possible).
Perhaps it would be better:

• Use hook_js_settings_alter() and add an event dispatcher there. But here we can't pass the payment gateway settings to the event.
• Define a new method in the Redirect payment gateway getLocale() and add an event dispatcher there.

What do you think?

@vmarchuk, I like your second option: if we'll always have the payment gateway object in the context where we're determining the locale, let's add getLocale() with the event dispatcher. This will preserve the idea that the gateway configuration stores the default and then it can optionally be overridden at the point of display.

@rszrama

MR is ready https://git.drupalcode.org/project/commerce_affirm/-/merge_requests/10
Feel free to merge it and tag a new release.

Sorry to send it back, but in order to be consistent with the Affirm API, we need to revise this MR one last time:

1. Use $locale instead of $default_locale as the variable name in getLocale().
2. Rename the alteration event to AffirmEvents::AFFIRM_LOCALE.
3. Use Locale instead of DefaultLocale as the property name in the JS settings array.

Basically, "default locale" is a concept specific to our local payment gateway configuration. When we prepare the parameter to send it to Affirm, we should just be using "locale".

@rszrama

I updated MR https://git.drupalcode.org/project/commerce_affirm/-/merge_requests/10/d...
I also renamed the event to AFFIRM_LOCALE_PRESEND to make it clearer what it does + added related changes to the AffirmLocalePreSendEvent

Ahh, I see. I understand the intent behind the name, but I'm going to change it back to keep it in line with our various alter events in Commerce Core, e.g., OrderEvents::ORDER_LABEL replacing a hook_commerce_order_label_alter(). Merging now and will roll that release!

Committed.

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