feat(crm): add invoice list search

Make CRM invoice lists searchable by invoice number, customer details, and line items so staff can find invoices faster.

Author: nijel

weblate_web/crm/forms.py

@@ -48,7 +48,7 @@ def clean(self):
         return self.cleaned_data
 
 
-class CustomerSearchForm(forms.Form):
+class CRMSearchForm(forms.Form):
     q = forms.CharField(
         label=gettext_lazy("Search"),
         required=False,

weblate_web/crm/templates/invoices/invoice_list.html

@@ -3,6 +3,8 @@
 {% load i18n %}
 
 {% block content %}
+  {% include "crm/snippets/search_form.html" %}
+
   <section class="crm-section">
     {% translate "Invoice list" as table_title %}
     {% include "crm/snippets/section_header.html" with section_title=table_title only %}

weblate_web/crm/tests.py

@@ -221,6 +221,117 @@ def test_transient_vies_interactions_are_deleted(self) -> None:
         )
 
 
+class CRMInvoiceSearchTestCase(BaseCRMTestCase):
+    user: User
+
+    def setUp(self):
+        self.user = User.objects.create_superuser(
+            username="admin", email="admin@example.com"
+        )
+        self.client.force_login(self.user)
+
+    def create_search_invoice(
+        self,
+        *,
+        customer_name: str,
+        description: str,
+        customer_email: str = "",
+        kind: InvoiceKind = InvoiceKind.INVOICE,
+    ) -> Invoice:
+        customer = self.create_customer(customer_name)
+        if customer_email:
+            customer.email = customer_email
+            customer.save(update_fields=["email"])
+        invoice = Invoice.objects.create(
+            kind=kind,
+            category=InvoiceCategory.HOSTING,
+            customer=customer,
+            currency=Currency.EUR,
+        )
+        invoice.invoiceitem_set.create(
+            description=description, quantity=1, unit_price=Decimal(100)
+        )
+        invoice.refresh_from_db()
+        return invoice
+
+    def test_invoice_search(self):
+        invoice = self.create_search_invoice(
+            customer_name="Acme Search Customer",
+            customer_email="billing-search@example.com",
+            description="Hosted invoice search item",
+        )
+        other_invoice = self.create_search_invoice(
+            customer_name="Other Customer",
+            customer_email="other@example.com",
+            description="Consulting invoice item",
+        )
+
+        list_url = reverse("crm:invoice-list", kwargs={"kind": "all"})
+        response = self.client.get(list_url)
+        self.assertContains(response, invoice.number)
+        self.assertContains(response, other_invoice.number)
+        self.assertContains(response, 'type="search"')
+
+        searches = (
+            invoice.number,
+            "acme search",
+            "billing-search@example.com",
+            "hosted invoice search",
+        )
+        for query in searches:
+            with self.subTest(query=query):
+                response = self.client.get(list_url, {"q": query})
+
+                self.assertEqual(response.context["query"], query)
+                self.assertContains(response, invoice.number)
+                self.assertNotContains(response, other_invoice.number)
+
+    def test_invoice_search_deduplicates_line_item_matches(self):
+        invoice = self.create_search_invoice(
+            customer_name="Repeated Item Customer",
+            description="Repeated support item",
+        )
+        invoice.invoiceitem_set.create(
+            description="Repeated support item follow-up",
+            quantity=1,
+            unit_price=Decimal(50),
+        )
+
+        response = self.client.get(
+            reverse("crm:invoice-list", kwargs={"kind": "all"}),
+            {"q": "Repeated support item"},
+        )
+
+        self.assertContains(response, invoice.number, count=1)
+
+    def test_invoice_search_keeps_kind_filter(self):
+        invoice = self.create_search_invoice(
+            customer_name="Shared Search Customer",
+            description="Shared search invoice",
+        )
+        quote = self.create_search_invoice(
+            customer_name="Shared Search Customer",
+            description="Shared search quote",
+            kind=InvoiceKind.QUOTE,
+        )
+
+        response = self.client.get(
+            reverse("crm:invoice-list", kwargs={"kind": "quote"}),
+            {"q": "Shared Search Customer"},
+        )
+
+        self.assertContains(response, quote.number)
+        self.assertNotContains(response, invoice.number)
+
+        response = self.client.get(
+            reverse("crm:invoice-list", kwargs={"kind": "invoice"}),
+            {"q": "Shared Search Customer"},
+        )
+
+        self.assertContains(response, invoice.number)
+        self.assertNotContains(response, quote.number)
+
+
 class CRMTestCase(BaseCRMTestCase):
     user: User
 

