[19.0][IMP] mail_tracking: Add email score search functionality (fw port)

mail_tracking/README.rst

@@ -179,6 +179,10 @@ Contributors
 
   - Quoc Pham Ngoc
 
+- `Onestein <https://onestein.nl>`__:
+
+  - Dennis Sluijk
+
 Other credits
 -------------
 

mail_tracking/models/res_partner.py

@@ -23,7 +23,37 @@ class ResPartner(models.Model):
     tracking_emails_count = fields.Integer(
         compute="_compute_email_score_and_count", readonly=True
     )
-    email_score = fields.Float(compute="_compute_email_score_and_count", readonly=True)
+    email_score = fields.Float(
+        compute="_compute_email_score_and_count",
+        search="_search_email_score",
+    )
+
+    def _search_email_score(self, operator, value):
+        supported_operators = ["<", ">", "<=", ">=", "=", "!="]
+        if operator not in supported_operators:
+            raise NotImplementedError()
+        weights = self.env["mail.tracking.email"]._email_score_weights()
+        case_expr = " ".join(
+            f"WHEN '{state}' THEN {score}" for state, score in weights.items()
+        )
+        state_expr = f"CASE state {case_expr} ELSE 0.0 END"
+        query = f"""
+            SELECT partner.id
+            FROM res_partner partner
+            LEFT JOIN (
+                SELECT recipient_address,
+                GREATEST(0.0, LEAST(100.0,
+                    50.0 + SUM({state_expr})
+                )) AS score
+                FROM mail_tracking_email
+                WHERE recipient_address IS NOT NULL
+                GROUP BY recipient_address
+            ) mte ON mte.recipient_address = LOWER(partner.email)
+            WHERE COALESCE(mte.score, 50.0) {operator} %s
+        """
+        self.env.cr.execute(query, (value,))
+        partner_ids = [row[0] for row in self.env.cr.fetchall()]
+        return [("id", "in", partner_ids)]
 
     @api.depends("email")
     def _compute_email_score_and_count(self):

mail_tracking/readme/CONTRIBUTORS.md

@@ -13,3 +13,5 @@
   - Tris Doan
 - [Komit](https://komit-consulting.com):
   - Quoc Pham Ngoc
+- [Onestein](https://onestein.nl):
+  - Dennis Sluijk

mail_tracking/static/description/index.html

@@ -505,6 +505,10 @@ <h3><a class="toc-backref" href="#toc-entry-8">Contributors</a></h3>
 <li>Quoc Pham Ngoc</li>
 </ul>
 </li>
+<li><a class="reference external" href="https://onestein.nl">Onestein</a>:<ul>
+<li>Dennis Sluijk</li>
+</ul>
+</li>
 </ul>
 </div>
 <div class="section" id="other-credits">

mail_tracking/tests/test_mail_tracking.py

@@ -53,6 +53,13 @@ def setUp(self, *args, **kwargs):
         self.recipient = self.env["res.partner"].create(
             {"name": "Test recipient", "email": "recipient@example.com"}
         )
+        self.recipient_1 = self.env["res.partner"].create(
+            {"name": "Test recipient 1", "email": "recipient1@example.com"}
+        )
+        self.recipient_2 = self.env["res.partner"].create(
+            {"name": "Test recipient 2", "email": "recipient2@example.com"}
+        )
+        self.recipients = self.recipient + self.recipient_1 + self.recipient_2
         self.last_request = None
         if self.patch_http_request:
             self.last_request = http.request
@@ -811,6 +818,54 @@ def test_partner_email_change(self):
         self.assertEqual(orig_score, self.recipient.email_score)
         self.assertEqual(orig_count, self.recipient.tracking_emails_count)
 
+    def test_search_on_email_score(self):
+        recipients_domain = [("id", "in", self.recipients.ids)]
+        mail, tracking = self.mail_send(self.recipient.email)
+        tracking.event_create("open", {})
+        mail, tracking = self.mail_send(self.recipient.email)
+        tracking.event_create("open", {})
+        mail, tracking = self.mail_send(self.recipient_1.email)
+        tracking.event_create("reject", {})
+        # Ensure the email_score is correctly computed for the 3 partners of the test
+        self.assertEqual(60.0, self.recipient.email_score)
+        self.assertEqual(25.0, self.recipient_1.email_score)
+        self.assertEqual(50.0, self.recipient_2.email_score)
+        # Search for email_score > 50
+        result = self.env["res.partner"].search(
+            recipients_domain + [("email_score", ">", 50)]
+        )
+        self.assertEqual(result, self.recipient)
+        # Search for email_score < 30
+        result = self.env["res.partner"].search(
+            recipients_domain + [("email_score", "<", 30)]
+        )
+        self.assertEqual(result, self.recipient_1)
+        # Search for email_score = 50
+        result = self.env["res.partner"].search(
+            recipients_domain + [("email_score", "=", 50)]
+        )
+        self.assertEqual(result, self.recipient_2)
+        # Search for email_score >= 50
+        result = self.env["res.partner"].search(
+            recipients_domain + [("email_score", ">=", 50)]
+        )
+        self.assertEqual(result, self.recipient + self.recipient_2)
+        # Search for email_score <= 50
+        result = self.env["res.partner"].search(
+            recipients_domain + [("email_score", "<=", 50)]
+        )
+        self.assertEqual(result, self.recipient_1 + self.recipient_2)
+        # Search for email_score != 50
+        result = self.env["res.partner"].search(
+            recipients_domain + [("email_score", "!=", 50)]
+        )
+        self.assertEqual(result, self.recipient + self.recipient_1)
+        # Search for email_score between 30 and 65
+        result = self.env["res.partner"].search(
+            recipients_domain + [("email_score", ">", 30), ("email_score", "<", 65)]
+        )
+        self.assertEqual(result, self.recipient + self.recipient_2)
+
     def test_process_hard_bounce(self):
         mail, tracking = self.mail_send(self.recipient.email)
         tracking.event_create("hard_bounce", {})