mirror of
https://github.com/frappe/erpnext.git
synced 2026-08-13 06:31:48 +00:00
refactor(postgres): port call_log link_existing_conversations to the query builder
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -7,6 +7,8 @@ from frappe import _
|
||||
from frappe.contacts.doctype.contact.contact import get_contact_with_phone_number
|
||||
from frappe.core.doctype.dynamic_link.dynamic_link import deduplicate_dynamic_links
|
||||
from frappe.model.document import Document
|
||||
from frappe.query_builder import Case
|
||||
from frappe.query_builder.functions import Sum
|
||||
|
||||
from erpnext.crm.doctype.lead.lead import get_lead_with_phone_number
|
||||
from erpnext.crm.doctype.utils import get_scheduled_employees_for_popup, strip_number
|
||||
@@ -168,22 +170,22 @@ def link_existing_conversations(doc, state):
|
||||
number = strip_number(number)
|
||||
if not number:
|
||||
continue
|
||||
logs = frappe.db.sql_list(
|
||||
"""
|
||||
SELECT cl.name FROM `tabCall Log` cl
|
||||
LEFT JOIN `tabDynamic Link` dl
|
||||
ON cl.name = dl.parent
|
||||
WHERE (cl.`from` like %(phone_number)s or cl.`to` like %(phone_number)s)
|
||||
GROUP BY cl.name
|
||||
HAVING SUM(
|
||||
CASE
|
||||
WHEN dl.link_doctype = %(doctype)s AND dl.link_name = %(docname)s
|
||||
THEN 1
|
||||
ELSE 0
|
||||
END
|
||||
)=0
|
||||
""",
|
||||
dict(phone_number=f"%{number}", docname=doc.name, doctype=doc.doctype),
|
||||
cl = frappe.qb.DocType("Call Log")
|
||||
dl = frappe.qb.DocType("Dynamic Link")
|
||||
logs = (
|
||||
frappe.qb.from_(cl)
|
||||
.left_join(dl)
|
||||
.on(cl.name == dl.parent)
|
||||
.select(cl.name)
|
||||
.where(cl["from"].like(f"%{number}") | cl["to"].like(f"%{number}"))
|
||||
.groupby(cl.name)
|
||||
.having(
|
||||
Sum(
|
||||
Case().when((dl.link_doctype == doc.doctype) & (dl.link_name == doc.name), 1).else_(0)
|
||||
)
|
||||
== 0
|
||||
)
|
||||
.run(pluck=True)
|
||||
)
|
||||
if logs:
|
||||
for log in logs:
|
||||
|
||||
@@ -1,9 +1,112 @@
|
||||
# Copyright (c) 2020, Frappe Technologies Pvt. Ltd. and Contributors
|
||||
# See license.txt
|
||||
# import frappe
|
||||
# Copyright (c) 2024, Frappe Technologies Pvt. Ltd. and Contributors
|
||||
# License: GNU General Public License v3. See license.txt
|
||||
|
||||
import random
|
||||
import string
|
||||
|
||||
import frappe
|
||||
|
||||
from erpnext.telephony.doctype.call_log.call_log import link_existing_conversations
|
||||
from erpnext.tests.utils import ERPNextTestSuite
|
||||
|
||||
|
||||
class TestCallLog(ERPNextTestSuite):
|
||||
pass
|
||||
def setUp(self):
|
||||
# A fresh, unused 8-digit suffix guarantees the controller's before_insert
|
||||
# auto-linking (Contact/Lead lookup) finds nothing, so the only Dynamic Link
|
||||
# rows present are the ones this test creates.
|
||||
self.number = "98" + "".join(random.choices(string.digits, k=8))
|
||||
|
||||
# Two Call Logs that share the same phone number: one via `to`, one via
|
||||
# `from`. Both must be matched by the `from LIKE | to LIKE` predicate, and
|
||||
# the leading "+91" / "0" prefixes exercise strip_number normalisation
|
||||
# (the trailing digits still end with self.number).
|
||||
self.linked_log = self._make_call_log(to=f"+91{self.number}", type="Incoming")
|
||||
self.unlinked_log = self._make_call_log(**{"from": f"0{self.number}", "type": "Outgoing"})
|
||||
|
||||
# The target doc the existing conversations get linked to. A real Contact
|
||||
# (with a name + matching phone) is required so link_existing_conversations
|
||||
# accepts it (doctype == "Contact") and reads doc.phone_nos / doc.name.
|
||||
self.contact = frappe.get_doc(
|
||||
{
|
||||
"doctype": "Contact",
|
||||
"first_name": f"_Test Caller {self.number}",
|
||||
"phone_nos": [{"phone": self.number, "is_primary_phone": 1}],
|
||||
}
|
||||
)
|
||||
# Suppress the Contact's own after_insert auto-link hook during insert, so
|
||||
# the test controls exactly which log is pre-linked (the hook is invoked
|
||||
# explicitly via _run_linker once the fixtures are in place).
|
||||
self.contact.flags.ignore_auto_link_call_log = True
|
||||
self.contact.insert(ignore_permissions=True)
|
||||
|
||||
# Pre-link ONLY one of the two logs to the contact via a Dynamic Link row.
|
||||
# The converted HAVING SUM(CASE ...) == 0 filter must therefore exclude
|
||||
# this log and return the other when link_existing_conversations runs.
|
||||
self._add_link(self.linked_log, "Contact", self.contact.name)
|
||||
|
||||
def _make_call_log(self, **kwargs):
|
||||
doc = frappe.get_doc({"doctype": "Call Log", "id": frappe.generate_hash(length=10), **kwargs})
|
||||
doc.insert(ignore_permissions=True)
|
||||
return doc.name
|
||||
|
||||
def _add_link(self, call_log, link_doctype, link_name):
|
||||
doc = frappe.get_doc("Call Log", call_log)
|
||||
doc.append("links", {"link_doctype": link_doctype, "link_name": link_name})
|
||||
doc.save(ignore_permissions=True)
|
||||
|
||||
def _run_linker(self):
|
||||
# Clear the flag set during insert so the explicit call actually runs the
|
||||
# converted LEFT JOIN / GROUP BY / HAVING query path.
|
||||
self.contact.flags.ignore_auto_link_call_log = False
|
||||
link_existing_conversations(self.contact, "Open")
|
||||
|
||||
def _contact_links_of(self, call_log):
|
||||
return frappe.get_all(
|
||||
"Dynamic Link",
|
||||
filters={"parenttype": "Call Log", "parent": call_log, "link_doctype": "Contact"},
|
||||
fields=["link_name"],
|
||||
pluck="link_name",
|
||||
)
|
||||
|
||||
def test_links_previously_unlinked_log(self):
|
||||
"""The converted query's HAVING == 0 returns the log NOT yet linked to the
|
||||
contact, so link_existing_conversations adds the Contact link to it."""
|
||||
self.assertEqual(self._contact_links_of(self.unlinked_log), [], "precondition")
|
||||
|
||||
self._run_linker()
|
||||
|
||||
self.assertEqual(
|
||||
self._contact_links_of(self.unlinked_log),
|
||||
[self.contact.name],
|
||||
"Previously-unlinked log matching the number must gain the Contact link",
|
||||
)
|
||||
|
||||
def test_already_linked_log_is_not_relinked(self):
|
||||
"""The HAVING SUM(CASE ...) == 0 must EXCLUDE the already-linked log from the returned set,
|
||||
so link_existing_conversations never re-saves it. Asserting only the link count is not enough
|
||||
(validate() -> deduplicate_dynamic_links strips a duplicate either way), so pin the HAVING by
|
||||
asserting the already-linked log was never touched: an excluded log is not in `logs`, so
|
||||
add_link()/save() never runs and its `modified` timestamp is unchanged."""
|
||||
self.assertEqual(self._contact_links_of(self.linked_log), [self.contact.name], "precondition")
|
||||
modified_before = frappe.db.get_value("Call Log", self.linked_log, "modified")
|
||||
|
||||
self._run_linker()
|
||||
|
||||
# Excluded by HAVING -> never re-saved -> modified unchanged. (If HAVING were dropped/inverted
|
||||
# the log would be returned, re-saved, and modified would bump.)
|
||||
self.assertEqual(
|
||||
frappe.db.get_value("Call Log", self.linked_log, "modified"),
|
||||
modified_before,
|
||||
"Already-linked log must be excluded by HAVING and never re-saved",
|
||||
)
|
||||
self.assertEqual(self._contact_links_of(self.linked_log), [self.contact.name])
|
||||
|
||||
def test_log_not_matching_number_is_untouched(self):
|
||||
"""A log whose from/to does not contain the number is excluded by the
|
||||
from/to LIKE predicate and must stay unlinked."""
|
||||
other = self._make_call_log(**{"from": "+919999999999", "to": "+918888888888", "type": "Outgoing"})
|
||||
|
||||
self._run_linker()
|
||||
|
||||
self.assertEqual(self._contact_links_of(other), [], "Log not matching the number must stay unlinked")
|
||||
|
||||
Reference in New Issue
Block a user