Merge pull request #36213 from dimagi/bmb/dc/select-records-mismatch-alert

[Data Cleaning] Show an alert to the user when there are selected records not visible in the current filtered view

Author: biyeun

corehq/apps/data_cleaning/models.py

@@ -254,6 +254,21 @@ def get_queryset(self):
     def get_num_selected_records(self):
         return self.records.filter(is_selected=True).count()
 
+    def get_num_selected_records_in_queryset(self):
+        case_ids = self.records.filter(is_selected=True).values_list(
+            "doc_id", flat=True
+        )
+
+        from corehq.apps.hqwebapp.tables.elasticsearch.tables import ElasticTableData
+
+        num_selected_records = 0
+        for doc_ids in chunked(case_ids, BULK_OPERATION_CHUNK_SIZE, list):
+            num_selected_records += ElasticTableData.get_total_records_in_query(
+                self.get_queryset().case_ids(doc_ids)
+            )
+
+        return num_selected_records
+
     def get_num_edited_records(self):
         return self.records.filter(changes__isnull=False).count()
 

corehq/apps/data_cleaning/tables.py

@@ -1,3 +1,5 @@
+from memoized import memoized
+
 from django.utils.translation import gettext_lazy
 from django_tables2 import columns, tables
 
@@ -65,13 +67,33 @@ def get_columns_from_session(cls, session):
         return visible_columns
 
     @property
+    @memoized
+    def has_any_filtering(self):
+        """
+        Return whether any filtering is applied to the session.
+        """
+        return self.session.has_any_filtering
+
+    @property
+    @memoized
     def num_selected_records(self):
         """
         Return the number of selected records in the session.
         """
         return self.session.get_num_selected_records()
 
     @property
+    @memoized
+    def num_visible_selected_records(self):
+        """
+        Return the number of selected records visible with the current set of filters.
+        """
+        if self.has_any_filtering:
+            return self.session.get_num_selected_records_in_queryset()
+        return self.num_selected_records
+
+    @property
+    @memoized
     def num_edited_records(self):
         """
         Return the number of edited records in the session.

corehq/apps/data_cleaning/templates/data_cleaning/tables/table_with_controls.html

@@ -5,7 +5,7 @@
 {% block table-container-attrs %}
   {{ block.super }}
   x-data="{
-    numRecordsSelected: {{ table.num_selected_records }},
+    numRecordsSelected: {{ table.num_visible_selected_records }},
     totalRecords: {{ table.page.paginator.count }},
     pageTotalRecords: {{ table.paginated_rows|length }},
     pageNumRecordsSelected: 0,
@@ -36,7 +36,7 @@
 {% block before_table %}
   <div class="d-flex align-items-center pb-2">
 
-    {% if table.session.has_any_filtering %}
+    {% if table.has_any_filtering %}
       <div class="pe-2">
         <div class="input-group">
           <div class="input-group-text">
@@ -76,6 +76,16 @@
           {% blocktrans %}
             Records Selected
           {% endblocktrans %}
+          {% if table.num_visible_selected_records != table.num_selected_records %}
+            <div
+              class="ms-2 ps-2 border-start inline-block text-warning"
+              data-bs-custom-class="fs-6"
+              data-bs-title="{% trans 'Some records are selected in the session but not currently visible. They will not be part of cleaning actions until all filters are removed.' %}"
+              x-tooltip=""
+            >
+              <i class="fa-solid fa-triangle-exclamation"></i>
+            </div>
+          {% endif %}
         </div>
         <button
           class="btn btn-outline-danger"

corehq/apps/hqwebapp/tables/elasticsearch/tables.py

@@ -103,7 +103,7 @@ def _get_records(self, start, stop):
             raise ValueError("'stop' must be greater than 'start'")
         size = stop - start
         page_query = self.query.start(start).size(size)
-        results = self._get_es_results(page_query)
+        results = self.get_es_results(page_query)
         self.data = [self.table.record_class(record, self.table.request, **self.record_kwargs)
                      for record in results['hits'].get('hits', [])]
         return self.data
@@ -133,14 +133,21 @@ def __len__(self):
     @property
     @memoized
     def _total_records(self):
-        res = self._get_es_results(self.query.size(0))
+        return self.get_total_records_in_query(self.query)
+
+    @classmethod
+    def get_total_records_in_query(cls, query):
+        """
+        Returns the total number of records in the ESQuery.
+        """
+        res = cls.get_es_results(query.size(0))
         if res is not None:
             return res['hits'].get('total', 0)
         else:
             return 0
 
     @staticmethod
-    def _get_es_results(query):
+    def get_es_results(query):
         try:
             return query.run().raw
         except ESError as e: