Create iexec-task-api to access task feedback API

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## [[NEXT]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/vNEXT) 2024
 
+### New Features
+
+- Create `iexec-task-api` to access task feedback API. (#695)
+
 ### Bug Fixes
 
 - Always use `WorkerpoolAuthorization` to retrieve JWT and check result upload on Result Proxy. (#690)

build.gradle

@@ -59,6 +59,7 @@ dependencies {
     implementation "com.iexec.result-proxy:iexec-result-proxy-library:$iexecResultVersion"
     implementation "com.iexec.sms:iexec-sms-library:$iexecSmsVersion"
     implementation project(':iexec-core-library')
+    implementation project(':iexec-task-api')
 
     // spring
     implementation "org.springframework.boot:spring-boot-starter"

iexec-core-library/build.gradle

@@ -8,6 +8,8 @@ plugins {
 dependencies {
     implementation "com.iexec.commons:iexec-commons-poco:$iexecCommonsPocoVersion"
     implementation "com.iexec.common:iexec-common:$iexecCommonVersion"
+    // TODO remove this later when migration has been done
+    implementation project(':iexec-task-api')
 }
 
 java {

iexec-core-library/src/main/java/com/iexec/core/api/SchedulerClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2023-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.
@@ -35,6 +35,10 @@
 import java.util.List;
 
 public interface SchedulerClient {
+    /**
+     * @deprecated Use iexec-task-feedback-api
+     */
+    @Deprecated(forRemoval = true)
     @RequestLine("GET /metrics")
     PlatformMetric getMetrics();
 
@@ -85,18 +89,35 @@ TaskNotificationType updateReplicateStatus(
     // endregion
 
     // region /tasks
+
+    /**
+     * @deprecated Use iexec-task-feedback-api
+     */
+    @Deprecated(forRemoval = true)
     @RequestLine("GET /tasks/{chainTaskId}")
     TaskModel getTask(@Param("chainTaskId") String chainTaskId);
 
+    /**
+     * @deprecated Use iexec-task-feedback-api
+     */
+    @Deprecated(forRemoval = true)
     @RequestLine("GET /tasks/logs/challenge?address={address}")
     EIP712Challenge getTaskLogsChallenge(@Param("address") String address);
 
+    /**
+     * @deprecated Use iexec-task-feedback-api
+     */
+    @Deprecated(forRemoval = true)
     @Headers("Authorization: {authorization}")
     @RequestLine("GET /tasks/{chainTaskId}/logs")
     TaskLogsModel getTaskLogs(
             @Param("chainTaskId") String chainTaskId,
             @Param("authorization") String authorization);
 
+    /**
+     * @deprecated Use iexec-task-feedback-api
+     */
+    @Deprecated(forRemoval = true)
     @Headers("Authorization: {authorization}")
     @RequestLine("GET /tasks/{chainTaskId}/replicates/{walletAddress}/logs")
     ComputeLogs getComputeLogs(

iexec-task-api/build.gradle

@@ -0,0 +1,57 @@
+plugins {
+    id 'java-library'
+    id 'io.freefair.lombok'
+    id 'jacoco'
+    id 'maven-publish'
+}
+
+dependencies {
+    implementation "com.iexec.commons:iexec-commons-poco:$iexecCommonsPocoVersion"
+    implementation "com.iexec.common:iexec-common:$iexecCommonVersion"
+}
+
+java {
+    sourceCompatibility = "11"
+    targetCompatibility = "11"
+    withJavadocJar()
+    withSourcesJar()
+}
+
+testing {
+    suites {
+        test {
+            useJUnitJupiter()
+            dependencies {
+                implementation 'org.junit.jupiter:junit-jupiter:5.8.2'
+            }
+        }
+    }
+}
+
+tasks.withType(Test).configureEach {
+    finalizedBy tasks.jacocoTestReport
+}
+
+// sonarqube code coverage requires jacoco XML report
+jacocoTestReport {
+    reports {
+        xml.required = true
+    }
+}
+
+publishing {
+    publications {
+        maven(MavenPublication) {
+            from components.java
+        }
+    }
+    repositories {
+        maven {
+            credentials {
+                username nexusUser
+                password nexusPassword
+            }
+            url = project.hasProperty("nexusUrl") ? project.nexusUrl : ''
+        }
+    }
+}

iexec-task-api/src/main/java/com/iexec/core/api/IexecTaskApiClient.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 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.
+ * 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.api;
+
+import com.iexec.common.replicate.ComputeLogs;
+import com.iexec.commons.poco.eip712.entity.EIP712Challenge;
+import com.iexec.core.logs.TaskLogsModel;
+import com.iexec.core.metric.PlatformMetric;
+import com.iexec.core.task.TaskModel;
+import feign.Headers;
+import feign.Param;
+import feign.RequestLine;
+
+public interface IexecTaskApiClient {
+    @RequestLine("GET /metrics")
+    PlatformMetric getMetrics();
+
+    // region /tasks
+    @RequestLine("GET /tasks/{chainTaskId}")
+    TaskModel getTask(@Param("chainTaskId") String chainTaskId);
+
+    @RequestLine("GET /tasks/logs/challenge?address={address}")
+    EIP712Challenge getTaskLogsChallenge(@Param("address") String address);
+
+    @Headers("Authorization: {authorization}")
+    @RequestLine("GET /tasks/{chainTaskId}/logs")
+    TaskLogsModel getTaskLogs(
+            @Param("chainTaskId") String chainTaskId,
+            @Param("authorization") String authorization);
+
+    @Headers("Authorization: {authorization}")
+    @RequestLine("GET /tasks/{chainTaskId}/replicates/{walletAddress}/logs")
+    ComputeLogs getComputeLogs(
+            @Param("chainTaskId") String chainTaskId,
+            @Param("walletAddress") String walletAddress,
+            @Param("authorization") String authorization);
+    // endregion
+}

iexec-task-api/src/main/java/com/iexec/core/api/IexecTaskApiClientBuilder.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 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.
+ * 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.api;
+
+import com.iexec.common.utils.FeignBuilder;
+import feign.Logger;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class IexecTaskApiClientBuilder {
+    public static IexecTaskApiClient getInstance(Logger.Level logLevel, String url) {
+        return FeignBuilder.createBuilder(logLevel)
+                .target(IexecTaskApiClient.class, url);
+    }
+}

iexec-core-library/src/main/java/com/iexec/core/task/TaskStatus.java → iexec-task-api/src/main/java/com/iexec/core/task/TaskStatus.java

@@ -16,7 +16,10 @@
 
 package com.iexec.core.task;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
 
 public enum TaskStatus {
     RECEIVED,
@@ -52,10 +55,10 @@ public static List<TaskStatus> getWaitingContributionStatuses() {
 
     public static List<TaskStatus> getWaitingRevealStatuses() {
         return Arrays.asList(
-            CONSENSUS_REACHED,
-            AT_LEAST_ONE_REVEALED,
-            RESULT_UPLOADING,
-            RESULT_UPLOADED
+                CONSENSUS_REACHED,
+                AT_LEAST_ONE_REVEALED,
+                RESULT_UPLOADING,
+                RESULT_UPLOADED
         );
     }
 
@@ -83,9 +86,9 @@ public static boolean isInResultUploadPhase(TaskStatus status) {
 
     public static boolean isInCompletionPhase(TaskStatus status) {
         return Arrays.asList(
-            FINALIZING,
-            FINALIZED,
-            COMPLETED
+                FINALIZING,
+                FINALIZED,
+                COMPLETED
         ).contains(status);
     }
 

iexec-task-api/src/test/java/com/iexec/core/api/IexecTaskApiClientTests.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 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.
+ * 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.api;
+
+import feign.Logger;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+class IexecTaskApiClientTests {
+    @Test
+    void instantiationTest() {
+        Assertions.assertNotNull(IexecTaskApiClientBuilder.getInstance(Logger.Level.FULL, "localhost"));
+    }
+}

settings.gradle

@@ -1,2 +1,2 @@
 rootProject.name = 'iexec-core'
-include 'iexec-core-library'
+include 'iexec-core-library', 'iexec-task-api'