From 9dc32fe12816bd69dee17967e69f8480d68da918 Mon Sep 17 00:00:00 2001 From: Mohamed Karray Date: Fri, 19 Oct 2018 11:15:37 +0200 Subject: [PATCH 1/8] add i18n Servlet --- .../main/resources/locales/de/plugins.json | 5 + .../main/resources/locales/en/plugins.json | 5 + .../main/resources/locales/de/plugins.json | 5 + .../main/resources/locales/en/plugins.json | 5 + .../main/resources/locales/de/plugins.json | 5 + .../main/resources/locales/en/plugins.json | 5 + .../java/sonia/scm/WebResourceServlet.java | 2 +- .../java/sonia/scm/web/i18n/I18nServlet.java | 151 ++++++++++++++++++ 8 files changed, 182 insertions(+), 1 deletion(-) create mode 100644 scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json create mode 100644 scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json create mode 100644 scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json create mode 100644 scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json create mode 100644 scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json create mode 100644 scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json create mode 100644 scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java diff --git a/scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json b/scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json new file mode 100644 index 0000000000..a405e36d23 --- /dev/null +++ b/scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json @@ -0,0 +1,5 @@ +{ + "git": { + "description": "die git repo ist super " + } +} diff --git a/scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json b/scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json new file mode 100644 index 0000000000..0412a162b3 --- /dev/null +++ b/scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json @@ -0,0 +1,5 @@ +{ + "git": { + "description": "the git repo is great " + } +} diff --git a/scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json b/scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json new file mode 100644 index 0000000000..49a3d97570 --- /dev/null +++ b/scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json @@ -0,0 +1,5 @@ +{ + "hg": { + "description": "die hg repo ist super " + } +} diff --git a/scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json b/scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json new file mode 100644 index 0000000000..28c628e81e --- /dev/null +++ b/scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json @@ -0,0 +1,5 @@ +{ + "hg": { + "description": "the hg repo is great " + } +} diff --git a/scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json b/scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json new file mode 100644 index 0000000000..1c25a5bcf5 --- /dev/null +++ b/scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json @@ -0,0 +1,5 @@ +{ + "svn": { + "description": "die svn repo ist super " + } +} diff --git a/scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json b/scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json new file mode 100644 index 0000000000..cbfbaac63b --- /dev/null +++ b/scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json @@ -0,0 +1,5 @@ +{ + "svn": { + "description": "the svn repo is great " + } +} diff --git a/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java b/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java index 6b4a29961d..6405c16ddc 100644 --- a/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java +++ b/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java @@ -33,7 +33,7 @@ public class WebResourceServlet extends HttpServlet { * TODO remove old protocol servlets and hook. Move /hook/hg to api? */ @VisibleForTesting - static final String PATTERN = "/(?!api/|git/|hg/|svn/|hook/|repo/).*"; + static final String PATTERN = "/(?!api/|git/|hg/|svn/|hook/|repo/|locales/).*"; private static final Logger LOG = LoggerFactory.getLogger(WebResourceServlet.class); diff --git a/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java new file mode 100644 index 0000000000..00d1f3aaf4 --- /dev/null +++ b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java @@ -0,0 +1,151 @@ +package sonia.scm.web.i18n; + + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.legman.Subscribe; +import com.google.inject.Singleton; +import com.sun.org.apache.regexp.internal.RE; +import lombok.extern.slf4j.Slf4j; +import sonia.scm.NotFoundException; +import sonia.scm.SCMContext; +import sonia.scm.Stage; +import sonia.scm.boot.RestartEvent; +import sonia.scm.cache.Cache; +import sonia.scm.cache.CacheManager; +import sonia.scm.filter.WebElement; +import sonia.scm.plugin.PluginLoader; +import sonia.scm.plugin.UberClassLoader; + +import javax.inject.Inject; +import javax.servlet.http.HttpServlet; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.io.PrintWriter; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.function.BiConsumer; +import java.util.function.Function; + + +/** + * Collect + */ +@Singleton +@WebElement(value = I18nServlet.PATTERN, regex = true) +@Slf4j +public class I18nServlet extends HttpServlet { + + public static final String PATH = "/locales"; + public static final String PLUGINS_JSON = "plugins.json"; + public static final String PATTERN = PATH + "/[a-z\\-A-Z]*/" + PLUGINS_JSON; + public static final String CACHE_NAME = "sonia.cache.plugins.translations"; + + private final UberClassLoader uberClassLoader; + private final Cache> cache; + private RE languagePathPostfix = new RE(".*(\\-[A-Z]+)/.*"); + private ObjectMapper objectMapper = new ObjectMapper(); + + + @Inject + public I18nServlet(PluginLoader pluginLoader, CacheManager cacheManager) { + this.uberClassLoader = (UberClassLoader) pluginLoader.getUberClassLoader(); + this.cache = cacheManager.getCache(CACHE_NAME); + } + + @Subscribe + public void handleRestartEvent(RestartEvent event) { + log.info("clear cache on restart event with reason {}", event.getReason()); + cache.clear(); + } + + public Map getCollectedJson(String path, + Function>> jsonFileProvider, + BiConsumer> createdJsonFileConsumer) throws NotFoundException { + return Optional.ofNullable(jsonFileProvider.apply(path) + .orElseGet(() -> { + Optional> createdFile = collectJsonFile(path); + createdFile.ifPresent(map -> createdJsonFileConsumer.accept(path, map)); + return createdFile.orElse(null); + } + )).orElseThrow(NotFoundException::new); + } + + @Override + protected void doGet(HttpServletRequest req, HttpServletResponse response) { + try { + response.setContentType("application/json"); + PrintWriter out = response.getWriter(); + String path = req.getServletPath(); + Function>> jsonFileProvider = usedPath -> Optional.empty(); + BiConsumer> createdJsonFileConsumer = (usedPath, foundJsonMap) -> log.info("A json File is created from the path {}", usedPath); + if (SCMContext.getContext().getStage() == Stage.PRODUCTION) { + log.info("In Production Stage get the plugin translations from the cache"); + jsonFileProvider = usedPath -> Optional.ofNullable( + cache.get(usedPath)); + createdJsonFileConsumer = createdJsonFileConsumer + .andThen((usedPath, map) -> log.info("Put the created json File in the cache with the key {}", usedPath)) + .andThen(cache::put); + } + out.write(objectMapper.writeValueAsString(getCollectedJson(path, jsonFileProvider, createdJsonFileConsumer))); + } catch (IOException e) { + log.error("error on getting the translation of the plugins", e); + response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); + } catch (NotFoundException e) { + log.error("Plugin translations are not found", e); + response.setStatus(HttpServletResponse.SC_NOT_FOUND); + } +// ScmEventBus.getInstance().post(new RestartEvent(I18nServlet.class,"einfach so")); + } + + /** + * Return a collected Json File as map with the given path from all plugins in the class path + * + * @param path the searched resource path + * @return a collected Json File as map with the given path from all plugins in the class path + */ + private Optional> collectJsonFile(String path) { + log.info("Collect plugin translations from path {} for every plugin", path); + HashMap result = null; + try { + Enumeration resources = uberClassLoader.getResources(path.replaceFirst("/", "")); + if (resources.hasMoreElements()) { + result = new HashMap<>(); + while (resources.hasMoreElements()) { + URL url = resources.nextElement(); + result.putAll(mergeJSONs(objectMapper, url)); + } + } + } catch (IOException e) { + log.error("Error on loading sources from {}", path, e); + } + return Optional.ofNullable(result); + } + + private boolean hasLanguagePostfix(String path) { + return languagePathPostfix.match(path); + } + + /** + * remove the -DE from the path locales/de-DE/plugins + * + * @param servletPath + * @return + * @throws IOException + */ + private String removeLanguagePostfix(String servletPath) { + return servletPath.replace(languagePathPostfix.getParen(1), ""); + } + + // TODO simplify + private HashMap mergeJSONs(ObjectMapper objectMapper, URL url) throws IOException { + byte[] src = Files.readAllBytes(Paths.get(url.getPath())); + Map json = objectMapper.readValue(src, HashMap.class); + return objectMapper.readerForUpdating(json).readValue(src); + } +} From 9cb661b4601175fe0def4840d0f39a9cc6c31e31 Mon Sep 17 00:00:00 2001 From: Mohamed Karray Date: Sat, 20 Oct 2018 14:40:03 +0200 Subject: [PATCH 2/8] plugin translation servlet --- .../java/sonia/scm/it/I18nServletITCase.java | 19 ++ .../java/sonia/scm/it/utils/ScmRequests.java | 10 + .../src/main/js/ProtocolInformation.js | 12 +- .../main/resources/locales/de/plugins.json | 8 +- .../main/resources/locales/en/plugins.json | 8 +- .../src/main/js/ProtocolInformation.js | 12 +- .../main/resources/locales/de/plugins.json | 8 +- .../main/resources/locales/en/plugins.json | 8 +- .../src/main/js/ProtocolInformation.js | 8 +- .../main/resources/locales/de/plugins.json | 6 +- .../main/resources/locales/en/plugins.json | 6 +- .../java/sonia/scm/web/i18n/I18nServlet.java | 68 ++--- .../sonia/scm/web/i18n/I18nServletTest.java | 253 ++++++++++++++++++ 13 files changed, 357 insertions(+), 69 deletions(-) create mode 100644 scm-it/src/test/java/sonia/scm/it/I18nServletITCase.java create mode 100644 scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java diff --git a/scm-it/src/test/java/sonia/scm/it/I18nServletITCase.java b/scm-it/src/test/java/sonia/scm/it/I18nServletITCase.java new file mode 100644 index 0000000000..6597880665 --- /dev/null +++ b/scm-it/src/test/java/sonia/scm/it/I18nServletITCase.java @@ -0,0 +1,19 @@ +package sonia.scm.it; + +import org.junit.Test; +import sonia.scm.it.utils.ScmRequests; + +import static org.assertj.core.api.Assertions.assertThat; + +public class I18nServletITCase { + + @Test + public void shouldGetCollectedPluginTranslations() { + ScmRequests.start() + .requestPluginTranslations("de") + .assertStatusCode(200) + .assertSingleProperty(value -> assertThat(value).isNotNull(), "scm-git-plugin") + .assertSingleProperty(value -> assertThat(value).isNotNull(), "scm-hg-plugin") + .assertSingleProperty(value -> assertThat(value).isNotNull(), "scm-svn-plugin"); + } +} diff --git a/scm-it/src/test/java/sonia/scm/it/utils/ScmRequests.java b/scm-it/src/test/java/sonia/scm/it/utils/ScmRequests.java index 69c79c37bf..9d08594006 100644 --- a/scm-it/src/test/java/sonia/scm/it/utils/ScmRequests.java +++ b/scm-it/src/test/java/sonia/scm/it/utils/ScmRequests.java @@ -52,7 +52,12 @@ public class ScmRequests { setUsername(username); setPassword(password); return new ChangePasswordResponse<>(applyPUTRequest(RestUtil.REST_BASE_URL.resolve("users/"+userPathParam+"/password").toString(), VndMediaType.PASSWORD_OVERWRITE, TestData.createPasswordChangeJson(password,newPassword)), null); + } + @SuppressWarnings("unchecked") + public ModelResponse requestPluginTranslations(String language) { + Response response = applyGETRequest(RestUtil.BASE_URL.resolve("locales/" + language + "/plugins.json").toString()); + return new ModelResponse(response, null); } /** @@ -90,6 +95,11 @@ public class ScmRequests { */ private Response applyGETRequestWithQueryParams(String url, String params) { LOG.info("GET {}", url); + if (username == null || password == null){ + return RestAssured.given() + .when() + .get(url + params); + } return RestAssured.given() .auth().preemptive().basic(username, password) .when() diff --git a/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js b/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js index d8eb4ae0e0..f17dc5e2e9 100644 --- a/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js +++ b/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js @@ -2,9 +2,11 @@ import React from "react"; import { repositories } from "@scm-manager/ui-components"; import type { Repository } from "@scm-manager/ui-types"; +import { translate } from "react-i18next"; type Props = { - repository: Repository + repository: Repository, + t: string => string } class ProtocolInformation extends React.Component { @@ -18,11 +20,11 @@ class ProtocolInformation extends React.Component { return (
-

Clone the repository

+

{t("scm-git-plugin.information.clone")}

           git clone {href}
         
-

Create a new repository

+

{t("scm-git-plugin.information.create")}

           
             git init {repository.name}
@@ -39,7 +41,7 @@ class ProtocolInformation extends React.Component {
             
-

Push an existing repository

+

{t("scm-git-plugin.information.replace")}

           
             git remote add origin {href}
@@ -54,4 +56,4 @@ class ProtocolInformation extends React.Component {
 
 }
 
-export default ProtocolInformation;
+export default translate("plugins")(ProtocolInformation);
diff --git a/scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json b/scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json
index a405e36d23..1dc0e254c2 100644
--- a/scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json
+++ b/scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json
@@ -1,5 +1,9 @@
 {
-  "git": {
-    "description": "die git repo ist super "
+  "scm-git-plugin": {
+    "information": {
+      "clone" : "Repository Klonen",
+      "create" : "Neue Repository erstellen",
+      "replace" : "Eine existierende Repository aktualisieren"
+    }
   }
 }
diff --git a/scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json b/scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json
index 0412a162b3..65594bae19 100644
--- a/scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json
+++ b/scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json
@@ -1,5 +1,9 @@
 {
-  "git": {
-    "description": "the git repo is great "
+  "scm-git-plugin": {
+    "information": {
+      "clone" : "Clone the repository",
+      "create" : "Create a new repository",
+      "replace" : "Push an existing repository"
+    }
   }
 }
diff --git a/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js b/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js
index 03fc41450a..6a55578926 100644
--- a/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js
+++ b/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js
@@ -2,9 +2,11 @@
 import React from "react";
 import { repositories } from "@scm-manager/ui-components";
 import type { Repository } from "@scm-manager/ui-types";
+import { translate } from "react-i18next";
 
 type Props = {
-  repository: Repository
+  repository: Repository,
+  t: string => string
 }
 
 class ProtocolInformation extends React.Component {
@@ -17,11 +19,11 @@ class ProtocolInformation extends React.Component {
     }
     return (
       
-

Clone the repository

+

{t("scm-hg-plugin.information.clone")}

           hg clone {href}
         
-

Create a new repository

+

{t("scm-hg-plugin.information.create")}

           
             hg init {repository.name}
@@ -41,7 +43,7 @@ class ProtocolInformation extends React.Component {
             
-

Push an existing repository

+

{t("scm-hg-plugin.information.replace")}

           
             # add the repository url as default to your .hg/hgrc e.g:
@@ -59,4 +61,4 @@ class ProtocolInformation extends React.Component {
 
 }
 
-export default ProtocolInformation;
+export default translate("plugins")(ProtocolInformation);
diff --git a/scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json b/scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json
index 49a3d97570..0824a4ad38 100644
--- a/scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json
+++ b/scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json
@@ -1,5 +1,9 @@
 {
-  "hg": {
-    "description": "die hg repo ist super "
+  "scm-hg-plugin": {
+    "information": {
+      "clone" : "Repository Klonen",
+      "create" : "Neue Repository erstellen",
+      "replace" : "Eine existierende Repository aktualisieren"
+    }
   }
 }
diff --git a/scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json b/scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json
index 28c628e81e..4ec1d4e4d2 100644
--- a/scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json
+++ b/scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json
@@ -1,5 +1,9 @@
 {
-  "hg": {
-    "description": "the hg repo is great "
+  "scm-hg-plugin": {
+    "information": {
+      "clone" : "Clone the repository",
+      "create" : "Create a new repository",
+      "replace" : "Push an existing repository"
+    }
   }
 }
diff --git a/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js b/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js
index 0ba195887f..bcfe223b83 100644
--- a/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js
+++ b/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js
@@ -2,9 +2,11 @@
 import React from "react";
 import { repositories } from "@scm-manager/ui-components";
 import type { Repository } from "@scm-manager/ui-types";
+import { translate } from "react-i18next";
 
 type Props = {
-  repository: Repository
+  repository: Repository,
+  t: string => string
 }
 
 class ProtocolInformation extends React.Component {
@@ -17,7 +19,7 @@ class ProtocolInformation extends React.Component {
     }
     return (
       
-

Checkout the repository

+

{t("scm-svn-plugin.information.checkout")}

           svn checkout {href}
         
@@ -27,4 +29,4 @@ class ProtocolInformation extends React.Component { } -export default ProtocolInformation; +export default translate("plugins")(ProtocolInformation); diff --git a/scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json b/scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json index 1c25a5bcf5..7c58498ef1 100644 --- a/scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json +++ b/scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json @@ -1,5 +1,7 @@ { - "svn": { - "description": "die svn repo ist super " + "scm-svn-plugin": { + "information": { + "checkout" : "Repository auschecken" + } } } diff --git a/scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json b/scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json index cbfbaac63b..07b34baf10 100644 --- a/scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json +++ b/scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json @@ -1,5 +1,7 @@ { - "svn": { - "description": "the svn repo is great " + "scm-svn-plugin": { + "information": { + "checkout" : "Checkout repository" + } } } diff --git a/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java index 00d1f3aaf4..d0c78bf1f5 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java +++ b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java @@ -4,7 +4,6 @@ package sonia.scm.web.i18n; import com.fasterxml.jackson.databind.ObjectMapper; import com.github.legman.Subscribe; import com.google.inject.Singleton; -import com.sun.org.apache.regexp.internal.RE; import lombok.extern.slf4j.Slf4j; import sonia.scm.NotFoundException; import sonia.scm.SCMContext; @@ -34,7 +33,7 @@ import java.util.function.Function; /** - * Collect + * Collect the plugin translations. */ @Singleton @WebElement(value = I18nServlet.PATTERN, regex = true) @@ -47,9 +46,8 @@ public class I18nServlet extends HttpServlet { public static final String CACHE_NAME = "sonia.cache.plugins.translations"; private final UberClassLoader uberClassLoader; - private final Cache> cache; - private RE languagePathPostfix = new RE(".*(\\-[A-Z]+)/.*"); - private ObjectMapper objectMapper = new ObjectMapper(); + private final Cache cache; + private static ObjectMapper objectMapper = new ObjectMapper(); @Inject @@ -58,18 +56,18 @@ public class I18nServlet extends HttpServlet { this.cache = cacheManager.getCache(CACHE_NAME); } - @Subscribe + @Subscribe(async = false) public void handleRestartEvent(RestartEvent event) { - log.info("clear cache on restart event with reason {}", event.getReason()); + log.info("Clear cache on restart event with reason {}", event.getReason()); cache.clear(); } - public Map getCollectedJson(String path, - Function>> jsonFileProvider, - BiConsumer> createdJsonFileConsumer) throws NotFoundException { + private Map getCollectedJson(String path, + Function> jsonFileProvider, + BiConsumer createdJsonFileConsumer) { return Optional.ofNullable(jsonFileProvider.apply(path) .orElseGet(() -> { - Optional> createdFile = collectJsonFile(path); + Optional createdFile = collectJsonFile(path); createdFile.ifPresent(map -> createdJsonFileConsumer.accept(path, map)); return createdFile.orElse(null); } @@ -82,9 +80,9 @@ public class I18nServlet extends HttpServlet { response.setContentType("application/json"); PrintWriter out = response.getWriter(); String path = req.getServletPath(); - Function>> jsonFileProvider = usedPath -> Optional.empty(); - BiConsumer> createdJsonFileConsumer = (usedPath, foundJsonMap) -> log.info("A json File is created from the path {}", usedPath); - if (SCMContext.getContext().getStage() == Stage.PRODUCTION) { + Function> jsonFileProvider = usedPath -> Optional.empty(); + BiConsumer createdJsonFileConsumer = (usedPath, foundJsonMap) -> log.info("A json File is created from the path {}", usedPath); + if (isProductionStage()) { log.info("In Production Stage get the plugin translations from the cache"); jsonFileProvider = usedPath -> Optional.ofNullable( cache.get(usedPath)); @@ -94,58 +92,40 @@ public class I18nServlet extends HttpServlet { } out.write(objectMapper.writeValueAsString(getCollectedJson(path, jsonFileProvider, createdJsonFileConsumer))); } catch (IOException e) { - log.error("error on getting the translation of the plugins", e); + log.error("Error on getting the translation of the plugins", e); response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); } catch (NotFoundException e) { log.error("Plugin translations are not found", e); response.setStatus(HttpServletResponse.SC_NOT_FOUND); } -// ScmEventBus.getInstance().post(new RestartEvent(I18nServlet.class,"einfach so")); + } + + protected boolean isProductionStage() { + return SCMContext.getContext().getStage() == Stage.PRODUCTION; } /** - * Return a collected Json File as map with the given path from all plugins in the class path + * Return a collected Json File as map from the given path from all plugins in the class path * * @param path the searched resource path - * @return a collected Json File as map with the given path from all plugins in the class path + * @return a collected Json File as map from the given path from all plugins in the class path */ - private Optional> collectJsonFile(String path) { + protected Optional collectJsonFile(String path) { log.info("Collect plugin translations from path {} for every plugin", path); - HashMap result = null; + Map result = null; try { Enumeration resources = uberClassLoader.getResources(path.replaceFirst("/", "")); if (resources.hasMoreElements()) { - result = new HashMap<>(); + result = new HashMap(); while (resources.hasMoreElements()) { URL url = resources.nextElement(); - result.putAll(mergeJSONs(objectMapper, url)); + result.putAll(objectMapper.readValue(Files.readAllBytes(Paths.get(url.getPath())), Map.class)); } } } catch (IOException e) { log.error("Error on loading sources from {}", path, e); + return Optional.empty(); } return Optional.ofNullable(result); } - - private boolean hasLanguagePostfix(String path) { - return languagePathPostfix.match(path); - } - - /** - * remove the -DE from the path locales/de-DE/plugins - * - * @param servletPath - * @return - * @throws IOException - */ - private String removeLanguagePostfix(String servletPath) { - return servletPath.replace(languagePathPostfix.getParen(1), ""); - } - - // TODO simplify - private HashMap mergeJSONs(ObjectMapper objectMapper, URL url) throws IOException { - byte[] src = Files.readAllBytes(Paths.get(url.getPath())); - Map json = objectMapper.readValue(src, HashMap.class); - return objectMapper.readerForUpdating(json).readValue(src); - } } diff --git a/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java new file mode 100644 index 0000000000..b8deb4b069 --- /dev/null +++ b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java @@ -0,0 +1,253 @@ +package sonia.scm.web.i18n; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.github.sdorra.shiro.ShiroRule; +import com.github.sdorra.shiro.SubjectAware; +import com.google.common.base.Charsets; +import com.google.common.io.Files; +import org.assertj.core.util.Lists; +import org.junit.Before; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.TemporaryFolder; +import org.junit.runner.RunWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Mock; +import org.mockito.MockSettings; +import org.mockito.internal.creation.MockSettingsImpl; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.junit.MockitoJUnitRunner; +import sonia.scm.boot.RestartEvent; +import sonia.scm.cache.Cache; +import sonia.scm.cache.CacheManager; +import sonia.scm.event.ScmEventBus; +import sonia.scm.plugin.PluginLoader; +import sonia.scm.plugin.UberClassLoader; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.File; +import java.io.IOException; +import java.io.PrintWriter; +import java.net.URL; +import java.util.Collections; +import java.util.Enumeration; +import java.util.Map; +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.doCallRealMethod; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +@RunWith(MockitoJUnitRunner.Silent.class) +@SubjectAware(configuration = "classpath:sonia/scm/shiro-001.ini") +public class I18nServletTest { + + @Rule + public ShiroRule shiro = new ShiroRule(); + + private static final String GIT_PLUGIN_JSON = "{\n" + + " \"scm-git-plugin\": {\n" + + " \"information\": {\n" + + " \"clone\" : \"Clone\",\n" + + " \"create\" : \"Create\",\n" + + " \"replace\" : \"Push\"\n" + + " }\n" + + " }\n" + + "}\n"; + private static final String HG_PLUGIN_JSON = "{\n" + + " \"scm-hg-plugin\": {\n" + + " \"information\": {\n" + + " \"clone\" : \"Clone\",\n" + + " \"create\" : \"Create\",\n" + + " \"replace\" : \"Push\"\n" + + " }\n" + + " }\n" + + "}\n"; + private static String SVN_PLUGIN_JSON = "{\n" + + " \"scm-svn-plugin\": {\n" + + " \"information\": {\n" + + " \"checkout\" : \"Checkout\"\n" + + " }\n" + + " }\n" + + "}\n"; + + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + @Mock + PluginLoader pluginLoader; + + @Mock + CacheManager cacheManager; + + @Mock + UberClassLoader uberClassLoader; + + I18nServlet servlet; + + @Mock + private Cache cache; + private Enumeration resources; + + @Before + @SuppressWarnings("unchecked") + public void init() throws IOException { + resources = Collections.enumeration(Lists.newArrayList( + createFileFromString(SVN_PLUGIN_JSON).toURL(), + createFileFromString(GIT_PLUGIN_JSON).toURL(), + createFileFromString(HG_PLUGIN_JSON).toURL() + )); + when(pluginLoader.getUberClassLoader()).thenReturn(uberClassLoader); + when(cacheManager.getCache(I18nServlet.CACHE_NAME)).thenReturn(cache); + MockSettings settings = new MockSettingsImpl<>(); + settings.useConstructor(pluginLoader, cacheManager); + settings.defaultAnswer(InvocationOnMock::callRealMethod); + servlet = mock(I18nServlet.class, settings); + } + + @Test + public void shouldCleanCacheOnRestartEvent() { + ScmEventBus.getInstance().register(servlet); + + ScmEventBus.getInstance().post(new RestartEvent(I18nServlet.class, "Restart to reload the plugin resources")); + + verify(cache).clear(); + } + + @Test + @SuppressWarnings("unchecked") + public void shouldFailWith404OnMissingResources() throws IOException { + String path = "/locales/de/plugins.json"; + HttpServletRequest request = mock(HttpServletRequest.class); + HttpServletResponse response = mock(HttpServletResponse.class); + PrintWriter writer = mock(PrintWriter.class); + when(response.getWriter()).thenReturn(writer); + when(request.getServletPath()).thenReturn(path); + when(uberClassLoader.getResources("locales/de/plugins.json")).thenThrow(IOException.class); + + servlet.doGet(request, response); + + verify(response).setStatus(404); + } + + @Test + @SuppressWarnings("unchecked") + public void shouldFailWith500OnIOException() throws IOException { + String path = "/locales/de/plugins.json"; + HttpServletRequest request = mock(HttpServletRequest.class); + HttpServletResponse response = mock(HttpServletResponse.class); + PrintWriter writer = mock(PrintWriter.class); + when(response.getWriter()).thenReturn(writer); + when(request.getServletPath()).thenReturn(path); + when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); + doThrow(IOException.class).when(writer).write(any(String.class)); + + servlet.doGet(request, response); + + verify(response).setStatus(500); + } + + @Test + @SuppressWarnings("unchecked") + public void inDevelopmentStageShouldNotUseCache() throws IOException { + String path = "/locales/de/plugins.json"; + when(servlet.isProductionStage()).thenReturn(false); + HttpServletRequest request = mock(HttpServletRequest.class); + HttpServletResponse response = mock(HttpServletResponse.class); + PrintWriter writer = mock(PrintWriter.class); + when(response.getWriter()).thenReturn(writer); + when(request.getServletPath()).thenReturn(path); + when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + doCallRealMethod().when(writer).write(captor.capture()); + + servlet.doGet(request, response); + + assertJsonMap(jsonStringToMap(captor.getValue())); + verify(cache, never()).get(any()); + } + + @Test + @SuppressWarnings("unchecked") + public void inProductionStageShouldUseCache() throws IOException { + String path = "/locales/de/plugins.json"; + when(servlet.isProductionStage()).thenReturn(true); + HttpServletRequest request = mock(HttpServletRequest.class); + HttpServletResponse response = mock(HttpServletResponse.class); + PrintWriter writer = mock(PrintWriter.class); + when(response.getWriter()).thenReturn(writer); + when(request.getServletPath()).thenReturn(path); + when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + doCallRealMethod().when(writer).write(captor.capture()); + + servlet.doGet(request, response); + + assertJsonMap(jsonStringToMap(captor.getValue())); + verify(cache).get(path); + verify(cache).put(eq(path), any()); + } + + @Test + @SuppressWarnings("unchecked") + public void inProductionStageShouldGetFromCache() throws IOException { + String path = "/locales/de/plugins.json"; + when(servlet.isProductionStage()).thenReturn(true); + HttpServletRequest request = mock(HttpServletRequest.class); + HttpServletResponse response = mock(HttpServletResponse.class); + PrintWriter writer = mock(PrintWriter.class); + when(response.getWriter()).thenReturn(writer); + when(request.getServletPath()).thenReturn(path); + when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + doCallRealMethod().when(writer).write(captor.capture()); + Map cachedMap = jsonStringToMap(GIT_PLUGIN_JSON); + cachedMap.putAll(jsonStringToMap(HG_PLUGIN_JSON)); + cachedMap.putAll(jsonStringToMap(SVN_PLUGIN_JSON)); + when(cache.get(path)).thenReturn(cachedMap); + servlet.doGet(request, response); + verify(servlet, never()).collectJsonFile(path); + verify(cache, never()).put(eq(path), any()); + verify(cache).get(path); + assertJsonMap(jsonStringToMap(captor.getValue())); + } + + @Test + @SuppressWarnings("unchecked") + public void shouldCollectJsonFile() throws IOException { + String path = "locales/de/plugins.json"; + + when(uberClassLoader.getResources(path)).thenReturn(resources); + Optional mapOptional = servlet.collectJsonFile("/" + path); + + assertJsonMap(mapOptional.orElse(null)); + } + + @SuppressWarnings("unchecked") + public void assertJsonMap(Map actual) throws IOException { + assertThat(actual) + .isNotEmpty() + .containsAllEntriesOf(jsonStringToMap(GIT_PLUGIN_JSON)) + .containsAllEntriesOf(jsonStringToMap(HG_PLUGIN_JSON)) + .containsAllEntriesOf(jsonStringToMap(SVN_PLUGIN_JSON)); + } + + public File createFileFromString(String json) throws IOException { + File file = temporaryFolder.newFile(); + Files.write(json.getBytes(Charsets.UTF_8), file); + return file; + } + + private Map jsonStringToMap(String fileAsString) throws IOException { + ObjectMapper mapper = new ObjectMapper(); + return mapper.readValue(fileAsString, Map.class); + } + +} From 6233e600f2753c67aec09bf89e92dba9195a3b2a Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Mon, 22 Oct 2018 13:00:44 +0200 Subject: [PATCH 3/8] fix missing translate (t) function --- scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js | 2 +- scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js | 2 +- scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js b/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js index f17dc5e2e9..c6aed483e7 100644 --- a/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js +++ b/scm-plugins/scm-git-plugin/src/main/js/ProtocolInformation.js @@ -12,7 +12,7 @@ type Props = { class ProtocolInformation extends React.Component { render() { - const { repository } = this.props; + const { repository, t } = this.props; const href = repositories.getProtocolLinkByType(repository, "http"); if (!href) { return null; diff --git a/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js b/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js index 6a55578926..a8ae91cdfb 100644 --- a/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js +++ b/scm-plugins/scm-hg-plugin/src/main/js/ProtocolInformation.js @@ -12,7 +12,7 @@ type Props = { class ProtocolInformation extends React.Component { render() { - const { repository } = this.props; + const { repository, t } = this.props; const href = repositories.getProtocolLinkByType(repository, "http"); if (!href) { return null; diff --git a/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js b/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js index bcfe223b83..68fdc68f74 100644 --- a/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js +++ b/scm-plugins/scm-svn-plugin/src/main/js/ProtocolInformation.js @@ -12,7 +12,7 @@ type Props = { class ProtocolInformation extends React.Component { render() { - const { repository } = this.props; + const { repository, t } = this.props; const href = repositories.getProtocolLinkByType(repository, "http"); if (!href) { return null; From 66776c54dd7e16c3b36ca32d3514bd160acbe4a9 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Mon, 22 Oct 2018 14:15:21 +0200 Subject: [PATCH 4/8] fix missing translations in livereload mode --- scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java b/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java index 6405c16ddc..222800c9e3 100644 --- a/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java +++ b/scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java @@ -23,6 +23,7 @@ import java.net.URL; * @since 2.0.0 */ @Singleton +@Priority(WebResourceServlet.PRIORITY) @WebElement(value = WebResourceServlet.PATTERN, regex = true) public class WebResourceServlet extends HttpServlet { @@ -33,7 +34,10 @@ public class WebResourceServlet extends HttpServlet { * TODO remove old protocol servlets and hook. Move /hook/hg to api? */ @VisibleForTesting - static final String PATTERN = "/(?!api/|git/|hg/|svn/|hook/|repo/|locales/).*"; + static final String PATTERN = "/(?!api/|git/|hg/|svn/|hook/|repo/).*"; + + // Be sure that this servlet is the last one in the servlet chain. + static final int PRIORITY = Integer.MAX_VALUE; private static final Logger LOG = LoggerFactory.getLogger(WebResourceServlet.class); From a7d14636dcd7115aeec31a03f4fe32c6edf9767c Mon Sep 17 00:00:00 2001 From: Mohamed Karray Date: Mon, 22 Oct 2018 17:37:10 +0200 Subject: [PATCH 5/8] use JsonNode in the I18nServlet --- .../java/sonia/scm/util/JacksonUtils.java | 49 ++++++++++ .../java/sonia/scm/web/i18n/I18nServlet.java | 62 ++++++------- .../sonia/scm/web/i18n/I18nServletTest.java | 93 +++++++++---------- 3 files changed, 124 insertions(+), 80 deletions(-) create mode 100644 scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java diff --git a/scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java b/scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java new file mode 100644 index 0000000000..3847b1fb55 --- /dev/null +++ b/scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java @@ -0,0 +1,49 @@ +package sonia.scm.util; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; + +import java.util.Iterator; + +public class JacksonUtils { + + private JacksonUtils() { + } + + public static JsonNode merge(JsonNode mainNode, JsonNode updateNode) { + Iterator fieldNames = updateNode.fieldNames(); + + while (fieldNames.hasNext()) { + + String fieldName = fieldNames.next(); + JsonNode jsonNode = mainNode.get(fieldName); + + if (jsonNode != null) { + if (jsonNode.isObject()) { + merge(jsonNode, updateNode.get(fieldName)); + } else if (jsonNode.isArray()) { + for (int i = 0; i < jsonNode.size(); i++) { + merge(jsonNode.get(i), updateNode.get(fieldName).get(i)); + } + } + } else { + if (mainNode instanceof ObjectNode) { + // Overwrite field + JsonNode value = updateNode.get(fieldName); + if (value.isNull()) { + continue; + } + if (value.isIntegralNumber() && value.toString().equals("0")) { + continue; + } + if (value.isFloatingPointNumber() && value.toString().equals("0.0")) { + continue; + } + ((ObjectNode) mainNode).put(fieldName, value); + } + } + } + + return mainNode; + } +} diff --git a/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java index d0c78bf1f5..16e8c974e7 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java +++ b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java @@ -1,6 +1,7 @@ package sonia.scm.web.i18n; +import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import com.github.legman.Subscribe; import com.google.inject.Singleton; @@ -13,7 +14,7 @@ import sonia.scm.cache.Cache; import sonia.scm.cache.CacheManager; import sonia.scm.filter.WebElement; import sonia.scm.plugin.PluginLoader; -import sonia.scm.plugin.UberClassLoader; +import sonia.scm.util.JacksonUtils; import javax.inject.Inject; import javax.servlet.http.HttpServlet; @@ -22,11 +23,7 @@ import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.io.PrintWriter; import java.net.URL; -import java.nio.file.Files; -import java.nio.file.Paths; import java.util.Enumeration; -import java.util.HashMap; -import java.util.Map; import java.util.Optional; import java.util.function.BiConsumer; import java.util.function.Function; @@ -45,29 +42,29 @@ public class I18nServlet extends HttpServlet { public static final String PATTERN = PATH + "/[a-z\\-A-Z]*/" + PLUGINS_JSON; public static final String CACHE_NAME = "sonia.cache.plugins.translations"; - private final UberClassLoader uberClassLoader; - private final Cache cache; + private final ClassLoader classLoader; + private final Cache cache; private static ObjectMapper objectMapper = new ObjectMapper(); @Inject public I18nServlet(PluginLoader pluginLoader, CacheManager cacheManager) { - this.uberClassLoader = (UberClassLoader) pluginLoader.getUberClassLoader(); + this.classLoader = pluginLoader.getUberClassLoader(); this.cache = cacheManager.getCache(CACHE_NAME); } @Subscribe(async = false) public void handleRestartEvent(RestartEvent event) { - log.info("Clear cache on restart event with reason {}", event.getReason()); + log.debug("Clear cache on restart event with reason {}", event.getReason()); cache.clear(); } - private Map getCollectedJson(String path, - Function> jsonFileProvider, - BiConsumer createdJsonFileConsumer) { + private JsonNode getCollectedJson(String path, + Function> jsonFileProvider, + BiConsumer createdJsonFileConsumer) { return Optional.ofNullable(jsonFileProvider.apply(path) .orElseGet(() -> { - Optional createdFile = collectJsonFile(path); + Optional createdFile = collectJsonFile(path); createdFile.ifPresent(map -> createdJsonFileConsumer.accept(path, map)); return createdFile.orElse(null); } @@ -76,21 +73,20 @@ public class I18nServlet extends HttpServlet { @Override protected void doGet(HttpServletRequest req, HttpServletResponse response) { - try { + try (PrintWriter out = response.getWriter()) { response.setContentType("application/json"); - PrintWriter out = response.getWriter(); String path = req.getServletPath(); - Function> jsonFileProvider = usedPath -> Optional.empty(); - BiConsumer createdJsonFileConsumer = (usedPath, foundJsonMap) -> log.info("A json File is created from the path {}", usedPath); + Function> jsonFileProvider = usedPath -> Optional.empty(); + BiConsumer createdJsonFileConsumer = (usedPath, jsonNode) -> log.debug("A json File is created from the path {}", usedPath); if (isProductionStage()) { - log.info("In Production Stage get the plugin translations from the cache"); + log.debug("In Production Stage get the plugin translations from the cache"); jsonFileProvider = usedPath -> Optional.ofNullable( cache.get(usedPath)); createdJsonFileConsumer = createdJsonFileConsumer - .andThen((usedPath, map) -> log.info("Put the created json File in the cache with the key {}", usedPath)) + .andThen((usedPath, jsonNode) -> log.debug("Put the created json File in the cache with the key {}", usedPath)) .andThen(cache::put); } - out.write(objectMapper.writeValueAsString(getCollectedJson(path, jsonFileProvider, createdJsonFileConsumer))); + objectMapper.writeValue(out, getCollectedJson(path, jsonFileProvider, createdJsonFileConsumer)); } catch (IOException e) { log.error("Error on getting the translation of the plugins", e); response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); @@ -105,27 +101,29 @@ public class I18nServlet extends HttpServlet { } /** - * Return a collected Json File as map from the given path from all plugins in the class path + * Return a collected Json File as JsonNode from the given path from all plugins in the class path * * @param path the searched resource path - * @return a collected Json File as map from the given path from all plugins in the class path + * @return a collected Json File as JsonNode from the given path from all plugins in the class path */ - protected Optional collectJsonFile(String path) { - log.info("Collect plugin translations from path {} for every plugin", path); - Map result = null; + protected Optional collectJsonFile(String path) { + log.debug("Collect plugin translations from path {} for every plugin", path); + JsonNode mergedJsonNode = null; try { - Enumeration resources = uberClassLoader.getResources(path.replaceFirst("/", "")); - if (resources.hasMoreElements()) { - result = new HashMap(); - while (resources.hasMoreElements()) { - URL url = resources.nextElement(); - result.putAll(objectMapper.readValue(Files.readAllBytes(Paths.get(url.getPath())), Map.class)); + Enumeration resources = classLoader.getResources(path.replaceFirst("/", "")); + while (resources.hasMoreElements()) { + URL url = resources.nextElement(); + JsonNode jsonNode = objectMapper.readTree(url); + if (mergedJsonNode != null) { + JacksonUtils.merge(mergedJsonNode, jsonNode); + } else { + mergedJsonNode = jsonNode; } } } catch (IOException e) { log.error("Error on loading sources from {}", path, e); return Optional.empty(); } - return Optional.ofNullable(result); + return Optional.ofNullable(mergedJsonNode); } } diff --git a/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java index b8deb4b069..243a9bd6ed 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java @@ -1,17 +1,18 @@ package sonia.scm.web.i18n; +import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import com.github.sdorra.shiro.ShiroRule; import com.github.sdorra.shiro.SubjectAware; import com.google.common.base.Charsets; import com.google.common.io.Files; +import org.apache.commons.lang3.StringUtils; import org.assertj.core.util.Lists; import org.junit.Before; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; import org.junit.runner.RunWith; -import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.mockito.MockSettings; import org.mockito.internal.creation.MockSettingsImpl; @@ -22,23 +23,23 @@ import sonia.scm.cache.Cache; import sonia.scm.cache.CacheManager; import sonia.scm.event.ScmEventBus; import sonia.scm.plugin.PluginLoader; -import sonia.scm.plugin.UberClassLoader; +import sonia.scm.util.JacksonUtils; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.File; +import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintWriter; import java.net.URL; +import java.nio.charset.Charset; import java.util.Collections; import java.util.Enumeration; -import java.util.Map; import java.util.Optional; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.doCallRealMethod; import static org.mockito.Mockito.doThrow; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; @@ -60,7 +61,7 @@ public class I18nServletTest { " \"replace\" : \"Push\"\n" + " }\n" + " }\n" + - "}\n"; + "}"; private static final String HG_PLUGIN_JSON = "{\n" + " \"scm-hg-plugin\": {\n" + " \"information\": {\n" + @@ -69,14 +70,14 @@ public class I18nServletTest { " \"replace\" : \"Push\"\n" + " }\n" + " }\n" + - "}\n"; + "}"; private static String SVN_PLUGIN_JSON = "{\n" + " \"scm-svn-plugin\": {\n" + " \"information\": {\n" + " \"checkout\" : \"Checkout\"\n" + " }\n" + " }\n" + - "}\n"; + "}"; @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); @@ -88,7 +89,7 @@ public class I18nServletTest { CacheManager cacheManager; @Mock - UberClassLoader uberClassLoader; + ClassLoader classLoader; I18nServlet servlet; @@ -104,7 +105,7 @@ public class I18nServletTest { createFileFromString(GIT_PLUGIN_JSON).toURL(), createFileFromString(HG_PLUGIN_JSON).toURL() )); - when(pluginLoader.getUberClassLoader()).thenReturn(uberClassLoader); + when(pluginLoader.getUberClassLoader()).thenReturn(classLoader); when(cacheManager.getCache(I18nServlet.CACHE_NAME)).thenReturn(cache); MockSettings settings = new MockSettingsImpl<>(); settings.useConstructor(pluginLoader, cacheManager); @@ -130,7 +131,7 @@ public class I18nServletTest { PrintWriter writer = mock(PrintWriter.class); when(response.getWriter()).thenReturn(writer); when(request.getServletPath()).thenReturn(path); - when(uberClassLoader.getResources("locales/de/plugins.json")).thenThrow(IOException.class); + when(classLoader.getResources("locales/de/plugins.json")).thenThrow(IOException.class); servlet.doGet(request, response); @@ -140,14 +141,9 @@ public class I18nServletTest { @Test @SuppressWarnings("unchecked") public void shouldFailWith500OnIOException() throws IOException { - String path = "/locales/de/plugins.json"; HttpServletRequest request = mock(HttpServletRequest.class); HttpServletResponse response = mock(HttpServletResponse.class); - PrintWriter writer = mock(PrintWriter.class); - when(response.getWriter()).thenReturn(writer); - when(request.getServletPath()).thenReturn(path); - when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); - doThrow(IOException.class).when(writer).write(any(String.class)); + doThrow(IOException.class).when(response).getWriter(); servlet.doGet(request, response); @@ -161,16 +157,16 @@ public class I18nServletTest { when(servlet.isProductionStage()).thenReturn(false); HttpServletRequest request = mock(HttpServletRequest.class); HttpServletResponse response = mock(HttpServletResponse.class); - PrintWriter writer = mock(PrintWriter.class); + File file = temporaryFolder.newFile(); + PrintWriter writer = new PrintWriter(new FileOutputStream(file)); when(response.getWriter()).thenReturn(writer); when(request.getServletPath()).thenReturn(path); - when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); - ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); - doCallRealMethod().when(writer).write(captor.capture()); + when(classLoader.getResources("locales/de/plugins.json")).thenReturn(resources); servlet.doGet(request, response); - assertJsonMap(jsonStringToMap(captor.getValue())); + String json = Files.readLines(file, Charset.defaultCharset()).get(0); + assertJson(json); verify(cache, never()).get(any()); } @@ -181,16 +177,16 @@ public class I18nServletTest { when(servlet.isProductionStage()).thenReturn(true); HttpServletRequest request = mock(HttpServletRequest.class); HttpServletResponse response = mock(HttpServletResponse.class); - PrintWriter writer = mock(PrintWriter.class); + File file = temporaryFolder.newFile(); + PrintWriter writer = new PrintWriter(new FileOutputStream(file)); when(response.getWriter()).thenReturn(writer); when(request.getServletPath()).thenReturn(path); - when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); - ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); - doCallRealMethod().when(writer).write(captor.capture()); + when(classLoader.getResources("locales/de/plugins.json")).thenReturn(resources); servlet.doGet(request, response); - assertJsonMap(jsonStringToMap(captor.getValue())); + String json = Files.readLines(file, Charset.defaultCharset()).get(0); + assertJson(json); verify(cache).get(path); verify(cache).put(eq(path), any()); } @@ -202,41 +198,47 @@ public class I18nServletTest { when(servlet.isProductionStage()).thenReturn(true); HttpServletRequest request = mock(HttpServletRequest.class); HttpServletResponse response = mock(HttpServletResponse.class); - PrintWriter writer = mock(PrintWriter.class); + File file = temporaryFolder.newFile(); + PrintWriter writer = new PrintWriter(new FileOutputStream(file)); when(response.getWriter()).thenReturn(writer); when(request.getServletPath()).thenReturn(path); - when(uberClassLoader.getResources("locales/de/plugins.json")).thenReturn(resources); - ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); - doCallRealMethod().when(writer).write(captor.capture()); - Map cachedMap = jsonStringToMap(GIT_PLUGIN_JSON); - cachedMap.putAll(jsonStringToMap(HG_PLUGIN_JSON)); - cachedMap.putAll(jsonStringToMap(SVN_PLUGIN_JSON)); - when(cache.get(path)).thenReturn(cachedMap); + when(classLoader.getResources("locales/de/plugins.json")).thenReturn(resources); + ObjectMapper objectMapper = new ObjectMapper(); + JsonNode node = objectMapper.readTree(GIT_PLUGIN_JSON); + node = JacksonUtils.merge(node, objectMapper.readTree(HG_PLUGIN_JSON)); + node = JacksonUtils.merge(node, objectMapper.readTree(SVN_PLUGIN_JSON)); + when(cache.get(path)).thenReturn(node); + servlet.doGet(request, response); + + String json = Files.readLines(file, Charset.defaultCharset()).get(0); verify(servlet, never()).collectJsonFile(path); verify(cache, never()).put(eq(path), any()); verify(cache).get(path); - assertJsonMap(jsonStringToMap(captor.getValue())); + assertJson(json); } @Test @SuppressWarnings("unchecked") public void shouldCollectJsonFile() throws IOException { String path = "locales/de/plugins.json"; + when(classLoader.getResources(path)).thenReturn(resources); - when(uberClassLoader.getResources(path)).thenReturn(resources); - Optional mapOptional = servlet.collectJsonFile("/" + path); + Optional jsonNodeOptional = servlet.collectJsonFile("/" + path); - assertJsonMap(mapOptional.orElse(null)); + assertJson(jsonNodeOptional.orElse(null)); } - @SuppressWarnings("unchecked") - public void assertJsonMap(Map actual) throws IOException { + public void assertJson(JsonNode actual) throws IOException { + assertJson(actual.toString()); + } + + public void assertJson(String actual) throws IOException { assertThat(actual) .isNotEmpty() - .containsAllEntriesOf(jsonStringToMap(GIT_PLUGIN_JSON)) - .containsAllEntriesOf(jsonStringToMap(HG_PLUGIN_JSON)) - .containsAllEntriesOf(jsonStringToMap(SVN_PLUGIN_JSON)); + .contains(StringUtils.deleteWhitespace(GIT_PLUGIN_JSON.substring(1, GIT_PLUGIN_JSON.length() - 1))) + .contains(StringUtils.deleteWhitespace(HG_PLUGIN_JSON.substring(1, HG_PLUGIN_JSON.length() - 1))) + .contains(StringUtils.deleteWhitespace(SVN_PLUGIN_JSON.substring(1, SVN_PLUGIN_JSON.length() - 1))); } public File createFileFromString(String json) throws IOException { @@ -245,9 +247,4 @@ public class I18nServletTest { return file; } - private Map jsonStringToMap(String fileAsString) throws IOException { - ObjectMapper mapper = new ObjectMapper(); - return mapper.readValue(fileAsString, Map.class); - } - } From 36a55bffaeb03d7a67410979ef8b567e326d48cd Mon Sep 17 00:00:00 2001 From: Mohamed Karray Date: Wed, 24 Oct 2018 10:18:09 +0200 Subject: [PATCH 6/8] Move the json merge in the I18nServlet class --- .../java/sonia/scm/util/JacksonUtils.java | 49 -------------- .../java/sonia/scm/web/i18n/I18nServlet.java | 67 +++++++++++++++++-- .../sonia/scm/web/i18n/I18nServletTest.java | 5 +- 3 files changed, 65 insertions(+), 56 deletions(-) delete mode 100644 scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java diff --git a/scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java b/scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java deleted file mode 100644 index 3847b1fb55..0000000000 --- a/scm-webapp/src/main/java/sonia/scm/util/JacksonUtils.java +++ /dev/null @@ -1,49 +0,0 @@ -package sonia.scm.util; - -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.node.ObjectNode; - -import java.util.Iterator; - -public class JacksonUtils { - - private JacksonUtils() { - } - - public static JsonNode merge(JsonNode mainNode, JsonNode updateNode) { - Iterator fieldNames = updateNode.fieldNames(); - - while (fieldNames.hasNext()) { - - String fieldName = fieldNames.next(); - JsonNode jsonNode = mainNode.get(fieldName); - - if (jsonNode != null) { - if (jsonNode.isObject()) { - merge(jsonNode, updateNode.get(fieldName)); - } else if (jsonNode.isArray()) { - for (int i = 0; i < jsonNode.size(); i++) { - merge(jsonNode.get(i), updateNode.get(fieldName).get(i)); - } - } - } else { - if (mainNode instanceof ObjectNode) { - // Overwrite field - JsonNode value = updateNode.get(fieldName); - if (value.isNull()) { - continue; - } - if (value.isIntegralNumber() && value.toString().equals("0")) { - continue; - } - if (value.isFloatingPointNumber() && value.toString().equals("0.0")) { - continue; - } - ((ObjectNode) mainNode).put(fieldName, value); - } - } - } - - return mainNode; - } -} diff --git a/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java index 16e8c974e7..9773b91cf7 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java +++ b/scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java @@ -3,7 +3,9 @@ package sonia.scm.web.i18n; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ObjectNode; import com.github.legman.Subscribe; +import com.google.common.annotations.VisibleForTesting; import com.google.inject.Singleton; import lombok.extern.slf4j.Slf4j; import sonia.scm.NotFoundException; @@ -14,7 +16,6 @@ import sonia.scm.cache.Cache; import sonia.scm.cache.CacheManager; import sonia.scm.filter.WebElement; import sonia.scm.plugin.PluginLoader; -import sonia.scm.util.JacksonUtils; import javax.inject.Inject; import javax.servlet.http.HttpServlet; @@ -24,6 +25,7 @@ import java.io.IOException; import java.io.PrintWriter; import java.net.URL; import java.util.Enumeration; +import java.util.Iterator; import java.util.Optional; import java.util.function.BiConsumer; import java.util.function.Function; @@ -37,9 +39,8 @@ import java.util.function.Function; @Slf4j public class I18nServlet extends HttpServlet { - public static final String PATH = "/locales"; public static final String PLUGINS_JSON = "plugins.json"; - public static final String PATTERN = PATH + "/[a-z\\-A-Z]*/" + PLUGINS_JSON; + public static final String PATTERN = "/locales/[a-z\\-A-Z]*/" + PLUGINS_JSON; public static final String CACHE_NAME = "sonia.cache.plugins.translations"; private final ClassLoader classLoader; @@ -71,6 +72,7 @@ public class I18nServlet extends HttpServlet { )).orElseThrow(NotFoundException::new); } + @VisibleForTesting @Override protected void doGet(HttpServletRequest req, HttpServletResponse response) { try (PrintWriter out = response.getWriter()) { @@ -96,6 +98,7 @@ public class I18nServlet extends HttpServlet { } } + @VisibleForTesting protected boolean isProductionStage() { return SCMContext.getContext().getStage() == Stage.PRODUCTION; } @@ -106,6 +109,7 @@ public class I18nServlet extends HttpServlet { * @param path the searched resource path * @return a collected Json File as JsonNode from the given path from all plugins in the class path */ + @VisibleForTesting protected Optional collectJsonFile(String path) { log.debug("Collect plugin translations from path {} for every plugin", path); JsonNode mergedJsonNode = null; @@ -115,7 +119,7 @@ public class I18nServlet extends HttpServlet { URL url = resources.nextElement(); JsonNode jsonNode = objectMapper.readTree(url); if (mergedJsonNode != null) { - JacksonUtils.merge(mergedJsonNode, jsonNode); + merge(mergedJsonNode, jsonNode); } else { mergedJsonNode = jsonNode; } @@ -126,4 +130,59 @@ public class I18nServlet extends HttpServlet { } return Optional.ofNullable(mergedJsonNode); } + + + /** + * Merge the updateNode into the mainNode and return it. + * + * This is not a deep merge. + * + * @param mainNode the main node + * @param updateNode the update node + * @return the merged mainNode + */ + @VisibleForTesting + protected JsonNode merge(JsonNode mainNode, JsonNode updateNode) { + Iterator fieldNames = updateNode.fieldNames(); + + while (fieldNames.hasNext()) { + + String fieldName = fieldNames.next(); + JsonNode jsonNode = mainNode.get(fieldName); + + if (jsonNode != null) { + mergeNode(updateNode, fieldName, jsonNode); + } else { + mergeField(mainNode, updateNode, fieldName); + } + } + return mainNode; + } + + private void mergeField(JsonNode mainNode, JsonNode updateNode, String fieldName) { + if (mainNode instanceof ObjectNode) { + JsonNode value = updateNode.get(fieldName); + if (value.isNull()) { + return; + } + if (value.isIntegralNumber() && value.toString().equals("0")) { + return; + } + if (value.isFloatingPointNumber() && value.toString().equals("0.0")) { + return; + } + ((ObjectNode) mainNode).set(fieldName, value); + } + } + + private void mergeNode(JsonNode updateNode, String fieldName, JsonNode jsonNode) { + if (jsonNode.isObject()) { + merge(jsonNode, updateNode.get(fieldName)); + } else if (jsonNode.isArray()) { + for (int i = 0; i < jsonNode.size(); i++) { + merge(jsonNode.get(i), updateNode.get(fieldName).get(i)); + } + } + } + } diff --git a/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java index 243a9bd6ed..6f0e0d07d9 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java @@ -23,7 +23,6 @@ import sonia.scm.cache.Cache; import sonia.scm.cache.CacheManager; import sonia.scm.event.ScmEventBus; import sonia.scm.plugin.PluginLoader; -import sonia.scm.util.JacksonUtils; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -205,8 +204,8 @@ public class I18nServletTest { when(classLoader.getResources("locales/de/plugins.json")).thenReturn(resources); ObjectMapper objectMapper = new ObjectMapper(); JsonNode node = objectMapper.readTree(GIT_PLUGIN_JSON); - node = JacksonUtils.merge(node, objectMapper.readTree(HG_PLUGIN_JSON)); - node = JacksonUtils.merge(node, objectMapper.readTree(SVN_PLUGIN_JSON)); + node = servlet.merge(node, objectMapper.readTree(HG_PLUGIN_JSON)); + node = servlet.merge(node, objectMapper.readTree(SVN_PLUGIN_JSON)); when(cache.get(path)).thenReturn(node); servlet.doGet(request, response); From 96faa3cad76d0fbbc61cae5e0f35e1f4064899c1 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 24 Oct 2018 11:15:55 +0200 Subject: [PATCH 7/8] simplify declaration of test data --- .../sonia/scm/web/i18n/I18nServletTest.java | 66 ++++++++++--------- 1 file changed, 36 insertions(+), 30 deletions(-) diff --git a/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java index 6f0e0d07d9..a912f738e2 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java @@ -39,11 +39,7 @@ import java.util.Optional; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.doThrow; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; +import static org.mockito.Mockito.*; @RunWith(MockitoJUnitRunner.Silent.class) @SubjectAware(configuration = "classpath:sonia/scm/shiro-001.ini") @@ -52,31 +48,41 @@ public class I18nServletTest { @Rule public ShiroRule shiro = new ShiroRule(); - private static final String GIT_PLUGIN_JSON = "{\n" + - " \"scm-git-plugin\": {\n" + - " \"information\": {\n" + - " \"clone\" : \"Clone\",\n" + - " \"create\" : \"Create\",\n" + - " \"replace\" : \"Push\"\n" + - " }\n" + - " }\n" + - "}"; - private static final String HG_PLUGIN_JSON = "{\n" + - " \"scm-hg-plugin\": {\n" + - " \"information\": {\n" + - " \"clone\" : \"Clone\",\n" + - " \"create\" : \"Create\",\n" + - " \"replace\" : \"Push\"\n" + - " }\n" + - " }\n" + - "}"; - private static String SVN_PLUGIN_JSON = "{\n" + - " \"scm-svn-plugin\": {\n" + - " \"information\": {\n" + - " \"checkout\" : \"Checkout\"\n" + - " }\n" + - " }\n" + - "}"; + private static final String GIT_PLUGIN_JSON = json( + "{", + "'scm-git-plugin': {", + "'information': {", + "'clone' : 'Clone',", + "'create' : 'Create',", + "'replace' : 'Push'", + "}", + "}", + "}" + ); + private static final String HG_PLUGIN_JSON = json( + "{", + "'scm-hg-plugin': {", + "'information': {", + "'clone' : 'Clone',", + "'create' : 'Create',", + "'replace' : 'Push'", + "}", + "}", + "}" + ); + private static String SVN_PLUGIN_JSON = json( + "{", + "'scm-svn-plugin': {", + "'information': {", + "'checkout' : 'Checkout'", + "}", + "}", + "}" + ); + + private static String json(String... parts) { + return String.join("\n", parts ).replaceAll("'", "\""); + } @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); From 9672d2c2b8f5843a2266a2a550413ae4d83aded2 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 24 Oct 2018 09:22:47 +0000 Subject: [PATCH 8/8] Close branch feature/i18n_for_plugins_v2