Merge pull request #515 from exadel-inc/release-2.5.1

smiakchilo · web-flow · commit bc18e2895aa0 · 2024-02-12T14:15:24.000+03:00
[Tech] Merged release-2.5.1 branch to master
diff --git a/all/pom.xml b/all/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.5.0</version>
+        <version>2.5.1</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-all</artifactId>
@@ -66,13 +66,13 @@
                             <excludeDefaultDirectories>true</excludeDefaultDirectories>
                             <filesets>
                                 <fileset>
-                                    <directory>${basedir}/src/main/content/jcr_root/etc/packages/${project.groupId}/${project.parent.artifactId}</directory>
+                                    <directory>${basedir}/src/main/content/jcr_root/etc/packages/${project.groupId}</directory>
                                     <includes>
                                         <include>**</include>
                                     </includes>
                                     <excludes>
-                                        <exclude>.snapshot</exclude>
-                                        <exclude>.snapshot/.keep</exclude>
+                                        <exclude>${project.parent.artifactId}/.snapshot</exclude>
+                                        <exclude>${project.parent.artifactId}/.snapshot/.keep</exclude>
                                     </excludes>
                                 </fileset>
                             </filesets>
diff --git a/all/src/main/content/META-INF/vault/filter.xml b/all/src/main/content/META-INF/vault/filter.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <workspaceFilter version="1.0">
-    <!-- The following filters clear old directories in JCR. They can be removed after v.2 release -->
-    <filter root="/etc/packages/authoring-toolkit"/>
-    <filter root="/etc/packages/aem-authoring-toolkit"/>
+    <!-- The following filters clear irrelevant directories in JCR -->
+    <filter root="/etc/packages/com.exadel.etoolbox/etoolbox-authoring-kit-plus"/>
 </workspaceFilter>
diff --git a/core/pom.xml b/core/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.5.0</version>
+        <version>2.5.1</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-core</artifactId>
diff --git a/core/src/main/java/com/exadel/aem/toolkit/api/annotations/editconfig/DropTargetConfig.java b/core/src/main/java/com/exadel/aem/toolkit/api/annotations/editconfig/DropTargetConfig.java
@@ -18,6 +18,8 @@
 import java.lang.annotation.Target;
 
 import com.exadel.aem.toolkit.api.annotations.meta.AnnotationRendering;
+import com.exadel.aem.toolkit.api.annotations.meta.ValueRestriction;
+import com.exadel.aem.toolkit.api.annotations.meta.ValueRestrictions;
 
 /**
  * Defines a target for a drag-and-drop operation in Granite UI. Upon processing this annotation, a {@code
@@ -46,11 +48,13 @@
      * Maps to the {@code propertyName} attribute of {@code cq:editConfig/cq:dropTargets/<targetName>} node
      * @return Non-blank string
      */
+    @ValueRestriction(ValueRestrictions.NOT_BLANK)
     String propertyName();
 
     /**
      * Used to specify tag name of the current {@code cq:editConfig/cq:dropTargets} subnode
      * @return Non-blank string
      */
+    @ValueRestriction(ValueRestrictions.NOT_BLANK)
     String nodeName();
 }
diff --git a/docs/content/getting-started/installation.md b/docs/content/getting-started/installation.md
@@ -11,7 +11,7 @@ seoTitle: Installation - Exadel Authoring Kit
 <dependency>
    <groupId>com.exadel.etoolbox</groupId>
    <artifactId>etoolbox-authoring-kit-core</artifactId>
-   <version>2.5.0</version> <!-- Prefer the latest stable version whenever possible -->
+   <version>2.5.1</version> <!-- Prefer the latest stable version whenever possible -->
    <scope>provided</scope> <!-- Do not use compile or runtime scope!-->
 </dependency>
 ```
@@ -21,7 +21,7 @@ seoTitle: Installation - Exadel Authoring Kit
 <plugin>
     <groupId>com.exadel.etoolbox</groupId>
     <artifactId>etoolbox-authoring-kit-plugin</artifactId>
-    <version>2.5.0</version>
+    <version>2.5.1</version>
     <executions>
         <execution>
             <goals>
@@ -32,7 +32,7 @@ seoTitle: Installation - Exadel Authoring Kit
     <configuration>
         <!-- RECOMMENDED: Place here the path to the node under which your component nodes are stored -->
         <componentsPathBase>jcr_root/apps/acme/components</componentsPathBase>
-        <!-- RECOMMENDED: Specify root package for component classes that match the current package -->
+        <!-- RECOMMENDED: Specify root package for component classes that match the current package. Multiple values can be separated with a comma  -->
         <componentsReferenceBase>com.acme.project.components.*</componentsReferenceBase>
         <!-- OPTIONAL: specify list of exceptions that would cause this plugin to terminate -->
         <terminateOn>ALL</terminateOn>
@@ -79,7 +79,7 @@ You need to do two steps.
 <dependency>
     <groupId>com.exadel.etoolbox</groupId>
     <artifactId>etoolbox-authoring-kit-all</artifactId>
-    <version>2.5.0</version>
+    <version>2.5.1</version>
     <type>content-package</type>
 </dependency>
 ```
