Skip to content

Commit

Permalink
Merge pull request #619 from Netcentric/feature/618-Allow-startup-hoo…
Browse files Browse the repository at this point in the history 
…k-to-run-async-for-mutable-content

#618 Allow startup hook to run asynchronously for mutable content
  • Loading branch information
@ghenzler
ghenzler authored Nov 18, 2021
2 parents d94ef15 + f6f8124 commit 42b2eaa
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 22 deletions.
1 change: 1 addition & 0 deletions ...l-bundle/src/main/java/biz/netcentric/cq/tools/actool/impl/AcInstallationServiceImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ public void installConfigurationFiles(PersistableInstallationLogger installLog,
sw.stop();
long executionTime = sw.getTime();
installLog.setExecutionTime(executionTime);
installLog.addVerboseMessage(LOG, "Finished at bundle start level " + RuntimeHelper.getCurrentStartLevel());
installLog.addMessage(LOG, "Successfully applied AC Tool configuration in " + msHumanReadable(executionTime));
} catch (Exception e) {
installLog.addError("Could not process yaml files", e); // ensure exception is added to installLog before it's persisted in log in finally clause
Expand Down
73 changes: 51 additions & 22 deletions ...in/java/biz/netcentric/cq/tools/actool/startuphook/impl/AcToolStartupHookServiceImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
public class AcToolStartupHookServiceImpl {
private static final Logger LOG = LoggerFactory.getLogger(AcToolStartupHookServiceImpl.class);

private static final String THREAD_NAME_ASYNC = "actool-async";

@ObjectClassDefinition(name = "AC Tool Startup Hook", description = "Applies AC Tool config automatically upon startup (depending on configuration/runtime)")
public static @interface Config {
public enum StartupHookActivation {
Expand All @@ -49,8 +51,11 @@ public enum StartupHookActivation {

@AttributeDefinition(name = "Activation Mode", description = "Apply on startup - CLOUD_ONLY autodetects the cloud (by missing OSGi installer bundle) and only runs on startup if deployed in the cloud. ALWAYS can be useful for local testing. NEVER disables AC Tool runs on startup entirely.")
StartupHookActivation activationMode() default StartupHookActivation.CLOUD_ONLY;

@AttributeDefinition(name = "Async for Mutable Content", description = "Will execute on the mutable content asynchronously using a Sling Job")
boolean runAsyncForMutableConent() default false;
}

@Reference(policyOption = ReferencePolicyOption.GREEDY)
private AcInstallationService acInstallationService;

Expand All @@ -64,43 +69,65 @@ 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),
boolean runAsyncForMutableConent = config.runAsyncForMutableConent();
int currentStartLevel = RuntimeHelper.getCurrentStartLevel(bundleContext);
LOG.info("AcTool Startup Hook (start level: {} isCloudReady: {} activationMode: {} runAsyncForMutableConent: {})",
currentStartLevel,
isCloudReady,
activationMode);
activationMode,
runAsyncForMutableConent);

boolean applyOnStartup = (activationMode == Config.StartupHookActivation.ALWAYS)
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);
if (applyOnStartup) {

} catch (RepositoryException e) {
LOG.error("Exception while triggering AC Tool on startup: " + e, e);
List<String> relevantPathsForInstallation = getRelevantPathsForInstallation();
LOG.info("Running AcTool with "
+ (relevantPathsForInstallation.isEmpty() ? "all paths" : "paths " + relevantPathsForInstallation) + "...");

if (runAsyncForMutableConent && isCompositeNodeStore) {
LOG.info(
"Running AcTool asynchronously on mutable content of composite node store (config runAsyncForMutableConent=true)...");
runAcToolAsync(relevantPathsForInstallation, currentStartLevel, isCloudReady);
} else {
runAcTool(relevantPathsForInstallation, currentStartLevel, isCloudReady);
}

} else {
LOG.debug("Skipping AcTool Startup Hook: activationMode: {} isCloudReady: {}", activationMode, isCloudReady);
}

}

private List<String> getRelevantPathsForInstallation() throws RepositoryException {
private void runAcTool(List<String> relevantPathsForInstallation, int currentStartLevel, boolean isCloudReady) {

acInstallationService.apply(null, relevantPathsForInstallation.toArray(new String[relevantPathsForInstallation.size()]),
true);
LOG.info("AC Tool Startup Hook done. (start level {})", currentStartLevel);

copyAcHistoryToOrFromApps(isCloudReady);

}

private void runAcToolAsync(final List<String> relevantPathsForInstallation, final int currentStartLevel, final boolean isCloudReady) {

final AcToolStartupHookServiceImpl startupHook = this;
new Thread(new Runnable() {
@Override
public void run() {
startupHook.runAcTool(relevantPathsForInstallation, currentStartLevel, isCloudReady);
}
}, THREAD_NAME_ASYNC).start();
}

private List<String> getRelevantPathsForInstallation() {
Session session = null;
try {
session = repository.loginService(null, null);

isCompositeNodeStore = RuntimeHelper.isCompositeNodeStore(session);
LOG.info("Repo is running with Composite NodeStore: " + isCompositeNodeStore);
LOG.info("Repo is running with Composite NodeStore: {}", isCompositeNodeStore);

if(!isCompositeNodeStore) {
return Collections.emptyList();
Expand Down Expand Up @@ -131,6 +158,8 @@ private List<String> getRelevantPathsForInstallation() throws RepositoryExceptio

return relevantPathsForInstallation;

} catch (RepositoryException e) {
throw new IllegalStateException("Could not retrieve relevant base paths for AC Tool installation: " + e, e);
} finally {
if (session != null) {
session.logout();
Expand All @@ -152,7 +181,7 @@ private void copyAcHistoryToOrFromApps(boolean isCloudReady) {
NodeIterator nodesInAppsIt = session.getNode(HistoryUtils.AC_HISTORY_PATH_IN_APPS).getNodes();
while(nodesInAppsIt.hasNext()) {
Node historyNodeInApps = nodesInAppsIt.nextNode();
String historyNodeInVarPath = HistoryUtils.ACHISTORY_PATH + "/"+ historyNodeInApps.getName();
String historyNodeInVarPath = HistoryUtils.ACHISTORY_PATH + "/" + historyNodeInApps.getName();
if(!session.nodeExists(historyNodeInVarPath)) {
LOG.info(" restoring history node {} to {}", historyNodeInApps.getPath(), historyNodeInVarPath);
session.getWorkspace().copy(historyNodeInApps.getPath(), historyNodeInVarPath);
Expand Down

0 comments on commit 42b2eaa

Please sign in to comment.