[REF] sms: refactor message_post using SMS notifications

Purpose of this commit is to better include SMS notifications when posting a
message. SMS is now just another way of notifying people along with Inbox and
email. Following recent mail merge improving notification mechanism [1] we
have to define a _notify_record_by_sms method on mail.thread.

When a message_post is done using message_type being ``sms`` notification type
of customers is set to sms. Customers can be computed on model (generally based
on partner_id field) or directly set usign partner°ids. Notification model is
updated to store this information directly inside the notification itself.

An new ``_message_sms`` helper method is introduced in SMS module allowing
to send messages using sms type and notification with a reduced parameters
number. It is just a shortcut to message_post, easier to use. Either it
computes default recipients on the record set, either it is based on given
partners and numbers to notify.

The following use cases are notably supported

  * default computation: find customer, notify by sms;
  * force recipients to notify by sms (partner_ids);
  * give a set of numbers to notify by sms (sms_nubmers), not necessarily
    linked to existing partners;
  * force number / customer relationship independently of mobile number defined
    on customer (for example when sending an SMS directly from a mobile field
    on a lead linked to a customer);

Tests are updated accordingly. Performance tests are added in order to have
some insights on queries generated when sending SMS, like already done for
mail.thread alone.

Related to task 1922163
Linked to PR #33510

[1] see be2795513644f09f6b443f462bb67cc5a0762e8d: performance and notification code improvements

Co-Authored-By: Thibault Delavallee <tde@odoo.com>
Co-Authored-By: Pierre Rousseau <pro@odoo.com>

1 files changed, 88 insertions, 5 deletions

diff --git a/addons/sms/tests/common.py b/addons/sms/tests/common.py
index 25ca2dfdf7f..7c0c3b5d22a 100644
--- a/addons/sms/tests/common.py
+++ b/addons/sms/tests/common.py
@@ -3,7 +3,8 @@
 from contextlib import contextmanager
 from unittest.mock import patch
 
-from odoo import exceptions
+from odoo import exceptions, tools
+from odoo.addons.phone_validation.tools import phone_validation
 from odoo.tests import common
 from odoo.addons.sms.models.sms_api import SmsApi
 
@@ -54,18 +55,100 @@ class MockSMS(common.BaseCase):
         finally:
             pass
 
+    def _clear_sms_sent(self):
+        self._sms = []
+
     def assertSMSSent(self, numbers, content):
         """ Check sent SMS. Order is not checked. Each number should have received
-        the same content. Usefull to check batch sending.
+        the same content. Useful to check batch sending.
 
         :param numbers: list of numbers;
         :param content: content to check for each number;
         """
-        self.assertEqual(len(self._sms), len(numbers))
         for number in numbers:
             sent_sms = next((sms for sms in self._sms if sms['number'] == number), None)
             self.assertTrue(bool(sent_sms), 'Number %s not found in %s' % (number, repr([s['number'] for s in self._sms])))
             self.assertEqual(sent_sms['body'], content)
 
-    def _clear_sms_sent(self):
-        self._sms = []
+    def assertSMSCanceled(self, partner, number, error_code, content=None):
+        """ Check canceled SMS. Search is done for a pair partner / number where
+        partner can be an empty recordset. """
+        sms = self.env['sms.sms'].sudo().search([
+            ('partner_id', '=', partner.id), ('number', '=', number),
+            ('state', '=', 'canceled')
+        ])
+        self.assertTrue(sms, 'SMS: not found canceled SMS for %s (number: %s)' % (partner, number))
+        self.assertEqual(sms.error_code, error_code)
+        if content is not None:
+            self.assertEqual(sms.body, content)
+
+    def assertSMSFailed(self, partner, number, error_code, content=None):
+        """ Check failed SMS. Search is done for a pair partner / number where
+        partner can be an empty recordset. """
+        sms = self.env['sms.sms'].sudo().search([
+            ('partner_id', '=', partner.id), ('number', '=', number),
+            ('state', '=', 'error')
+        ])
+        self.assertTrue(sms, 'SMS: not found failed SMS for %s (number: %s)' % (partner, number))
+        self.assertEqual(sms.error_code, error_code)
+        if content is not None:
+            self.assertEqual(sms.body, content)
+
+    def assertSMSOutgoing(self, partner, number, content=None):
+        """ Check outgoing SMS. Search is done for a pair partner / number where
+        partner can be an empty recordset. """
+        sms = self.env['sms.sms'].sudo().search([
+            ('partner_id', '=', partner.id), ('number', '=', number),
+            ('state', '=', 'outgoing')
+        ])
+        self.assertTrue(sms, 'SMS: not found failed SMS for %s (number: %s, state)' % (partner, number))
+        if content is not None:
+            self.assertEqual(sms.body, content)
+
+    def assertSMSNotification(self, recipients_info, content, messages=None, check_sms=True):
+        """ Check content of notifications.
+
+          :param recipients_info: list[{
+            'partner': res.partner record (may be empty),
+            'number': number used for notification (may be empty, computed based on partner),
+            'state': ready / sent / exception / canceled (sent by default),
+            'failure_type': optional: sms_number_missing / sms_number_format / sms_credit / sms_server
+            }, { ... }]
+        """
+        partners = self.env['res.partner'].concat(*list(p['partner'] for p in recipients_info if p.get('partner')))
+        numbers = [p['number'] for p in recipients_info if p.get('number')]
+        base_domain = [
+            '|', ('res_partner_id', 'in', partners.ids),
+            '&', ('res_partner_id', '=', False), ('sms_number', 'in', numbers),
+            ('notification_type', '=', 'sms')
+        ]
+        if messages is not None:
+            base_domain += [('mail_message_id', 'in', messages.ids)]
+        notifications = self.env['mail.notification'].search(base_domain)
+
+        self.assertEqual(notifications.mapped('res_partner_id'), partners)
+
+        for recipient_info in recipients_info:
+            partner = recipient_info.get('partner', self.env['res.partner'])
+            number = recipient_info.get('number')
+            state = recipient_info.get('state', 'sent')
+            if number is None and partner:
+                number = phone_validation.phone_get_sanitized_record_number(partner)
+
+            notif = notifications.filtered(lambda n: n.res_partner_id == partner and n.sms_number == number and n.notification_status == state)
+            self.assertTrue(notif, 'SMS: not found notification for %s (number: %s, state: %s)' % (partner, number, state))
+
+            if state not in ('sent', 'ready', 'canceled'):
+                self.assertEqual(notif.failure_type, recipient_info['failure_type'])
+            if check_sms:
+                if state == 'sent':
+                    self.assertSMSSent([number], content)
+                elif state == 'ready':
+                    self.assertSMSOutgoing(partner, number, content)
+                elif state == 'exception':
+                    self.assertSMSFailed(partner, number, recipient_info['failure_type'], content)
+                elif state == 'canceled':
+                    self.assertSMSCanceled(partner, number, recipient_info.get('failure_type', False), content)
+
+        for message in messages:
+            self.assertEqual(content, tools.html2plaintext(message.body).rstrip('\n'))