Startup hook should implement SlingRepositoryInitializer to propagate

exceptions properly This closes #545 partially
Netcentric · Jan 26, 2021 · a9a1f23 · a9a1f23
1 parent 46d6457
commit a9a1f23
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 80 deletions.
diff --git a/accesscontroltool-startuphook-bundle/pom.xml b/accesscontroltool-startuphook-bundle/pom.xml
@@ -57,6 +57,12 @@
             <groupId>org.apache.sling</groupId>
             <artifactId>org.apache.sling.settings</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.apache.sling</groupId>
+            <artifactId>org.apache.sling.jcr.api</artifactId>
+            <version>2.4.0</version><!-- required for https://issues.apache.org/jira/browse/SLING-5456, only available in AEM 6.3+ -->
+            <scope>provided</scope>
+       </dependency>
 
         <!-- START: Test Dependencies -->
         <dependency>
@@ -114,7 +120,6 @@ Bundle-DocURL: https://github.com/Netcentric/accesscontroltool
 Bundle-License: Eclipse Public License, Version 1.0; link="https://www.eclipse.org/legal/epl-v10.html"
 Bundle-SymbolicName: biz.netcentric.cq.tools.accesscontroltool.startuphook.bundle
 Bundle-Vendor: Netcentric
-Bundle-Activator: biz.netcentric.cq.tools.actool.startuphook.impl.StartupBundleActivator
 Bundle-Name: ${project.name}
 Conditional-Package: biz.netcentric.cq.tools.actool.helper.runtime
                     ]]></bnd>

diff --git a/...in/java/biz/netcentric/cq/tools/actool/startuphook/impl/AcToolStartupHookServiceImpl.java b/...in/java/biz/netcentric/cq/tools/actool/startuphook/impl/AcToolStartupHookServiceImpl.java
@@ -21,6 +21,7 @@
 import org.apache.jackrabbit.JcrConstants;
 import org.apache.jackrabbit.oak.spi.security.authorization.accesscontrol.AccessControlConstants;
 import org.apache.sling.jcr.api.SlingRepository;
+import org.apache.sling.jcr.api.SlingRepositoryInitializer;
 import org.osgi.framework.BundleContext;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
@@ -33,13 +34,13 @@
 import org.slf4j.LoggerFactory;
 
 import biz.netcentric.cq.tools.actool.api.AcInstallationService;
-import biz.netcentric.cq.tools.actool.helper.Constants;
 import biz.netcentric.cq.tools.actool.helper.runtime.RuntimeHelper;
 import biz.netcentric.cq.tools.actool.history.impl.HistoryUtils;
 
-@Component
+@Component(
+        property = {"service.ranking:Integer=400"}) // must be executed after https://github.com/apache/sling-org-apache-sling-jcr-packageinit/blob/master/src/main/java/org/apache/sling/jcr/packageinit/impl/ExecutionPlanRepoInitializer.java#L53
 @Designate(ocd=AcToolStartupHookServiceImpl.Config.class)
