Merge pull request #1531 from dimagi/jt/clear-on-search

Adds searchOnClear to queryResponse
dimagi · Jan 22, 2024 · 59121b3 · 59121b3
2 parents 432c9df + 402dca4
commit 59121b3
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 2 deletions.
diff --git a/libs/commcare b/libs/commcare
diff --git a/src/main/java/org/commcare/formplayer/beans/menus/QueryResponseBean.java b/src/main/java/org/commcare/formplayer/beans/menus/QueryResponseBean.java
@@ -26,6 +26,7 @@ public class QueryResponseBean extends MenuBean {
     private final String type = "query";
     private String description;
     private Hashtable<String, String> groupHeaders;
+    private Boolean searchOnClear;
 
     QueryResponseBean() {
     }
@@ -54,6 +55,14 @@ public void setGroupHeaders(Hashtable<String, String> groupHeaders){
         this.groupHeaders = groupHeaders;
     }
 
+    public boolean isSearchOnClear() {
+        return searchOnClear;
+    }
+
+    public void setIsSearchOnClear(boolean searchOnClear) {
+        this.searchOnClear = searchOnClear;
+    }
+
     public QueryResponseBean(QueryScreen queryScreen) {
         OrderedHashtable<String, QueryPrompt> queryPromptMap = queryScreen.getUserInputDisplays();
         Hashtable<String, String> currentAnswers = queryScreen.getCurrentAnswers();
@@ -101,6 +110,7 @@ public QueryResponseBean(QueryScreen queryScreen) {
         setDescription(queryScreen.getDescriptionText());
         setQueryKey(queryScreen.getQueryKey());
         setDynamicSearch(queryScreen.getDynamicSearch());
+        setIsSearchOnClear(queryScreen.isSearchOnClear());
     }
 
     @Override

diff --git a/src/test/java/org/commcare/formplayer/tests/CaseClaimTests.java b/src/test/java/org/commcare/formplayer/tests/CaseClaimTests.java
@@ -105,6 +105,23 @@ public void testDynamicSearch() throws Exception {
         assertFalse(queryResponseBean.getDynamicSearch());
     }
 
+    @Test
+    public void testSearchOnClear() throws Exception {
+        configureQueryMock();
+        // Run query with an app with dynamic_search true and verify
+        QueryData queryData = new QueryData();
+        queryData.setForceManualSearch("search_command.m1_results", true);
+        QueryResponseBean queryResponseBean = runQuery(queryData);
+        assertTrue(queryResponseBean.isSearchOnClear());
+
+        // Run query with an app with dynamic_search false and verify
+        queryResponseBean = sessionNavigateWithQuery(new String[]{"1"},
+                "case_claim_eof_navigation",
+                null,
+                QueryResponseBean.class);
+        assertFalse(queryResponseBean.isSearchOnClear());
+    }
+
     @Test
     public void testEmptySearch() throws Exception {
         configureQueryMock();

diff --git a/src/test/resources/archives/caseclaim/suite.xml b/src/test/resources/archives/caseclaim/suite.xml
@@ -366,7 +366,7 @@
     <instance id="state" src="jr://fixture/item-list:state"/>
     <instance id="my-search-input" src="jr://instance/search-input/results"/>
     <session>
-      <query url="http://localhost:8000/a/test/phone/search/" template="case" storage-instance="results" default_search="true" dynamic_search="true">
+      <query url="http://localhost:8000/a/test/phone/search/" template="case" storage-instance="results" default_search="true" dynamic_search="true" search_on_clear="true">
         <data ref="'case1'" key="case_type"/>
         <data ref="'case2'" key="case_type"/>
         <data ref="'case3'" key="case_type"/>
+6 −0		src/cli/java/org/commcare/util/screen/QueryScreen.java
+4 −0		src/main/java/org/commcare/session/RemoteQuerySessionManager.java
+8 −2		src/main/java/org/commcare/suite/model/RemoteQueryDatum.java
+3 −1		src/main/java/org/commcare/xml/SessionDatumParser.java
+2 −0		src/test/java/org/commcare/backend/suite/model/test/CaseClaimModelTests.java
+1 −1		src/test/resources/case_claim_example/suite.xml