RSDEV-280: Return the list of Subsamples when cannot delete a Sample

Author: rs-nicof

pom.xml

@@ -3037,7 +3037,7 @@
     <jstl.version>1.1.2</jstl.version>
     <lucene.version>5.5.5</lucene.version>
     <netty.version>4.1.63.Final</netty.version>
-    <rspace-core-model.version>2.0.1</rspace-core-model.version>
+    <rspace-core-model.version>2.0.2-NIK-SNAPSHOT</rspace-core-model.version>
     <servlet.version>3.1.0</servlet.version>
     <sitemesh.version>2.4.2</sitemesh.version>
     <urlrewrite.version>4.0.3</urlrewrite.version>

src/main/java/com/researchspace/api/v1/model/ApiInventoryBulkOperationResult.java

@@ -74,6 +74,15 @@ public void addError(ApiError error) {
     errorCount++;
   }
 
+  public void addErrorWithRecord(ApiInventoryRecordInfo operationResult, ApiError error) {
+    ApiInventoryBulkOperationRecordResult result =
+        new ApiInventoryBulkOperationRecordResult(operationResult, error);
+    result.record = operationResult;
+    result.error = error;
+    results.add(result);
+    errorCount++;
+  }
+
   public void changeIntoErrorResult(ApiInventoryBulkOperationRecordResult result, ApiError error) {
     result.record = null;
     result.error = error;

src/main/java/com/researchspace/api/v1/model/ApiSample.java

@@ -1,11 +1,12 @@
 /** RSpace Inventory API Access your RSpace Inventory programmatically. */
 package com.researchspace.api.v1.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.researchspace.model.inventory.Sample;
 import com.researchspace.model.inventory.SubSample;
-import java.util.ArrayList;
+import java.util.LinkedList;
 import java.util.List;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
@@ -28,6 +29,7 @@
   "lastModified",
   "modifiedBy",
   "modifiedByFullName",
+  "canBeDeleted",
   "deleted",
   "deletedDate",
   "iconId",
@@ -56,19 +58,34 @@
   "fields",
   "extraFields",
   "subSamples",
+  "subSamplesIntoContainer",
   "_links"
 })
