Merge pull request #45 from iExecBlockchainComputing/hotfix/3.0.5

Release version 3.0.5

Author: jbern0rd

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## [[3.0.5]](https://github.com/iExecBlockchainComputing/iexec-commons-poco/releases/tag/v3.0.5) 2023-06-26
+
+### Bug Fixes
+- Fix regression on dataset URI decryption in `TaskDescription`. The regression concerned bad interpretation of IPFS MultiAddress URIs. (#45)
+
 ## [[3.0.4]](https://github.com/iExecBlockchainComputing/iexec-commons-poco/releases/tag/v3.0.4) 2023-06-23
 
 ### Bug Fixes

gradle.properties

@@ -1,4 +1,4 @@
-version=3.0.4
+version=3.0.5
 
 nexusUser
 nexusPassword

src/main/java/com/iexec/commons/poco/task/TaskDescription.java

@@ -23,6 +23,7 @@
 import com.iexec.commons.poco.tee.TeeFramework;
 import com.iexec.commons.poco.tee.TeeUtils;
 import com.iexec.commons.poco.utils.BytesUtils;
+import com.iexec.commons.poco.utils.MultiAddressHelper;
 import lombok.Builder;
 import lombok.Value;
 import org.apache.commons.lang3.StringUtils;
@@ -141,7 +142,7 @@ public static TaskDescription toTaskDescription(String chainTaskId,
         String datasetChecksum = "";
         if (chainDeal.containsDataset()) {
             datasetAddress = chainDeal.getChainDataset().getChainDatasetId();
-            datasetUri = BytesUtils.hexStringToAscii(
+            datasetUri = MultiAddressHelper.convertToURI(
                             chainDeal.getChainDataset().getUri());
             datasetName = chainDeal.getChainDataset().getName();
             datasetChecksum = chainDeal.getChainDataset().getChecksum();

src/main/java/com/iexec/commons/poco/utils/MultiAddressHelper.java

@@ -18,6 +18,7 @@
 
 import io.ipfs.multiaddr.MultiAddress;
 import org.apache.commons.lang3.StringUtils;
+import org.web3j.utils.Numeric;
 
 import java.util.List;
 
@@ -33,6 +34,25 @@ private MultiAddressHelper() {
         throw new UnsupportedOperationException();
     }
 
+    /**
+     * Converts the hexadecimal String stored in an on-chain deal to a human-readable format.
+     * <p>
+     * IPFS addresses are stored in a specific format and have to be converted with the {@link MultiAddress} constructor.
+     * If a {@link MultiAddress} instance can be constructed, the URI it represents has been successfully converted.
+     * In other cases, the value is considered to be a string encoded in hexadecimal and will be converted with
+     * {@link BytesUtils#hexStringToAscii(String)}.
+     *
+     * @param hexaString String to convert
+     * @return Conversion result
+     */
+    public static String convertToURI(String hexaString) {
+        try {
+            return new MultiAddress(Numeric.hexStringToByteArray(hexaString)).toString();
+        } catch (Exception e) {
+            return BytesUtils.hexStringToAscii(hexaString);
+        }
+    }
+
     public static boolean isMultiAddress(String uri) {
         if (StringUtils.isBlank(uri)) {
             return false;

src/test/java/com/iexec/commons/poco/utils/MultiAddressHelperTests.java

@@ -21,11 +21,32 @@
 import org.junit.jupiter.params.provider.NullAndEmptySource;
 import org.junit.jupiter.params.provider.ValueSource;
 
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 class MultiAddressHelperTests {
 
+    @Test
+    void shouldConvertToIPFSAddress() {
+        String content = MultiAddressHelper.convertToURI("0xa5032212205d008f22f8f878fd58473a634cc73d41049fc0d19b81002eaae221ac5a446a3e");
+        String expected = "/ipfs/QmUbh7ugQ9WVprTVYjzrCS4d9cCy73zUz4MMchsrqzzu1w";
+
+        assertEquals(content, expected);
+
+        content = MultiAddressHelper.convertToURI("0xa5032212207237a7f4091a74ae95514890fa86a2e8a36037c350ea71c06a34c8cbe25a5057");
+        expected = "/ipfs/QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ";
+
+        assertEquals(content, expected);
+    }
+
+    @Test
+    void shouldConvertToHTTPAddress() {
+        // this is hexa value of an HTTP address in String format, not in multiaddress format!
+        String content = MultiAddressHelper.convertToURI("0x68747470733a2f2f676174657761792e697066732e696f2f697066732f516d5732575169376a36633755674a546172416374703774444e696b453442327158744643664c506473676154512f6361742e6a7067");
+        String expected = "https://gateway.ipfs.io/ipfs/QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ/cat.jpg";
+
+        assertEquals(content, expected);
+    }
+
     @Test
     void shouldBeMultiAddress() {
         assertTrue(MultiAddressHelper.isMultiAddress("/ipfs/QmUbh7ugQ9WVprTVYjzrCS4d9cCy73zUz4MMchsrqzzu1w"));