Support .xtb translation autodiscovery (#172)

This is the next commit in adding first-class support for xtb files for closure compilation from Java apps and libraries. If the newly added "auto" flag is set, the closure task will find the first .xtb file that matches the desired locale and use that. Future work will merge discovered xtb files, both across dependencies and locales. Co-authored-by: Colin Alworth <[email protected]>
Vertispan · Jun 20, 2022 · 47710a8 · 47710a8
1 parent 487473f
commit 47710a8
Show file tree

Hide file tree

Showing 18 changed files with 357 additions and 28 deletions.
diff --git a/build-caching/src/main/java/com/vertispan/j2cl/build/PropertyTrackingConfig.java b/build-caching/src/main/java/com/vertispan/j2cl/build/PropertyTrackingConfig.java
@@ -141,12 +141,6 @@ public Collection<String> getExterns() {
         return Collections.emptySet();
     }
 
-    @Override
-    public Optional<File> getTranslationsFile() {
-        ConfigValueProvider.ConfigNode node = config.findNode("translationsFile");
-        return Optional.ofNullable(node).map(this::useFileConfig);
-    }
-
     @Override
     public boolean getCheckAssertions() {
         return Boolean.parseBoolean(getString("checkAssertions"));

diff --git a/build-caching/src/main/java/com/vertispan/j2cl/build/task/Config.java b/build-caching/src/main/java/com/vertispan/j2cl/build/task/Config.java
@@ -5,7 +5,6 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 
 public interface Config {
     String getString(String key);
@@ -24,8 +23,6 @@ public interface Config {
 
     Collection<String> getExterns();
 
-    Optional<File> getTranslationsFile();
-
     boolean getCheckAssertions();
 
     boolean getRewritePolyfills();

diff --git a/j2cl-maven-plugin/src/it/translationsfile/pom.xml b/j2cl-maven-plugin/src/it/translationsfile/pom.xml
@@ -15,6 +15,8 @@
     <module>tests/pom_cz_in_resource.xml</module>
     <module>tests/pom_fr_meta_inf.xml</module>
     <module>tests/pom_executions.xml</module>
+    <module>tests/pom_cz_auto.xml</module>
+    <module>tests/pom_de_in_java_package-auto.xml</module>
   </modules>
 
 </project>
diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_cz.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_cz.xml
@@ -71,7 +71,9 @@
           </execution>
         </executions>
         <configuration>
-          <translationsFile>${project.basedir}/MyTranslationBundle_cz.xtb</translationsFile>
+          <translationsFile>
+            <file>${project.basedir}/MyTranslationBundle_cz.xtb</file>
+          </translationsFile>
           <defines>
             <goog.LOCALE>cz</goog.LOCALE>
             <holder.value>Asi se něco stalo!</holder.value>

diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_cz_auto.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_cz_auto.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>translation.test</groupId>
+    <artifactId>cz-auto</artifactId>
+    <packaging>jar</packaging>
+    <version>1.0</version>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.google.jsinterop</groupId>
+            <artifactId>base</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.vertispan.j2cl</groupId>
+            <artifactId>junit-annotations</artifactId>
+            <version>@j2cl.version@</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>com.vertispan.j2cl</groupId>
+            <artifactId>junit-emul</artifactId>
+            <version>@j2cl.version@</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>com.vertispan.j2cl</groupId>
+            <artifactId>junit-emul</artifactId>
+            <version>@j2cl.version@</version>
+            <classifier>sources</classifier>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.6.1</version>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>@project.groupId@</groupId>
+                <artifactId>@project.artifactId@</artifactId>
+                <version>@project.version@</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>build</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>test-js</id>
+                        <goals>
+                            <goal>test</goal>
+                        </goals>
+                        <configuration>
+                            <!-- In order to use htmlunit, we must compile to remove es6 classes -->
+                            <compilationLevel>ADVANCED</compilationLevel>
+                        </configuration>
+                    </execution>
+                </executions>
+                <configuration>
+                    <translationsFile>
+                        <auto>true</auto>
+                    </translationsFile>
+                    <defines>
+                        <goog.LOCALE>cz</goog.LOCALE>
+                        <holder.value>Asi se něco stalo!</holder.value>
+                    </defines>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_cz_in_resource.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_cz_in_resource.xml
@@ -71,7 +71,9 @@
           </execution>
         </executions>
         <configuration>
-          <translationsFile>${project.basedir}/src/main/resources/MyTranslationBundle_cz.xtb</translationsFile>
+          <translationsFile>
+            <file>${project.basedir}/src/main/resources/MyTranslationBundle_cz.xtb</file>
+          </translationsFile>
           <defines>
             <goog.LOCALE>cz</goog.LOCALE>
             <holder.value>Asi se něco stalo!</holder.value>

diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_de_in_java_package-auto.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_de_in_java_package-auto.xml
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>translation.test</groupId>
+  <artifactId>de_in_java_package_auto</artifactId>
+  <packaging>jar</packaging>
+  <version>1.0</version>
+
+  <dependencies>
+
+    <dependency>
+      <groupId>com.google.jsinterop</groupId>
+      <artifactId>base</artifactId>
+      <version>1.0.0</version>
+    </dependency>
+
+    <dependency>
+      <groupId>com.vertispan.j2cl</groupId>
+      <artifactId>junit-annotations</artifactId>
+      <version>@j2cl.version@</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>com.vertispan.j2cl</groupId>
+      <artifactId>junit-emul</artifactId>
+      <version>@j2cl.version@</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>com.vertispan.j2cl</groupId>
+      <artifactId>junit-emul</artifactId>
+      <version>@j2cl.version@</version>
+      <classifier>sources</classifier>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.6.1</version>
+        <configuration>
+          <source>1.8</source>
+          <target>1.8</target>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>@project.groupId@</groupId>
+        <artifactId>@project.artifactId@</artifactId>
+        <version>@project.version@</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>build</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>test-js</id>
+            <goals>
+              <goal>test</goal>
+            </goals>
+            <configuration>
+              <!-- In order to use htmlunit, we must compile to remove es6 classes -->
+              <compilationLevel>ADVANCED</compilationLevel>
+            </configuration>
+          </execution>
+        </executions>
+        <configuration>
+          <translationsFile>
+            <auto>true</auto>
+          </translationsFile>
+          <defines>
+            <goog.LOCALE>de</goog.LOCALE>
+            <holder.value>Ich schätze, es ist etwas passiert!</holder.value>
+          </defines>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_de_in_java_package.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_de_in_java_package.xml
@@ -72,7 +72,9 @@
           </execution>
         </executions>
         <configuration>
-          <translationsFile>${project.basedir}/src/main/java/example/test/MyTranslationBundle_de.xtb</translationsFile>
+          <translationsFile>
+            <file>${project.basedir}/src/main/java/example/test/MyTranslationBundle_de.xtb</file>
+          </translationsFile>
           <defines>
             <goog.LOCALE>de</goog.LOCALE>
             <holder.value>Ich schätze, es ist etwas passiert!</holder.value>

diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_executions.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_executions.xml
@@ -65,7 +65,9 @@
               <goal>test</goal>
             </goals>
             <configuration>
-              <translationsFile>${project.basedir}/MyTranslationBundle_cz.xtb</translationsFile>
+              <translationsFile>
+                <file>${project.basedir}/MyTranslationBundle_cz.xtb</file>
+              </translationsFile>
               <initialScriptFilename>test-js-cz.js</initialScriptFilename>
               <defines>
                 <goog.LOCALE>cz</goog.LOCALE>
@@ -81,7 +83,9 @@
             <configuration>
               <!-- In order to use htmlunit, we must compile to remove es6 classes -->
               <initialScriptFilename>test-js-fr.js</initialScriptFilename>
-              <translationsFile>${project.basedir}/MyTranslationBundle_fr.xtb</translationsFile>
+              <translationsFile>
+                <file>${project.basedir}/MyTranslationBundle_fr.xtb</file>
+              </translationsFile>
               <defines>
                 <goog.LOCALE>cz</goog.LOCALE>
                 <holder.value>Je suppose qu'il s'est passé quelque chose !</holder.value>
@@ -96,7 +100,7 @@
             <configuration>
               <!-- In order to use htmlunit, we must compile to remove es6 classes -->
               <initialScriptFilename>test-js-de_in_java_package.js</initialScriptFilename>
-              <translationsFile>${project.basedir}/src/main/java/example/test/MyTranslationBundle_de.xtb</translationsFile>
+              <translationsFile><file>${project.basedir}/src/main/java/example/test/MyTranslationBundle_de.xtb</file></translationsFile>
               <defines>
                 <goog.LOCALE>de</goog.LOCALE>
                 <holder.value>Ich schätze, es ist etwas passiert!</holder.value>

diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_fr.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_fr.xml
@@ -71,7 +71,9 @@
           </execution>
         </executions>
         <configuration>
-          <translationsFile>${project.basedir}/MyTranslationBundle_fr.xtb</translationsFile>
+          <translationsFile>
+            <file>${project.basedir}/MyTranslationBundle_fr.xtb</file>
+          </translationsFile>
           <defines>
             <goog.LOCALE>cz</goog.LOCALE>
             <holder.value>Je suppose qu'il s'est passé quelque chose !</holder.value>

diff --git a/j2cl-maven-plugin/src/it/translationsfile/tests/pom_fr_meta_inf.xml b/j2cl-maven-plugin/src/it/translationsfile/tests/pom_fr_meta_inf.xml
@@ -71,7 +71,9 @@
           </execution>
         </executions>
         <configuration>
-          <translationsFile>${project.basedir}/src/main/resources/META-INF/MyTranslationBundle_fr.xtb</translationsFile>
+          <translationsFile>
+            <file>${project.basedir}/src/main/resources/META-INF/MyTranslationBundle_fr.xtb</file>
+          </translationsFile>
           <defines>
             <goog.LOCALE>cz</goog.LOCALE>
             <holder.value>Je suppose qu'il s'est passé quelque chose !</holder.value>

diff --git a/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/BuildMojo.java b/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/BuildMojo.java
@@ -13,6 +13,7 @@
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugin.PluginParameterExpressionEvaluator;
 import org.apache.maven.plugin.descriptor.PluginDescriptor;
+import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
@@ -138,7 +139,7 @@ public class BuildMojo extends AbstractBuildMojo {
      * Closure flag: "Source of translated messages. Currently only supports XTB."
      */
     @Parameter
-    protected String translationsFile;
+    protected TranslationsFileConfig translationsFile;
 
     /**
      * Closure flag: "Determines the set of builtin externs to load. Options: BROWSER, CUSTOM. Defaults to BROWSER."

diff --git a/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/TestMojo.java b/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/TestMojo.java
@@ -248,7 +248,7 @@ public class TestMojo extends AbstractBuildMojo {
      * Closure flag: "Source of translated messages. Currently only supports XTB."
      */
     @Parameter
-    protected String translationsFile;
+    protected TranslationsFileConfig translationsFile;
 
     @Override
     public void execute() throws MojoExecutionException, MojoFailureException {

diff --git a/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/TranslationsFileConfig.java b/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/TranslationsFileConfig.java
@@ -0,0 +1,23 @@
+package com.vertispan.j2cl.mojo;
+
+public class TranslationsFileConfig {
+
+    private boolean auto;
+    private String file;
+
+    public boolean isAuto() {
+        return auto;
+    }
+
+    public void setAuto(boolean auto) {
+        this.auto = auto;
+    }
+
+    public String getFile() {
+        return file;
+    }
+
+    public void setFile(String file) {
+        this.file = file;
+    }
+}
diff --git a/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/Xpp3DomConfigValueProvider.java b/j2cl-maven-plugin/src/main/java/com/vertispan/j2cl/mojo/Xpp3DomConfigValueProvider.java
@@ -205,7 +205,13 @@ private Xpp3Dom findNodeWithKey(Xpp3Dom config, String prefix, String remaining)
             if (index == -1) {
                 return null;// failed to find it so far, must not be present
             }
-            return findNodeWithKey(config, prefix.substring(0, index), prefix.substring(index + 1) + '.' + remaining);
+            String nextRemaining;
+            if (remaining.isEmpty()) {
+                nextRemaining = prefix.substring(index + 1);
+            } else {
+                nextRemaining = prefix.substring(index + 1) + '.' + remaining;
+            }
+            return findNodeWithKey(config, prefix.substring(0, index), nextRemaining);
         }
     }
 

diff --git a/j2cl-tasks/src/main/java/com/vertispan/j2cl/build/provided/ClosureTask.java b/j2cl-tasks/src/main/java/com/vertispan/j2cl/build/provided/ClosureTask.java
@@ -27,6 +27,8 @@ public class ClosureTask extends TaskFactory {
     private static final Path PUBLIC = Paths.get("public");
 
     private static final PathMatcher JS_SOURCES = withSuffix(".js");
+
+    private static final PathMatcher XTB = withSuffix(".xtb");
     private static final PathMatcher NATIVE_JS_SOURCES = withSuffix(".native.js");
     private static final PathMatcher EXTERNS_SOURCES = withSuffix(".externs.js");
 
@@ -176,7 +178,17 @@ public Task resolve(Project project, Config config) {
         CompilerOptions.LanguageMode languageOut = CompilerOptions.LanguageMode.fromString(config.getLanguageOut());
         //TODO probably kill this, or at least make it work like an import via another task so we detect changes
         Collection<String> externs = config.getExterns();
-        Optional<File> translationsfile = config.getTranslationsFile();
+
+        TranslationsFileProcessor translationsFileProcessor = TranslationsFileProcessor.get(config);
+        List<Input> xtbInputs = Stream.concat(
+                        Stream.of(project),
+                        scope(project.getDependencies(), Dependency.Scope.RUNTIME).stream()
+                )
+                .map(p -> input(p, OutputTypes.BYTECODE))
+                // Only include the .xtb
+                .map(i -> i.filter(XTB))
+                .collect(Collectors.toList());
+
         boolean checkAssertions = config.getCheckAssertions();
         boolean rewritePolyfills = config.getRewritePolyfills();
         boolean sourcemapsEnabled = config.getSourcemapsEnabled();
@@ -240,7 +252,7 @@ public void execute(TaskContext context) throws Exception {
                         entrypoint,
                         defines,
                         externs,
-                        translationsfile,
+                        translationsFileProcessor.getTranslationsFile(xtbInputs, context.log()),
                         true,//TODO have this be passed in,
                         checkAssertions,
                         rewritePolyfills,