+@JsonIgnoreProperties(ignoreUnknown = true)
 public class ApiSample extends ApiSampleWithoutSubSamples {
 
   @JsonProperty("subSamples")
-  private List<ApiSubSampleInfo> subSamples = new ArrayList<>();
+  private List<ApiSubSampleInfo> subSamples = new LinkedList<>();
+
+  @JsonProperty("subSamplesIntoContainer")
+  @JsonIgnoreProperties(ignoreUnknown = true)
+  private List<ApiSubSampleInfo> subSamplesIntoContainer = new LinkedList<>();
+
+  /* this will be `true` only when `subSamplesIntoContainer` is null or empty */
+  @JsonProperty("canBeDeleted")
+  private Boolean canBeDeleted;
 
   public ApiSample(Sample sample) {
     super(sample);
 
     for (SubSample subSample : sample.getActiveSubSamples()) {
-      subSamples.add(new ApiSubSampleInfo(subSample));
+      ApiSubSampleInfo subSampInfo = new ApiSubSampleInfo(subSample);
+      this.subSamples.add(subSampInfo);
+      if (subSample.isLocatedIntoContainer()) {
+        this.subSamplesIntoContainer.add(subSampInfo);
+      }
     }
+    this.canBeDeleted = this.subSamplesIntoContainer.isEmpty();
   }
 
   @Override

src/main/java/com/researchspace/service/inventory/impl/InventoryBulkOperationHandler.java

@@ -11,6 +11,7 @@
 import com.researchspace.api.v1.model.ApiInventoryBulkOperationResult;
 import com.researchspace.api.v1.model.ApiInventoryRecordInfo;
 import com.researchspace.api.v1.model.ApiInventoryRecordInfo.ApiInventoryRecordType;
+import com.researchspace.api.v1.model.ApiSample;
 import com.researchspace.api.v1.model.ApiSampleInfo;
 import com.researchspace.api.v1.model.ApiSampleTemplate;
 import com.researchspace.api.v1.model.ApiSampleWithFullSubSamples;
@@ -104,7 +105,7 @@ public ApiInventoryBulkOperationResult runBulkOperation(
   private ApiInventoryBulkOperationResult runOperationForEachRecordFromBulkList(
       InventoryBulkOperationConfig bulkOpConfig,
       BiFunction<ApiInventoryRecordInfo, User, ApiInventoryRecordInfo> operation) {
-
+    // TODO[nik]: change this
     ApiInventoryBulkOperationResult result = new ApiInventoryBulkOperationResult();
     List<ApiInventoryRecordInfo> records = bulkOpConfig.getRecords();
     User user = bulkOpConfig.getUser();
@@ -117,7 +118,21 @@ private ApiInventoryBulkOperationResult runOperationForEachRecordFromBulkList(
           }
           ApiInventoryRecordInfo operationResult = operation.apply(recInfo, user);
           if (operationResult != null) {
-            result.addSuccessResult(operationResult);
+            /* manage Sample deletion */
+            if (operationResult.getClass().isAssignableFrom(ApiSample.class)) {
+              ApiSample apiSample = (ApiSample) operationResult;
+              if (!apiSample.getCanBeDeleted()) {
+                ApiError err =
+                    new ApiError(
+                        HttpStatus.NOT_ACCEPTABLE,
+                        ApiErrorCodes.CONSTRAINT_VIOLATION.getCode(),
+                        "Errors detected : 1",
+                        "The Sample had got at least one active Subsample(s) located in a container");
+                result.addErrorWithRecord(operationResult, err);
+              }
+            } else {
+              result.addSuccessResult(operationResult);
+            }
           }
         } catch (Exception e) {
           ApiError error = convertExceptionToApiError(e);

src/main/java/com/researchspace/service/inventory/impl/SampleApiManagerImpl.java

@@ -1,7 +1,6 @@
 package com.researchspace.service.inventory.impl;
 
 import com.axiope.search.InventorySearchConfig.InventorySearchDeletedOption;
-import com.researchspace.api.v1.auth.ApiRuntimeException;
 import com.researchspace.api.v1.model.ApiFieldToModelFieldFactory;
 import com.researchspace.api.v1.model.ApiInventoryRecordInfo;
 import com.researchspace.api.v1.model.ApiInventorySearchResult;
@@ -595,42 +594,28 @@ public ApiSample markSampleAsDeleted(Long sampleId, boolean forceDelete, User us
       dbSample = getIfExists(dbSample.getId());
       if (!dbSample.isDeleted()) {
         /* first try deleting undeleted subsamples */
-        if (!forceDelete) {
-          long ssInContainersCount =
-              dbSample.getActiveSubSamples().stream()
-                  .filter(
-                      ss ->
-                          ss.getParentContainer() != null
-                              && !ContainerType.WORKBENCH.equals(
-                                  ss.getParentContainer().getContainerType()))
-                  .count();
-          if (ssInContainersCount > 0) {
-            throw new ApiRuntimeException(
-                "sample.deletion.failure.subsamples.in.containers",
-                dbSample.getGlobalIdentifier(),
-                ssInContainersCount);
-          }
+        if (forceDelete) {
+          dbSample
+              .getActiveSubSamples()
+              .forEach(ss -> subSampleMgr.markSubSampleAsDeleted(ss.getId(), user, true));
+          dbSample.refreshActiveSubSamples();
+          dbSample.recalculateTotalQuantity();
+
+          /* then delete the sample */
+          dbSample.setRecordDeleted(true);
+          dbSample = sampleDao.save(dbSample);
+          publisher.publishEvent(new InventoryDeleteEvent(dbSample, user));
         }
-        dbSample
-            .getActiveSubSamples()
-            .forEach(ss -> subSampleMgr.markSubSampleAsDeleted(ss.getId(), user, true));
-        dbSample.refreshActiveSubSamples();
-        dbSample.recalculateTotalQuantity();
-
-        /* then delete the sample */
-        dbSample.setRecordDeleted(true);
-        dbSample = sampleDao.save(dbSample);
-        publisher.publishEvent(new InventoryDeleteEvent(dbSample, user));
       }
     } finally {
       if (temporaryLock) {
         unlockItemAfterEdit(dbSample, user);
       }
     }
 
-    ApiSample deleted = getOutgoingApiSample(dbSample, user);
-    updateOntologyOnRecordChanges(deleted, user);
-    return deleted;
+    ApiSample apiSampleResult = getOutgoingApiSample(dbSample, user);
+    updateOntologyOnRecordChanges(apiSampleResult, user);
+    return apiSampleResult;
   }
 
   @Override

src/main/java/com/researchspace/webapp/controller/ServiceLoggerAspct.java

@@ -101,7 +101,8 @@ protected String methodInfo(ProceedingJoinPoint jp, String methodName) {
     MethodSignature methodSignature = (MethodSignature) jp.getSignature();
     if (shouldSkipMethodArgs(methodSignature)) {
       return String.format(
-          "In method [%s] in class [%s] (args hidden)", methodName, jp.getSignature().getDeclaringTypeName());
+          "In method [%s] in class [%s] (args hidden)",
+          methodName, jp.getSignature().getDeclaringTypeName());
     }
     return String.format(
         "In method [%s] in class [%s] with args: %s",

src/test/java/com/researchspace/service/ExternalMessageHandlerImplTest.java

@@ -10,7 +10,6 @@
 import com.researchspace.model.views.ServiceOperationResult;
 import com.researchspace.service.impl.ConditionalTestRunner;
 import com.researchspace.service.impl.RunIfSystemPropertyDefined;
-import com.researchspace.slack.SlackPosterTest;
 import com.researchspace.testutils.RSpaceTestUtils;
 import com.researchspace.testutils.SpringTransactionalTest;
 import java.util.HashMap;
@@ -159,5 +158,4 @@ private Map<String, String> getMsTeamsCfg() {
     map.put("MSTEAMS_WEBHOOK_URL", msTeamsTestWebhookUrl);
     return map;
   }
-
 }

src/test/java/com/researchspace/slack/SlackPosterTest.java

@@ -7,7 +7,6 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.researchspace.service.impl.ConditionalTestRunner;
-import com.researchspace.service.impl.ConditionalTestRunnerNotSpring;
 import com.researchspace.service.impl.RunIfSystemPropertyDefined;
 import com.researchspace.session.SessionTimeZoneUtils;
 import com.researchspace.testutils.SpringTransactionalTest;
@@ -74,6 +73,4 @@ public void testSlackTemplate() throws URISyntaxException, JsonProcessingExcepti
     assertEquals(HttpStatus.OK, resp.getStatusCode());
     System.err.println(resp);
   }
-
-
 }

src/test/java/com/researchspace/webapp/integrations/dmptool/DMPToolOAuthControllerMVCIT.java

@@ -13,7 +13,6 @@
 import com.researchspace.dmptool.model.DMPList;
 import com.researchspace.dmptool.model.DMPPlanScope;
 import com.researchspace.dmptool.model.DMPToolDMP;
-import com.researchspace.model.User;
 import com.researchspace.model.dmps.DMPUser;
 import com.researchspace.service.impl.ConditionalTestRunner;
 import com.researchspace.service.impl.RunIfSystemPropertyDefined;