fix(translations): empty array value instead of empty object (#324)

Author: innomaxx

src/main/java/com/crowdin/client/translations/model/PreTranslationReportResponse.java

@@ -1,9 +1,10 @@
 package com.crowdin.client.translations.model;
 
+import com.crowdin.client.core.http.impl.json.EmptyArrayToNullDeserializer;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import lombok.Data;
 import java.util.List;
 import java.util.Map;
-import com.crowdin.client.translationstatus.model.Category;
 
 
 @Data
@@ -16,8 +17,10 @@ public class PreTranslationReportResponse {
     public static class TargetLanguage {
         private String id;
         private List<File> files;
+        @JsonDeserialize(using = EmptyArrayToNullDeserializer.class)
         private Map<String, Integer> skipped;
-        private List<Category> skippedQaCheckCategories;
+        @JsonDeserialize(using = EmptyArrayToNullDeserializer.class)
+        private Map<String, Integer> skippedQaCheckCategories;
     }
 
     @Data

src/main/java/com/crowdin/client/translationstatus/model/Category.java

@@ -5,7 +5,7 @@
 public enum Category implements EnumConverter<Category> {
 
     EMPTY, VARIABLES, TAGS, PUNCTUATION, SYMBOL_REGISTER,
-    SPACES, SIZE, SPECIAL_SYMBOLS, WRONG_TRANSLATION, SPELLCHECK, ICU;
+    SPACES, SIZE, SPECIAL_SYMBOLS, WRONG_TRANSLATION, SPELLCHECK, ICU, DUPLICATE;
 
     public static Category from(String value) {
         return Category.valueOf(value.toUpperCase());

src/test/java/com/crowdin/client/translations/TranslationsApiIssuesTest.java

@@ -0,0 +1,53 @@
+package com.crowdin.client.translations;
+
+import com.crowdin.client.core.model.ResponseObject;
+import com.crowdin.client.framework.RequestMock;
+import com.crowdin.client.framework.TestClient;
+import com.crowdin.client.translations.model.Method;
+import com.crowdin.client.translations.model.PreTranslationReportResponse;
+import org.apache.http.client.methods.HttpGet;
+import org.junit.jupiter.api.Test;
+
+import java.util.Arrays;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class TranslationsApiIssuesTest extends TestClient {
+
+    private final Long projectId = 12L;
+    private final Long parallelProjectId = 13L;
+    private final String language = "uk";
+    private final String preTranslationId = "9e7de270-4f83-41cb-b606-2f90631f26e2";
+    private final long directoryId = 3L;
+    private final Long fileId = 2L;
+    private final Long branchId = 211L;
+    private final Long storageId = 14L;
+    private final Long buildId = 2L;
+    private final String link = "test.com";
+
+    @Override
+    public List<RequestMock> getMocks() {
+        return Arrays.asList(
+            RequestMock.build(this.url + "/projects/" + projectId + "/pre-translations/" + preTranslationId + "/report", HttpGet.METHOD_NAME, "api/translations/preTranslationReportResponse_issueEmptyArray.json")
+        );
+    }
+
+    @Test
+    public void getPreTranslationReportTest() {
+        ResponseObject<PreTranslationReportResponse> response = this.getTranslationsApi().getPreTranslationReport(projectId, preTranslationId);
+
+        PreTranslationReportResponse report = response.getData();
+        assertNotNull(report);
+        assertEquals(Method.AI, report.getPreTranslateType());
+
+        PreTranslationReportResponse.TargetLanguage lang = report.getLanguages().get(0);
+        assertEquals(language, lang.getId());
+
+        PreTranslationReportResponse.File file = lang.getFiles().get(0);
+        assertEquals(fileId, file.getId());
+
+        assertNull(lang.getSkipped());
+        assertNull(lang.getSkippedQaCheckCategories());
+    }
+}

src/test/java/com/crowdin/client/translations/TranslationsApiTest.java

@@ -35,6 +35,7 @@
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 
 import static java.util.Collections.singletonList;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -272,13 +273,30 @@ public void editPreTranslationTest() {
 
     @Test
     public void getPreTranslationReportTest() {
-    	 ResponseObject<PreTranslationReportResponse> response = this.getTranslationsApi().getPreTranslationReport(projectId, preTranslationId);    	 
-    	 PreTranslationReportResponse report = response.getData();
-         assertNotNull(report);
-         assertEquals(Method.AI, report.getPreTranslateType());
-         PreTranslationReportResponse.TargetLanguage lang = report.getLanguages().get(0);
-         assertEquals(language, lang.getId());
-         PreTranslationReportResponse.File file = lang.getFiles().get(0);
-         assertEquals(fileId, file.getId());
+        ResponseObject<PreTranslationReportResponse> response = this.getTranslationsApi().getPreTranslationReport(projectId, preTranslationId);
+        PreTranslationReportResponse report = response.getData();
+        assertNotNull(report);
+
+        assertEquals(Method.AI, report.getPreTranslateType());
+
+        PreTranslationReportResponse.TargetLanguage language = report.getLanguages().get(0);
+        assertEquals("es", language.getId());
+
+        PreTranslationReportResponse.File file = language.getFiles().get(0);
+        assertEquals(10191, file.getId());
+
+        PreTranslationReportResponse.Statistics statistics = file.getStatistics();
+        assertEquals(6, statistics.getPhrases());
+        assertEquals(13, statistics.getWords());
+
+        Map<String, Integer> skipped = language.getSkipped();
+        assertEquals(2, skipped.get("translation_eq_source"));
+        assertEquals(1, skipped.get("qa_check"));
+        assertEquals(0, skipped.get("hidden_strings"));
+        assertEquals(6, skipped.get("ai_error"));
+
+        Map<String, Integer> skippedQaCheckCategories = language.getSkippedQaCheckCategories();
+        assertEquals(1,  skippedQaCheckCategories.get("duplicate"));
+        assertEquals(1, skippedQaCheckCategories.get("spellcheck"));
     }
 }

src/test/resources/api/translations/preTranslationReportResponse.json

@@ -2,17 +2,28 @@
   "data": {
     "languages": [
       {
-        "id": "uk",
+        "id": "es",
         "files": [
           {
-            "id": "2",
-            "statistics": { "phrases": 6, "words": 13 }
+            "id": "10191",
+            "statistics": {
+              "phrases": 6,
+              "words": 13
+            }
           }
         ],
-        "skipped": { "ai_error": 6 },
-        "skippedQaCheckCategories": ["spellcheck"]
+        "skipped": {
+          "translation_eq_source": 2,
+          "qa_check": 1,
+          "hidden_strings": 0,
+          "ai_error": 6
+        },
+        "skippedQaCheckCategories": {
+          "duplicate": 1,
+          "spellcheck": 1
+        }
       }
     ],
     "preTranslateType": "ai"
   }
-}
+}

src/test/resources/api/translations/preTranslationReportResponse_issueEmptyArray.json

@@ -0,0 +1,18 @@
+{
+  "data": {
+    "languages": [
+      {
+        "id": "uk",
+        "files": [
+          {
+            "id": "2",
+            "statistics": { "phrases": 6, "words": 13 }
+          }
+        ],
+        "skipped": [],
+        "skippedQaCheckCategories": []
+      }
+    ],
+    "preTranslateType": "ai"
+  }
+}