Yaltik/social
2
0
Fork 0
Code Pull Requests Releases Activity
0dea354601
social/mail_tracking_mailgun/wizards/res_config_settings_views.xml

146 lines
8.3 KiB
XML
Raw Normal View History

[IMP] mail_tracking_mailgun: refactor to support modern webhooks Before this patch, the module was designed after the [deprecated Mailgun webhooks][3]. However Mailgun had the [events API][2] which was quite different. Modern Mailgun has deprecated those webhooks and instead uses new ones that include the same payload as the events API, so you can reuse code. However, this was incorrectly reusing the code inversely: trying to process the events API through the same code prepared for the deprecated webhooks. Besides, both `failed` and `rejected` mailgun events were mapped to `error` state, but that was also wrong because [`mail_tracking` doesn't have an `error` state][1]. So the logic of the whole module is changed, adapting it to process the events API payload, both through controllers (prepared for the new webhooks) and manual updates that directly call the events API. Also, `rejected` is now translated into `reject`, and `failed` is translated into `hard_bounce` or `soft_bounce` depending on the severity, as specified by [mailgun docs][2]. Also, `bounced` and `dropped` mailgun states are removed because they don't exist, and instead `failed` and `rejected` properly get their metadata. Of course, to know the severity, now the method to obtain that info must change, it' can't be a simple dict anymore. Added more parameters because for example modern Mailgun uses different keys for signing payload than for accessing the API. As there are so many parameters, configuration is now possible through `res.config.settings`. Go there to autoregister webhooks too. Since the new webhooks are completely incompatible with the old supposedly-abstract webhooks controllers (that were never really that abstract), support for old webhooks is removed, and it will be removed in the future from `mail_tracking` directly. There is a migration script that attempts to unregister old webhooks and register new ones automatically. [1]: https://github.com/OCA/social/blob/f73de421e28a43d018176f61725a3a59665f715d/mail_tracking/models/mail_tracking_event.py#L31-L42 [2]: https://documentation.mailgun.com/en/latest/api-events.html#event-types [3]: https://documentation.mailgun.com/en/latest/api-webhooks-deprecated.html
2021-10-28 12:33:59 +02:00
<?xml version="1.0" encoding="utf-8" ?>
<!-- Copyright 2021 Tecnativa - Jairo Llopis
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). -->
<data>
<record id="res_config_settings_view_form" model="ir.ui.view">
<field name="name">res.config.settings.view.form.inherit</field>
<field name="model">res.config.settings</field>
<field name="inherit_id" ref="mail.res_config_settings_view_form" />
<field name="arch" type="xml">
<div id="emails" position="inside">
<div id="mail_tracking_mailgun" class="col-12 o_setting_box">
<div class="o_setting_left_pane">
<field name="mail_tracking_mailgun_enabled" />
</div>
<div class="o_setting_right_pane">
<label for="mail_tracking_mailgun_enabled" />
<div class="text-muted">
Connecting Odoo with <a
href="https://www.mailgun.com/"
target="_blank"
>Mailgun</a> enhances Odoo's mail tracking features.
</div>
<div
class="content-group"
attrs="{'invisible': [('mail_tracking_mailgun_enabled', '=', False)]}"
>
<div class="row">
<div class="col-12 col-lg-6">
<div class="text-muted mt16 mb4">
Obtain keys in <a
href="https://app.mailgun.com/app/account/security/api_keys"
target="_blank"
>Mailgun &gt; Settings &gt; API keys</a>:
</div>
<div class="row mt16">
<label
for="mail_tracking_mailgun_api_key"
class="col-lg-3 o_light_label"
/>
<field
name="mail_tracking_mailgun_api_key"
password="True"
placeholder="key-abcde0123456789abcde0123456789ab"
attrs="{'required': [('mail_tracking_mailgun_enabled', '=', True)]}"
/>
</div>
<div class="row mt16">
<label
for="mail_tracking_mailgun_webhook_signing_key"
class="col-lg-3 o_light_label"
/>
<field
name="mail_tracking_mailgun_webhook_signing_key"
password="True"
placeholder="abcde0123456789abcde0123456789ab"
/>
</div>
<div class="row mt16">
<label
for="mail_tracking_mailgun_validation_key"
class="col-lg-3 o_light_label"
/>
<field
name="mail_tracking_mailgun_validation_key"
password="True"
placeholder="pubkey-abcde0123456789abcde0123456789ab"
attrs="{'required': [('mail_tracking_mailgun_auto_check_partner_emails', '=', True)]}"
/>
</div>
</div>
<div class="col-12 col-lg-6">
<div class="text-muted mt16 mb4">
Other settings:
</div>
<div class="mt16">
<field
name="mail_tracking_mailgun_auto_check_partner_emails"
class="oe_inline"
/>
<label
for="mail_tracking_mailgun_auto_check_partner_emails"
class="o_light_label"
/>
</div>
<div class="row mt16">
<label
for="mail_tracking_mailgun_domain"
class="col-lg-3 o_light_label"
/>
<field
name="mail_tracking_mailgun_domain"
placeholder="odoo.example.com"
/>
</div>
<div class="row mt16">
<label
for="mail_tracking_mailgun_api_url"
class="col-lg-3 o_light_label"
/>
<field
name="mail_tracking_mailgun_api_url"
placeholder="https://api.mailgun.net"
/>
</div>
<div class="row mt16">
<label
for="mail_tracking_mailgun_webhooks_domain"
class="col-lg-3 o_light_label"
/>
<field
name="mail_tracking_mailgun_webhooks_domain"
placeholder="https://odoo.example.com"
/>
</div>
</div>
<div class="col-12">
<div class="text-muted mt16 mb4">
If you change Mailgun settings, your Odoo URL or your sending domain, unregister webhooks and register them again to get automatic updates about sent emails:
</div>
<button
type="object"
name="mail_tracking_mailgun_unregister_webhooks"
string="Unregister Mailgun webhooks"
icon="fa-arrow-right"
class="btn-link"
confirm="This will unregister ALL webhooks from Mailgun, which can include webhooks for other apps."
/>
<button
type="object"
name="mail_tracking_mailgun_register_webhooks"
string="Register Mailgun webhooks"
icon="fa-arrow-right"
class="btn-link"
/>
</div>
</div>
</div>
</div>
</div>
</div>
</field>
</record>
</data>
Copy Permalink