Merge branch 'release/6.0.1'

HISTORY

@@ -1,3 +1,6 @@
+2022-05-19 6.0.1
+  - Fixed race condition on AEM Cloud startup hook (184)
+
 2022-04-22 6.0.0
   - Added startup hook for automatic script execution on AEM Cloud (171)
   - AecuService: added executeWithInstallHookHistory() method (172)

api/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.api</artifactId>

api/src/main/java/de/valtech/aecu/api/groovy/console/bindings/filters/FilterByProperty.java

@@ -51,7 +51,7 @@ public FilterByProperty(@Nonnull String name, Object value) {
     public boolean filter(@Nonnull Resource resource, StringBuilder output) {
         ValueMap properties = resource.getValueMap();
         Object attrValue = properties.get(name);
-        return (value == null) && (attrValue == null) || ((value != null) && value.equals(attrValue));
+        return ((value == null) && (attrValue == null)) || ((value != null) && value.equals(attrValue));
     }
 }
 

complete-cloud/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.complete.cloud</artifactId>

complete/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.complete</artifactId>

core/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.core</artifactId>

core/src/main/java/de/valtech/aecu/core/groovy/console/bindings/actions/multivalue/ReplaceMultiValues.java

@@ -59,8 +59,8 @@ public String doAction(@Nonnull Resource resource) throws PersistenceException {
             }
 
             String warning = (oldValues.length != newValues.length)
