Skip to content

Commit

Permalink
avniproject/avni-webapp#1214 | Add validation for mandatory headers a…
Browse files Browse the repository at this point in the history 
…nd their column values
  • Loading branch information
@himeshr
himeshr committed Aug 16, 2024
1 parent fb90c13 commit 6a9c490
Show file tree
Hide file tree
Showing 2 changed files with 96 additions and 20 deletions.
90 changes: 70 additions & 20 deletions ...r-api/src/main/java/org/avni/server/importer/batch/csv/writer/UserAndCatchmentWriter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@

import org.avni.server.dao.LocationRepository;
import org.avni.server.dao.UserRepository;
import org.avni.server.domain.*;
import org.avni.server.domain.Locale;
import org.avni.server.domain.*;
import org.avni.server.framework.security.UserContextHolder;
import org.avni.server.importer.batch.csv.writer.header.UsersAndCatchmentsHeaders;
import org.avni.server.importer.batch.model.Row;
import org.avni.server.service.*;
import org.avni.server.util.RegionUtil;
import org.avni.server.util.S;
import org.avni.server.web.request.syncAttribute.UserSyncSettings;
import org.avni.server.web.validation.ValidationException;
import org.springframework.batch.item.ItemWriter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;

import java.io.Serializable;
Expand All @@ -22,6 +25,7 @@

import static java.lang.String.format;
import static org.avni.server.domain.OperatingIndividualScope.ByCatchment;
import static org.avni.server.importer.batch.csv.writer.header.UsersAndCatchmentsHeaders.*;

