Merge pull request #394 from iExecBlockchainComputing/feature/next-action-on-replicate-status-and-cause

james-toussaint · web-flow · commit 7ffdd87334d3 · 2021-02-10T12:38:53.000+01:00
Next action depends on replicate status and cause
diff --git a/src/main/java/com/iexec/core/chain/DealWatcherService.java b/src/main/java/com/iexec/core/chain/DealWatcherService.java
@@ -100,7 +100,7 @@ private void onDealEvent(DealEvent dealEvent) {
      */
     private void handleDeal(String chainDealId) {
         Optional<ChainDeal> oChainDeal = iexecHubService.getChainDeal(chainDealId);
-        if (!oChainDeal.isPresent()) {
+        if (oChainDeal.isEmpty()) {
             log.error("Could not get chain deal [chainDealId:{}]", chainDealId);
             return;
         }
diff --git a/src/main/java/com/iexec/core/replicate/ReplicatesService.java b/src/main/java/com/iexec/core/replicate/ReplicatesService.java
@@ -36,6 +36,7 @@
 import com.iexec.common.chain.ChainContribution;
 import com.iexec.common.notification.TaskNotificationType;
 import com.iexec.common.replicate.ReplicateStatus;
+import com.iexec.common.replicate.ReplicateStatusCause;
 import com.iexec.common.replicate.ReplicateStatusDetails;
 import com.iexec.common.replicate.ReplicateStatusUpdate;
 import com.iexec.common.task.TaskDescription;
@@ -316,10 +317,13 @@ public Optional<TaskNotificationType> updateReplicateStatus(String chainTaskId,
         replicate.updateStatus(statusUpdate);
         replicatesRepository.save(replicatesList);
         applicationEventPublisher.publishEvent(new ReplicateUpdatedEvent(chainTaskId, walletAddress, statusUpdate));
-        TaskNotificationType nextAction = ReplicateWorkflow.getInstance().getNextAction(newStatus);
+        ReplicateStatusCause newStatusCause = statusUpdate.getDetails() != null ?
+                statusUpdate.getDetails().getCause() : null;
+        TaskNotificationType nextAction = ReplicateWorkflow.getInstance().getNextAction(newStatus, newStatusCause);
 
-        log.info("Replicate updated successfully [newStatus:{} nextAction:{}, chainTaskId:{}, walletAddress:{}]",
-                replicate.getCurrentStatus(), nextAction, chainTaskId, walletAddress);
+        log.info("Replicate updated successfully [newStatus:{}, newStatusCause:{} " +
+                        "nextAction:{}, chainTaskId:{}, walletAddress:{}]",
+                replicate.getCurrentStatus(), newStatusCause, nextAction, chainTaskId, walletAddress);
 
         return Optional.ofNullable(nextAction); // should we return a default action when null?
     }
diff --git a/src/main/java/com/iexec/core/workflow/ReplicateWorkflow.java b/src/main/java/com/iexec/core/workflow/ReplicateWorkflow.java
@@ -18,6 +18,7 @@
 
 import com.iexec.common.notification.TaskNotificationType;
 import com.iexec.common.replicate.ReplicateStatus;
+import com.iexec.common.replicate.ReplicateStatusCause;
 
 import static com.iexec.common.notification.TaskNotificationType.*;
 import static com.iexec.common.replicate.ReplicateStatus.*;
@@ -31,7 +32,7 @@
 public class ReplicateWorkflow extends Workflow<ReplicateStatus> {
 
     private static ReplicateWorkflow instance;
-    private Map<ReplicateStatus, TaskNotificationType> actionMap = new LinkedHashMap<>();
+    private final Map<ReplicateStatus, TaskNotificationType> actionMap = new LinkedHashMap<>();
 
     private ReplicateWorkflow() {
         super();
@@ -171,7 +172,39 @@ private void setNextAction(ReplicateStatus whenStatus, TaskNotificationType next
         actionMap.putIfAbsent(whenStatus, nextAction);
     }
 
-    public TaskNotificationType getNextAction(ReplicateStatus whenStatus) {
+    public TaskNotificationType getNextAction(ReplicateStatus whenStatus, ReplicateStatusCause whenCause) {
+        TaskNotificationType nextAction = getNextActionWhenStatusAndCause(whenStatus, whenCause);
+        if (nextAction == null){
+            nextAction = getNextActionWhenStatus(whenStatus);
+        }
+        return nextAction;
+    }
+
+    TaskNotificationType getNextActionWhenStatusAndCause(ReplicateStatus whenStatus, ReplicateStatusCause whenCause) {
+        if (whenStatus == null){
+            return null;
+        }
+        if (whenCause == null){
+            return null;
+        }
+        switch (whenStatus){
+            case APP_DOWNLOAD_FAILED:
+                if (whenCause.equals(ReplicateStatusCause.APP_IMAGE_DOWNLOAD_FAILED)){
+                    return PLEASE_CONTRIBUTE;
+                }
+                return PLEASE_ABORT;
+            case DATA_DOWNLOAD_FAILED:
+                if (whenCause.equals(ReplicateStatusCause.DATASET_FILE_DOWNLOAD_FAILED)
+                        || whenCause.equals(ReplicateStatusCause.INPUT_FILES_DOWNLOAD_FAILED)){
+                    return PLEASE_CONTRIBUTE;
+                }
+                return PLEASE_ABORT;
+            default:
+                return null;
+        }
+    }
+
+    TaskNotificationType getNextActionWhenStatus(ReplicateStatus whenStatus) {
         if (actionMap.containsKey(whenStatus)){
             return actionMap.get(whenStatus);
         }
@@ -185,11 +218,11 @@ private void setNextActions() {
 
         setNextAction(APP_DOWNLOADING, PLEASE_CONTINUE);
         setNextAction(APP_DOWNLOADED, PLEASE_DOWNLOAD_DATA);
-        setNextAction(APP_DOWNLOAD_FAILED, PLEASE_CONTRIBUTE);
+        setNextAction(APP_DOWNLOAD_FAILED, PLEASE_ABORT);
 
         setNextAction(DATA_DOWNLOADING, PLEASE_CONTINUE);
         setNextAction(DATA_DOWNLOADED, PLEASE_COMPUTE);
-        setNextAction(DATA_DOWNLOAD_FAILED, PLEASE_CONTRIBUTE);
+        setNextAction(DATA_DOWNLOAD_FAILED, PLEASE_ABORT);
 
         setNextAction(COMPUTING, PLEASE_CONTINUE);
         setNextAction(COMPUTED, PLEASE_CONTRIBUTE);
diff --git a/src/main/resources/workflow/replicate-actions.json b/src/main/resources/workflow/replicate-actions.json
@@ -4,10 +4,10 @@
   "START_FAILED" : "PLEASE_ABORT",
   "APP_DOWNLOADING" : "PLEASE_CONTINUE",
   "APP_DOWNLOADED" : "PLEASE_DOWNLOAD_DATA",
-  "APP_DOWNLOAD_FAILED" : "PLEASE_CONTRIBUTE",
+  "APP_DOWNLOAD_FAILED" : "PLEASE_ABORT",
   "DATA_DOWNLOADING" : "PLEASE_CONTINUE",
   "DATA_DOWNLOADED" : "PLEASE_COMPUTE",
-  "DATA_DOWNLOAD_FAILED" : "PLEASE_CONTRIBUTE",
+  "DATA_DOWNLOAD_FAILED" : "PLEASE_ABORT",
   "COMPUTING" : "PLEASE_CONTINUE",
   "COMPUTED" : "PLEASE_CONTRIBUTE",
   "COMPUTE_FAILED" : "PLEASE_ABORT",
diff --git a/src/test/java/com/iexec/core/workflow/ReplicateWorkflowTests.java b/src/test/java/com/iexec/core/workflow/ReplicateWorkflowTests.java
@@ -0,0 +1,126 @@
+/*
+ * Copyright 2020 IEXEC BLOCKCHAIN TECH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.iexec.core.workflow;
+
+import com.iexec.common.notification.TaskNotificationType;
+import com.iexec.common.replicate.ReplicateStatus;
+import com.iexec.common.replicate.ReplicateStatusCause;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.MockitoAnnotations;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class ReplicateWorkflowTests {
+
+    private ReplicateWorkflow replicateWorkflow;
+
+    @Before
+    public void setup() {
+        replicateWorkflow = ReplicateWorkflow.getInstance();
+    }
+
+    @Test
+    public void shouldNotGetNextActionWhenStatusSinceStatusIsNull(){
+        assertThat(replicateWorkflow
+                .getNextActionWhenStatus(null)).isNull();
+    }
+
+    @Test
+    public void shouldNotGetNextActionWhenStatusSinceStatusIsUnknown(){
+        assertThat(replicateWorkflow
+                .getNextActionWhenStatus(ReplicateStatus.ABORTED)) //unknown
+                .isNull();
+    }
+
+    @Test
+    public void shouldNotGetNextActionWhenStatusAndCauseSinceCauseIsNull(){
+        assertThat(replicateWorkflow
+                .getNextActionWhenStatusAndCause(null,
+                        ReplicateStatusCause.INPUT_FILES_DOWNLOAD_FAILED)) //any
+                .isNull();
+    }
+
+    @Test
+    public void shouldNotGetNextActionWhenStatusAndCauseSinceStatusIsUnknown(){
+        assertThat(replicateWorkflow
+                .getNextActionWhenStatusAndCause(ReplicateStatus.ABORTED, //unknown
+                        ReplicateStatusCause.ABORTED_BY_WORKER)) //any
+                .isNull();
+    }
+
+    // app
+
+    @Test
+    public void shouldGetNextActionOnAppDownloadFailed(){
+        assertThat(replicateWorkflow
+                .getNextAction(ReplicateStatus.APP_DOWNLOAD_FAILED,
+                        null))
+                .isEqualTo(TaskNotificationType.PLEASE_ABORT);
+    }
+
+    @Test
+    public void shouldGetNextActionOnAppDownloadFailedWithPostComputeFailed(){
+        assertThat(replicateWorkflow
+                .getNextAction(ReplicateStatus.APP_DOWNLOAD_FAILED,
+                        ReplicateStatusCause.POST_COMPUTE_FAILED))
+                .isEqualTo(TaskNotificationType.PLEASE_ABORT);
+    }
+
+    @Test
+    public void shouldGetNextActionOnAppDownloadFailedWithAppImageDownloadFailed(){
+        assertThat(replicateWorkflow
+                .getNextAction(ReplicateStatus.APP_DOWNLOAD_FAILED,
+                        ReplicateStatusCause.APP_IMAGE_DOWNLOAD_FAILED))
+                .isEqualTo(TaskNotificationType.PLEASE_CONTRIBUTE);
+    }
+
+    // data
+
+    @Test
+    public void shouldGetNextActionOnDataDownloadFailed(){
+        assertThat(replicateWorkflow
+                .getNextAction(ReplicateStatus.DATA_DOWNLOAD_FAILED,
+                        null))
+                .isEqualTo(TaskNotificationType.PLEASE_ABORT);
+    }
+
+    @Test
+    public void shouldGetNextActionOnDataDownloadFailedWithPostComputeFailed(){
+        assertThat(replicateWorkflow
+                .getNextAction(ReplicateStatus.DATA_DOWNLOAD_FAILED,
+                        ReplicateStatusCause.POST_COMPUTE_FAILED))
+                .isEqualTo(TaskNotificationType.PLEASE_ABORT);
+    }
+
+    @Test
+    public void shouldGetNextActionOnDataDownloadFailedWithDatasetDownloadFailed(){
+        assertThat(replicateWorkflow
+                .getNextAction(ReplicateStatus.DATA_DOWNLOAD_FAILED,
+                        ReplicateStatusCause.DATASET_FILE_DOWNLOAD_FAILED))
+                .isEqualTo(TaskNotificationType.PLEASE_CONTRIBUTE);
+    }
+
+    @Test
+    public void shouldGetNextActionOnDataDownloadFailedWithInputFilesDownloadFailed(){
+        assertThat(replicateWorkflow
+                .getNextAction(ReplicateStatus.DATA_DOWNLOAD_FAILED,
+                        ReplicateStatusCause.INPUT_FILES_DOWNLOAD_FAILED))
+                .isEqualTo(TaskNotificationType.PLEASE_CONTRIBUTE);
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ private void onDealEvent(DealEvent dealEvent) {`
`100`	`100`	`*/`
`101`	`101`	`private void handleDeal(String chainDealId) {`
`102`	`102`	`Optional<ChainDeal> oChainDeal = iexecHubService.getChainDeal(chainDealId);`
`103`		`- if (!oChainDeal.isPresent()) {`
	`103`	`+ if (oChainDeal.isEmpty()) {`
`104`	`104`	`log.error("Could not get chain deal [chainDealId:{}]", chainDealId);`
`105`	`105`	`return;`
`106`	`106`	`}`