Dynamic search suite changes

corehq/apps/app_manager/models.py

@@ -2158,6 +2158,7 @@ class CaseSearch(DocumentSchema):
     title_label = LabelProperty(default={})
     description = LabelProperty(default={})
     include_all_related_cases = BooleanProperty(default=False)
+    dynamic_search = BooleanProperty(default=False)
 
     # case property referencing another case's ID
     custom_related_case_property = StringProperty(exclude_if_none=True)
@@ -4142,6 +4143,7 @@ def assert_app_v2(self):
         default=const.DEFAULT_LOCATION_FIXTURE_OPTION, choices=const.LOCATION_FIXTURE_OPTIONS,
         required=False
     )
+    split_screen_dynamic_search = BooleanProperty(default=False)
 
     @property
     def id(self):

corehq/apps/app_manager/static/app_manager/json/commcare-app-settings.yml

@@ -169,3 +169,12 @@
     - ['only_flat_fixture', 'Only Flat Fixture']
     - ['only_hierarchical_fixture', 'Only Hierarchical Fixture']
   default: 'project_default'
+
+
+- id: split_screen_dynamic_search
+  name: Dynamic Search for Split Screen Case Search
+  description: Enable searching as input values change after initial Split Screen Case Search
+  toggle: DYNAMICALLY_UPDATE_SEARCH_RESULTS
+  widget: bool
+  default: false
+  since: '2.54'

corehq/apps/app_manager/static_strings.py

@@ -73,9 +73,11 @@
     gettext_noop('Disable'),
     gettext_noop('Disabled'),
     gettext_noop('Display root menu as a list or grid. Read more on the <a target="_blank" href="https://help.commcarehq.org/display/commcarepublic/Grid+View+for+Form+and+Module+Screens">Help Site</a>.'),
+    gettext_noop('Dynamic Search for Split Screen Case Search'),
     gettext_noop('Enable Menu Display Setting Per-Module'),
     gettext_noop('Enable'),
     gettext_noop('Enabled'),
+    gettext_noop('Enable searching as input values change after initial Split Screen Case Search'),
     gettext_noop('For mobile map displays, chooses a base tileset for the underlying map layer'),
     gettext_noop('Forms Menu Display'),
     gettext_noop('Forms are Never Removed'),

corehq/apps/app_manager/suite_xml/post_process/remote_requests.py

@@ -210,6 +210,7 @@ def build_remote_request_queries(self):
                 data=self._remote_request_query_datums,
                 prompts=self.build_query_prompts(),
                 default_search=self.module.search_config.default_search,
+                dynamic_search=self.app.split_screen_dynamic_search and not self.module.is_auto_select(),
             )
         ]
 

corehq/apps/app_manager/suite_xml/xml_models.py

@@ -581,6 +581,7 @@ class RemoteRequestQuery(OrderedXmlObject, XmlObject):
     data = NodeListField('data', QueryData)
     prompts = NodeListField('prompt', QueryPrompt)
     default_search = BooleanField("@default_search")
+    dynamic_search = BooleanField("@dynamic_search")
 
     @property
     def id(self):

corehq/apps/app_manager/tests/data/suite/multi_select_case_list/basic_remote_request.xml

@@ -19,7 +19,7 @@
       <instance id="results" src="jr://instance/remote/results"/>
     <instance id="search_selected_cases" src="jr://instance/selected-entities/search_selected_cases"/>
     <session>
-      <query default_search="false" storage-instance="results" template="case" url="https://www.example.com/a/multiple-referrals/phone/search/{app_id}/">
+      <query default_search="false" dynamic_search="false" storage-instance="results" template="case" url="https://www.example.com/a/multiple-referrals/phone/search/{app_id}/">
         <title>
           <text>
             <locale id="case_search.m0.inputs"/>

corehq/apps/app_manager/tests/data/suite/remote_request.xml

