updated html logger

- now saves variables to separate independent html
- now does not need screenshot folder path

Author: Bot-Dev-RPA

build.gradle

@@ -25,7 +25,7 @@ configure(allprojects){
 		testNgVersion = '6.14.3'
 		loggerVersion = '2.20.0'
 		jnaVersion = '5.3.1'
-		version '3.0.7'
+		version '3.1.0'
 	}
 	group "$groupName"
 

src/main/java/com/automationanywhere/botcommand/actions/config/CSVReader.java

@@ -13,12 +13,7 @@
 import org.apache.commons.csv.CSVParser;
 import org.apache.commons.csv.CSVRecord;
 
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.Reader;
+import java.io.*;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.LinkedHashMap;
@@ -166,7 +161,9 @@ public DictionaryValue action(
 
             // Process CSV records
             for (CSVRecord csvRecord : csvParser) {
-                if (csvRecord.size() == 0) continue;
+                if (csvRecord.size() == 0) {
+                    continue;
+                }
 
                 String key = null;
                 String value = null;

src/main/java/com/automationanywhere/botcommand/actions/config/ExcelReader.java

@@ -167,7 +167,9 @@ public DictionaryValue action(
             // Process rows
             boolean headerSkipped = false;
             for (Row row : sheet) {
-                if (row == null) continue;
+                if (row == null) {
+                    continue;
+                }
 
                 // Skip header row if using column headers
                 if (!headerSkipped && hasHeader) {

src/main/java/com/automationanywhere/botcommand/actions/logs/LogMessage.java

@@ -163,6 +163,11 @@ public void action(
             message.put(CustomHTMLLayout.Columns.VARIABLES, variableValues);
             message.put(CustomHTMLLayout.Columns.SOURCE, getFormattedBotUri());
 
+            // Add variables folder path if variables are being logged
+            if (variableValues != null && !variableValues.isEmpty()) {
+                message.put(CustomHTMLLayout.Columns.VARIABLES_FOLDER_PATH, session.getVariablesFolderPath(log4jLevel));
+            }
+
             Logger logger = session.getLogger();
             switch (logLevel) {
                 case LEVEL_INFO:
@@ -184,7 +189,9 @@ public void action(
 
     /**
      * Converts string log level to Log4j Level object
+     *
      * @param logLevel The string representation of log level
+     *
      * @return The corresponding Log4j Level object
      */
     private Level convertToLog4jLevel(String logLevel) {

src/main/java/com/automationanywhere/botcommand/utilities/logger/CustomHTMLLayout.java

@@ -18,6 +18,7 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.UUID;
 
 /**
  * @author Sumit Kumar
@@ -41,14 +42,13 @@ public class CustomHTMLLayout extends AbstractStringLayout {
         }
     }
 
-    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MMM-dd HH:mm:ss Z"); // Define your desired date and time
-    // format
+    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MMM-dd HH:mm:ss Z"); // Define your desired date and
+    // time format
 
     public CustomHTMLLayout(Charset charset) {
         super(charset);
     }
 
-
     @PluginBuilderFactory
     public static Builder newBuilder() {
         return new Builder();
@@ -59,61 +59,86 @@ public String toSerializable(LogEvent event) {
         String formattedContent;
         String message;
         String sourceBotPath = "";
-        String htmlFormattedVariables = "";
-        String screenshotPath = "";
+        String variablesLink = "";
+        String screenshotLink = "";
 
-        //parse the message and extract column details for current row
+        // Parse the message and extract column details for current row
         Object[] parameters = event.getMessage().getParameters();
         if (parameters != null && parameters.length > 0 && parameters[ 0 ] instanceof Map) {
             Map<String, Object> messageObject = (Map<String, Object>) parameters[ 0 ];
             message = Optional.ofNullable(messageObject.get(Columns.MESSAGE)).map(Object::toString).orElse("");
             sourceBotPath = Optional.ofNullable(messageObject.get(Columns.SOURCE)).map(Object::toString).orElse("");
-            screenshotPath = Optional.ofNullable(messageObject.get(Columns.SCREENSHOT)).map(Object::toString).orElse(
-                    "");
+            String screenshotPath =
+                    Optional.ofNullable(messageObject.get(Columns.SCREENSHOT)).map(Object::toString).orElse("");
 
+            // Process variables if present
             if (messageObject.get(Columns.VARIABLES) != null && messageObject.get(Columns.VARIABLES) instanceof Map) {
                 Map<String, Value> variableMap = (Map<String, Value>) messageObject.get(Columns.VARIABLES);
-                htmlFormattedVariables = HTMLGenerator.generateHTML(variableMap);
+
+                // Generate count display for the main log
+                String variablesCount = HTMLGenerator.generateHTML(variableMap);
+
+                // If the variables folder path is provided, generate a separate file
+                if (messageObject.get("variablesFolderPath") != null) {
+                    String variablesFolderPath = messageObject.get("variablesFolderPath").toString();
+                    String logEventId = UUID.randomUUID().toString();
+
+                    // Generate variable file and get the link
+                    String variablesFilePath = HTMLGenerator.generateVariableFile(variableMap, variablesFolderPath,
+                            logEventId);
+
+                    if (!variablesFilePath.isEmpty()) {
+                        variablesLink =
+                                "<a href='" + variablesFilePath + "' target='_blank' class='vars-link'>" + variablesCount + "</a>";
+                    } else {
+                        variablesLink = variablesCount;
+                    }
+                } else {
+                    variablesLink = variablesCount;
+                }
             }
 
+            // Get screenshot link if screenshot exists
+            screenshotLink = HTMLGenerator.getScreenshotHTML(screenshotPath);
         } else {
             message = event.getMessage().getFormattedMessage();
         }
 
+        // Get the level as a CSS class for styling
+        String levelClass = "level-" + event.getLevel().toString();
+
         formattedContent = String.format(
                 "<tr>" +
                         "<td>%s</td>" +
+                        "<td class='%s'>%s</td>" +
                         "<td>%s</td>" +
-                        "<td>%s</td>" +
-                        "<td>%s</td>" +
-                        "<td>%s</td>" +
+                        "<td class='responsive-hide'>%s</td>" +
+                        "<td class='responsive-hide'>%s</td>" +
                         "<td>%s</td>" +
                         "<td>%s</td>" +
                         "<td>%s</td>" +
                         "</tr>",
                 StringEscapeUtils.escapeHtml4(dateFormat.format(event.getTimeMillis())),
+                levelClass,
                 StringEscapeUtils.escapeHtml4(event.getLevel().toString()),
                 StringEscapeUtils.escapeHtml4(sourceBotPath),
                 StringEscapeUtils.escapeHtml4(machine),
                 StringEscapeUtils.escapeHtml4(user),
                 StringEscapeUtils.escapeHtml4(message),
-                htmlFormattedVariables,
-                HTMLGenerator.getScreenshotHTML(screenshotPath)
+                variablesLink,
+                screenshotLink
         );
 
-
         return formattedContent;
     }
 
     @Override
     public byte[] getFooter() {
-        // Add footer content similar to Log4j2's HtmlLayout
         return footer;
     }
 
     @Override
     public byte[] getHeader() {
-        // Add header content similar to Log4j2's HtmlLayout
         return header;
     }
 
@@ -134,13 +159,13 @@ public Builder withCharset(Charset charset) {
         public CustomHTMLLayout build() {
             return new CustomHTMLLayout(charset);
         }
-
     }
 
     public static class Columns {
         public static final String SOURCE = "Source";
         public static final String MESSAGE = "Message";
         public static final String VARIABLES = "Variables";
         public static final String SCREENSHOT = "Screenshot";
+        public static final String VARIABLES_FOLDER_PATH = "variablesFolderPath";
     }
-}
+}

src/main/java/com/automationanywhere/botcommand/utilities/logger/CustomLogger.java

@@ -3,15 +3,8 @@
 import com.automationanywhere.toolchain.runtime.session.CloseableSessionObject;
 import org.apache.commons.io.FilenameUtils;
 import org.apache.logging.log4j.Level;
-import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.apache.logging.log4j.core.Appender;
 import org.apache.logging.log4j.core.LoggerContext;
-import org.apache.logging.log4j.core.appender.RollingFileAppender;
-import org.apache.logging.log4j.core.config.Configuration;
-import org.apache.logging.log4j.core.config.ConfigurationFactory;
-import org.apache.logging.log4j.core.config.ConfigurationSource;
-import org.apache.logging.log4j.core.config.DefaultConfiguration;
 import org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder;
 import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder;
 import org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder;
@@ -39,6 +32,7 @@ public class CustomLogger implements CloseableSessionObject {
     private final String loggerId;
     private final LoggerContext loggerContext;
     private final Map<Level, String> screenshotFolderPaths;
+    private final Map<Level, String> variablesFolderPaths;
 
     // Constructor for a single log file for all levels
     public CustomLogger(String loggerName, String logFilePath, long sizeLimitMB) throws IOException {
@@ -47,15 +41,22 @@ public CustomLogger(String loggerName, String logFilePath, long sizeLimitMB) thr
         // Create screenshot folder at the same location as log file
         String baseDir = FilenameUtils.getFullPath(logFilePath);
         String screenshotFolder = baseDir + "screenshots";
+        String variablesFolder = baseDir + "variables";
 
         this.screenshotFolderPaths = new HashMap<>();
-        // Use the same screenshot folder for all levels when using a combined log file
+        this.variablesFolderPaths = new HashMap<>();
+
+        // Use the same folder for all levels when using a combined log file
         this.screenshotFolderPaths.put(Level.INFO, screenshotFolder);
         this.screenshotFolderPaths.put(Level.WARN, screenshotFolder);
         this.screenshotFolderPaths.put(Level.ERROR, screenshotFolder);
 
-        // Create screenshot directory
-        createScreenshotDirectories();
+        this.variablesFolderPaths.put(Level.INFO, variablesFolder);
+        this.variablesFolderPaths.put(Level.WARN, variablesFolder);
+        this.variablesFolderPaths.put(Level.ERROR, variablesFolder);
+
+        // Create directories
+        createDirectories();
 
         // Create a unique logger context for this instance
         LoggerContext context = createNewLoggerContext();
@@ -64,7 +65,8 @@ public CustomLogger(String loggerName, String logFilePath, long sizeLimitMB) thr
         ConfigurationBuilder<BuiltConfiguration> builder = new DefaultConfigurationBuilder();
         setupLoggerConfiguration(builder);
 
-        AppenderComponentBuilder appenderBuilder = getCustomAppenderBuilder(builder, "COMBINED_" + loggerId, logFilePath,
+        AppenderComponentBuilder appenderBuilder = getCustomAppenderBuilder(builder, "COMBINED_" + loggerId,
+                logFilePath,
                 sizeLimitMB);
         builder.add(appenderBuilder);
         builder.add(builder.newLogger(loggerName, Level.INFO)
@@ -84,6 +86,20 @@ public CustomLogger(String loggerName, String logFilePath, long sizeLimitMB) thr
         this.logger = context.getLogger(loggerName);
     }
 
+    private void createDirectories() throws IOException {
+        // Create screenshot directories
+        for (String path : screenshotFolderPaths.values()) {
+            Path directoryPath = Paths.get(path);
+            Files.createDirectories(directoryPath);
+        }
+
+        // Create variables directories
+        for (String path : variablesFolderPaths.values()) {
+            Path directoryPath = Paths.get(path);
+            Files.createDirectories(directoryPath);
+        }
+    }
+
     private LoggerContext createNewLoggerContext() {
         // Creating a completely separate LoggerContext
         return new LoggerContext("Context-" + loggerId);
@@ -122,17 +138,20 @@ private AppenderComponentBuilder getCustomAppenderBuilder(ConfigurationBuilder<B
     public CustomLogger(String loggerName, Map<Level, String> levelFilePathMap, long sizeLimitMB) throws IOException {
         this.loggerId = UUID.randomUUID().toString();
         this.screenshotFolderPaths = new HashMap<>();
+        this.variablesFolderPaths = new HashMap<>();
 
-        // Create a screenshot folder alongside each log file
+        // Create a screenshot and variables folder alongside each log file
         for (Map.Entry<Level, String> entry : levelFilePathMap.entrySet()) {
             Level level = entry.getKey();
             String filePath = entry.getValue();
             String baseDir = FilenameUtils.getFullPath(filePath);
+
             this.screenshotFolderPaths.put(level, baseDir + "screenshots");
+            this.variablesFolderPaths.put(level, baseDir + "variables");
         }
 
-        // Create all screenshot directories
-        createScreenshotDirectories();
+        // Create all directories
+        createDirectories();
 
         // Create a unique logger context for this instance
         LoggerContext context = createNewLoggerContext();
@@ -176,14 +195,6 @@ public CustomLogger(String loggerName, Map<Level, String> levelFilePathMap, long
         this.logger = context.getLogger(loggerName);
     }
 
-    private void createScreenshotDirectories() throws IOException {
-        // Create unique directories only (remove duplicates)
-        for (String path : screenshotFolderPaths.values()) {
-            Path directoryPath = Paths.get(path);
-            Files.createDirectories(directoryPath);
-        }
-    }
-
     public Logger getLogger() {
         return logger;
     }
@@ -210,9 +221,30 @@ public String getScreenshotFolderPath(Level level) {
 
     /**
      * Returns the screenshot folder path for the INFO level
+     *
      * @return default screenshot folder path (INFO level)
      */
     public String getScreenshotFolderPath() {
         return screenshotFolderPaths.get(Level.INFO);
     }
+
+    /**
+     * Returns the variables folder path for the specified log level
+     *
+     * @param level Log level
+     *
+     * @return variables folder path for the specified level
+     */
+    public String getVariablesFolderPath(Level level) {
+        return variablesFolderPaths.getOrDefault(level, variablesFolderPaths.get(Level.INFO));
+    }
+
+    /**
+     * Returns the variables folder path for the INFO level
+     *
+     * @return default variables folder path (INFO level)
+     */
+    public String getVariablesFolderPath() {
+        return variablesFolderPaths.get(Level.INFO);
+    }
 }