HCMPRE-1922 - Microplanning v0.2 master merge

health-services/plan-service/src/main/java/digit/config/ServiceConstants.java

@@ -360,10 +360,20 @@ public class ServiceConstants {
 
     public static final String FACILITY_NAME_SEARCH_PARAMETER_KEY = "facilityName";
 
+    public static final String FACILITY_ID_SEARCH_PARAMETER_KEY = "facilityId";
+
     public static final String FACILITY_STATUS_SEARCH_PARAMETER_KEY = "facilityStatus";
 
     public static final String FACILITY_TYPE_SEARCH_PARAMETER_KEY = "facilityType";
 
+    public static final String TERRAIN_CONDITION_SEARCH_PARAMETER_KEY = "accessibilityDetails|terrain|code";
+
+    public static final String ROAD_CONDITION_SEARCH_PARAMETER_KEY = "accessibilityDetails|roadCondition|code";
+
+    public static final String SECURITY_Q1_SEARCH_PARAMETER_KEY = "securityDetails|1|code";
+
+    public static final String SECURITY_Q2_SEARCH_PARAMETER_KEY = "securityDetails|2|code";
+
     public static final String COMMA_DELIMITER = ",";
 
     public static final String SERVING_POPULATION_CODE = "servingPopulation";
@@ -374,4 +384,11 @@ public class ServiceConstants {
 
     public static final String CONFIRMED_TARGET_POPULATION = "CONFIRMED_HCM_ADMIN_CONSOLE_TARGET_POPULATION";
 
+    public static final String ADDITIONAL_DETAILS_QUERY = " additional_details @> CAST( ? AS jsonb )";
+
+    public static final String JSONB_QUERY_FORMAT = "additional_details @> ?::jsonb";
+
+    public static final String AND_CONDITION = " AND ";
+
+    public static final String OR_CONDITION = " OR ";
 }

health-services/plan-service/src/main/java/digit/repository/impl/PlanRepositoryImpl.java

@@ -189,6 +189,7 @@ private PlanRequestDTO convertToPlanReqDTO(PlanRequest planRequest) {
                 .assignee(assignee)
                 .additionalDetails(plan.getAdditionalDetails())
                 .jurisdictionMapping(plan.getJurisdictionMapping())
+                .additionalFields(plan.getAdditionalFields())
                 .activities(plan.getActivities())
                 .resources(plan.getResources())
                 .targets(plan.getTargets())

health-services/plan-service/src/main/java/digit/repository/querybuilder/PlanQueryBuilder.java

@@ -7,10 +7,10 @@
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.ObjectUtils;
 
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.LinkedHashSet;
-import java.util.List;
+import java.util.*;
+
+import static digit.config.ServiceConstants.ADDITIONAL_DETAILS_QUERY;
+import static digit.config.ServiceConstants.FACILITY_ID_SEARCH_PARAMETER_KEY;
 
 @Component
 public class PlanQueryBuilder {
@@ -30,12 +30,14 @@ public PlanQueryBuilder(Configuration config, QueryUtil queryUtil) {
             "\t   plan_activity.id as plan_activity_id, plan_activity.code as plan_activity_code, plan_activity.description as plan_activity_description, plan_activity.planned_start_date as plan_activity_planned_start_date, plan_activity.planned_end_date as plan_activity_planned_end_date, plan_activity.dependencies as plan_activity_dependencies, plan_activity.plan_id as plan_activity_plan_id, plan_activity.created_by as plan_activity_created_by, plan_activity.created_time as plan_activity_created_time, plan_activity.last_modified_by as plan_activity_last_modified_by, plan_activity.last_modified_time as plan_activity_last_modified_time,\n" +
             "\t   plan_activity_condition.id as plan_activity_condition_id, plan_activity_condition.entity as plan_activity_condition_entity, plan_activity_condition.entity_property as plan_activity_condition_entity_property, plan_activity_condition.expression as plan_activity_condition_expression, plan_activity_condition.activity_id as plan_activity_condition_activity_id, plan_activity_condition.is_active as plan_activity_condition_is_active, plan_activity_condition.created_by as plan_activity_condition_created_by, plan_activity_condition.created_time as plan_activity_condition_created_time, plan_activity_condition.last_modified_by as plan_activity_condition_last_modified_by, plan_activity_condition.last_modified_time as plan_activity_condition_last_modified_time,\n" +
             "\t   plan_resource.id as plan_resource_id, plan_resource.resource_type as plan_resource_resource_type, plan_resource.estimated_number as plan_resource_estimated_number, plan_resource.plan_id as plan_resource_plan_id, plan_resource.activity_code as plan_resource_activity_code, plan_resource.created_by as plan_resource_created_by, plan_resource.created_time as plan_resource_created_time, plan_resource.last_modified_by as plan_resource_last_modified_by, plan_resource.last_modified_time as plan_resource_last_modified_time,\n" +
-            "\t   plan_target.id as plan_target_id, plan_target.metric as plan_target_metric, plan_target.metric_value as plan_target_metric_value, plan_target.metric_comparator as plan_target_metric_comparator, plan_target.metric_unit as plan_target_metric_unit, plan_target.plan_id as plan_target_plan_id, plan_target.activity_code as plan_target_activity_code, plan_target.created_by as plan_target_created_by, plan_target.created_time as plan_target_created_time, plan_target.last_modified_by as plan_target_last_modified_by, plan_target.last_modified_time as plan_target_last_modified_time\n" +
+            "\t   plan_target.id as plan_target_id, plan_target.metric as plan_target_metric, plan_target.metric_value as plan_target_metric_value, plan_target.metric_comparator as plan_target_metric_comparator, plan_target.metric_unit as plan_target_metric_unit, plan_target.plan_id as plan_target_plan_id, plan_target.activity_code as plan_target_activity_code, plan_target.created_by as plan_target_created_by, plan_target.created_time as plan_target_created_time, plan_target.last_modified_by as plan_target_last_modified_by, plan_target.last_modified_time as plan_target_last_modified_time, \n" +
+            "\t   paf.id as plan_additional_field_id, paf.plan_id as plan_additional_field_plan_id, paf.key as plan_additional_field_key, paf.value as plan_additional_field_value, paf.show_on_ui as plan_additional_field_show_on_ui, paf.editable as plan_additional_field_editable, paf.order as plan_additional_field_order \n" +
             "\t   FROM plan \n" +
             "\t   LEFT JOIN plan_activity ON plan.id = plan_activity.plan_id\n" +
             "\t   LEFT JOIN plan_activity_condition ON plan_activity.id = plan_activity_condition.activity_id\n" +
             "\t   LEFT JOIN plan_resource ON plan.id = plan_resource.plan_id\n" +
-            "\t   LEFT JOIN plan_target ON plan.id = plan_target.plan_id";
+            "\t   LEFT JOIN plan_target ON plan.id = plan_target.plan_id\n" +
+            "\t   LEFT JOIN plan_additional_field paf ON plan.id = paf.plan_id";
 
     private static final String BULK_PLAN_UPDATE_QUERY = "UPDATE plan SET status = ?, assignee = ?, last_modified_by = ?, last_modified_time = ? WHERE id = ?";
 
@@ -170,6 +172,22 @@ private String buildPlanSearchQuery(PlanSearchCriteria planSearchCriteria, List<
             queryUtil.addToPreparedStatement(preparedStmtList, planSearchCriteria.getJurisdiction());
         }
 
+        if (!CollectionUtils.isEmpty(planSearchCriteria.getFiltersMap())) {
+            Map<String, Set<String>> filtersMap = planSearchCriteria.getFiltersMap();
+            for (String key : filtersMap.keySet()) {
+                if (FACILITY_ID_SEARCH_PARAMETER_KEY.equals(key)) {
+                    // its for facility multi select then no need to add to preparedStmtList
+                    String partialQueryJsonString = queryUtil.preparePartialJsonStringFromFilterMap(planSearchCriteria.getFiltersMap(), preparedStmtList, key);
+                    builder.append(partialQueryJsonString);
+                } else {
+                    // handle all other keys normally.
+                    queryUtil.addClauseIfRequired(builder, preparedStmtList);
+                    builder.append(ADDITIONAL_DETAILS_QUERY);
+                    String partialQueryJsonString = queryUtil.preparePartialJsonStringFromFilterMap(planSearchCriteria.getFiltersMap(), preparedStmtList, key);
+                    preparedStmtList.add(partialQueryJsonString);
+                }
+            }
+        }
 
         StringBuilder countQuery = new StringBuilder();
         if (isCount) {

health-services/plan-service/src/main/java/digit/repository/rowmapper/PlanRowMapper.java

@@ -30,6 +30,7 @@ public List<Plan> extractData(ResultSet rs) throws SQLException, DataAccessExcep
         Set<String> conditionSet = new HashSet<>();
         Set<String> resourceSet = new HashSet<>();
         Set<String> targetSet = new HashSet<>();
+        Set<String> additionalFieldSet = new HashSet<>();
 
         // Traverse through result set and create plan objects
         while (rs.next()) {
@@ -43,6 +44,7 @@ public List<Plan> extractData(ResultSet rs) throws SQLException, DataAccessExcep
                 conditionSet.clear();
                 resourceSet.clear();
                 targetSet.clear();
+                additionalFieldSet.clear();
 
                 // Prepare audit details
                 AuditDetails auditDetails = AuditDetails.builder()
@@ -72,6 +74,7 @@ public List<Plan> extractData(ResultSet rs) throws SQLException, DataAccessExcep
             addActivities(rs, planEntry, activityMap, conditionSet);
             addResources(rs, planEntry, resourceSet);
             addTargets(rs, planEntry, targetSet);
+            addAdditionalField(rs, planEntry, additionalFieldSet);
             planMap.put(planId, planEntry);
         }
 
@@ -234,4 +237,39 @@ private void addTargets(ResultSet rs, Plan planEntry, Set<String> targetSet) thr
         targetSet.add(target.getId());
 
     }
+
+    /**
+     * Adds a AdditionalField object to the plan entry based on the result set.
+     *
+     * @param rs                 The ResultSet containing the data.
+     * @param additionalFieldSet A set to keep track of added AdditionalField objects.
+     * @param planEntry          The Plan entry to which the AdditionalField object will be added.
+     * @throws SQLException If an SQL error occurs.
+     */
+    private void addAdditionalField(ResultSet rs, Plan planEntry, Set<String> additionalFieldSet) throws SQLException {
+        String additionalFieldId = rs.getString("plan_additional_field_id");
+
+        if (ObjectUtils.isEmpty(additionalFieldId) || additionalFieldSet.contains(additionalFieldId)) {
+            return;
+        }
+
+        AdditionalField additionalField = new AdditionalField();
+        additionalField.setId(rs.getString("plan_additional_field_id"));
+        additionalField.setKey(rs.getString("plan_additional_field_key"));
+        additionalField.setValue(rs.getBigDecimal("plan_additional_field_value"));
+        additionalField.setShowOnUi(rs.getBoolean("plan_additional_field_show_on_ui"));
+        additionalField.setEditable(rs.getBoolean("plan_additional_field_editable"));
+        additionalField.setOrder(rs.getInt("plan_additional_field_order"));
+
+        if (CollectionUtils.isEmpty(planEntry.getAdditionalFields())) {
+            List<AdditionalField> additionalFields = new ArrayList<>();
+            additionalFields.add(additionalField);
+            planEntry.setAdditionalFields(additionalFields);
+        } else {
+            planEntry.getAdditionalFields().add(additionalField);
+        }
+
+        additionalFieldSet.add(additionalFieldId);
+    }
+
 }

health-services/plan-service/src/main/java/digit/service/enrichment/PlanEnricher.java → health-services/plan-service/src/main/java/digit/service/PlanEnricher.java

@@ -1,7 +1,6 @@
-package digit.service.enrichment;
+package digit.service;
 
-import digit.web.models.Plan;
-import digit.web.models.PlanRequest;
+import digit.web.models.*;
 import digit.web.models.boundary.BoundaryTypeHierarchy;
 import digit.web.models.boundary.BoundaryTypeHierarchyDefinition;
 import digit.web.models.boundary.EnrichedBoundary;
@@ -14,6 +13,8 @@
 
 import java.util.*;
 
+import static digit.config.ServiceConstants.*;
+
 @Component
 public class PlanEnricher {
 
@@ -53,6 +54,10 @@ public void enrichPlanCreate(PlanRequest body) {
         // Generate id for targets
         body.getPlan().getTargets().forEach(target -> UUIDEnrichmentUtil.enrichRandomUuid(target, "id"));
 
+        // Generate id for additional fields
+        if(!CollectionUtils.isEmpty(body.getPlan().getAdditionalFields()))
+            body.getPlan().getAdditionalFields().forEach(additionalField -> UUIDEnrichmentUtil.enrichRandomUuid(additionalField, "id"));
+
         // Enrich audit details
         body.getPlan().setAuditDetails(AuditDetailsEnrichmentUtil
                 .prepareAuditDetails(body.getPlan().getAuditDetails(), body.getRequestInfo(), Boolean.TRUE));
@@ -107,6 +112,15 @@ public void enrichPlanUpdate(PlanRequest body) {
             }
         });
 
+        // Generate uuid for new additionalFields
+        if(!CollectionUtils.isEmpty(body.getPlan().getAdditionalFields())) {
+            body.getPlan().getAdditionalFields().forEach(additionalFields -> {
+                if(ObjectUtils.isEmpty(additionalFields.getId())) {
+                    UUIDEnrichmentUtil.enrichRandomUuid(additionalFields, "id");
+                }
+            });
+        }
+
         // Enriching last modified time for update
         body.getPlan().getAuditDetails().setLastModifiedTime(System.currentTimeMillis());
     }
@@ -228,4 +242,45 @@ private List<String> getBoundaryCodeFromAncestralPath(String boundaryAncestralPa
         }
         return Arrays.asList(boundaryAncestralPath.split("\\|"));
     }
+
+    /**
+     * Enriches the PlanSearchRequest by populating the filters map from the fields in search criteria.
+     * This filterMap is populated to search the fields in plan additional detail object.
+     *
+     * @param planSearchRequest the planSearchRequest object whose search criteria need enrichment.
+     */
+    public void enrichSearchRequest(PlanSearchRequest planSearchRequest) {
+        PlanSearchCriteria planSearchCriteria = planSearchRequest.getPlanSearchCriteria();
+
+        // Filter map for filtering plan metadata present in additional details
+        Map<String, Set<String>> filtersMap = new LinkedHashMap<>();
+
+        // Add facility id as a filter if present in search criteria
+        if (!ObjectUtils.isEmpty(planSearchCriteria.getFacilityIds())) {
+            filtersMap.put(FACILITY_ID_SEARCH_PARAMETER_KEY, planSearchCriteria.getFacilityIds());
+        }
+
+        // Add terrain as a filter if present in search criteria
+        if (!ObjectUtils.isEmpty(planSearchCriteria.getTerrain())) {
+            filtersMap.put(TERRAIN_CONDITION_SEARCH_PARAMETER_KEY, Collections.singleton(planSearchCriteria.getTerrain()));
+        }
+
+        // Add onRoadCondition as a filter if present in search criteria
+        if (!ObjectUtils.isEmpty(planSearchCriteria.getOnRoadCondition())) {
+            filtersMap.put(ROAD_CONDITION_SEARCH_PARAMETER_KEY, Collections.singleton(planSearchCriteria.getOnRoadCondition()));
+        }
+
+        // Add securityQ1 as a filter if present in search criteria
+        if (!ObjectUtils.isEmpty(planSearchCriteria.getSecurityQ1())) {
+            filtersMap.put(SECURITY_Q1_SEARCH_PARAMETER_KEY, Collections.singleton(planSearchCriteria.getSecurityQ1()));
+        }
+
+        // Add securityQ2 as a filter if present in search criteria
+        if (!ObjectUtils.isEmpty(planSearchCriteria.getSecurityQ2())) {
+            filtersMap.put(SECURITY_Q2_SEARCH_PARAMETER_KEY, Collections.singleton(planSearchCriteria.getSecurityQ2()));
+        }
+
+        if(!CollectionUtils.isEmpty(filtersMap))
+            planSearchCriteria.setFiltersMap(filtersMap);
+    }
 }