@@ -23,6 +23,7 @@
     <session>
       <query url="https://www.example.com/a/test_domain/phone/search/123/"
              default_search="false"
+             dynamic_search="false"
              storage-instance="results"
              template="case">
         <title>

corehq/apps/app_manager/tests/data/suite/remote_request_custom_detail.xml

@@ -21,6 +21,7 @@
     <session>
       <query url="https://www.example.com/a/test_domain/phone/search/123/"
              default_search="false"
+             dynamic_search="false"
              storage-instance="results"
              template="case">
         <title>

corehq/apps/app_manager/tests/data/suite/search_config_blacklisted_owners.xml

@@ -20,6 +20,7 @@
     <session>
       <query url="https://www.example.com/a/test_domain/phone/search/123/"
              default_search="false"
+             dynamic_search="false"
              storage-instance="results"
              template="case">
         <title>

corehq/apps/app_manager/tests/data/suite/search_config_default_only.xml

@@ -21,6 +21,7 @@
     <session>
       <query url="https://www.example.com/a/test_domain/phone/search/123/"
              default_search="false"
+             dynamic_search="false"
              storage-instance="results"
              template="case">
         <title>

corehq/apps/app_manager/tests/data/suite/smart_link_remote_request.xml

@@ -15,7 +15,7 @@
     <instance id="commcaresession" src="jr://instance/session"/>
     <instance id="results" src="jr://instance/remote/results"/>
     <session>
-      <query default_search="false" storage-instance="results" template="case" url="https://www.example.com/a/test_domain/phone/search/{app_id}/">
+      <query default_search="false" dynamic_search="false" storage-instance="results" template="case" url="https://www.example.com/a/test_domain/phone/search/{app_id}/">
         <title>
           <text>
             <locale id="case_search.m1.inputs"/>

corehq/apps/app_manager/tests/data/suite_inline_search/shadow_module_entry.xml

@@ -15,7 +15,7 @@
         <instance id="commcaresession" src="jr://instance/session"/>
         <instance id="results:inline" src="jr://instance/remote/results:inline"/>
         <session>
-            <query default_search="false" storage-instance="results:inline" template="case"
+            <query default_search="false" dynamic_search="false" storage-instance="results:inline" template="case"
                    url="http://localhost:8000/a/test_domain/phone/search/456/">
                 <title>
                     <text>

corehq/apps/app_manager/tests/data/suite_registry/form_link_followup_module_registry.xml

@@ -10,7 +10,7 @@
         <instance id="item-list:colors" src="jr://fixture/item-list:colors"/>
         <instance id="results" src="jr://instance/remote/results"/>
         <session>
-          <query url="http://localhost:8000/a/test_domain/phone/search/123/" storage-instance="results" template="case" default_search="false">
+          <query url="http://localhost:8000/a/test_domain/phone/search/123/" storage-instance="results" template="case" default_search="false" dynamic_search="false">
             <title>
               <text>
                 <locale id="case_search.m0.inputs"/>

corehq/apps/app_manager/tests/data/suite_registry/shadow_module_entry.xml

@@ -10,7 +10,7 @@
     <instance id="item-list:textures" src="jr://fixture/item-list:textures"/>
     <instance id="results" src="jr://instance/remote/results"/>
     <session>
-      <query default_search="false" storage-instance="results" template="case" url="https://www.example.com/a/test_domain/phone/search/456/">
+      <query default_search="false" dynamic_search="false" storage-instance="results" template="case" url="https://www.example.com/a/test_domain/phone/search/456/">
         <title>
           <text>
             <locale id="case_search.m1.inputs"/>

corehq/apps/app_manager/tests/data/suite_registry/shadow_module_remote_request.xml

@@ -15,7 +15,7 @@
     <instance id="item-list:textures" src="jr://fixture/item-list:textures"/>
     <instance id="results" src="jr://instance/remote/results"/>
     <session>
