enhanced request validation, refactored services to service-common

module #EA-3589
europeana · Nov 7, 2023 · 5f2c00f · 5f2c00f
1 parent b3586b7
commit 5f2c00f
Show file tree

Hide file tree

Showing 33 changed files with 192 additions and 127 deletions.
diff --git a/pom.xml b/pom.xml
@@ -17,10 +17,12 @@
 
 	<modules>
 		<module>translation-definitions</module>
-		<module>translation-web</module>
-		<module>translation-tests</module>
+		<module>translation-service-common</module>
 		<module>translation-service-google</module>
 		<module>translation-service-pangeanic</module>
+		<module>translation-web</module>
+		<module>translation-tests</module>
+
 	</modules>
 
 	<repositories>

diff --git a/translation-service-common/AbstractTranslationService.java b/translation-service-common/AbstractTranslationService.java
@@ -0,0 +1,12 @@
+package eu.europeana.api.translation.service.pangeanic;
+
+import org.apache.commons.lang3.StringUtils;
+import eu.europeana.api.translation.definitions.language.Language;
+
+public class AbstractTranslationService {
+
+  public static boolean noTranslationRequired(String lang) {
+    return (lang == null || StringUtils.equals(lang, Language.NO_LINGUISTIC_CONTENT)
+        || StringUtils.equals(lang, Language.ENGLISH));
+  }
+}
diff --git a/translation-service-common/pom.xml b/translation-service-common/pom.xml
@@ -0,0 +1,31 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>eu.europeana.api</groupId>
+    <artifactId>translation-api</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>translation-service-common</artifactId>
+  <name>translation-service-common</name>
+  <description>Common functionality to be reused by specific implementation of language detection and translation services</description>
+
+  <properties>
+  	<sonar.coverage.jacoco.xmlReportPaths>${basedir}/../${aggregate.report.xml}</sonar.coverage.jacoco.xmlReportPaths>
+  </properties>
+
+  	<dependencies>
+		<dependency>
+			<groupId>eu.europeana.api</groupId>
+			<artifactId>translation-definitions</artifactId>
+			<version>0.0.1-SNAPSHOT</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.apache.logging.log4j</groupId>
+			<artifactId>log4j-api</artifactId>
+		</dependency>
+
+	</dependencies>
+
+</project>
diff --git a/...common/src/main/java/eu/europeana/api/translation/service/AbstractTranslationService.java b/...common/src/main/java/eu/europeana/api/translation/service/AbstractTranslationService.java
@@ -0,0 +1,6 @@
+package eu.europeana.api.translation.service;
+
+public abstract class AbstractTranslationService implements TranslationService {
+
+
+}
diff --git a/...ons/service/LanguageDetectionService.java → ...ion/service/LanguageDetectionService.java b/...ons/service/LanguageDetectionService.java → ...ion/service/LanguageDetectionService.java
@@ -1,7 +1,7 @@
-package eu.europeana.api.translation.definitions.service;
+package eu.europeana.api.translation.service;
 
 import java.util.List;
