Merge pull request #2702 from bcgov/feature/other-removal

Remove Other From Document Types

Author: TayGov

src/backend/README.md

@@ -33,3 +33,7 @@ Run
 ```
 mvn -f src/backend/pom.xml versions:set -DartifactId=*  -DgroupId=*
 ```
+
+## caching
+
+Currently lookups are cached using redis. In the event of a code table change redis should be restarted. Check the api for activity beore doing so. 

src/backend/libs/efiling-cso-client/pom.xml

@@ -3,12 +3,6 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-    <parent>
-        <groupId>org.springframework.boot</groupId>
-        <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.4.0</version>
-        <relativePath/> <!-- lookup parent from repository -->
-    </parent>
     <groupId>ca.bc.gov.open.jag</groupId>
     <artifactId>efiling-cso-client</artifactId>
     <version>1.5.2-SNAPSHOT</version>
@@ -76,14 +70,9 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-web</artifactId>
-            <version>3.1.0</version>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-webflux</artifactId>
-            <version>3.1.0</version>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+            <version>5.3.28</version>
         </dependency>
     </dependencies>
 

src/backend/libs/efiling-cso-client/src/main/java/ca/bc/gov/open/jag/efilingcsoclient/CsoDocumentServiceImpl.java

@@ -12,6 +12,8 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+import static ca.bc.gov.open.jag.efilingcsoclient.Keys.OTHER_DOCUMENT_TYPE;
+
 
 public class CsoDocumentServiceImpl implements EfilingDocumentService {
 
@@ -55,10 +57,13 @@ public List<DocumentTypeDetails> getDocumentTypes(String courtLevel, String cour
 
     private List<DocumentType> getSoapDocumentTypes(String courtLevel, String courtClass) {
 
-        List<DocumentType> documentTypes = new ArrayList<>();
+        List<DocumentType> documentTypes;
 
         try {
-            documentTypes.addAll(filingStatusFacadeBean.getDocumentTypes(courtLevel, courtClass));
+            documentTypes = new ArrayList<>(filingStatusFacadeBean.getDocumentTypes(courtLevel, courtClass));
+            //Remove other document types. NOTE these are cached and redis requires a restart
+            //TODO: consider feature flagging this
+            documentTypes.removeIf(documentType -> documentType.getDocumentTypeCd().equals(OTHER_DOCUMENT_TYPE));
         } catch (NestedEjbException_Exception e) {
             throw new EfilingDocumentServiceException("Exception while retrieving document details", e.getCause());
         }

src/backend/libs/efiling-cso-client/src/main/java/ca/bc/gov/open/jag/efilingcsoclient/Keys.java

@@ -63,4 +63,6 @@ private Keys() {}
     public static final String AUTO_PROCESSING_STATE = "AUTO";
     public static final String MANUAL_PROCESSING_STATE = "MANUAL";
 
+    public static final String OTHER_DOCUMENT_TYPE = "OTH";
+
 }

src/backend/libs/efiling-cso-client/src/test/java/ca/bc/gov/open/jag/efilingcsoclient/csoDocumentServiceImpl/GetDocumentTypesTest.java

@@ -22,6 +22,7 @@
 @DisplayName("Get Document Type Test Suite")
 public class GetDocumentTypesTest {
     private static final String DOCUMENT_TYPE_CD = "ACODE";
+    private static final String DOCUMENT_TYPE_OTHER_CD = "OTH";
     private static final String DESCRIPTION = "DESCRIPTION";
     private static final String NODOC = "NODOC";
     public static final String COURT_LEVEL = "level1";
@@ -36,15 +37,8 @@ public class GetDocumentTypesTest {
     public void setUp() throws NestedEjbException_Exception {
 
         MockitoAnnotations.openMocks(this);
-        DocumentType documentType = new DocumentType();
-        documentType.setDocumentTypeCd(DOCUMENT_TYPE_CD);
-        documentType.setDocumentTypeDesc(DESCRIPTION);
-        documentType.setDefaultStatutoryFee(BigDecimal.TEN);
-        documentType.setOrderDocumentYn(true);
-        documentType.setRushRequiredYn(true);
-        documentType.setAutoProcessYn(false);
-
-        Mockito.when(filingStatusFacadeBean.getDocumentTypes(Mockito.eq(COURT_LEVEL),any())).thenReturn(Arrays.asList(documentType));
+
+        Mockito.when(filingStatusFacadeBean.getDocumentTypes(Mockito.eq(COURT_LEVEL),any())).thenReturn(createDocumentTypeList());
         Mockito.when(filingStatusFacadeBean.getDocumentTypes(Mockito.eq(NODOC),any())).thenReturn(new ArrayList<>());
 
         Mockito.when(filingStatusFacadeBean.getDocumentTypes(Mockito.eq(EXCEPTION),any())).thenThrow(NestedEjbException_Exception.class);
@@ -56,15 +50,19 @@ public void setUp() throws NestedEjbException_Exception {
     @Test
     public void testWithFoundResult() {
         List<DocumentTypeDetails> result = sut.getDocumentTypes(COURT_LEVEL, COURT_CLASS);
+
+        Assertions.assertEquals(1, result.size());
         Assertions.assertEquals(DESCRIPTION, result.get(0).getDescription());
         Assertions.assertEquals(DOCUMENT_TYPE_CD, result.get(0).getType());
+
     }
 
     @DisplayName("Failure: when SOAP service throws NestedEjbException_Exception, service should throw EfilingDocumentServiceException")
     @Test
     public void testThrowException() throws NestedEjbException_Exception {
 
         Assertions.assertThrows(EfilingDocumentServiceException.class, () -> sut.getDocumentTypes(EXCEPTION, COURT_CLASS));
+
     }
 
     @DisplayName("Exception: courtLevel is required")
@@ -87,4 +85,27 @@ public void whenCourtClassIsBlankShouldThrowIllegalArgumentException() {
 
     }
 
+    private List<DocumentType> createDocumentTypeList() {
+
+        DocumentType documentType1 = new DocumentType();
+        documentType1.setDocumentTypeCd(DOCUMENT_TYPE_CD);
+        documentType1.setDocumentTypeDesc(DESCRIPTION);
+        documentType1.setDefaultStatutoryFee(BigDecimal.TEN);
+        documentType1.setOrderDocumentYn(true);
+        documentType1.setRushRequiredYn(true);
+        documentType1.setAutoProcessYn(false);
+
+        DocumentType documentType2 = new DocumentType();
+        documentType2.setDocumentTypeCd(DOCUMENT_TYPE_OTHER_CD);
+        documentType2.setDocumentTypeDesc(DESCRIPTION);
+        documentType2.setDefaultStatutoryFee(BigDecimal.TEN);
+        documentType2.setOrderDocumentYn(true);
+        documentType2.setRushRequiredYn(true);
+        documentType2.setAutoProcessYn(false);
+
+        return Arrays.asList(documentType1, documentType2);
+
+    }
+
+
 }