-      <query default_search="false" storage-instance="results" template="case" url="https://www.example.com/a/test_domain/phone/search/456/">
+      <query default_search="false" dynamic_search="false" storage-instance="results" template="case" url="https://www.example.com/a/test_domain/phone/search/456/">
         <title>
           <text>
             <locale id="case_search.m1.inputs"/>

corehq/apps/app_manager/tests/test_advanced_suite.py

@@ -390,7 +390,7 @@ def test_advanced_module_remote_request(self, *args):
             <instance id="results" src="jr://instance/remote/results"/>
             <session>
               <query url="http://localhost:8000/a/domain/phone/search/123/"
-                storage-instance="results" template="case" default_search="false">
+                storage-instance="results" template="case" default_search="false" dynamic_search="false">
                 <title>
                     <text>
                         <locale id="case_search.m0.inputs"/>

corehq/apps/app_manager/tests/test_suite_inline_search.py

@@ -103,7 +103,7 @@ def test_inline_search(self):
             <instance id="results:inline" src="jr://instance/remote/results:inline"/>
             <session>
                 <query url="http://localhost:8000/a/test_domain/phone/search/123/"
-                    storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false">
+                    storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false" dynamic_search="false">
                   <title>
                     <text>
                       <locale id="case_search.m0.inputs"/>
@@ -146,7 +146,7 @@ def test_inline_search_case_list_item(self):
             <instance id="results:inline" src="jr://instance/remote/results:inline"/>
             <session>
                 <query url="http://localhost:8000/a/test_domain/phone/search/123/"
-                    storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false">
+                    storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false" dynamic_search="false">
                   <title>
                     <text>
                         <locale id="case_search.m0.inputs"/>
@@ -201,7 +201,7 @@ def test_inline_search_multi_select(self):
             <session>
                 <query url="http://localhost:8000/a/test_domain/phone/search/123/"
                     storage-instance="{RESULTS_INSTANCE_INLINE}"
-                    template="case" default_search="false">
+                    template="case" default_search="false" dynamic_search="false">
                   <title>
                     <text>
                         <locale id="case_search.m0.inputs"/>
@@ -395,7 +395,7 @@ def test_inline_search_with_parent_select(self):
                 nodeset="instance('casedb')/casedb/case[@case_type='case'][@status='open']"
                 value="./@case_id" detail-select="m2_case_short"/>
               <query url="http://localhost:8000/a/test_domain/phone/search/123/"
-                storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false">
+                storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false" dynamic_search="false">
                 <title>
                   <text>
                       <locale id="case_search.m0.inputs"/>
@@ -564,7 +564,7 @@ def test_child_module_with_inline_search_entry(self):
               <datum id="case_id" nodeset="instance('casedb')/casedb/case[@case_type='case'][@status='open']"
                 value="./@case_id" detail-select="m0_case_short"/>
               <query url="http://localhost:8000/a/test_domain/phone/search/123/"
-                storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false">
+                storage-instance="{RESULTS_INSTANCE_INLINE}" template="case" default_search="false" dynamic_search="false">
                 <title>
                   <text>
                       <locale id="case_search.m1.inputs"/>

corehq/apps/app_manager/tests/test_suite_registry_search.py

@@ -103,7 +103,7 @@ def test_search_data_registry(self, *args):
         <partial>
           <session>
             <query url="http://localhost:8000/a/test_domain/phone/search/123/" storage-instance="results"
-                template="case" default_search="false">
+                template="case" default_search="false" dynamic_search="false">
                 <title>
                     <text>
                         <locale id="case_search.m0.inputs"/>
@@ -551,7 +551,7 @@ def test_inline_search_with_data_registry(self):
             <instance id="results:inline" src="jr://instance/remote/results:inline"/>
             <session>
                 <query url="http://localhost:8000/a/test_domain/phone/search/123/" storage-instance="{RESULTS_INSTANCE_INLINE}"
