Techsystech
/
social
mirror of https://github.com/OCA/social.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[FIX/IMP] mail_tracking_mailgun: finish migration 

- 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
pull/1247/head
David 2023-10-31 16:14:31 +01:00
parent f68e28996b
commit b5e695dc84
9 changed files with 51 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
mail_tracking_mailgun/README.rst
View File

@ -7,7 +7,7 @@ Mail tracking for Mailgun
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:8920907240b8a1e7fceee196aa3c437a5c4ea4864588b43458c13b55d708ea36
!! source digest: sha256:764adcded4764f2ebb3b2834f9c9b9863f66068f3644b44fda6e123607a03092
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@ -63,10 +63,6 @@ To configure this module, you need to:
#. Optionally click *Unregister Mailgun webhooks* and accept.
#. Click *Register Mailgun webhooks*.
You can also config partner email autocheck with this system parameter:
- `mailgun.auto_check_partner_email`: Set it to True.
You can also config timeout for mailgun with this system parameter:
- `mailgun.timeout`: Set it to a number of seconds.

3
mail_tracking_mailgun/controllers/main.py
View File

@ -12,8 +12,9 @@ from odoo import _
from odoo.exceptions import ValidationError
from odoo.http import request, route
from odoo.addons.web.controllers.utils import ensure_db
from ...mail_tracking.controllers import main
from ...web.controllers.main import ensure_db
_logger = logging.getLogger(__name__)

11
mail_tracking_mailgun/models/mail_tracking_email.py
View File

