Merge pull request #205 from wttech/executor-session-isolation

krystian-panek-vmltech · web-flow · commit 86d78d640e58 · 2025-09-17T10:43:05.000+02:00
Executor session isolation
diff --git a/core/src/main/java/dev/vml/es/acm/core/code/Executor.java b/core/src/main/java/dev/vml/es/acm/core/code/Executor.java
@@ -17,6 +17,8 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.function.Consumer;
+import java.util.function.Function;
 import java.util.regex.Pattern;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.api.resource.LoginException;
@@ -92,7 +94,7 @@ public class Executor {
     }
 
     @Reference
-    private ResourceResolverFactory resourceResolverFactory;
+    private ResourceResolverFactory resolverFactory;
 
     @Reference
     private OsgiContext osgiContext;
@@ -120,10 +122,9 @@ public ExecutionContext createContext(
     }
 
     public Execution execute(Executable executable, ExecutionContextOptions contextOptions) throws AcmException {
-        try (ResourceResolver resourceResolver =
-                        ResolverUtils.contentResolver(resourceResolverFactory, contextOptions.getUserId());
+        try (ResourceResolver resolver = ResolverUtils.contentResolver(resolverFactory, contextOptions.getUserId());
                 ExecutionContext executionContext = createContext(
-                        ExecutionId.generate(), contextOptions.getExecutionMode(), executable, resourceResolver)) {
+                        ExecutionId.generate(), contextOptions.getExecutionMode(), executable, resolver)) {
             return execute(executionContext);
         } catch (LoginException e) {
             throw new AcmException(
@@ -166,15 +167,13 @@ private ImmediateExecution executeImmediately(ExecutionContext context) {
                 return execution.end(ExecutionStatus.SUCCEEDED);
             }
 
-            Locker locker = context.getCodeContext().getLocker();
             String lockName = executableLockName(context);
-
-            if (locker.isLocked(lockName)) {
+            if (queryLocker(resolverFactory, l -> l.isLocked(lockName))) {
                 return execution.end(ExecutionStatus.SKIPPED);
             }
 
             try {
-                locker.lock(lockName);
+                useLocker(resolverFactory, l -> l.lock(lockName));
                 statuses.put(context.getId(), ExecutionStatus.RUNNING);
                 if (config.logPrintingEnabled()) {
                     context.getOut().fromSelfLogger();
@@ -184,7 +183,7 @@ private ImmediateExecution executeImmediately(ExecutionContext context) {
                 contentScript.run();
                 return execution.end(ExecutionStatus.SUCCEEDED);
             } finally {
-                locker.unlock(lockName);
+                useLocker(resolverFactory, l -> l.unlock(lockName));
             }
         } catch (Throwable e) {
             execution.error(e);
@@ -209,9 +208,7 @@ public Optional<ExecutionStatus> checkStatus(String executionId) {
 
     private void handleHistory(ExecutionContext context, ImmediateExecution execution) {
         if (context.isHistory() && (context.isDebug() || (execution.getStatus() != ExecutionStatus.SKIPPED))) {
-            ExecutionHistory history =
-                    new ExecutionHistory(context.getCodeContext().getResourceResolver());
-            history.save(context, execution);
+            useHistory(resolverFactory, h -> h.save(context, execution));
         }
     }
 
@@ -299,6 +296,10 @@ public ScheduleResult schedule(ExecutionContext context) {
         }
     }
 
+    public void reset() {
+        useLocker(resolverFactory, l -> l.unlockAll());
+    }
+
     public boolean isDebug() {
         return config.debug();
     }
@@ -310,4 +311,16 @@ public boolean isHistory() {
     public boolean isLocked(ExecutionContext context) {
         return context.getCodeContext().getLocker().isLocked(executableLockName(context));
     }
+
+    private <T> T queryLocker(ResourceResolverFactory resolverFactory, Function<Locker, T> consumer) {
+        return ResolverUtils.queryContentResolver(resolverFactory, null, r -> consumer.apply(new Locker(r)));
+    }
+
+    private void useLocker(ResourceResolverFactory resolverFactory, Consumer<Locker> consumer) {
+        ResolverUtils.useContentResolver(resolverFactory, null, r -> consumer.accept(new Locker(r)));
+    }
+
+    private void useHistory(ResourceResolverFactory resolverFactory, Consumer<ExecutionHistory> consumer) {
+        ResolverUtils.useContentResolver(resolverFactory, null, r -> consumer.accept(new ExecutionHistory(r)));
+    }
 }
diff --git a/core/src/main/java/dev/vml/es/acm/core/code/FileManager.java b/core/src/main/java/dev/vml/es/acm/core/code/FileManager.java
@@ -72,8 +72,8 @@ private void validatePath(File targetFile) {
             String rootCanonical = rootDir.getCanonicalPath();
             String targetCanonical = targetFile.getCanonicalPath();
             if (!targetCanonical.startsWith(rootCanonical + File.separator) && !targetCanonical.equals(rootCanonical)) {
-                throw new AcmException(
-                        String.format("File path '%s' must be within the root directory '%s'!", targetFile.getPath(), rootCanonical));
+                throw new AcmException(String.format(
+                        "File path '%s' must be within the root directory '%s'!", targetFile.getPath(), rootCanonical));
             }
         } catch (IOException e) {
             throw new AcmException(String.format("File path resolution error '%s'!", targetFile.getPath()), e);
diff --git a/core/src/main/java/dev/vml/es/acm/core/code/Locker.java b/core/src/main/java/dev/vml/es/acm/core/code/Locker.java
@@ -88,6 +88,20 @@ public void unlock(String lockName) {
         }
     }
 
+    public void unlockAll() {
+        Resource root = resolver.getResource(ROOT);
+        if (root == null) {
+            return;
+        }
+        try {
+            resolver.delete(root);
+            resolver.commit();
+            LOG.debug("Deleted all locks");
+        } catch (PersistenceException e) {
+            throw new AcmException("Cannot delete all locks!", e);
+        }
+    }
+
     private Resource getLock(String lockName) {
         String name = normalizeName(lockName);
         if (StringUtils.isBlank(name)) {
diff --git a/core/src/main/java/dev/vml/es/acm/core/event/EventDispatcher.java b/core/src/main/java/dev/vml/es/acm/core/event/EventDispatcher.java
@@ -2,6 +2,7 @@
 
 import dev.vml.es.acm.core.code.ExecutionHistory;
 import dev.vml.es.acm.core.code.ExecutionQueue;
+import dev.vml.es.acm.core.code.Executor;
 import dev.vml.es.acm.core.util.ResolverUtils;
 import java.util.Collections;
 import org.apache.sling.api.resource.LoginException;
@@ -25,6 +26,9 @@ public class EventDispatcher implements EventListener {
     @Reference
     private ExecutionQueue executionQueue;
 
+    @Reference
+    private Executor executor;
+
     @Reference
     private ResourceResolverFactory resourceResolverFactory;
 
@@ -39,8 +43,9 @@ public void onEvent(Event event) {
             return;
         }
         switch (eventType) {
-            case EXECUTION_QUEUE_RESET:
+            case EXECUTOR_RESET:
                 executionQueue.reset();
+                executor.reset();
                 break;
             case HISTORY_CLEAR:
                 doHistoryClear();
diff --git a/core/src/main/java/dev/vml/es/acm/core/event/EventType.java b/core/src/main/java/dev/vml/es/acm/core/event/EventType.java
@@ -4,7 +4,7 @@
 import java.util.Optional;
 
 public enum EventType {
-    EXECUTION_QUEUE_RESET,
+    EXECUTOR_RESET,
     HISTORY_CLEAR;
 
     public static Optional<EventType> of(String name) {
diff --git a/core/src/main/java/dev/vml/es/acm/core/instance/HealthChecker.java b/core/src/main/java/dev/vml/es/acm/core/instance/HealthChecker.java
@@ -268,6 +268,9 @@ private void checkCodeExecutor(List<HealthIssue> issues, ResourceResolver resour
                 ExecutionId.generate(), ExecutionMode.RUN, Code.consoleMinimal(), resourceResolver)) {
             context.setHistory(false);
             Execution execution = executor.execute(context);
+            if (execution.getStatus() == ExecutionStatus.SKIPPED) {
+                return; // do not check when locked
+            }
             if (execution.getStatus() != ExecutionStatus.SUCCEEDED) {
                 issues.add(new HealthIssue(
                         HealthIssueSeverity.CRITICAL,
diff --git a/core/src/main/java/dev/vml/es/acm/core/util/ResolverUtils.java b/core/src/main/java/dev/vml/es/acm/core/util/ResolverUtils.java
@@ -4,6 +4,8 @@
 import dev.vml.es.acm.core.repo.RepoException;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.function.Consumer;
+import java.util.function.Function;
 import javax.jcr.*;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.api.resource.*;
@@ -35,6 +37,25 @@ public static ResourceResolver contentResolver(
         return serviceResolver(resourceResolverFactory, Subservice.CONTENT, userImpersonationId);
     }
 
+    public static <T> T queryContentResolver(
+            ResourceResolverFactory resolverFactory,
+            String userImpersonationId,
+            Function<ResourceResolver, T> consumer) {
+        try (ResourceResolver resourceResolver = ResolverUtils.contentResolver(resolverFactory, userImpersonationId)) {
+            return consumer.apply(resourceResolver);
+        } catch (LoginException e) {
+            throw new RepoException("Cannot access repository while using content resolver!", e);
+        }
+    }
+
+    public static void useContentResolver(
+            ResourceResolverFactory resolverFactory, String userImpersonationId, Consumer<ResourceResolver> consumer) {
+        queryContentResolver(resolverFactory, userImpersonationId, r -> {
+            consumer.accept(r);
+            return null;
+        });
+    }
+
     public static ResourceResolver mockResolver(ResourceResolverFactory resourceResolverFactory) throws LoginException {
         return serviceResolver(resourceResolverFactory, Subservice.MOCK, null);
     }
diff --git a/core/src/main/java/dev/vml/es/acm/core/util/StringUtil.java b/core/src/main/java/dev/vml/es/acm/core/util/StringUtil.java
@@ -33,29 +33,27 @@ private static String truncateCode(String code, int maxLength, boolean skipStart
         }
         String humanSize = FileUtils.byteCountToDisplaySize(code.length());
         String text = StringUtils.trimToEmpty(code);
+
+        int totalLines = text.isEmpty() ? 0 : text.split("\r?\n").length;
+        String lineWord = totalLines == 1 ? "line" : "lines";
+
         if (maxLength < 0 || text.length() <= maxLength) {
-            return String.format("%s\n```\n%s\n```", humanSize, text);
+            String msg = String.format("%s, %d %s", humanSize, totalLines, lineWord);
+            return String.format("%s\n```\n%s\n```", msg, text);
         }
-        int skippedChars = text.length() - maxLength;
-        String remaining;
-        int skippedLines;
 
+        String remaining;
+        String rangeInfo;
         if (skipStart) {
+            int skippedChars = text.length() - maxLength;
             remaining = text.substring(skippedChars);
-            String skippedPart = text.substring(0, skippedChars);
-            skippedLines = skippedPart.isEmpty() ? 0 : skippedPart.split("\r?\n").length;
+            rangeInfo = String.format("last %d chars", maxLength);
         } else {
             remaining = text.substring(0, maxLength);
-            String skippedPart = text.substring(maxLength);
-            skippedLines = skippedPart.isEmpty() ? 0 : skippedPart.split("\r?\n").length;
-        }
-        String lineWord = skippedLines == 1 ? "line" : "lines";
-        String msg;
-        if (skippedLines > 0) {
-            msg = String.format("%s, %d %s skipped", humanSize, skippedLines, lineWord);
-        } else {
-            msg = humanSize;
+            rangeInfo = String.format("first %d chars", maxLength);
         }
+
+        String msg = String.format("%s, %d %s (%s)", humanSize, totalLines, lineWord, rangeInfo);
         return String.format("%s\n```\n%s\n```", msg, remaining);
     }
 
diff --git a/test/project/setup.sh b/test/project/setup.sh
@@ -35,7 +35,8 @@ print_error() {
   echo >&2
 }
 
-package_append_to_all() {
+# https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/developing/aem-project-content-package-structure
+add_vendor_package() {
   local groupId="$1"
   local artifactId="$2"
   local version="$3"
@@ -52,7 +53,7 @@ package_append_to_all() {
         <groupId>${groupId}</groupId>
         <artifactId>${artifactId}</artifactId>
         <type>${type}</type>
-        <target>/apps/${PROJECT_NAME}-packages/application/install</target>
+        <target>/apps/vendor-packages/container/install</target>
       </embedded>"
   local all_pom="all/pom.xml"
 
@@ -110,8 +111,8 @@ git commit -m "AEM Compose setup"
 
 print_step "Setting up ACM in the project"
 
-package_append_to_all "dev.vml.es" "acm.all" "$ACM_VERSION" "zip"
-package_append_to_all "dev.vml.es" "acm.ui.content.example" "$ACM_VERSION" "zip"
+add_vendor_package "dev.vml.es" "acm.all" "$ACM_VERSION" "zip"
+add_vendor_package "dev.vml.es" "acm.ui.content.example" "$ACM_VERSION" "zip"
 
 git add -A
 git commit -m "ACM packages added to all/pom.xml"
diff --git a/ui.config/src/main/content/jcr_root/apps/acm-config/osgiconfig/config/org.apache.sling.jcr.repoinit.RepositoryInitializer~acmcore.config b/ui.config/src/main/content/jcr_root/apps/acm-config/osgiconfig/config/org.apache.sling.jcr.repoinit.RepositoryInitializer~acmcore.config
@@ -19,6 +19,9 @@ scripts=["
         allow jcr:read on /conf
     end
 
+    create path /apps/acm(sling:Folder)
+    create path /apps/cq/core/content/nav/tools/acm(sling:Folder)
+
     set ACL for everyone
         deny jcr:read on /apps/acm
         deny jcr:read on /apps/cq/core/content/nav/tools/acm
diff --git a/ui.frontend/src/components/ExecutionHistoryClearButton.tsx b/ui.frontend/src/components/ExecutionHistoryClearButton.tsx
@@ -6,7 +6,7 @@ import DataRemove from '@spectrum-icons/workflow/DataRemove';
 import Flashlight from '@spectrum-icons/workflow/Flashlight';
 import React, { useState } from 'react';
 import { toastRequest } from '../utils/api';
-import { QueueOutput } from '../utils/api.types.ts';
+import { EventType, QueueOutput } from '../utils/api.types.ts';
 
 type ExecutionHistoryClearButtonProps = {
   onClear?: () => void;
@@ -21,7 +21,7 @@ const ExecutionHistoryClearButton: React.FC<ExecutionHistoryClearButtonProps> =
     try {
       await toastRequest<QueueOutput>({
         method: 'POST',
-        url: `/apps/acm/api/event.json?name=history_clear`,
+        url: `/apps/acm/api/event.json?name=${EventType.HISTORY_CLEAR}`,
         operation: 'Clear execution history',
       });
       if (onClear) onClear();
diff --git a/ui.frontend/src/components/ExecutionsResetButton.tsx b/ui.frontend/src/components/ExecutionsResetButton.tsx
@@ -5,7 +5,7 @@ import Checkmark from '@spectrum-icons/workflow/Checkmark';
 import GearsDelete from '@spectrum-icons/workflow/GearsDelete';
 import React, { useState } from 'react';
 import { toastRequest } from '../utils/api';
-import { QueueOutput } from '../utils/api.types.ts';
+import { EventType, QueueOutput } from '../utils/api.types.ts';
 
 type ExecutionsResetButtonProps = {
   onReset?: () => void;
@@ -20,7 +20,7 @@ const ExecutionsResetButton: React.FC<ExecutionsResetButtonProps> = ({ onReset }
     try {
       await toastRequest<QueueOutput>({
         method: 'POST',
-        url: `/apps/acm/api/event.json?name=execution_queue_reset`,
+        url: `/apps/acm/api/event.json?name=${EventType.EXECUTOR_RESET}`,
         operation: 'Reset executions',
       });
       if (onReset) onReset();
@@ -41,7 +41,7 @@ const ExecutionsResetButton: React.FC<ExecutionsResetButtonProps> = ({ onReset }
       <Content>
         <Text>
           <p>
-            Are you sure you want to reset the executor? This action will <strong>affect all instances</strong>, immediately stop any ongoing executions, and clear all jobs from the Sling queue.
+            Are you sure you want to reset the executor? This action will <strong>affect all instances</strong>, immediately stop any ongoing executions, clear all jobs from the Sling queue, and clear repository locks.
             <br />
           </p>
           <p>
diff --git a/ui.frontend/src/utils/api.types.ts b/ui.frontend/src/utils/api.types.ts
@@ -436,3 +436,8 @@ export enum JCR_CONSTANTS {
 export type FileOutput = {
   files: string[];
 };
+
+export enum EventType {
+  EXECUTOR_RESET = 'executor_reset',
+  HISTORY_CLEAR = 'history_clear',
+}
