Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

18.0 mig mail tracking mailgun #1603

Open
wants to merge 53 commits into
base: 18.0
Choose a base branch
from

Conversation

youelEl
Copy link

@youelEl youelEl commented Feb 24, 2025

No description provided.

antespi and others added 30 commits February 24, 2025 14:38
…ent events (OCA#82)

[IMP] mail_tracking: Speed installation time, discard concurrent events and other fixes
Both Carlos and me have work a lot in this module, maybe not coding but much testing and definition in usability
When this method is called without an event (a.k.a. `event=None`), this method produces the following error:

```
Traceback (most recent call last):
  File "/opt/odoo/auto/addons/mail/models/mail_mail.py", line 278, in send
    res = IrMailServer.send_email(msg, mail_server_id=mail.mail_server_id.id)
  File "/opt/odoo/auto/addons/mail_tracking/models/ir_mail_server.py", line 88, in send_email
    tracking_email.smtp_error(self, smtp_server_used, e)
  File "/opt/odoo/auto/addons/mail_tracking/models/mail_tracking_email.py", line 213, in smtp_error
    self.sudo()._partners_email_bounced_set('error')
  File "/opt/odoo/auto/addons/mail_tracking/models/mail_tracking_email.py", line 203, in
_partners_email_bounced_set
    ]).email_bounced_set(self, reason, event=event)
  File "/opt/odoo/auto/addons/mail_tracking_mailgun/models/res_partner.py", line 22, in
email_bounced_set
    self._email_bounced_set(reason, event)
  File "/opt/odoo/auto/addons/mail_tracking_mailgun/models/res_partner.py", line 33, in
_email_bounced_set
    event['Message-Id'] or '') TypeError: 'NoneType' object has no attribute '__getitem__'
```

So, we now assume we do not always have an event.
- Configurable partner email auto check.
Currently translated at 16.7% (4 of 24 strings)

Translation: social-11.0/social-11.0-mail_tracking_mailgun
Translate-URL: https://translation.odoo-community.org/projects/social-11-0/social-11-0-mail_tracking_mailgun/fr/
- In case the sending domain is different from the one configured in the
mail.domain.catchall setting.
Currently translated at 95.8% (23 of 24 strings)

Translation: social-12.0/social-12.0-mail_tracking_mailgun
Translate-URL: https://translation.odoo-community.org/projects/social-12-0/social-12-0-mail_tracking_mailgun/pt/
This change let odoo process a state sent from mailgun legacy webhooks
that seems to apply when the message is not sent because the related
email has been mark us as spam or have bounced before. For solve this
add two new states to _mailgun_event_type_mapping_mailgun_event_type_mapping
method:

* failed: Mailgun could not deliver the email to the recipient email server
* rejected: Mailgun rejected the request to send/forward the email

source in https://documentation.mailgun.com/en/latest/quickstart-events.html#events.
Currently translated at 12.5% (3 of 24 strings)

Translation: social-12.0/social-12.0-mail_tracking_mailgun
Translate-URL: https://translation.odoo-community.org/projects/social-12-0/social-12-0-mail_tracking_mailgun/sl/
HviorForgeFlow and others added 22 commits February 24, 2025 14:38
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
Mass mailing are tracked from mail.trace as the don't store a message in
the db. In order to gather the message_id and be able to do manual
checks to mailgun, that's the table where we should get the message id.

TT40816
Since odoo/odoo@9a47101
bouncing the emails through the mailgun controller causes a singleton
error when the anonymous user tries to record the bounce message.

TT44585
Currently translated at 100.0% (60 of 60 strings)

Translation: social-15.0/social-15.0-mail_tracking_mailgun
Translate-URL: https://translation.odoo-community.org/projects/social-15-0/social-15-0-mail_tracking_mailgun/es/
- Fix tests
- Fix warnings
- Improve code
- Get rid of superfluous stuff
- Remove auto-validation. It couldn't be working as it was and it would
  drag performance on contacts creation/write if active.

TT44207
Currently translated at 100.0% (58 of 58 strings)

Translation: social-16.0/social-16.0-mail_tracking_mailgun
Translate-URL: https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_tracking_mailgun/it/
Currently translated at 37.9% (22 of 58 strings)

Translation: social-16.0/social-16.0-mail_tracking_mailgun
Translate-URL: https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_tracking_mailgun/fr/
When we use the same Mailgun domain for other services, the email events
for those services we'll be pushed to the Odoo controller as well. We
want to discard them as they're useless to us.

Aside from that, in the case a wrong db is called to the controller, we
better logging the failed request is going to be more useful than
raising an error.
Updated by "Update PO files to match POT (msgmerge)" hook in Weblate.

Translation: social-17.0/social-17.0-mail_tracking_mailgun
Translate-URL: https://translation.odoo-community.org/projects/social-17-0/social-17-0-mail_tracking_mailgun/
@youelEl youelEl force-pushed the 18.0-mig-mail_tracking_mailgun branch 5 times, most recently from 1c4664e to 230554f Compare February 24, 2025 19:18
@youelEl youelEl force-pushed the 18.0-mig-mail_tracking_mailgun branch from 230554f to a46144a Compare February 24, 2025 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.