MCR-3161 improve startup component logging

Author: toKrause

mycore-base/src/main/java/org/mycore/common/config/MCRComponent.java

@@ -164,14 +164,21 @@ public String getResourceBase() {
     }
 
     /**
-     * Returns true, if this component is part of MyCoRe
+     * Returns true, if this component is a MyCore base component
+     */
+    public boolean isMyCoReBaseComponent() {
+        return type == Type.base;
+    }
+    
+    /**
+     * Returns true, if this component is a MyCoRe component
      */
     public boolean isMyCoReComponent() {
         return type == Type.base || type == Type.component;
     }
 
     /**
-     * Returns true, if this component is application module 
+     * Returns true, if this component is an application module 
      */
     public boolean isAppModule() {
         return type == Type.module;
@@ -185,6 +192,13 @@ public String getName() {
         return name;
     }
 
+    /**
+     * The unshortened name for this component.
+     */
+    public String getFullName() {
+        return artifactId;
+    }
+
     /**
      * Returns the jar file or <code>null</code> if nothing was set.
      *

mycore-base/src/main/java/org/mycore/common/events/MCRStartupHandler.java

@@ -18,19 +18,30 @@
 
 package org.mycore.common.events;
 
+import java.io.IOException;
+import java.time.ZoneId;
+import java.time.format.DateTimeFormatter;
+import java.util.List;
+import java.util.Locale;
+import java.util.jar.JarFile;
 import java.util.stream.Stream;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.mycore.common.MCRClassTools;
+import org.mycore.common.config.MCRComponent;
 import org.mycore.common.config.MCRConfiguration2;
 import org.mycore.common.config.MCRConfigurationDirSetup;
 import org.mycore.common.config.MCRConfigurationException;
 import org.mycore.common.config.MCRRuntimeComponentDetector;
+import org.mycore.common.log.MCRTableMessage;
 import org.mycore.common.xml.MCRURIResolver;
 
 import jakarta.servlet.ServletContext;
 
+import static jakarta.servlet.ServletContext.ORDERED_LIBS;
+import static org.mycore.common.config.MCRRuntimeComponentDetector.ComponentOrder.LOWEST_PRIORITY_FIRST;
+
 /**
  * Initializes classes that implement {@link AutoExecutable} interface that are defined via
  * <code>MCR.Startup.Class</code> property.
@@ -56,26 +67,71 @@ public static void startUp(ServletContext servletContext) {
         isWebApp = servletContext != null;
         //initialize ClassLoader here, so it can be used later reliably.
         MCRClassTools.updateClassLoader();
+
         ClassLoader resourceClassLoader = MCRClassTools.getClassLoader();
         LOGGER.info("The following ClassLoader is used: {}", resourceClassLoader);
-        LOGGER.info("I have these components for you: {}", MCRRuntimeComponentDetector.getAllComponents());
-        LOGGER.info("I have these mycore components for you: {}", MCRRuntimeComponentDetector.getMyCoReComponents());
-        LOGGER.info("I have these app modules for you: {}", MCRRuntimeComponentDetector.getApplicationModules());
+
+        MCRTableMessage<MCRComponent> componentTable = new MCRTableMessage<>(
+            new MCRTableMessage.Column<>("Type", MCRStartupHandler::toType),
+            new MCRTableMessage.Column<>("Name", MCRComponent::getFullName),
+            new MCRTableMessage.Column<>("Priority", MCRComponent::getPriority),
+            new MCRTableMessage.Column<>("Version", MCRStartupHandler::toVersion),
+            new MCRTableMessage.Column<>("Build time", MCRStartupHandler::toManifestModificationDate),
+            new MCRTableMessage.Column<>("Location", MCRStartupHandler::toJarFile));
+        MCRRuntimeComponentDetector.getAllComponents(LOWEST_PRIORITY_FIRST).forEach(componentTable::add);
+        LOGGER.info(componentTable.logMessage("Detected components:"));
+
         if (servletContext != null) {
-            LOGGER.info("Library order: {}", servletContext.getAttribute(ServletContext.ORDERED_LIBS));
+            LOGGER.info("Library order: {}", servletContext.getAttribute(ORDERED_LIBS));
         }
 
-        MCRConfiguration2.getString("MCR.Startup.Class")
+        MCRTableMessage<AutoExecutable> executableTable = new MCRTableMessage<>(
+            new MCRTableMessage.Column<>("Name", AutoExecutable::getName),
+            new MCRTableMessage.Column<>("Priority", AutoExecutable::getPriority),
+            new MCRTableMessage.Column<>("Class", executable -> executable.getClass().getName()));
+        List<AutoExecutable> executables = MCRConfiguration2.getString("MCR.Startup.Class")
             .map(MCRConfiguration2::splitValue)
             .orElseGet(Stream::empty)
             .map(MCRStartupHandler::getAutoExecutable)
-            //reverse ordering: highest priority first
-            .sorted((o1, o2) -> Integer.compare(o2.getPriority(), o1.getPriority()))
-            .forEachOrdered(autoExecutable -> startExecutable(servletContext, autoExecutable));
+            .sorted()
+            .peek(executableTable::add)
+            .toList();
+        LOGGER.info(executableTable.logMessage("Detected auto executables:"));
+        executables.forEach(autoExecutable -> startExecutable(servletContext, autoExecutable));
+        
         //initialize MCRURIResolver
         MCRURIResolver.init(servletContext);
     }
 
+    private static String toType(MCRComponent component) {
+        if (component.isMyCoReBaseComponent()) {
+            return "MyCoRe base component";
+        } else if (component.isMyCoReComponent()) {
+            return "MyCoRe component";
+        } else {
+            return "Application module";
+        }
+    }
+
+    private static Object toVersion(MCRComponent component) {
+        String version = component.getManifestMainAttribute("Implementation-Version");
+        return version != null ? version : "n/a";
+    }
+
+    private static Object toJarFile(MCRComponent component) {
+        return component.getJarFile().getAbsolutePath();
+    }
+
+    private static Object toManifestModificationDate(MCRComponent component) {
+        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss", Locale.getDefault());
+        try (JarFile jarFile = new JarFile(component.getJarFile())) {
+            return formatter.format(jarFile.getEntry("META-INF/MANIFEST.MF").getLastModifiedTime()
+                .toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime());
+        } catch (IOException e) {
+            return "n/a";
+        }
+    }
+
     public static boolean isWebApp() {
         return isWebApp;
     }
@@ -103,7 +159,7 @@ private static AutoExecutable getAutoExecutable(String className) {
         }
     }
 
-    public interface AutoExecutable {
+    public interface AutoExecutable extends Comparable<AutoExecutable> {
         /**
          * returns a name to display on start-up.
          */
@@ -118,5 +174,11 @@ public interface AutoExecutable {
          * This method get executed by {@link MCRStartupHandler#startUp(ServletContext)}
          */
         void startUp(ServletContext servletContext);
+
+        @Override
+        default int compareTo(AutoExecutable other) {
+            return Integer.compare(other.getPriority(), getPriority());
+        }
+        
     }
 }