-public class AcToolStartupHookServiceImpl {
+public class AcToolStartupHookServiceImpl implements SlingRepositoryInitializer {
     private static final Logger LOG = LoggerFactory.getLogger(AcToolStartupHookServiceImpl.class);
 
     @ObjectClassDefinition(name = "AC Tool Startup Hook", description = "Applies AC Tool config automatically upon startup (depending on configuration/runtime)")
@@ -55,53 +56,21 @@ public enum StartupHookActivation {
     @Reference(policyOption = ReferencePolicyOption.GREEDY)
     private AcInstallationService acInstallationService;
 
-    @Reference(policyOption = ReferencePolicyOption.GREEDY)
-    private SlingRepository repository;
-
     private boolean isCompositeNodeStore;
+    private Config.StartupHookActivation activationMode;
 
     @Activate
     public void activate(BundleContext bundleContext, Config config) {
-
-        boolean isCloudReady = RuntimeHelper.isCloudReadyInstance();
-        Config.StartupHookActivation activationMode = config.activationMode();
-        LOG.info("AcTool Startup Hook (start level: {}  isCloudReady: {}  activationMode: {})", 
-                RuntimeHelper.getCurrentStartLevel(bundleContext),
-                isCloudReady,
-                activationMode);
-
-        boolean applyOnStartup = (activationMode == Config.StartupHookActivation.ALWAYS) 
-                || (isCloudReady && activationMode == Config.StartupHookActivation.CLOUD_ONLY);
-
-        if(applyOnStartup) {
-
-            try {
-
-                List<String> relevantPathsForInstallation = getRelevantPathsForInstallation();
-                LOG.info("Running AcTool with "
-                        + (relevantPathsForInstallation.isEmpty() ? "all paths" : "paths " + relevantPathsForInstallation) + "...");
-                acInstallationService.apply(null, relevantPathsForInstallation.toArray(new String[relevantPathsForInstallation.size()]),
-                        true);
-                LOG.info("AC Tool Startup Hook done. (start level " + RuntimeHelper.getCurrentStartLevel(bundleContext) + ")");
-
-                copyAcHistoryToOrFromApps(isCloudReady);
-
-            } catch (RepositoryException e) {
-                LOG.error("Exception while triggering AC Tool on startup: " + e, e);
-            }
-        } else {
-            LOG.debug("Skipping AcTool Startup Hook: activationMode: {} isCloudReady: {}", activationMode, isCloudReady);
-        }
-
+        activationMode = config.activationMode();
     }
 
-    private List<String> getRelevantPathsForInstallation() throws RepositoryException {
+    private List<String> getRelevantPathsForInstallation(SlingRepository repository) throws RepositoryException {
         Session session = null;
         try {
             session = repository.loginService(null, null);
 
-            isCompositeNodeStore = RuntimeHelper.isCompositeNodeStore(session);
-            LOG.info("Repo is running with Composite NodeStore: " + isCompositeNodeStore);
+            boolean isCompositeNodeStore = RuntimeHelper.isCompositeNodeStore(session);
+            LOG.info("Repo is running with Composite NodeStore: {}", isCompositeNodeStore);
 
             if(!isCompositeNodeStore) {
                 return Collections.emptyList();
@@ -118,7 +87,7 @@ private List<String> getRelevantPathsForInstallation() throws RepositoryExceptio
                         AccessControlConstants.REP_REPO_POLICY).contains(node.getName())) {
                     continue;
                 }
-                if (isCompositeNodeStore && Arrays.asList("apps", "libs").contains(node.getName())) {
+                if (Arrays.asList("apps", "libs").contains(node.getName())) {
                     continue;
                 }
                 relevantPathsForInstallation.add(node.getPath());
@@ -139,7 +108,7 @@ private List<String> getRelevantPathsForInstallation() throws RepositoryExceptio
         }
     }
 
-    private void copyAcHistoryToOrFromApps(boolean isCloudReady) {
+    private void copyAcHistoryToOrFromApps(SlingRepository repository, boolean isCloudReady) {
 
         if(isCloudReady) {
             Session session = null;
@@ -178,4 +147,28 @@ private void copyAcHistoryToOrFromApps(boolean isCloudReady) {
 
     }
 
+    @Override
+    public void processRepository(SlingRepository repo) throws Exception {
+        boolean isCloudReady = RuntimeHelper.isCloudReadyInstance();
+        LOG.info("AcTool Startup Hook (isCloudReady: {}  activationMode: {})", 
+                isCloudReady,
+                activationMode);
+
+        boolean applyOnStartup = (activationMode == Config.StartupHookActivation.ALWAYS) 
+                || (isCloudReady && activationMode == Config.StartupHookActivation.CLOUD_ONLY);
+
+        if(applyOnStartup) {
+            List<String> relevantPathsForInstallation = getRelevantPathsForInstallation(repo);
+            LOG.info("Running AcTool with "
+                    + (relevantPathsForInstallation.isEmpty() ? "all paths" : "paths " + relevantPathsForInstallation) + "...");
+            acInstallationService.apply(null, relevantPathsForInstallation.toArray(new String[relevantPathsForInstallation.size()]),
+                    true);
+            LOG.info("AC Tool Startup Hook done.");
+
+            copyAcHistoryToOrFromApps(repo, isCloudReady);
+        } else {
+            LOG.debug("Skipping AcTool Startup Hook: activationMode: {} isCloudReady: {}", activationMode, isCloudReady);
+        }
+    }
+
 }
diff --git a/...src/main/java/biz/netcentric/cq/tools/actool/startuphook/impl/StartupBundleActivator.java b/...src/main/java/biz/netcentric/cq/tools/actool/startuphook/impl/StartupBundleActivator.java