Merge pull request #269 from wttech/out-success

Output success

Author: krystian-panek-vmltech

README.md

@@ -371,15 +371,14 @@ void doRun() {
 
 ##### Timestamped console output
 
-Use `out.error()`, `out.warn()`, `out.info()`, `out.debug()`, `out.trace()` to write messages to the console with timestamps and log levels. These messages appear only in the execution console and are not persisted to AEM logs.
+Use `out.error()`, `out.warn()`, `out.success()`, `out.info()`, `out.debug()` to write messages to the console with timestamps and log levels. These messages appear only in the execution console and are not persisted to AEM logs.
 
 ```groovy
 void doRun() {
     out.error "Failed to process resource: ${resource.path}"
     out.warn "Resource ${resource.path} is missing required property"
+    out.success "Resource ${resource.path} processed successfully"
     out.info "Processing started"
-    out.debug "Processing resource: ${resource.path}"
-    out.trace "Entering method with params: ${params}"
 }
 ```
 

core/src/main/java/dev/vml/es/acm/core/code/CodePrintLevel.java

@@ -4,11 +4,11 @@
 import java.util.Optional;
 
 public enum CodePrintLevel {
-    INFO,
+    SUCCESS,
     ERROR,
+    INFO,
     WARN,
-    DEBUG,
-    TRACE;
+    DEBUG;
 
     public static Optional<CodePrintLevel> find(String level) {
         return Arrays.stream(values())

core/src/main/java/dev/vml/es/acm/core/code/CodePrintStream.java

@@ -147,6 +147,10 @@ public void fromLoggers(List<String> loggerNames) {
         loggerNames.forEach(this::fromLogger);
     }
 
+    public void success(String message) {
+        printStamped(CodePrintLevel.SUCCESS, message);
+    }
+
     public void info(String message) {
         printStamped(CodePrintLevel.INFO, message);
     }
@@ -163,10 +167,6 @@ public void debug(String message) {
         printStamped(CodePrintLevel.DEBUG, message);
     }
 
-    public void trace(String message) {
-        printStamped(CodePrintLevel.TRACE, message);
-    }
-
     public void printStamped(String level, String message) {
         printStamped(CodePrintLevel.of(level), message);
     }

core/src/test/java/dev/vml/es/acm/core/code/CodePrintStreamTest.java

@@ -16,9 +16,9 @@ void shouldPrintInfoWithTimestamp() {
         }
 
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        CodePrintStream printStream = new CodePrintStream(outputStream, "test-id");
-
-        printStream.info("Test info message");
+        try (CodePrintStream out = new CodePrintStream(outputStream, "test-id")) {
+            out.info("Test info message");
+        }
 
         String output = outputStream.toString();
         assertTrue(output.matches("\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[INFO\\] Test info message\\R"));
@@ -31,9 +31,9 @@ void shouldPrintErrorWithTimestamp() {
         }
 
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        CodePrintStream printStream = new CodePrintStream(outputStream, "test-id");
-
-        printStream.error("Test error message");
+        try (CodePrintStream out = new CodePrintStream(outputStream, "test-id")) {
+            out.error("Test error message");
+        }
 
         String output = outputStream.toString();
         assertTrue(output.matches("\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[ERROR\\] Test error message\\R"));
@@ -46,42 +46,42 @@ void shouldPrintWarnWithTimestamp() {
         }
 
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        CodePrintStream printStream = new CodePrintStream(outputStream, "test-id");
-
-        printStream.warn("Test warn message");
+        try (CodePrintStream out = new CodePrintStream(outputStream, "test-id")) {
+            out.warn("Test warn message");
+        }
 
         String output = outputStream.toString();
         assertTrue(output.matches("\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[WARN\\] Test warn message\\R"));
     }
 
     @Test
-    void shouldPrintDebugWithTimestamp() {
+    void shouldPrintSuccessWithTimestamp() {
         if (!(LoggerFactory.getILoggerFactory() instanceof LoggerContext)) {
             return;
         }
 
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        CodePrintStream printStream = new CodePrintStream(outputStream, "test-id");
-
-        printStream.debug("Test debug message");
+        try (CodePrintStream out = new CodePrintStream(outputStream, "test-id")) {
+            out.success("Test success message");
+        }
 
         String output = outputStream.toString();
-        assertTrue(output.matches("\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[DEBUG\\] Test debug message\\R"));
+        assertTrue(output.matches("\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[SUCCESS\\] Test success message\\R"));
     }
 
     @Test
-    void shouldPrintTraceWithTimestamp() {
+    void shouldPrintDebugWithTimestamp() {
         if (!(LoggerFactory.getILoggerFactory() instanceof LoggerContext)) {
             return;
         }
 
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        CodePrintStream printStream = new CodePrintStream(outputStream, "test-id");
-
-        printStream.trace("Test trace message");
+        try (CodePrintStream out = new CodePrintStream(outputStream, "test-id")) {
+            out.debug("Test debug message");
+        }
 
         String output = outputStream.toString();
-        assertTrue(output.matches("\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[TRACE\\] Test trace message\\R"));
+        assertTrue(output.matches("\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[DEBUG\\] Test debug message\\R"));
     }
 
     @Test
@@ -91,15 +91,19 @@ void shouldPrintMultipleMessagesWithDifferentLevels() {
         }
 
         ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        CodePrintStream printStream = new CodePrintStream(outputStream, "test-id");
-
-        printStream.info("Info message");
-        printStream.error("Error message");
-        printStream.warn("Warn message");
+        try (CodePrintStream out = new CodePrintStream(outputStream, "test-id")) {
+            out.info("Info message");
+            out.error("Error message");
+            out.warn("Warn message");
+            out.debug("Debug message");
+            out.success("Success message");
+        }
 
         String output = outputStream.toString();
         assertTrue(output.contains("[INFO] Info message"));
         assertTrue(output.contains("[ERROR] Error message"));
         assertTrue(output.contains("[WARN] Warn message"));
+        assertTrue(output.contains("[DEBUG] Debug message"));
+        assertTrue(output.contains("[SUCCESS] Success message"));
     }
 }

ui.content/src/main/content/jcr_root/conf/acm/settings/snippet/available/core/general/demo_processing.yml

@@ -16,7 +16,7 @@ content: |
       out.info "Updated (\${i + 1}/\${max})"
     }
     
-    out.info "Processing done"
+    out.success "Processing done"
   }
 documentation: |
   A skeleton for a script that simulates a processing task.