weblate_web/crm/views.py

@@ -39,8 +39,8 @@
 from django.views.generic import DetailView, ListView, TemplateView
 
 from weblate_web.crm.forms import (
+    CRMSearchForm,
     CustomerMergeForm,
-    CustomerSearchForm,
     CustomerUserForm,
     InvoiceConfirmationForm,
     ManualInteractionForm,
@@ -340,6 +340,7 @@ class InvoiceListView(CRMMixin, ListView[Invoice]):  # type: ignore[misc]
     permission = "invoices.view_invoice"
     title = "Invoices"
     paginate_by = 100
+    _search_form: CRMSearchForm | None = None
 
     def get_title(self) -> str:
         match self.kwargs["kind"]:
@@ -353,22 +354,45 @@ def get_title(self) -> str:
                 return "Invoices"
         raise ValueError(self.kwargs["kind"])
 
+    def get_search_form(self) -> CRMSearchForm:
+        if self._search_form is None:
+            self._search_form = CRMSearchForm(self.request.GET)
+        return self._search_form
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)  # type:ignore[misc]
+        search_form = self.get_search_form()
+        context["search_form"] = search_form
+        context["query"] = search_form["q"].value() or ""
+        return context
+
     def get_queryset(self):
         qs = super().get_queryset().order_by("-number")
         match self.kwargs["kind"]:
             case "unpaid":
-                return qs.filter(
+                qs = qs.filter(
                     Q(paid_payment_set__state__in={Payment.NEW, Payment.PENDING})
                     | Q(paid_payment_set=None),
                     kind=InvoiceKind.INVOICE,
                 )
             case "quote":
-                return qs.filter(kind=InvoiceKind.QUOTE)
+                qs = qs.filter(kind=InvoiceKind.QUOTE)
             case "invoice":
-                return qs.filter(kind=InvoiceKind.INVOICE)
+                qs = qs.filter(kind=InvoiceKind.INVOICE)
             case "all":
-                return qs
-        raise ValueError(self.kwargs["kind"])
+                pass
+            case _:
+                raise ValueError(self.kwargs["kind"])
+
+        search_form = self.get_search_form()
+        if search_form.is_valid() and (query := search_form.cleaned_data["q"]):
+            qs = qs.filter(
+                Q(number__icontains=query)
+                | Q(customer__name__icontains=query)
+                | Q(customer__email__icontains=query)
+                | Q(invoiceitem__description__icontains=query)
+            ).distinct()
+        return qs
 
 
 class InvoiceDetailView(CRMMixin, DetailView[Invoice]):  # type: ignore[misc]
@@ -510,7 +534,7 @@ class CustomerListView(CRMMixin, ListView[Customer]):  # type: ignore[misc]
     permission = "payments.view_customer"
     title = "Customers"
     paginate_by = 100
-    _search_form: CustomerSearchForm | None = None
+    _search_form: CRMSearchForm | None = None
 
     def get_title(self) -> str:
         match self.kwargs["kind"]:
@@ -520,9 +544,9 @@ def get_title(self) -> str:
                 return "All customers"
         raise ValueError(self.kwargs["kind"])
 
-    def get_search_form(self) -> CustomerSearchForm:
+    def get_search_form(self) -> CRMSearchForm:
         if self._search_form is None:
-            self._search_form = CustomerSearchForm(self.request.GET)
+            self._search_form = CRMSearchForm(self.request.GET)
         return self._search_form
 
     def get_context_data(self, **kwargs):