@ -14,6 +14,8 @@ from odoo import _, api, fields, models
from odoo.exceptions import UserError, ValidationError
from odoo.tools import email_split
from ..wizards.res_config_settings import MAILGUN_TIMEOUT
_logger = logging.getLogger(__name__)
MailgunParameters = namedtuple(
@ -201,6 +203,11 @@ class MailTrackingEmail(models.Model):
API Documentation:
https://documentation.mailgun.com/en/latest/api-events.html
"""
timeout = (
self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", MAILGUN_TIMEOUT)
)
api_key, api_url, domain, *__ = self._mailgun_values()
for tracking in self.filtered("message_id"):
message_id = tracking.message_id.replace("<", "").replace(">", "")
@ -217,9 +224,7 @@ class MailTrackingEmail(models.Model):
url,
auth=("api", api_key),
params=params,
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
timeout=timeout,
)
if not res or res.status_code != 200:
raise UserError(_("Couldn't retrieve Mailgun information"))

59
mail_tracking_mailgun/models/res_partner.py
View File

@ -8,9 +8,11 @@ from urllib.parse import urljoin
import requests
from odoo import SUPERUSER_ID, _, api, models
from odoo import SUPERUSER_ID, _, models
from odoo.exceptions import UserError
from ..wizards.res_config_settings import MAILGUN_TIMEOUT
class ResPartner(models.Model):
_inherit = "res.partner"
@ -49,6 +51,11 @@ class ResPartner(models.Model):
https://documentation.mailgun.com/en/latest/api-email-validation.html
"""
params = self.env["mail.tracking.email"]._mailgun_values()
timeout = (
self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", MAILGUN_TIMEOUT)
)
if not params.validation_key:
raise UserError(
_(
@ -61,9 +68,7 @@ class ResPartner(models.Model):
urljoin(params.api_url, "/v3/address/validate"),
auth=("api", params.validation_key),
params={"address": partner.email, "mailbox_verification": True},
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
timeout=timeout,
)
if (
not res
@ -135,13 +140,16 @@ class ResPartner(models.Model):
api_key, api_url, domain, *__ = self.env[
"mail.tracking.email"
]._mailgun_values()
timeout = (
self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", MAILGUN_TIMEOUT)
)
for partner in self:
res = requests.get(
urljoin(api_url, "/v3/%s/bounces/%s" % (domain, partner.email)),
auth=("api", api_key),
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
timeout=timeout,
)
if res.status_code == 200 and not partner.email_bounced:
partner.email_bounced = True
@ -157,14 +165,17 @@ class ResPartner(models.Model):
api_key, api_url, domain, *__ = self.env[
"mail.tracking.email"
]._mailgun_values()
timeout = (
self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", MAILGUN_TIMEOUT)
)
for partner in self:
res = requests.post(
urljoin(api_url, "/v3/%s/bounces" % domain),
auth=("api", api_key),
data={"address": partner.email},
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
timeout=timeout,
)
partner.email_bounced = res.status_code == 200 and not partner.email_bounced
@ -177,32 +188,16 @@ class ResPartner(models.Model):
api_key, api_url, domain, *__ = self.env[
"mail.tracking.email"
]._mailgun_values()
timeout = (
self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", MAILGUN_TIMEOUT)
)
for partner in self:
res = requests.delete(
urljoin(api_url, "/v3/%s/bounces/%s" % (domain, partner.email)),
auth=("api", api_key),
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
timeout=timeout,
)
if res.status_code in (200, 404) and partner.email_bounced:
partner.email_bounced = False
def _autocheck_partner_email(self):
for partner in self:
partner.with_context(mailgun_auto_check=True).check_email_validity()
@api.model
def create(self, vals):
if "email" in vals and self.env["ir.config_parameter"].sudo().get_param(
"mailgun.auto_check_partner_email"
):
self._autocheck_partner_email()
return super().create(vals)
def write(self, vals):
if "email" in vals and self.env["ir.config_parameter"].sudo().get_param(
"mailgun.auto_check_partner_email"
):
self._autocheck_partner_email()
return super().write(vals)

4
mail_tracking_mailgun/readme/CONFIGURE.rst
View File

@ -7,10 +7,6 @@ To configure this module, you need to:
#. Optionally click *Unregister Mailgun webhooks* and accept.
#. Click *Register Mailgun webhooks*.
You can also config partner email autocheck with this system parameter:
- `mailgun.auto_check_partner_email`: Set it to True.
You can also config timeout for mailgun with this system parameter:
- `mailgun.timeout`: Set it to a number of seconds.

6
mail_tracking_mailgun/static/description/index.html
View File

@ -367,7 +367,7 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:8920907240b8a1e7fceee196aa3c437a5c4ea4864588b43458c13b55d708ea36
!! source digest: sha256:764adcded4764f2ebb3b2834f9c9b9863f66068f3644b44fda6e123607a03092
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/social/tree/16.0/mail_tracking_mailgun"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_tracking_mailgun"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/social&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module integrates mail_tracking events with Mailgun webhooks.</p>
@ -415,10 +415,6 @@ you need to add <tt class="docutils literal">mail_tracking_mailgun</tt> addon to
<li>Optionally click <em>Unregister Mailgun webhooks</em> and accept.</li>
<li>Click <em>Register Mailgun webhooks</em>.</li>
</ol>
<p>You can also config partner email autocheck with this system parameter:</p>
<ul class="simple">
<li><cite>mailgun.auto_check_partner_email</cite>: Set it to True.</li>
</ul>
<p>You can also config timeout for mailgun with this system parameter:</p>
<ul class="simple">
<li><cite>mailgun.timeout</cite>: Set it to a number of seconds.</li>

19
mail_tracking_mailgun/tests/test_mailgun.py
View File

@ -4,8 +4,8 @@
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from contextlib import contextmanager, suppress
from unittest.mock import patch
import mock
from freezegun import freeze_time
from werkzeug.exceptions import NotAcceptable
@ -58,7 +58,6 @@ class TestMailgun(TransactionCase):
cf.mail_tracking_mailgun_validation_key
) = "key-12345678901234567890123456789012"
cf.mail_tracking_mailgun_domain = False
cf.mail_tracking_mailgun_auto_check_partner_emails = False
config = cf.save()
# Done this way as `hr_expense` adds this field again as readonly, and thus Form
# doesn't process it correctly
@ -111,7 +110,7 @@ class TestMailgun(TransactionCase):
# Imitate Mailgun JSON request
mock = MockRequest(self.env)
with mock as request:
request.jsonrequest = {
request.dispatcher.jsonrequest = {
"signature": {
"timestamp": self.timestamp,
"token": self.token,
@ -368,7 +367,7 @@ class TestMailgun(TransactionCase):
self.assertEqual(event.error_description, reason)
self.assertEqual(event.error_details, description)
@mock.patch(_packagepath + ".models.res_partner.requests")
@patch(f"{_packagepath}.models.res_partner.requests")
def test_email_validity(self, mock_request):
self.partner.email_bounced = False
mock_request.get.return_value.apparent_encoding = "ascii"
@ -377,10 +376,6 @@ class TestMailgun(TransactionCase):
"is_valid": True,
"mailbox_verification": "true",
}
# Trigger email auto validation in partner
self.env["ir.config_parameter"].set_param(
"mailgun.auto_check_partner_email", "True"
)
self.partner.email = "info@tecnativa.com"
self.assertFalse(self.partner.email_bounced)
self.partner.email = "xoxoxoxo@tecnativa.com"
@ -409,7 +404,7 @@ class TestMailgun(TransactionCase):
with self.assertRaises(UserError):
self.partner.check_email_validity()
@mock.patch(_packagepath + ".models.res_partner.requests")
@patch(f"{_packagepath}.models.res_partner.requests")
def test_email_validity_exceptions(self, mock_request):
mock_request.get.return_value.status_code = 404
with self.assertRaises(UserError):
@ -418,7 +413,7 @@ class TestMailgun(TransactionCase):
with self.assertRaises(UserError):
self.partner.check_email_validity()
@mock.patch(_packagepath + ".models.res_partner.requests")
@patch(f"{_packagepath}.models.res_partner.requests")
def test_bounced(self, mock_request):
self.partner.email_bounced = True
mock_request.get.return_value.status_code = 404
@ -440,7 +435,7 @@ class TestMailgun(TransactionCase):
self.partner._email_bounced_set("test_error", False)
self.assertEqual(len(self.partner.message_ids), message_number)
@mock.patch(_packagepath + ".models.mail_tracking_email.requests")
@patch(f"{_packagepath}.models.mail_tracking_email.requests")
def test_manual_check(self, mock_request):
mock_request.get.return_value.json.return_value = self.response
mock_request.get.return_value.status_code = 200
@ -451,7 +446,7 @@ class TestMailgun(TransactionCase):
self.assertTrue(event)
self.assertEqual(event.event_type, self.response["items"][0]["event"])
@mock.patch(_packagepath + ".models.mail_tracking_email.requests")
@patch(f"{_packagepath}.models.mail_tracking_email.requests")
def test_manual_check_exceptions(self, mock_request):
mock_request.get.return_value.status_code = 404
with self.assertRaises(UserError):

13
mail_tracking_mailgun/wizards/res_config_settings.py
View File

@ -19,6 +19,8 @@ WEBHOOK_EVENTS = (
"temporary_fail",
"unsubscribed",
)
# Default Mailgun timeout when no parameter is set
MAILGUN_TIMEOUT = 10
class ResConfigSettings(models.TransientModel):
@ -61,11 +63,6 @@ class ResConfigSettings(models.TransientModel):
config_parameter="mailgun.webhooks_domain",
help="Leave empty to use the base Odoo URL.",
)
mail_tracking_mailgun_auto_check_partner_emails = fields.Boolean(
string="Check partner emails automatically",
config_parameter="mailgun.auto_check_partner_email",
help="Attempt to check partner emails always. This may cost money.",
)
def get_values(self):
"""Is Mailgun enabled?"""
@ -84,7 +81,7 @@ class ResConfigSettings(models.TransientModel):
auth=("api", params.api_key),
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
.get_param("mailgun.timeout", MAILGUN_TIMEOUT),
)
webhooks.raise_for_status()
for event, data in webhooks.json()["webhooks"].items():
@ -105,7 +102,7 @@ class ResConfigSettings(models.TransientModel):
auth=("api", params.api_key),
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
.get_param("mailgun.timeout", MAILGUN_TIMEOUT),
)
response.raise_for_status()
@ -124,7 +121,7 @@ class ResConfigSettings(models.TransientModel):
data={"id": event, "url": [odoo_webhook]},
timeout=self.env["ir.config_parameter"]
.sudo()
.get_param("mailgun.timeout", 10),
.get_param("mailgun.timeout", MAILGUN_TIMEOUT),
)
# Assert correct registration
response.raise_for_status()

11
mail_tracking_mailgun/wizards/res_config_settings_views.xml
View File

@ -65,7 +65,6 @@
name="mail_tracking_mailgun_validation_key"
password="True"
placeholder="pubkey-abcde0123456789abcde0123456789ab"
attrs="{'required': [('mail_tracking_mailgun_auto_check_partner_emails', '=', True)]}"
/>
</div>
</div>
@ -73,16 +72,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"