diff --git a/docs/website/package-lock.json b/docs/website/package-lock.json
diff --git a/it.tests/pom.xml b/it.tests/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.5.0</version>
+        <version>2.5.1</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-it.tests</artifactId>
diff --git a/plugin/pom.xml b/plugin/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.5.0</version>
+        <version>2.5.1</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-plugin</artifactId>
diff --git a/plugin/src/main/java/com/exadel/aem/toolkit/plugin/handlers/editconfig/DropTargetsHandler.java b/plugin/src/main/java/com/exadel/aem/toolkit/plugin/handlers/editconfig/DropTargetsHandler.java
@@ -17,10 +17,14 @@
 import java.util.function.BiConsumer;
 import java.util.stream.Collectors;
 
+import org.apache.commons.lang3.StringUtils;
+
 import com.exadel.aem.toolkit.api.annotations.editconfig.DropTargetConfig;
 import com.exadel.aem.toolkit.api.annotations.editconfig.EditConfig;
 import com.exadel.aem.toolkit.api.handlers.Source;
 import com.exadel.aem.toolkit.api.handlers.Target;
+import com.exadel.aem.toolkit.plugin.exceptions.ValidationException;
+import com.exadel.aem.toolkit.plugin.maven.PluginRuntime;
 import com.exadel.aem.toolkit.plugin.metadata.RenderingFilter;
 import com.exadel.aem.toolkit.plugin.utils.DialogConstants;
 
@@ -31,6 +35,8 @@
  */
 public class DropTargetsHandler implements BiConsumer<Source, Target> {
 
+    private static final String INVALID_NAME_MESSAGE = "Invalid drop target node name";
+
     /**
      * Processes data that can be extracted from the given {@code Source} and stores it into the provided {@code Target}
      * @param source {@code Source} object used for data retrieval
@@ -45,6 +51,9 @@ public void accept(Source source, Target target) {
         Target dropTargetsElement = target.getOrCreateTarget(DialogConstants.NN_DROP_TARGETS);
         for (int i = 0; i < editConfig.dropTargets().length; i++) {
             DropTargetConfig dropTargetConfig = editConfig.dropTargets()[i];
+            if (StringUtils.isBlank(dropTargetConfig.nodeName())) {
+                PluginRuntime.context().getExceptionHandler().handle(new ValidationException(INVALID_NAME_MESSAGE));
+            }
             dropTargetsElement.getOrCreateTarget(dropTargetConfig.nodeName())
                     .attribute(DialogConstants.PN_PRIMARY_TYPE, DialogConstants.NT_DROP_TARGET_CONFIG)
                     .attributes(dropTargetConfig, new RenderingFilter(dropTargetConfig))
diff --git a/plugin/src/main/java/com/exadel/aem/toolkit/plugin/runtime/ReflectionContextHelper.java b/plugin/src/main/java/com/exadel/aem/toolkit/plugin/runtime/ReflectionContextHelper.java
@@ -59,6 +59,7 @@
  */
 public class ReflectionContextHelper {
 
+    private static final char SEPARATOR_COMMA = ',';
     private Reflections reflections;
 
     private ClassLoader classLoader;
@@ -101,9 +102,10 @@ public ClassLoader getClassLoader() {
      * @return A non-null list of {@code ComponentSource} objects; can be empty
      */
     public List<ComponentSource> getComponents(String packageBase) {
+        String[] packageRoots = StringUtils.split(packageBase, SEPARATOR_COMMA);
         return getComponents()
             .stream()
-            .filter(comp -> StringUtils.isEmpty(packageBase) || ClassUtil.matchesReference(comp.adaptTo(Class.class), packageBase))
+            .filter(comp -> StringUtils.isEmpty(packageBase) || ClassUtil.matchesReference(comp.adaptTo(Class.class), packageRoots))
             .collect(Collectors.toList());
     }
 
diff --git a/plugin/src/test/com/exadel/aem/toolkit/plugin/validators/ValidatorsTest.java b/plugin/src/test/com/exadel/aem/toolkit/plugin/validators/ValidatorsTest.java
@@ -128,4 +128,20 @@ public void testDialogTitleMissing() {
             ValidationException.class,
             "Title property is missing for dialog");
     }
+
+    @Test
+    public void testWrongDropTarget() {
+        pluginContext.testThrows(
+            ValidatorTestCases.InvalidDropTargetConfig.class,
+            ValidationException.class,
+            "Invalid drop target");
+    }
+
+    @Test
+    public void testWrongDropTarget2() {
+        pluginContext.testThrows(
+            ValidatorTestCases.InvalidDropTargetConfig2.class,
+            ValidationException.class,
+            "' ' provided");
+    }
 }
diff --git a/plugin/src/test/com/exadel/aem/toolkit/plugin/validators/cases/ValidatorTestCases.java b/plugin/src/test/com/exadel/aem/toolkit/plugin/validators/cases/ValidatorTestCases.java
@@ -16,6 +16,8 @@
 import static com.exadel.aem.toolkit.plugin.maven.TestConstants.DEFAULT_COMPONENT_NAME;
 import static com.exadel.aem.toolkit.plugin.maven.TestConstants.DEFAULT_COMPONENT_TITLE;
 
+import com.exadel.aem.toolkit.api.annotations.editconfig.DropTargetConfig;
+import com.exadel.aem.toolkit.api.annotations.editconfig.EditConfig;
 import com.exadel.aem.toolkit.api.annotations.main.AemComponent;
 import com.exadel.aem.toolkit.api.annotations.main.Dialog;
 import com.exadel.aem.toolkit.api.annotations.main.HtmlTag;
@@ -114,4 +116,22 @@ public static class ComponentWithWrongHtmlTag1 {}
     @Dialog
     @HtmlTag(className = " ")
     public static class ComponentWithWrongHtmlTag2 {}
+
+    @AemComponent(path = DEFAULT_COMPONENT_NAME, title = DEFAULT_COMPONENT_TITLE)
+    @EditConfig(
+        dropTargets = @DropTargetConfig(
+            nodeName = " ",
+            accept = {"image/*"},
+            groups = {"media"},
+            propertyName = ""))
+    public static class InvalidDropTargetConfig {}
+
+    @AemComponent(path = DEFAULT_COMPONENT_NAME, title = DEFAULT_COMPONENT_TITLE)
+    @EditConfig(
+        dropTargets = @DropTargetConfig(
+            nodeName = "image",
+            accept = {"image/*"},
+            groups = {"media"},
+            propertyName = " "))
+    public static class InvalidDropTargetConfig2 {}
 }
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>com.exadel.etoolbox</groupId>
     <artifactId>etoolbox-authoring-kit</artifactId>