@Component
public class UserAndCatchmentWriter implements ItemWriter<Row>, Serializable {
Expand Down Expand Up @@ -60,38 +64,82 @@ public UserAndCatchmentWriter(CatchmentService catchmentService,

@Override
public void write(List<? extends Row> rows) throws Exception {
for (Row row : rows) write(row);
if(!CollectionUtils.isEmpty(rows)) {
validateHeaders(rows.get(0).getHeaders());
for (Row row : rows) write(row);
}
}

private void validateHeaders(String[] headers) {
List<String> headerList = Arrays.asList(headers);
List<String> allErrorMsgs = new ArrayList<>();
UsersAndCatchmentsHeaders usersAndCatchmentsHeaders = new UsersAndCatchmentsHeaders();
List<String> expectedStandardHeaders = Arrays.asList(usersAndCatchmentsHeaders.getAllHeaders());
List<String> syncAttributeHeadersForSubjectTypes = subjectTypeService.constructSyncAttributeHeadersForSubjectTypes();
checkForMissingHeaders(headerList, allErrorMsgs, expectedStandardHeaders, syncAttributeHeadersForSubjectTypes);
checkForUnknownHeaders(headerList, allErrorMsgs, expectedStandardHeaders, syncAttributeHeadersForSubjectTypes);
if(!allErrorMsgs.isEmpty()) {
throw new RuntimeException(String.join(", ", allErrorMsgs));
}
}

private void checkForUnknownHeaders(List<String> headerList, List<String> allErrorMsgs, List<String> expectedStandardHeaders, List<String> syncAttributeHeadersForSubjectTypes) {
headerList.removeIf(StringUtils::isEmpty);
headerList.removeIf(header -> expectedStandardHeaders.contains(header));
headerList.removeIf(header -> syncAttributeHeadersForSubjectTypes.contains(header));
if (!headerList.isEmpty()) {
allErrorMsgs.add("Unknown headers included in file. Please refer to sample file for valid list of headers.");
}
}

private void checkForMissingHeaders(List<String> headerList, List<String> allErrorMsgs, List<String> expectedStandardHeaders, List<String> syncAttributeHeadersForSubjectTypes) {
if (headerList.isEmpty() || !headerList.containsAll(expectedStandardHeaders) || !headerList.containsAll(syncAttributeHeadersForSubjectTypes)) {
allErrorMsgs.add("Mandatory columns are missing from uploaded file. Please refer to sample file for the list of mandatory headers.");
}
}

private void write(Row row) throws Exception {
String fullAddress = row.get("Location with full hierarchy");
String fullAddress = row.get(LOCATION_WITH_FULL_HIERARCHY);
if (fullAddress != null && fullAddress.startsWith(METADATA_ROW_START_STRING)) return;
String catchmentName = row.get("Catchment Name");
String nameOfUser = row.get("Full Name of User");
String username = row.get("Username");
String email = row.get("Email Address");
String phoneNumber = row.get("Mobile Number");
String language = row.get("Preferred Language");
String catchmentName = row.get(CATCHMENT_NAME);
String nameOfUser = row.get(FULL_NAME_OF_USER);
String username = row.get(USERNAME);
String email = row.get(EMAIL_ADDRESS);
String phoneNumber = row.get(MOBILE_NUMBER);
String language = row.get(PREFERRED_LANGUAGE);
Locale locale = S.isEmpty(language) ? Locale.en : Locale.valueByName(language);
Boolean trackLocation = row.getBool("Track Location");
String datePickerMode = row.get("Date picker mode");
Boolean beneficiaryMode = row.getBool("Enable Beneficiary mode");
String idPrefix = row.get("Identifier Prefix");
String groupsSpecified = row.get("User Groups");
Boolean trackLocation = row.getBool(TRACK_LOCATION);
String datePickerMode = row.get(DATE_PICKER_MODE);
Boolean beneficiaryMode = row.getBool(ENABLE_BENEFICIARY_MODE);
String idPrefix = row.get(IDENTIFIER_PREFIX);
String groupsSpecified = row.get(USER_GROUPS);
JsonObject syncSettings = constructSyncSettings(row);

AddressLevel location = locationRepository.findByTitleLineageIgnoreCase(fullAddress)
.orElseThrow(() -> new Exception(format(
"Provided Location does not exist in Avni. Please add it or check for spelling mistakes '%s'", fullAddress)));
if(!StringUtils.hasLength(catchmentName)) {
throw new Exception(format("Invalid or Empty value specified for mandatory field %s", CATCHMENT_NAME));
}
if(!StringUtils.hasLength(username)) {
throw new Exception(format("Invalid or Empty value specified for mandatory field %s", USERNAME));
}
if(!StringUtils.hasLength(nameOfUser)) {
throw new Exception(format("Invalid or Empty value specified for mandatory field %s", FULL_NAME_OF_USER));
}
if(!StringUtils.hasLength(email)) {
throw new Exception(format("Invalid or Empty value specified for mandatory field %s", EMAIL_ADDRESS));
}
if(!StringUtils.hasLength(phoneNumber)) {
throw new Exception(format("Invalid or Empty value specified for mandatory field %s", MOBILE_NUMBER));
}
if(Objects.isNull(locale)) {
throw new Exception(format("Provided value '%s' for Preferred Language is invalid;", language));
}

if(Objects.isNull(datePickerMode) || !DATE_PICKER_MODE_OPTIONS.contains(datePickerMode)) {
throw new Exception(format("Provided value '%s' for Date picker mode is invalid;", datePickerMode));
}

AddressLevel location = locationRepository.findByTitleLineageIgnoreCase(fullAddress)
.orElseThrow(() -> new Exception(format(
"Provided Location does not exist in Avni. Please add it or check for spelling mistakes '%s'", fullAddress)));

Catchment catchment = catchmentService.createOrUpdate(catchmentName, location);
Organisation organisation = UserContextHolder.getUserContext().getOrganisation();
String userSuffix = "@".concat(organisation.getEffectiveUsernameSuffix());
Expand Down Expand Up @@ -153,7 +201,9 @@ private void updateSyncSettingsFor(String saHeader, Row row, Map<String, UserSyn
if (headerPatternMatcher.matches()) {
String conceptName = headerPatternMatcher.group("conceptName");
String conceptValues = row.get(saHeader);
if (StringUtils.isEmpty(conceptValues)) return;
if (StringUtils.isEmpty(conceptValues)) {
throw new ValidationException(String.format("Invalid or Empty value specified for mandatory field %s", saHeader));
}
String subjectTypeName = headerPatternMatcher.group("subjectTypeName");
SubjectType subjectType = subjectTypeService.getByName(subjectTypeName);

Expand Down
26 changes: 26 additions & 0 deletions ...main/java/org/avni/server/importer/batch/csv/writer/header/UsersAndCatchmentsHeaders.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package org.avni.server.importer.batch.csv.writer.header;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

public class UsersAndCatchmentsHeaders implements Headers{
public static final String LOCATION_WITH_FULL_HIERARCHY = "Location with full hierarchy";
public static final String CATCHMENT_NAME = "Catchment Name";
public static final String FULL_NAME_OF_USER = "Full Name of User";
public static final String USERNAME = "Username";
public static final String EMAIL_ADDRESS = "Email Address";
public static final String MOBILE_NUMBER = "Mobile Number";
public static final String PREFERRED_LANGUAGE = "Preferred Language";
public static final String TRACK_LOCATION = "Track Location";
public static final String DATE_PICKER_MODE = "Date picker mode";
public static final String ENABLE_BENEFICIARY_MODE = "Enable Beneficiary mode";
public static final String IDENTIFIER_PREFIX = "Identifier Prefix";
public static final String USER_GROUPS = "User Groups";

@Override
public String[] getAllHeaders() {
List<String> headers = new ArrayList<>(Arrays.asList(LOCATION_WITH_FULL_HIERARCHY, CATCHMENT_NAME, USERNAME, FULL_NAME_OF_USER, EMAIL_ADDRESS, MOBILE_NUMBER, PREFERRED_LANGUAGE, TRACK_LOCATION, DATE_PICKER_MODE, ENABLE_BENEFICIARY_MODE, IDENTIFIER_PREFIX, USER_GROUPS));
return headers.toArray(new String[0]);
}
}

0 comments on commit 6a9c490

Please sign in to comment.