avniproject/avni-client#1458 | Capture errored entity details when transactional data's constraint violation occurs

himeshr · himeshr · commit 3d46d82bfe95 · 2024-07-16T13:09:12.000+05:30
diff --git a/avni-server-api/src/main/java/org/avni/server/dao/OperatingIndividualScopeAwareRepository.java b/avni-server-api/src/main/java/org/avni/server/dao/OperatingIndividualScopeAwareRepository.java
@@ -5,7 +5,10 @@
 import org.avni.server.dao.sync.TransactionDataCriteriaBuilderUtil;
 import org.avni.server.domain.*;
 import org.avni.server.framework.security.UserContextHolder;
+import org.avni.server.service.exception.ConstraintViolationExceptionAcrossOrganisations;
 import org.avni.server.util.JsonObjectUtil;
+import org.hibernate.exception.ConstraintViolationException;
+import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Slice;
 import org.springframework.data.jpa.domain.Specification;
@@ -16,6 +19,7 @@
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.Objects;
 
 @SuppressWarnings("rawtypes")
 @NoRepositoryBean
@@ -176,4 +180,15 @@ default <B extends CHSEntity, A extends CHSEntity> void addPredicate(CriteriaBui
             predicates.add(cb.equal(from.get("id"), cb.literal(0)));
         }
     }
+
+    default <S extends T> S saveEntity(S entity) {
+        try {
+            return save(entity);
+        } catch (DataIntegrityViolationException dive) {
+            if (Objects.isNull(entity.getId()) && dive.getCause() != null && dive.getCause().getClass().equals(ConstraintViolationException.class)) {
+                throw new ConstraintViolationExceptionAcrossOrganisations(String.format("Entity=> ID: %d, UUID: %s, Type:%s, User:%s, Msg: %s", entity.getId(), entity.getUuid(), entity.getClass().getCanonicalName(), entity.getLastModifiedByName(), dive.getMessage()), (ConstraintViolationException) dive.getCause());
+            }
+            throw dive;
+        }
+    }
 }