health-services/plan-service/src/main/java/digit/service/PlanService.java

@@ -1,8 +1,6 @@
 package digit.service;
 
 import digit.repository.PlanRepository;
-import digit.service.enrichment.PlanEnricher;
-import digit.service.validator.PlanValidator;
 import digit.service.workflow.WorkflowService;
 import digit.web.models.*;
 import org.egov.common.utils.ResponseInfoUtil;
@@ -61,6 +59,9 @@ public PlanResponse createPlan(PlanRequest body) {
      * @return
      */
     public PlanResponse searchPlan(PlanSearchRequest body) {
+        // Enrich search request
+        planEnricher.enrichSearchRequest(body);
+
         // Delegate search request to repository
         List<Plan> planList = planRepository.search(body.getPlanSearchCriteria());
 

health-services/plan-service/src/main/java/digit/service/validator/PlanValidator.java → health-services/plan-service/src/main/java/digit/service/PlanValidator.java

@@ -1,11 +1,9 @@
-package digit.service.validator;
+package digit.service;
 
 import com.jayway.jsonpath.JsonPath;
 import digit.config.Configuration;
 import digit.repository.PlanConfigurationRepository;
 import digit.repository.PlanRepository;
-import digit.service.PlanEmployeeService;
-import digit.service.enrichment.PlanEnricher;
 import digit.util.BoundaryUtil;
 import digit.util.CampaignUtil;
 import digit.util.CommonUtil;

health-services/plan-service/src/main/java/digit/service/enrichment/PlanFacilityEnricher.java

@@ -3,10 +3,7 @@
 import digit.util.BoundaryUtil;
 import digit.util.CensusUtil;
 import digit.util.CommonUtil;
-import digit.web.models.PlanFacility;
-import digit.web.models.PlanFacilityRequest;
-import digit.web.models.PlanFacilitySearchCriteria;
-import digit.web.models.PlanFacilitySearchRequest;
+import digit.web.models.*;
 import digit.web.models.boundary.BoundarySearchResponse;
 import digit.web.models.boundary.EnrichedBoundary;
 import digit.web.models.census.*;

health-services/plan-service/src/main/java/digit/service/validator/PlanEmployeeAssignmentValidator.java

@@ -317,8 +317,9 @@ public void validateUpdate(PlanEmployeeAssignmentRequest request) {
         // Validate if Plan employee assignment exists
         validatePlanEmployeeAssignmentExistance(planEmployeeAssignment);
 
-        // Validate campaign id and employee jurisdiction
-        validateCampaignDetails(planConfigurations.get(0).getCampaignId(), rootTenantId, request);
+        // Validate campaign id and employee jurisdiction for active records
+        if(planEmployeeAssignment.getActive())
+            validateCampaignDetails(planConfigurations.get(0).getCampaignId(), rootTenantId, request);
 
     }