-import eu.europeana.api.translation.definitions.service.exception.LanguageDetectionException;
+import eu.europeana.api.translation.service.exception.LanguageDetectionException;
 
 public interface LanguageDetectionService {
 

diff --git a/...finitions/service/TranslationService.java → ...anslation/service/TranslationService.java b/...finitions/service/TranslationService.java → ...anslation/service/TranslationService.java
@@ -1,7 +1,7 @@
-package eu.europeana.api.translation.definitions.service;
+package eu.europeana.api.translation.service;
 
 import java.util.List;
-import eu.europeana.api.translation.definitions.service.exception.TranslationException;
+import eu.europeana.api.translation.service.exception.TranslationException;
 
 /**
  * Generic translation service interface

diff --git a/...tectionServiceConfigurationException.java → ...tectionServiceConfigurationException.java b/...tectionServiceConfigurationException.java → ...tectionServiceConfigurationException.java
@@ -1,4 +1,4 @@
-package eu.europeana.api.translation.definitions.service.exception;
+package eu.europeana.api.translation.service.exception;
 
 /**
  * Exception that is thrown when there is an error using the translation service

diff --git a/...exception/LanguageDetectionException.java → ...exception/LanguageDetectionException.java b/...exception/LanguageDetectionException.java → ...exception/LanguageDetectionException.java
@@ -1,4 +1,4 @@
-package eu.europeana.api.translation.definitions.service.exception;
+package eu.europeana.api.translation.service.exception;
 
 /**
  * Exception that is thrown when there is an error using the translation service

diff --git a/...rvice/exception/TranslationException.java → ...rvice/exception/TranslationException.java b/...rvice/exception/TranslationException.java → ...rvice/exception/TranslationException.java
@@ -1,4 +1,4 @@
-package eu.europeana.api.translation.definitions.service.exception;
+package eu.europeana.api.translation.service.exception;
 
 /**
  * Exception that is thrown when there is an error using the translation service

diff --git a/...slationServiceConfigurationException.java → ...slationServiceConfigurationException.java b/...slationServiceConfigurationException.java → ...slationServiceConfigurationException.java
@@ -1,4 +1,4 @@
-package eu.europeana.api.translation.definitions.service.exception;
+package eu.europeana.api.translation.service.exception;
 
 /**
  * Exception that is thrown when there is an error using the translation service

diff --git a/...lation/definitions/util/LoggingUtils.java → ...ranslation/service/util/LoggingUtils.java b/...lation/definitions/util/LoggingUtils.java → ...ranslation/service/util/LoggingUtils.java
@@ -1,4 +1,4 @@
-package eu.europeana.api.translation.definitions.util;
+package eu.europeana.api.translation.service.util;
 
 /**
  * Utilities for logging 

diff --git a/translation-service-google/pom.xml b/translation-service-google/pom.xml
@@ -17,7 +17,7 @@
   	<dependencies>
 		<dependency>
 			<groupId>eu.europeana.api</groupId>
-			<artifactId>translation-definitions</artifactId>
+			<artifactId>translation-service-common</artifactId>
 			<version>0.0.1-SNAPSHOT</version>
 		</dependency>
 
@@ -39,11 +39,6 @@
 			<version>2.19.0</version>
 		</dependency>
 
-		<dependency>
-			<groupId>org.apache.logging.log4j</groupId>
-			<artifactId>log4j-api</artifactId>
-		</dependency>
-
 	</dependencies>
 
 </project>
diff --git a/...le/src/main/java/eu/europeana/api/translation/service/google/DummyGLangDetectService.java b/...le/src/main/java/eu/europeana/api/translation/service/google/DummyGLangDetectService.java
@@ -3,7 +3,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import org.apache.commons.lang3.StringUtils;
-import eu.europeana.api.translation.definitions.service.exception.LanguageDetectionException;
+import eu.europeana.api.translation.service.exception.LanguageDetectionException;
 
 /**
  * Dummy implementation preventing invocation of remote google service

diff --git a/...gle/src/main/java/eu/europeana/api/translation/service/google/DummyGTranslateService.java b/...gle/src/main/java/eu/europeana/api/translation/service/google/DummyGTranslateService.java
@@ -1,7 +1,7 @@
 package eu.europeana.api.translation.service.google;
 
 import java.util.List;
-import eu.europeana.api.translation.definitions.service.exception.TranslationException;
+import eu.europeana.api.translation.service.exception.TranslationException;
 
 /**
  * Dummy implementation preventing invocation of remote google service

diff --git a/...le/src/main/java/eu/europeana/api/translation/service/google/GoogleLangDetectService.java b/...le/src/main/java/eu/europeana/api/translation/service/google/GoogleLangDetectService.java
@@ -9,8 +9,8 @@
 import com.google.cloud.translate.v3.DetectLanguageRequest.Builder;
 import com.google.cloud.translate.v3.DetectLanguageResponse;
 import com.google.cloud.translate.v3.LocationName;
-import eu.europeana.api.translation.definitions.service.LanguageDetectionService;
-import eu.europeana.api.translation.definitions.service.exception.LanguageDetectionException;
+import eu.europeana.api.translation.service.LanguageDetectionService;
+import eu.europeana.api.translation.service.exception.LanguageDetectionException;
 
 /**
  * Translation service implementing remote invocation of google language detection service

diff --git a/...e/src/main/java/eu/europeana/api/translation/service/google/GoogleTranslationService.java b/...e/src/main/java/eu/europeana/api/translation/service/google/GoogleTranslationService.java
@@ -8,8 +8,9 @@
 import com.google.cloud.translate.v3.TranslateTextRequest.Builder;
 import com.google.cloud.translate.v3.TranslateTextResponse;
 import com.google.cloud.translate.v3.Translation;
-import eu.europeana.api.translation.definitions.service.TranslationService;
-import eu.europeana.api.translation.definitions.service.exception.TranslationException;
+import eu.europeana.api.translation.service.AbstractTranslationService;
+import eu.europeana.api.translation.service.TranslationService;
+import eu.europeana.api.translation.service.exception.TranslationException;
 
 /**
  * Translation service implementing remote invocation of google language detection service
@@ -18,7 +19,7 @@
  * @author GordeaS
  *
  */
-public class GoogleTranslationService implements TranslationService {
+public class GoogleTranslationService extends AbstractTranslationService implements TranslationService {
 
   private static final String MIME_TYPE_TEXT = "text/plain";
   private final String googleProjectId;

diff --git a/translation-service-pangeanic/pom.xml b/translation-service-pangeanic/pom.xml
@@ -17,15 +17,10 @@
 	<dependencies>
 		<dependency>
 			<groupId>eu.europeana.api</groupId>
-			<artifactId>translation-definitions</artifactId>
+			<artifactId>translation-service-common</artifactId>
 			<version>0.0.1-SNAPSHOT</version>
 		</dependency>
 
-		<dependency>
-			<groupId>org.apache.logging.log4j</groupId>
-			<artifactId>log4j-api</artifactId>
-		</dependency>
-
 		<dependency>
 		    <groupId>org.apache.httpcomponents</groupId>
 		    <artifactId>httpclient</artifactId>

diff --git a/.../main/java/eu/europeana/api/translation/service/pangeanic/DummyPangLangDetectService.java b/.../main/java/eu/europeana/api/translation/service/pangeanic/DummyPangLangDetectService.java
@@ -3,7 +3,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import org.apache.commons.lang3.StringUtils;
-import eu.europeana.api.translation.definitions.service.exception.LanguageDetectionException;
+import eu.europeana.api.translation.service.exception.LanguageDetectionException;
 
 /**
  * Dummy implementation preventing invocation of remote pangeanic service

diff --git a/...main/java/eu/europeana/api/translation/service/pangeanic/DummyPangTranslationService.java b/...main/java/eu/europeana/api/translation/service/pangeanic/DummyPangTranslationService.java
@@ -1,7 +1,7 @@
 package eu.europeana.api.translation.service.pangeanic;
 
 import java.util.List;
-import eu.europeana.api.translation.definitions.service.exception.TranslationException;
+import eu.europeana.api.translation.service.exception.TranslationException;
 
 /**
  * Dummy implementation preventing invocation of remote pangeanic service

diff --git a/.../main/java/eu/europeana/api/translation/service/pangeanic/PangeanicLangDetectService.java b/.../main/java/eu/europeana/api/translation/service/pangeanic/PangeanicLangDetectService.java
@@ -19,8 +19,8 @@
 import org.codehaus.jettison.json.JSONArray;
 import org.codehaus.jettison.json.JSONException;
 import org.codehaus.jettison.json.JSONObject;
-import eu.europeana.api.translation.definitions.service.LanguageDetectionService;
-import eu.europeana.api.translation.definitions.service.exception.LanguageDetectionException;
+import eu.europeana.api.translation.service.LanguageDetectionService;
+import eu.europeana.api.translation.service.exception.LanguageDetectionException;
 
 public class PangeanicLangDetectService implements LanguageDetectionService {
 

diff --git a/...main/java/eu/europeana/api/translation/service/pangeanic/PangeanicTranslationService.java b/...main/java/eu/europeana/api/translation/service/pangeanic/PangeanicTranslationService.java
@@ -21,18 +21,19 @@
 import org.codehaus.jettison.json.JSONException;
 import org.codehaus.jettison.json.JSONObject;
 import eu.europeana.api.translation.definitions.language.PangeanicLanguages;
-import eu.europeana.api.translation.definitions.service.TranslationService;
-import eu.europeana.api.translation.definitions.service.exception.LanguageDetectionException;
-import eu.europeana.api.translation.definitions.service.exception.TranslationException;
-import eu.europeana.api.translation.definitions.util.LoggingUtils;
+import eu.europeana.api.translation.service.AbstractTranslationService;
+import eu.europeana.api.translation.service.TranslationService;
+import eu.europeana.api.translation.service.exception.LanguageDetectionException;
+import eu.europeana.api.translation.service.exception.TranslationException;
+import eu.europeana.api.translation.service.util.LoggingUtils;
 
 /**
  * Service to send data to translate to Pangeanic Translate API V2
  * 
  * @author Srishti Singh
  */
 // TODO get api key, for now passed empty
-public class PangeanicTranslationService implements TranslationService {
+public class PangeanicTranslationService extends AbstractTranslationService implements TranslationService {
 
   private PangeanicLangDetectService langDetectService;
 
@@ -112,10 +113,12 @@ public List<String> translate(List<String> texts, String targetLanguage, String
         // lang-detection first and later will translated
         return translateWithLangDetect(texts, targetLanguage, sourceLanguage);
       }
+
+      //regular invocation of external translation service 
       HttpPost post = PangeanicTranslationUtils.createTranslateRequest(getExternalServiceEndPoint(),
           texts, targetLanguage, sourceLanguage, "");
       return PangeanicTranslationUtils.getResults(texts,
-          sendTranslateRequestAndParse(post, sourceLanguage), false);
+          sendTranslateRequestAndParse(post, sourceLanguage));
     } catch (JSONException e) {
       throw new TranslationException("Exception occured during Pangeanic translation!",
           HttpStatus.SC_BAD_GATEWAY, e);
@@ -148,8 +151,7 @@ private List<String> translateWithLangDetect(List<String> texts, String targetLa
       List<String> detectedLanguages = detectLanguages(texts, langHint);
       Map<String, String> translations =
           computeTranslations(texts, targetLanguage, detectedLanguages, langHint);
-      return PangeanicTranslationUtils.getResults(texts, translations,
-          PangeanicTranslationUtils.nonTranslatedDataExists(detectedLanguages));
+      return PangeanicTranslationUtils.getResults(texts, translations);
     } catch (JSONException | IOException e) {
       throw new TranslationException("Exception occured during Pangeanic translation!",
           HttpStatus.SC_BAD_GATEWAY, e);
@@ -173,18 +175,9 @@ private Map<String, String> computeTranslations(List<String> texts, String targe
     }
 
     for (Map.Entry<String, List<String>> entry : detectedLangValueMap.entrySet()) {
-      if (PangeanicTranslationUtils.noTranslationRequired(entry.getKey())) {
-        if (LOG.isDebugEnabled()) {
-          LOG.debug("NOT translating data for lang {} for detected values {} ",
-              LoggingUtils.sanitizeUserInput(entry.getKey()),
-              LoggingUtils.sanitizeUserInput(entry.getValue().toString()));
-        }
-        //TODO translations.put ... original value, this code should be refactored
-      } else {
         HttpPost translateRequest = PangeanicTranslationUtils.createTranslateRequest(
             getExternalServiceEndPoint(), entry.getValue(), targetLanguage, entry.getKey(), "");
-        translations.putAll(sendTranslateRequestAndParse(translateRequest, entry.getKey()));
-      }
+        translations.putAll(sendTranslateRequestAndParse(translateRequest, entry.getKey()));   
     }
     return translations;
   }

diff --git a/...c/main/java/eu/europeana/api/translation/service/pangeanic/PangeanicTranslationUtils.java b/...c/main/java/eu/europeana/api/translation/service/pangeanic/PangeanicTranslationUtils.java
@@ -172,8 +172,8 @@ public static Map<String, List<String>> getDetectedLangValueMap(List<String> tex
 
     /**
      * Returns the translations.
-     * If nonTranslatedDataExists is true then add non-translated values as it is
-     *
+     * SG: outdated documentation from record translations
+     * 
      * LOGIC :
      * if there is a size mismatch then the order the translation according to text sequence is performed.
      * As if multiple language were detected the order of translation result will vary.
@@ -185,37 +185,26 @@ public static Map<String, List<String>> getDetectedLangValueMap(List<String> tex
      *
      * @param texts original values sent for translations
      * @param translateResult
-     * @param nonTranslatedDataExists if language zxx or na was detected
      * @return
      */
-    public static List<String> getResults(List<String> texts, Map<String, String> translateResult, boolean nonTranslatedDataExists) {
+    public static List<String> getResults(List<String> texts, Map<String, String> translateResult) {
         List<String> translations = new ArrayList<>();
-        if (texts.size() != translateResult.size()) {
-            for (String text : texts) {
-                if (translateResult.containsKey(text)) {
-                    translations.add(translateResult.get(text));
-                } else if (nonTranslatedDataExists) {
-                    // add non-translated values as it is. Only if "zxx" or no-lang detected responses were present.
-                    translations.add(text);
-                }
-            }
-        } else {
+//        if (texts.size() != translateResult.size()) {
+//            for (String text : texts) {
+//                if (translateResult.containsKey(text)) {
+//                    translations.add(translateResult.get(text));
+//                } else {
+//                    //if (nonTranslatedDataExists) {
+//                    // add non-translated values as it is. Only if "zxx" or no-lang detected responses were present.
+//                    translations.add(text);
+//                }
+//            }
+//        } else {
             for (Map.Entry<String, String> entry : translateResult.entrySet()) {
                 translations.add(entry.getValue());
             }
-        }
+//        }
         return translations;
     }
-
-    public static boolean noTranslationRequired(String lang) {
-        return ( lang == null || StringUtils.equals(lang, Language.NO_LINGUISTIC_CONTENT)
-                || StringUtils.equals(lang, Language.ENGLISH));
-    }
-
-    public static boolean nonTranslatedDataExists(List<String> detectedLanguages) {
-        return (detectedLanguages.contains(Language.NO_LINGUISTIC_CONTENT)
-                || detectedLanguages.contains(null)
-                || detectedLanguages.contains(Language.ENGLISH));
-    }
 }
 
diff --git a/...sts/src/integration-test/java/eu/europeana/api/translation/tests/BaseTranslationTest.java b/...sts/src/integration-test/java/eu/europeana/api/translation/tests/BaseTranslationTest.java
@@ -24,8 +24,8 @@
 import org.springframework.web.context.WebApplicationContext;
 import eu.europeana.api.translation.TranslationApp;
 import eu.europeana.api.translation.config.TranslationServiceProvider;
-import eu.europeana.api.translation.definitions.service.exception.LangDetectionServiceConfigurationException;
-import eu.europeana.api.translation.definitions.service.exception.TranslationServiceConfigurationException;
+import eu.europeana.api.translation.service.exception.LangDetectionServiceConfigurationException;
+import eu.europeana.api.translation.service.exception.TranslationServiceConfigurationException;
 import okhttp3.mockwebserver.Dispatcher;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;

diff --git a/...ation-web/src/main/java/eu/europeana/api/translation/config/TranslationApiAutoconfig.java b/...ation-web/src/main/java/eu/europeana/api/translation/config/TranslationApiAutoconfig.java
@@ -22,8 +22,8 @@
 import eu.europeana.api.commons.config.i18n.I18nService;
 import eu.europeana.api.commons.config.i18n.I18nServiceImpl;
 import eu.europeana.api.commons.oauth2.service.impl.EuropeanaClientDetailsService;
-import eu.europeana.api.translation.definitions.service.exception.LangDetectionServiceConfigurationException;
-import eu.europeana.api.translation.definitions.service.exception.TranslationServiceConfigurationException;
+import eu.europeana.api.translation.service.exception.LangDetectionServiceConfigurationException;
+import eu.europeana.api.translation.service.exception.TranslationServiceConfigurationException;
 import eu.europeana.api.translation.service.google.DummyGLangDetectService;
 import eu.europeana.api.translation.service.google.DummyGTranslateService;
 import eu.europeana.api.translation.service.google.GoogleLangDetectService;