ui.frontend/src/utils/monaco/log.ts

@@ -17,6 +17,7 @@ export function registerLogLanguage(instance: Monaco) {
       root: [
         [/^(\d{2}:\d{2}:\d{2}\.\d{3} )?\[ERROR\].*$/, 'log-error'],
         [/^(\d{2}:\d{2}:\d{2}\.\d{3} )?\[WARN\].*$/, 'log-warn'],
+        [/^(\d{2}:\d{2}:\d{2}\.\d{3} )?\[SUCCESS\].*$/, 'log-success'],
         [/^(\d{2}:\d{2}:\d{2}\.\d{3} )?\[INFO\].*$/, 'log-info'],
         [/^(\d{2}:\d{2}:\d{2}\.\d{3} )?\[DEBUG\].*$/, 'log-debug'],
         [/^(\d{2}:\d{2}:\d{2}\.\d{3} )?\[TRACE\].*$/, 'log-trace'],
@@ -30,6 +31,7 @@ export function registerLogLanguage(instance: Monaco) {
     rules: [
       { token: 'log-error', foreground: 'f14c4c', fontStyle: 'bold' },
       { token: 'log-warn', foreground: 'e5c07b' },
+      { token: 'log-success', foreground: '89d185', fontStyle: 'bold' },
       { token: 'log-info', foreground: 'ededed' },
       { token: 'log-debug', foreground: '8b949e' },
       { token: 'log-trace', foreground: '6a6a6a' },