-                    ? "WARNING: old values and new values length mismatch (old: " + Arrays.toString(oldValues) + " , new: "
-                            + Arrays.toString(newValues) + ")" + " -> the smaller length will be considered\n"
+                    ? ("WARNING: old values and new values length mismatch (old: " + Arrays.toString(oldValues) + " , new: "
+                            + Arrays.toString(newValues) + ")" + " -> the smaller length will be considered\n")
                     : "";
 
             for (int i = 0; i < oldValues.length && i < newValues.length; i++) {

core/src/main/java/de/valtech/aecu/core/installhook/AecuInstallHook.java

@@ -80,7 +80,7 @@ public AecuInstallHook() {
 
     @Override
     public void execute(InstallContext installContext) throws PackageException {
-        LOG.info("Executing in phase {}", installContext.getPhase());
+        LOG.info("Executing in phase {} for package {}", installContext.getPhase(), installContext.getPackage().getId());
         ServiceReference<AecuService> aecuServiceReference = osgiServiceProvider.getServiceReference(AecuService.class);
         AecuService aecuService = osgiServiceProvider.getService(aecuServiceReference);
 
@@ -92,7 +92,6 @@ public void execute(InstallContext installContext) throws PackageException {
                     installContext.getOptions().setListener(listener);
                     break;
                 case INSTALLED:
-
                     Archive archive = installContext.getPackage().getArchive();
                     List<String> allValidScriptCandidatesInArchive = findCandidates("", archive.getJcrRoot(), aecuService);
                     List<String> scriptsForInstallation =
@@ -118,6 +117,9 @@ public void execute(InstallContext installContext) throws PackageException {
 
     private List<String> getScriptsForExecution(List<String> allValidScriptCandidatesInArchive, InstallContext installContext) {
         List<String> scriptsForExecution = new ArrayList<>();
+        if (listener == null) {
+            return scriptsForExecution;
+        }
         List<String> modifiedOrAddedScriptPaths = listener.getModifiedOrAddedPaths();
         for (String groovyScriptPath : allValidScriptCandidatesInArchive) {
             try {

core/src/main/java/de/valtech/aecu/core/installhook/AecuTrackerListener.java

@@ -67,7 +67,11 @@ public AecuTrackerListener(ProgressTrackerListener originalListener, AecuService
         this.originalListener = originalListener;
         this.aecuService = aecuService;
         this.paths = new HashSet<>();
-        logMessage("Starting install hook...");
+        if (originalListener == null) {
+            logMessage("No progress tracker listener given.");
+        } else {
+            logMessage("Starting install hook...");
+        }
     }
 
     /**
@@ -83,7 +87,9 @@ public List<String> getModifiedOrAddedPaths() {
 
     @Override
     public void onMessage(Mode mode, String action, String path) {
-        originalListener.onMessage(mode, action, path);
+        if (originalListener != null) {
+            originalListener.onMessage(mode, action, path);
+        }
 
         if (StringUtils.length(action) != VALID_ACTION_LENGTH) {
             // skip actions like 'Collecting import information... ', 'Package imported.' etc.
@@ -132,14 +138,21 @@ private boolean isValid(String path) {
 
     @Override
     public void onError(Mode mode, String action, Exception e) {
-        originalListener.onError(mode, action, e);
+        if (originalListener != null) {
+            originalListener.onError(mode, action, e);
+        }
     }
 
     public void logMessage(String message) {
-        onMessage(Mode.TEXT, LOG_PREFIX + message, "");
+        LOG.info(message);
+        if (originalListener != null) {
+            originalListener.onMessage(Mode.TEXT, LOG_PREFIX + message, "");
+        }
     }
 
     public void logError(String message, Exception e) {
+        LOG.error(message, e);
         onError(Mode.TEXT, LOG_PREFIX + message, e);
     }
+
 }

core/src/main/java/de/valtech/aecu/core/service/AecuCloudStartupService.java

@@ -18,20 +18,28 @@
  */
 package de.valtech.aecu.core.service;
 
+import java.util.Collection;
+
 import javax.jcr.Session;
 
 import org.apache.sling.api.resource.LoginException;
 import org.apache.sling.api.resource.ResourceResolver;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.FrameworkUtil;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.runtime.ServiceComponentRuntime;
+import org.osgi.service.component.runtime.dto.ComponentConfigurationDTO;
+import org.osgi.service.component.runtime.dto.ComponentDescriptionDTO;
+import org.osgi.service.component.runtime.dto.SatisfiedReferenceDTO;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.icfolson.aem.groovy.console.api.BindingExtensionProvider;
+
 import de.valtech.aecu.api.service.AecuException;
 import de.valtech.aecu.api.service.AecuService;
-import de.valtech.aecu.core.groovy.console.bindings.provider.AecuBindingExtensionProvider;
-import de.valtech.aecu.core.groovy.console.bindings.provider.AecuStarImportExtensionProvider;
 import de.valtech.aecu.core.serviceuser.ServiceResourceResolverService;
 import de.valtech.aecu.core.util.runtime.RuntimeHelper;
 
@@ -41,29 +49,80 @@
 @Component(service = AecuCloudStartupService.class, immediate = true, name = "AECU cloud startup hook")
 public class AecuCloudStartupService {
 
+    private static final String STAR_IMPORT_EXTENSION_PROVIDER = "StarImportExtensionProvider";
+    private static final String BINDING_EXTENSION_PROVIDER = "BindingExtensionProvider";
+    private static final String DEFAULT_EXTENSION_SERVICE =
+            "com.icfolson.aem.groovy.console.extension.impl.DefaultExtensionService";
+
     private static final Logger LOGGER = LoggerFactory.getLogger(AecuCloudStartupService.class);
 
+    private static final int WAIT_PERIOD = 10;
+    private static final int WAIT_INTERVALS = 30;
+
     @Reference
     private AecuService aecuService;
     @Reference
     private ServiceResourceResolverService resourceResolverService;
-
-    // dependencies to avoid scripts are executed before Groovy extension is loaded
     @Reference
-    private AecuBindingExtensionProvider dependency1;
-    @Reference
-    private AecuStarImportExtensionProvider dependency2;
+    private ServiceComponentRuntime serviceComponentRuntime;
 
     @Activate
-    public void activate() {
+    public void activate() throws InterruptedException {
         ResourceResolver resourceResolver = getResourceResolver();
         Session session = resourceResolver.adaptTo(Session.class);
         boolean isCompositeNodeStore = RuntimeHelper.isCompositeNodeStore(session);
         if (isCompositeNodeStore) {
+            if (!waitForServices()) {
+                LOGGER.error("Groovy extension services seem to be not bound");
+                throw new IllegalStateException("Groovy extension services seem to be not bound");
+            }
+            Thread.sleep(1000L * WAIT_PERIOD);
             startAecuMigration();
         }
     }
 
+    /**
+     * Waits till Groovy Console took up our services.
+     * 
+     * @return services are ok
+     * @throws InterruptedException sleep failed
+     */
+    protected boolean waitForServices() throws InterruptedException {
+        for (int i = 0; i < WAIT_INTERVALS; i++) {
+            if (servicesAreOk()) {
+                return true;
+            }
+            Thread.sleep(1000L * WAIT_PERIOD);
+            LOGGER.debug("Services not yet injected, waiting");
+        }
+        return false;
+    }
+
+    /**
+     * Checks if our services are already injected.
+     */
+    private boolean servicesAreOk() {
+        Bundle bundle = FrameworkUtil.getBundle(BindingExtensionProvider.class);
+        ComponentDescriptionDTO componentDescription =
+                serviceComponentRuntime.getComponentDescriptionDTO(bundle, DEFAULT_EXTENSION_SERVICE);
+        if ((componentDescription == null) || !serviceComponentRuntime.isComponentEnabled(componentDescription)) {
+            return false;
+        }
+        Collection<ComponentConfigurationDTO> componentConfigurations =
+                serviceComponentRuntime.getComponentConfigurationDTOs(componentDescription);
+        int satisfied = 0;
+        for (ComponentConfigurationDTO componentConfiguration : componentConfigurations) {
+            for (SatisfiedReferenceDTO satisfiedReference : componentConfiguration.satisfiedReferences) {
+                if ((BINDING_EXTENSION_PROVIDER.equals(satisfiedReference.name)
+                        || STAR_IMPORT_EXTENSION_PROVIDER.equals(satisfiedReference.name))
+                        && (satisfiedReference.boundServices.length >= 2)) {
+                    satisfied++;
+                }
+            }
+        }
+        return satisfied == 2;
+    }
+
     /**
      * Starts the AECU migration
      */

core/src/test/java/de/valtech/aecu/core/service/AecuCloudStartupServiceTest.java

@@ -18,6 +18,7 @@
  */
 package de.valtech.aecu.core.service;
 
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.doReturn;
@@ -68,6 +69,7 @@ public void setUp() throws Exception {
         when(resolverService.getAdminResourceResolver()).thenReturn(resolver);
         when(resolver.adaptTo(Session.class)).thenReturn(session);
         doReturn(true).when(session).hasPermission(anyString(), anyString());
+        doReturn(true).when(startupService).waitForServices();
     }
 
     @Test
@@ -79,6 +81,14 @@ public void testMigration_compositeNodeStore() throws Exception {
         verify(aecuService, times(1)).executeWithInstallHookHistory(AecuService.AECU_APPS_PATH_PREFIX);
     }
 
+    @Test
+    public void testMigration_compositeNodeStoreButServicesNotOk() throws Exception {
+        doReturn(false).when(session).hasCapability(anyString(), any(), any());
+        doReturn(false).when(startupService).waitForServices();
+
+        assertThrows(IllegalStateException.class, () -> startupService.activate());
+    }
+
     @Test
     public void testMigration_noCompositeNodeStore() throws Exception {
         doReturn(true).when(session).hasCapability(anyString(), any(), any());

examples-cloud/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.examples-cloud</artifactId>

examples/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.examples</artifactId>

oak.index/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.oak.index</artifactId>

pom.xml

@@ -4,7 +4,7 @@
     <groupId>de.valtech.aecu</groupId>
     <artifactId>aecu</artifactId>
     <packaging>pom</packaging>
-    <version>6.0.0</version>
+    <version>6.0.1</version>
     <name>AECU</name>
     <description>AEM Easy Content Upgrade</description>
     <url>https://github.com/valtech/aem-easy-content-upgrade</url>
@@ -694,6 +694,7 @@
                 <groupId>com.google.code.gson</groupId>
                 <artifactId>gson</artifactId>
                 <version>2.8.2</version>
+                <scope>provided</scope>
             </dependency>
             <dependency>
                 <groupId>com.google.code.findbugs</groupId>

sonar-project.properties

@@ -2,7 +2,7 @@
 sonar.projectKey=aecu
 # this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
 sonar.projectName=AEM Easy Content Upgrade
-sonar.projectVersion=5.3.0-SNAPSHOT
+sonar.projectVersion=6.0.1-SNAPSHOT
 
 # Encoding of the source code. Default is default system encoding
 sonar.sourceEncoding=UTF-8

ui.apps.groovyconsole/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.ui.apps.groovyconsole</artifactId>

ui.apps.structure/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.ui.apps.structure</artifactId>

ui.apps/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.ui.apps</artifactId>

ui.content/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>de.valtech.aecu</groupId>
         <artifactId>aecu</artifactId>
-        <version>6.0.0</version>
+        <version>6.0.1</version>
     </parent>
 
     <artifactId>aecu.ui.content</artifactId>