diff --git a/avni-server-api/src/main/java/org/avni/server/service/ChecklistService.java b/avni-server-api/src/main/java/org/avni/server/service/ChecklistService.java
@@ -37,7 +37,7 @@ public ChecklistItem findChecklistItem(String checklistUUID, String checklistIte
 
     @Transactional(Transactional.TxType.REQUIRED)
     public void saveItem(ChecklistItem checklistItem) {
-        checklistItemRepository.save(checklistItem);
+        checklistItemRepository.saveEntity(checklistItem);
     }
 
     @Override
diff --git a/avni-server-api/src/main/java/org/avni/server/service/CommentService.java b/avni-server-api/src/main/java/org/avni/server/service/CommentService.java
@@ -33,12 +33,12 @@ public CommentService(CommentRepository commentRepository, IndividualRepository
     public Comment saveComment(CommentContract commentContract) {
         Comment comment = new Comment();
         buildComment(commentContract, comment);
-        return commentRepository.save(comment);
+        return commentRepository.saveEntity(comment);
     }
 
     public Comment editComment(CommentContract commentContract, Comment existingComment) {
         buildComment(commentContract, existingComment);
-        return commentRepository.save(existingComment);
+        return commentRepository.saveEntity(existingComment);
     }
 
     private void buildComment(CommentContract commentContract, Comment comment) {
@@ -54,7 +54,7 @@ private void buildComment(CommentContract commentContract, Comment comment) {
 
     public Comment deleteComment(Comment comment) {
         comment.setVoided(true);
-        return commentRepository.save(comment);
+        return commentRepository.saveEntity(comment);
     }
 
     @Override
diff --git a/avni-server-api/src/main/java/org/avni/server/service/CommentThreadService.java b/avni-server-api/src/main/java/org/avni/server/service/CommentThreadService.java
@@ -44,13 +44,13 @@ public CommentThread createNewThread(CommentThreadContract threadContract) {
             comments.add(comment);
         });
         commentThread.setComments(comments);
-        return commentThreadRepository.save(commentThread);
+        return commentThreadRepository.saveEntity(commentThread);
     }
 
     public CommentThread resolveThread(CommentThread commentThread) {
         commentThread.setStatus(CommentThread.CommentThreadStatus.Resolved);
         commentThread.setResolvedDateTime(new DateTime());
-        return commentThreadRepository.save(commentThread);
+        return commentThreadRepository.saveEntity(commentThread);
     }
 
     @Override
diff --git a/avni-server-api/src/main/java/org/avni/server/service/EncounterService.java b/avni-server-api/src/main/java/org/avni/server/service/EncounterService.java
@@ -186,7 +186,7 @@ public Encounter save(Encounter encounter) {
         if (individual.getAddressLevel() != null) {
             encounter.setAddressId(individual.getAddressLevel().getId());
         }
-        return encounterRepository.save(encounter);
+        return encounterRepository.saveEntity(encounter);
     }
 
     public Page<Encounter> search(EncounterSearchRequest encounterSearchRequest) {
diff --git a/avni-server-api/src/main/java/org/avni/server/service/GroupSubjectService.java b/avni-server-api/src/main/java/org/avni/server/service/GroupSubjectService.java
@@ -40,7 +40,7 @@ public OperatingIndividualScopeAwareRepository<GroupSubject> repository() {
     public GroupSubject save(GroupSubject groupSubject) throws ValidationException {
         this.addSyncAttributes(groupSubject);
         assignMemberToTheAssigneeOfGroup(groupSubject);
-        return groupSubjectRepository.save(groupSubject);
+        return groupSubjectRepository.saveEntity(groupSubject);
     }
 
     private void assignMemberToTheAssigneeOfGroup(GroupSubject groupSubject) {
diff --git a/avni-server-api/src/main/java/org/avni/server/service/IndividualService.java b/avni-server-api/src/main/java/org/avni/server/service/IndividualService.java
@@ -348,7 +348,7 @@ public Individual voidSubject(Individual individual) {
         assertNoUnVoidedEncounters(individual);
         assertNoUnVoidedEnrolments(individual);
         individual.setVoided(true);
-        return individualRepository.save(individual);
+        return individualRepository.saveEntity(individual);
     }
 
     private void assertNoUnVoidedEnrolments(Individual individual) {
@@ -396,7 +396,7 @@ public Object getObservationValueForUpload(FormElement formElement, String answe
     @Messageable(EntityType.Subject)
     public Individual save(Individual individual) {
         individual.addConceptSyncAttributeValues(individual.getSubjectType(), individual.getObservations());
-        return individualRepository.save(individual);
+        return individualRepository.saveEntity(individual);
     }
 
     public String findPhoneNumber(long subjectId) {
diff --git a/avni-server-api/src/main/java/org/avni/server/service/ProgramEncounterService.java b/avni-server-api/src/main/java/org/avni/server/service/ProgramEncounterService.java
@@ -230,7 +230,7 @@ public ProgramEncounter save(ProgramEncounter programEncounter) {
         if (individual.getAddressLevel() != null) {
             programEncounter.setAddressId(individual.getAddressLevel().getId());
         }
-        programEncounter = programEncounterRepository.save(programEncounter);
+        programEncounter = programEncounterRepository.saveEntity(programEncounter);
         return programEncounter;
     }
 
diff --git a/avni-server-api/src/main/java/org/avni/server/service/ProgramEnrolmentService.java b/avni-server-api/src/main/java/org/avni/server/service/ProgramEnrolmentService.java
@@ -206,7 +206,7 @@ public ProgramEnrolment programEnrolmentSave(ProgramEnrolmentRequest request) {
             programEnrolment.setIndividual(individual);
             saveIdentifierAssignments(programEnrolment, request);
         }
-        programEnrolment = programEnrolmentRepository.save(programEnrolment);
+        programEnrolment = programEnrolmentRepository.saveEntity(programEnrolment);
 
         if (request.getVisitSchedules() != null && request.getVisitSchedules().size() > 0) {
             programEncounterService.saveVisitSchedules(request.getUuid(), request.getVisitSchedules(), null);
@@ -223,7 +223,7 @@ public ProgramEnrolment programEnrolmentSave(ProgramEnrolmentRequest request) {
     @Messageable(EntityType.ProgramEnrolment)
     public ProgramEnrolment save(ProgramEnrolment programEnrolment) {
         this.addSyncAttributes(programEnrolment);
-        return programEnrolmentRepository.save(programEnrolment);
+        return programEnrolmentRepository.saveEntity(programEnrolment);
     }
 
     private void addSyncAttributes(ProgramEnrolment enrolment) {
@@ -250,7 +250,7 @@ private Checklist saveChecklist(ChecklistContract checklistContract, String prog
         Checklist existingChecklist = checklistRepository.findByProgramEnrolmentId(programEnrolment.getId());
         if (existingChecklist != null) {
             existingChecklist.setBaseDate(checklistContract.getBaseDate());
-            return checklistRepository.save(existingChecklist);
+            return checklistRepository.saveEntity(existingChecklist);
         }
         Checklist checklist = new Checklist();
         checklist.assignUUIDIfRequired();
@@ -259,15 +259,15 @@ private Checklist saveChecklist(ChecklistContract checklistContract, String prog
         checklist.setBaseDate(checklistContract.getBaseDate());
         checklist.setChecklistDetail(checklistDetail);
         checklist.setProgramEnrolment(programEnrolment);
-        Checklist savedChecklist = checklistRepository.save(checklist);
+        Checklist savedChecklist = checklistRepository.saveEntity(checklist);
         checklistContract.getItems().forEach(item -> {
             ChecklistItem checklistItem = new ChecklistItem();
             checklistItem.assignUUIDIfRequired();
             String checklistItemDetailUUID = item.getDetail().getUuid();
             ChecklistItemDetail checklistItemDetail = checklistItemDetailRepository.findByUuid(checklistItemDetailUUID);
             checklistItem.setChecklistItemDetail(checklistItemDetail);
             checklistItem.setChecklist(savedChecklist);
-            checklistItemRepository.save(checklistItem);
+            checklistItemRepository.saveEntity(checklistItem);
         });
         return savedChecklist;
     }
@@ -276,7 +276,7 @@ private Checklist saveChecklist(ChecklistContract checklistContract, String prog
     public ProgramEnrolment voidEnrolment(ProgramEnrolment programEnrolment) {
         assertNoUnVoidedProgramEncounters(programEnrolment);
         programEnrolment.setVoided(true);
-        return programEnrolmentRepository.save(programEnrolment);
+        return programEnrolmentRepository.saveEntity(programEnrolment);
     }
 
     private void assertNoUnVoidedProgramEncounters(ProgramEnrolment programEnrolment) {
diff --git a/avni-server-api/src/main/java/org/avni/server/service/SubjectMigrationService.java b/avni-server-api/src/main/java/org/avni/server/service/SubjectMigrationService.java
@@ -127,7 +127,7 @@ public void changeSubjectsAddressLevel(List<Individual> subjects, AddressLevel d
         subjects.forEach(individual -> {
             this.markSubjectMigrationIfRequired(individual.getUuid(), null, destAddressLevel, null, individual.getObservations(), true);
             individual.setAddressLevel(destAddressLevel);
-            individualRepository.save(individual);
+            individualRepository.saveEntity(individual);
         });
     }
 }
diff --git a/avni-server-api/src/main/java/org/avni/server/service/exception/ConstraintViolationExceptionAcrossOrganisations.java b/avni-server-api/src/main/java/org/avni/server/service/exception/ConstraintViolationExceptionAcrossOrganisations.java
@@ -0,0 +1,9 @@
+package org.avni.server.service.exception;
+
+import org.hibernate.exception.ConstraintViolationException;
+
+public class ConstraintViolationExceptionAcrossOrganisations extends ConstraintViolationException {
+    public ConstraintViolationExceptionAcrossOrganisations(String message, ConstraintViolationException cve) {
+        super(message, cve.getSQLException(),  cve.getSQL(), cve.getConstraintName());
+    }
+}
diff --git a/avni-server-api/src/main/java/org/avni/server/web/ErrorInterceptors.java b/avni-server-api/src/main/java/org/avni/server/web/ErrorInterceptors.java
@@ -5,11 +5,14 @@
 import org.avni.server.domain.accessControl.AvniAccessException;
 import org.avni.server.domain.accessControl.AvniNoUserSessionException;
 import org.avni.server.framework.rest.RestControllerErrorResponse;
+import org.avni.server.service.exception.ConstraintViolationExceptionAcrossOrganisations;
 import org.avni.server.util.BadRequestError;
 import org.avni.server.util.BugsnagReporter;
 import org.avni.server.web.util.ErrorBodyBuilder;
+import org.hibernate.exception.ConstraintViolationException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
+import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.data.rest.webmvc.ResourceNotFoundException;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
@@ -91,6 +94,14 @@ public ResponseEntity fileUploadSizeLimitExceededError(Exception e) {
         return ResponseEntity.badRequest().body(String.format("Maximum upload file size exceeded; ensure file size is less than %s.", maxFileSize));
     }
 
+    @ExceptionHandler(value = {DataIntegrityViolationException.class, ConstraintViolationException.class, ConstraintViolationExceptionAcrossOrganisations.class})
+    public ResponseEntity entityUpsertErrorDueToDataConstraintViolation(Exception e) {
+        bugsnagReporter.logAndReportToBugsnag(e);
+        return ResponseEntity.status(HttpStatus.CONFLICT).body(
+                String.format("Entity create or update failed due to constraint violation: %s",
+                        errorBodyBuilder.getErrorMessageBody(e)));
+    }
+
     @ExceptionHandler(value = {Exception.class})
     public ResponseEntity unknownException(Exception e) {
         if (e instanceof BadRequestError) {

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public ChecklistItem findChecklistItem(String checklistUUID, String checklistIte`
`37`	`37`
`38`	`38`	`@Transactional(Transactional.TxType.REQUIRED)`
`39`	`39`	`public void saveItem(ChecklistItem checklistItem) {`
`40`		`- checklistItemRepository.save(checklistItem);`
	`40`	`+ checklistItemRepository.saveEntity(checklistItem);`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -33,12 +33,12 @@ public CommentService(CommentRepository commentRepository, IndividualRepository`
`33`	`33`	`public Comment saveComment(CommentContract commentContract) {`
`34`	`34`	`Comment comment = new Comment();`
`35`	`35`	`buildComment(commentContract, comment);`
`36`		`- return commentRepository.save(comment);`
	`36`	`+ return commentRepository.saveEntity(comment);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`public Comment editComment(CommentContract commentContract, Comment existingComment) {`
`40`	`40`	`buildComment(commentContract, existingComment);`
`41`		`- return commentRepository.save(existingComment);`
	`41`	`+ return commentRepository.saveEntity(existingComment);`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`private void buildComment(CommentContract commentContract, Comment comment) {`
`@@ -54,7 +54,7 @@ private void buildComment(CommentContract commentContract, Comment comment) {`
`54`	`54`
`55`	`55`	`public Comment deleteComment(Comment comment) {`
`56`	`56`	`comment.setVoided(true);`
`57`		`- return commentRepository.save(comment);`
	`57`	`+ return commentRepository.saveEntity(comment);`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -44,13 +44,13 @@ public CommentThread createNewThread(CommentThreadContract threadContract) {`
`44`	`44`	`comments.add(comment);`
`45`	`45`	`});`
`46`	`46`	`commentThread.setComments(comments);`
`47`		`- return commentThreadRepository.save(commentThread);`
	`47`	`+ return commentThreadRepository.saveEntity(commentThread);`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`public CommentThread resolveThread(CommentThread commentThread) {`
`51`	`51`	`commentThread.setStatus(CommentThread.CommentThreadStatus.Resolved);`
`52`	`52`	`commentThread.setResolvedDateTime(new DateTime());`
`53`		`- return commentThreadRepository.save(commentThread);`
	`53`	`+ return commentThreadRepository.saveEntity(commentThread);`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,7 @@ public Encounter save(Encounter encounter) {`
`186`	`186`	`if (individual.getAddressLevel() != null) {`
`187`	`187`	`encounter.setAddressId(individual.getAddressLevel().getId());`
`188`	`188`	`}`
`189`		`- return encounterRepository.save(encounter);`
	`189`	`+ return encounterRepository.saveEntity(encounter);`
`190`	`190`	`}`
`191`	`191`
`192`	`192`	`public Page<Encounter> search(EncounterSearchRequest encounterSearchRequest) {`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public OperatingIndividualScopeAwareRepository<GroupSubject> repository() {`
`40`	`40`	`public GroupSubject save(GroupSubject groupSubject) throws ValidationException {`
`41`	`41`	`this.addSyncAttributes(groupSubject);`
`42`	`42`	`assignMemberToTheAssigneeOfGroup(groupSubject);`
`43`		`- return groupSubjectRepository.save(groupSubject);`
	`43`	`+ return groupSubjectRepository.saveEntity(groupSubject);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`private void assignMemberToTheAssigneeOfGroup(GroupSubject groupSubject) {`
Original file line number	Diff line number	Diff line change
`@@ -230,7 +230,7 @@ public ProgramEncounter save(ProgramEncounter programEncounter) {`
`230`	`230`	`if (individual.getAddressLevel() != null) {`
`231`	`231`	`programEncounter.setAddressId(individual.getAddressLevel().getId());`
`232`	`232`	`}`
`233`		`- programEncounter = programEncounterRepository.save(programEncounter);`
	`233`	`+ programEncounter = programEncounterRepository.saveEntity(programEncounter);`
`234`	`234`	`return programEncounter;`
`235`	`235`	`}`
`236`	`236`
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ public void changeSubjectsAddressLevel(List<Individual> subjects, AddressLevel d`
`127`	`127`	`subjects.forEach(individual -> {`
`128`	`128`	`this.markSubjectMigrationIfRequired(individual.getUuid(), null, destAddressLevel, null, individual.getObservations(), true);`
`129`	`129`	`individual.setAddressLevel(destAddressLevel);`
`130`		`- individualRepository.save(individual);`
	`130`	`+ individualRepository.saveEntity(individual);`
`131`	`131`	`});`
`132`	`132`	`}`
`133`	`133`	`}`