-    <version>2.5.0</version>
+    <version>2.5.1</version>
 
     <name>Exadel Toolbox Authoring Kit</name>
     <description>Automates generating and managing rich and responsive authoring interfaces for Adobe Experience Manager</description>
diff --git a/ui.apps/package-lock.json b/ui.apps/package-lock.json
diff --git a/ui.apps/package.json b/ui.apps/package.json
@@ -1,7 +1,7 @@
 {
   "name": "depends-on",
   "description": "A clientlib that executes defined action on dependent fields",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "private": true,
   "devDependencies": {
     "eslint": "^8.45.0",
diff --git a/ui.apps/pom.xml b/ui.apps/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.5.0</version>
+        <version>2.5.1</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-ui.apps</artifactId>
diff --git a/ui.apps/src/main/content/META-INF/vault/filter.xml b/ui.apps/src/main/content/META-INF/vault/filter.xml
@@ -7,8 +7,4 @@
         <exclude pattern="/apps/etoolbox-authoring-kit/fixes(/.*)?"/>
         <exclude pattern="/apps/etoolbox-authoring-kit/samples(/.*)?"/>
     </filter>
-
-    <!-- The following filters clear old directories in JCR content. They can be removed after v.2 release -->
-    <filter root="/apps/authoring-toolkit"/>
-    <filter root="/apps/cq/core/content/nav/tools/aembox/lists"/>
 </workspaceFilter>
diff --git a/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/config/.content.xml b/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/config/.content.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
+    jcr:primaryType="sling:Folder"/>
diff --git a/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/config/org.apache.sling.commons.log.LogManager.factory.config-eak.xml b/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/config/org.apache.sling.commons.log.LogManager.factory.config-eak.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0"
+    xmlns:jcr="http://www.jcp.org/jcr/1.0" jcr:primaryType="sling:OsgiConfig"
+    org.apache.sling.commons.log.file="logs/eak.log"
+    org.apache.sling.commons.log.level="info"
+    org.apache.sling.commons.log.names="[com.exadel.aem.toolkit]"
+    org.apache.sling.commons.log.pattern="\{0,date,yyyy-MM-dd HH:mm:ss.SSS} {4} [{3}] {5}" />
diff --git a/ui.content/pom.xml b/ui.content/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.5.0</version>
+        <version>2.5.1</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-ui.content</artifactId>
diff --git a/ui.content/src/main/content/META-INF/vault/filter.xml b/ui.content/src/main/content/META-INF/vault/filter.xml
@@ -1,7 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <workspaceFilter version="1.0">
     <filter root="/conf/etoolbox-authoring-kit"/>
-
-    <!-- The following filter clears an old directory in JCR content. This can be removed after v.2 release -->
-    <filter root="/conf/authoring-toolkit"/>
 </workspaceFilter>