-                    template="case" default_search="false">
+                    template="case" default_search="false" dynamic_search="false">
                   <title>
                     <text>
                       <locale id="case_search.m0.inputs"/>

corehq/apps/app_manager/tests/test_suite_split_screen_case_search.py

@@ -1,10 +1,15 @@
+from unittest.mock import patch
+
 from django.test import SimpleTestCase
 
+from corehq.apps.app_manager.models import Module, Application, CaseSearch, CaseSearchProperty
 from corehq.apps.app_manager.tests.app_factory import AppFactory
 from corehq.apps.app_manager.tests.util import (
     SuiteMixin,
     patch_get_xform_resource_overrides,
 )
+from corehq.apps.builds.models import BuildSpec
+from corehq.tests.util.xml import parse_normalize
 from corehq.util.test_utils import flag_enabled
 
 
@@ -35,3 +40,41 @@ def test_split_screen_case_search_removes_search_again(self):
             suite,
             "./detail[@id='m0_search_short']/action[display/text/locale[@id='case_list_form.m0']]"
         )
+
+
+@patch_get_xform_resource_overrides()
+class DynamicSearchSuiteTest(SimpleTestCase, SuiteMixin):
+    file_path = ('data', 'suite')
+
+    def setUp(self):
+        self.app = Application.new_app("domain", "Untitled Application")
+        self.app._id = '123'
+        self.app.split_screen_dynamic_search = True
+        self.app.build_spec = BuildSpec(version='2.53.0', build_number=1)
+        self.module = self.app.add_module(Module.new_module("Followup", None))
+
+        self.module.search_config = CaseSearch(
+            properties=[
+                CaseSearchProperty(name='name', label={'en': 'Name'}),
+            ]
+        )
+        self.module.assign_references()
+        # wrap to have assign_references called
+        self.app = Application.wrap(self.app.to_json())
+        self.module = self.app.modules[0]
+
+    @flag_enabled('SPLIT_SCREEN_CASE_SEARCH')
+    @flag_enabled('DYNAMICALLY_UPDATE_SEARCH_RESULTS')
+    def test_dynamic_search_suite(self):
+        suite = self.app.create_suite()
+        suite = parse_normalize(suite, to_string=False)
+        self.assertEqual("true", suite.xpath("./remote-request[1]/session/query/@dynamic_search")[0])
+
+    @patch('corehq.apps.app_manager.models.ModuleBase.is_auto_select', return_value=True)
+    @flag_enabled('SPLIT_SCREEN_CASE_SEARCH')
+    @flag_enabled('DYNAMICALLY_UPDATE_SEARCH_RESULTS')
+    def test_dynamic_search_suite_disable_with_auto_select(self, mock):
+        suite = self.app.create_suite()
+        suite = parse_normalize(suite, to_string=False)
+        self.assertEqual(True, self.module.is_auto_select())
+        self.assertEqual("false", suite.xpath("./remote-request[1]/session/query/@dynamic_search")[0])

corehq/apps/app_manager/views/modules.py

@@ -273,6 +273,7 @@ def _get_shared_module_view_context(request, app, module, case_property_builder,
                 'custom_related_case_property': module.search_config.custom_related_case_property,
                 'inline_search': module.search_config.inline_search,
                 'include_all_related_cases': module.search_config.include_all_related_cases,
+                'dynamic_search': app.split_screen_dynamic_search,
             },
         },
     }
@@ -1353,7 +1354,8 @@ def _check_xpath(xpath, location):
                 additional_registry_cases=additional_registry_cases,
                 custom_related_case_property=search_properties.get('custom_related_case_property', ""),
                 inline_search=search_properties.get('inline_search', False),
-                include_all_related_cases=search_properties.get('include_all_related_cases', False)
+                include_all_related_cases=search_properties.get('include_all_related_cases', False),
+                dynamic_search=app.split_screen_dynamic_search and not module.is_auto_select(),
             )
 
     resp = {}