Merge pull request #585 from iExecBlockchainComputing/release/8.4.0

Release/8.4.0

Author: mcornaton

CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file.
 
+## [[8.4.0]](https://github.com/iExecBlockchainComputing/iexec-worker/releases/tag/v8.4.0) 2024-02-29
+
+### New Features
+
+- Retrieve Result Proxy JWT with `WorkerpoolAuthorization`. (#581)
+- Push Result Proxy JWT for IPFS to SMS. (#582)
+
+### Quality
+
+- `SconeConfiguration` class becomes immutable. (#577)
+- Fix `onTaskNotification` visibility and lower its complexity. (#578)
+- Throw a dedicated exception on empty parameters when authenticating to a docker registry. (#579)
+- Check replicate recoverability wih a dedicated check in `ReplicateRecoveryService`. (#580)
+
+### Dependency Upgrades
+
+- Upgrade to `iexec-common` 8.4.0. (#583)
+- Upgrade to `iexec-blockchain-adapter` 8.4.0. (#584)
+- Upgrade to `iexec-result-proxy` 8.4.0. (#584)
+- Upgrade to `iexec-sms` 8.5.0. (#584)
+
 ## [[8.3.0]](https://github.com/iExecBlockchainComputing/iexec-worker/releases/tag/v8.3.0) 2024-01-11
 
 ### New Features

gradle.properties

@@ -1,10 +1,10 @@
-version=8.3.0
-iexecCommonVersion=8.3.1
+version=8.4.0
+iexecCommonVersion=8.4.0
 iexecCommonsContainersVersion=1.2.1
 iexecCommonsPocoVersion=3.2.0
-iexecBlockchainAdapterVersion=8.3.0
-iexecResultVersion=8.3.0
-iexecSmsVersion=8.4.0
+iexecBlockchainAdapterVersion=8.4.0
+iexecResultVersion=8.4.0
+iexecSmsVersion=8.5.0
 
 nexusUser
 nexusPassword

src/main/java/com/iexec/worker/Application.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 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.
@@ -29,18 +29,19 @@
 import org.springframework.boot.CommandLineRunner;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
 import org.springframework.cloud.openfeign.EnableFeignClients;
 import org.springframework.retry.annotation.EnableRetry;
 import org.springframework.scheduling.annotation.EnableAsync;
 
 import java.util.List;
 
-
-@SpringBootApplication
-@EnableFeignClients
+@Slf4j
 @EnableRetry
 @EnableAsync
-@Slf4j
+@EnableFeignClients
+@SpringBootApplication
+@ConfigurationPropertiesScan
 public class Application implements CommandLineRunner {
 
     @Autowired

src/main/java/com/iexec/worker/compute/ComputeManagerService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 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.
@@ -41,7 +41,7 @@
 import java.time.temporal.ChronoUnit;
 import java.util.HashMap;
 import java.util.Map;
-
+import java.util.function.Predicate;
 
 @Slf4j
 @Service
@@ -225,4 +225,11 @@ public PostComputeResponse runPostCompute(TaskDescription taskDescription,
         return postComputeResponse;
     }
 
+    public boolean abort(String chainTaskId) {
+        Predicate<String> containsChainTaskId = name -> name.contains(chainTaskId);
+        long remaining = dockerService.stopRunningContainersWithNamePredicate(containsChainTaskId);
+        log.info("Stopped task containers [chainTaskId:{}, remaining:{}]", chainTaskId, remaining);
+        return remaining == 0L;
+    }
+
 }

src/main/java/com/iexec/worker/docker/DockerService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 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.
@@ -74,7 +74,7 @@ public DockerClientInstance getClient() {
      * <p>
      * e.g. for the image "registry.xyz/image:tag" we try to connect to
      * "registry.xyz" and for "iexechub/image:tag" we try to connect to docker.io.
-     * 
+     *
      * @param imageName
      * @return an authenticated Docker client if credentials for the image's registry are
      * to be found, an unauthenticated client otherwise.
@@ -99,21 +99,20 @@ public DockerClientInstance getClient(String imageName) {
 
     /**
      * Get a Docker client that is authenticated to the specified registry.
-     * 
-     * @param registryAddress
-     * @param registryUsername
-     * @param registryPassword
-     * @return
-     * @throws Exception when on of the arguments is blank or when authentication fails
+     *
+     * @param registryAddress  Registry address
+     * @param registryUsername Username to authenticate on the registry
+     * @param registryPassword Password to authenticate on the registry
+     * @return An authenticated client
      */
     public DockerClientInstance getClient(String registryAddress,
                                           String registryUsername,
-                                          String registryPassword) throws Exception {
+                                          String registryPassword) {
         if (StringUtils.isBlank(registryAddress) || StringUtils.isBlank(registryUsername)
                 || StringUtils.isBlank(registryPassword)) {
             log.error("Registry parameters are required [registry:{}, username:{}]",
                     registryAddress, registryUsername);
-            throw new Exception("All Docker registry parameters must be provided: "
+            throw new IllegalArgumentException("All Docker registry parameters must be provided: "
                     + registryAddress);
         }
         return DockerClientFactory.getDockerClientInstance(
@@ -208,23 +207,25 @@ public void stopAllRunningContainers() {
      * the worker aborts a task and needs to stop its pre-compute, compute, or
      * post-compute containers. The container itself is not removed here as it is
      * removed by its watcher thread.
-     * 
+     *
      * @param containerNamePredicate predicate that contains a condition on the
      *                               container name.
+     * @return The remaining count of containers matching the provided predicate.
      */
-    public void stopRunningContainersWithNamePredicate(Predicate<String> containerNamePredicate) {
+    public long stopRunningContainersWithNamePredicate(Predicate<String> containerNamePredicate) {
         log.info("Stopping containers with names matching the provided predicate");
         List.copyOf(runningContainersRecord).stream()
                 .filter(containerNamePredicate)
                 .forEach(this::stopRunningContainer);
+        return List.copyOf(runningContainersRecord).stream()
+                .filter(containerNamePredicate).count();
     }
 
     /**
-     * Stop a running container with the provided containerName and remove it from
-     * running containers record. The container itself is not stopped here as it is
-     * removed by its watcher thread.
-     * 
-     * @param containerName
+     * Stop a running container with the provided name and remove it from the running containers record.
+     * The container itself is not stopped here as it is removed by its watcher thread.
+     *
+     * @param containerName Name of container to stop
      */
     void stopRunningContainer(String containerName) {
         if (!getClient().isContainerPresent(containerName)) {
@@ -244,8 +245,8 @@ void stopRunningContainer(String containerName) {
 
     /**
      * Get the record of running containers. Added originally for testing purposes.
-     * 
-     * @return
+     *
+     * @return The current set of running containers
      */
     Set<String> getRunningContainersRecord() {
         return runningContainersRecord;

src/main/java/com/iexec/worker/executor/TaskManagerService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 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.
@@ -32,9 +32,9 @@
 import com.iexec.worker.compute.post.PostComputeResponse;
 import com.iexec.worker.compute.pre.PreComputeResponse;
 import com.iexec.worker.dataset.DataService;
-import com.iexec.worker.docker.DockerService;
 import com.iexec.worker.pubsub.SubscriptionService;
 import com.iexec.worker.result.ResultService;
+import com.iexec.worker.sms.SmsService;
 import com.iexec.worker.tee.TeeService;
 import com.iexec.worker.tee.TeeServicesManager;
 import com.iexec.worker.utils.LoggingUtils;
@@ -43,14 +43,12 @@
 import org.springframework.stereotype.Service;
 
 import java.util.Optional;
-import java.util.function.Predicate;
 
 import static com.iexec.common.replicate.ReplicateStatus.APP_DOWNLOAD_FAILED;
 import static com.iexec.common.replicate.ReplicateStatus.DATA_DOWNLOAD_FAILED;
 import static com.iexec.common.replicate.ReplicateStatusCause.*;
 import static java.util.Objects.requireNonNull;
 
-
 @Slf4j
 @Service
 public class TaskManagerService {
@@ -65,7 +63,7 @@ public class TaskManagerService {
     private final TeeServicesManager teeServicesManager;
     private final DataService dataService;
     private final ResultService resultService;
-    private final DockerService dockerService;
+    private final SmsService smsService;
     private final SubscriptionService subscriptionService;
     private final PurgeService purgeService;
     private final String workerWalletAddress;
@@ -78,7 +76,7 @@ public TaskManagerService(
             TeeServicesManager teeServicesManager,
             DataService dataService,
             ResultService resultService,
-            DockerService dockerService,
+            SmsService smsService,
             SubscriptionService subscriptionService,
             PurgeService purgeService,
             String workerWalletAddress) {
@@ -89,7 +87,7 @@ public TaskManagerService(
         this.teeServicesManager = teeServicesManager;
         this.dataService = dataService;
         this.resultService = resultService;
-        this.dockerService = dockerService;
+        this.smsService = smsService;
         this.subscriptionService = subscriptionService;
         this.purgeService = purgeService;
         this.workerWalletAddress = workerWalletAddress;
@@ -121,7 +119,12 @@ ReplicateActionResponse start(TaskDescription taskDescription) {
                 log.error("TEE prerequisites are not met [chainTaskId: {}, issue: {}]", chainTaskId, teePrerequisitesIssue.get());
                 return getFailureResponseAndPrintError(teePrerequisitesIssue.get(), context, chainTaskId);
             }
+
+            final WorkerpoolAuthorization workerpoolAuthorization = contributionService.getWorkerpoolAuthorization(chainTaskId);
+            final String token = resultService.getIexecUploadToken(workerpoolAuthorization);
+            smsService.pushToken(workerpoolAuthorization, token);
         }
+
         return ReplicateActionResponse.success();
     }
 
@@ -342,8 +345,9 @@ private ReplicateActionResponse contributeOrContributeAndFinalize(String chainTa
                         context, chainTaskId);
             }
 
+            final WorkerpoolAuthorization workerpoolAuthorization = contributionService.getWorkerpoolAuthorization(chainTaskId);
             String callbackData = computedFile.getCallbackData();
-            String resultLink = resultService.uploadResultAndGetLink(chainTaskId);
+            String resultLink = resultService.uploadResultAndGetLink(workerpoolAuthorization);
             log.debug("contributeAndFinalize [contribution:{}, resultLink:{}, callbackData:{}]",
                     contribution, resultLink, callbackData);
             Optional<ChainReceipt> oChainReceipt = iexecHubService.contributeAndFinalize(contribution, resultLink, callbackData);
@@ -418,16 +422,16 @@ ReplicateActionResponse reveal(String chainTaskId,
     }
 
     ReplicateActionResponse uploadResult(String chainTaskId) {
-        String resultLink = resultService.uploadResultAndGetLink(chainTaskId);
+        final WorkerpoolAuthorization workerpoolAuthorization = contributionService.getWorkerpoolAuthorization(chainTaskId);
+        String resultLink = resultService.uploadResultAndGetLink(workerpoolAuthorization);
         String context = "upload result";
         if (resultLink.isEmpty()) {
             return getFailureResponseAndPrintError(RESULT_LINK_MISSING,
                     context, chainTaskId
             );
         }
 
-        ComputedFile computedFile =
-                resultService.getComputedFile(chainTaskId);
+        ComputedFile computedFile = resultService.getComputedFile(chainTaskId);
         String callbackData = computedFile != null ?
                 computedFile.getCallbackData() : "";
 
@@ -456,18 +460,18 @@ ReplicateActionResponse complete(String chainTaskId) {
      * related to the task in question, unsubscribe from the task's notifications,
      * then remove result folders.
      *
-     * @param chainTaskId
-     * @return
+     * @param chainTaskId Task ID
+     * @return {@literal true} if all cleanup operations went well, {@literal false} otherwise
      */
     boolean abort(String chainTaskId) {
         log.info("Aborting task [chainTaskId:{}]", chainTaskId);
-        Predicate<String> containsChainTaskId = name -> name.contains(chainTaskId);
-        dockerService.stopRunningContainersWithNamePredicate(containsChainTaskId);
-        log.info("Stopped task containers [chainTaskId:{}]", chainTaskId);
         subscriptionService.unsubscribeFromTopic(chainTaskId);
-        boolean isSuccess = purgeService.purgeAllServices(chainTaskId);
+        boolean allContainersStopped = computeManagerService.abort(chainTaskId);
+        boolean allServicesPurged = purgeService.purgeAllServices(chainTaskId);
+        final boolean isSuccess = allContainersStopped && allServicesPurged;
         if (!isSuccess) {
-            log.error("Failed to abort task [chainTaskId:{}]", chainTaskId);
+            log.error("Failed to abort task [chainTaskId:{}, containers:{}, services:{}]",
+                    chainTaskId, allContainersStopped, allServicesPurged);
         }
         return isSuccess;
     }