Normalization of bean class names for more correct logs

Fixed micronaut-projects#11320
altro3 · Nov 8, 2024 · c0b0ee7 · c0b0ee7
1 parent 0ce7262
commit c0b0ee7
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 8 deletions.
diff --git a/inject/src/main/java/io/micronaut/context/DefaultApplicationContext.java b/inject/src/main/java/io/micronaut/context/DefaultApplicationContext.java
@@ -65,6 +65,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import static io.micronaut.context.MessageUtils.normalizeBeanClassName;
 import static io.micronaut.core.util.StringUtils.EMPTY_STRING_ARRAY;
 
 /**
@@ -367,7 +368,7 @@ private <T> void appendMissingEachBeanMessage(String linePrefix,
         messageBuilder
             .append(lineSeparator)
             .append(linePrefix)
-            .append("* [").append(beanType.getTypeString(true))
+            .append("* [").append(normalizeBeanClassName(beanType.getTypeString(true)))
             .append("] requires the presence of a bean of type [")
             .append(dependentBean.getName())
             .append("]");
@@ -428,10 +429,10 @@ private <T> void appendEachPropertyMissingBeanMessage(String linePrefix,
             .append(lineSeparator)
             .append(linePrefix)
             .append("* [")
-            .append(definition.asArgument().getTypeString(true));
+            .append(normalizeBeanClassName(definition.asArgument().getTypeString(true)));
         if (!definition.getBeanType().equals(beanType.getType())) {
             messageBuilder.append("] a candidate of [")
-                .append(beanType.getTypeString(true));
+                .append(normalizeBeanClassName(beanType.getTypeString(true)));
         }
         messageBuilder.append("] is disabled because:")
             .append(lineSeparator);

diff --git a/inject/src/main/java/io/micronaut/context/DefaultBeanContext.java b/inject/src/main/java/io/micronaut/context/DefaultBeanContext.java
@@ -147,6 +147,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import static io.micronaut.context.MessageUtils.normalizeBeanClassName;
 import static io.micronaut.core.util.StringUtils.EMPTY_STRING_ARRAY;
 
 /**
@@ -848,7 +849,7 @@ public <T> T getBean(@NonNull Argument<T> beanType, @Nullable Qualifier<T> quali
                 null,
                 beanType,
                 qualifier,
-                "Bean of type [" + beanType.getTypeString(true) + "] disabled for reason: " + e.getMessage()
+                "Bean of type [" + normalizeBeanClassName(beanType.getTypeString(true)) + "] disabled for reason: " + e.getMessage()
             );
         }
     }
@@ -2840,7 +2841,7 @@ final <T> void resolveDisabledBeanMessage(String linePrefix,
                 messageBuilder.append(lineSeparator)
                     .append(linePrefix)
                     .append("* [")
-                    .append(beanType.getTypeString(true))
+                    .append(normalizeBeanClassName(beanType.getTypeString(true)))
                     .append("] is disabled because it is within the package [")
                     .append(pkg)
                     .append("] which is disabled due to bean requirements: ")
@@ -2875,10 +2876,10 @@ final <T> void resolveDisabledBeanMessage(String linePrefix,
                 messageBuilder
                     .append(lineSeparator)
                     .append(linePrefix)
-                    .append("* [").append(beanDefinition.asArgument().getTypeString(true));
+                    .append("* [").append(normalizeBeanClassName(beanDefinition.asArgument().getTypeString(true)));
                 if (!beanDefinition.getBeanType().equals(beanType.getType())) {
                     messageBuilder.append("] a candidate of [")
-                        .append(beanType.getTypeString(true));
+                        .append(normalizeBeanClassName(beanType.getTypeString(true)));
                 }
                 messageBuilder.append("] is disabled because:")
                     .append(lineSeparator);

diff --git a/inject/src/main/java/io/micronaut/context/MessageUtils.java b/inject/src/main/java/io/micronaut/context/MessageUtils.java
@@ -0,0 +1,35 @@
+package io.micronaut.context;
+
+/**
+ * @since 4.8.0
+ */
+public final class MessageUtils {
+
+    private static final String POSTFIX_BEAN_DEFINITION_REFERENCE = "$Definition$Intercepted$Definition$Reference";
+    private static final String POSTFIX_BEAN_DEFINITION = "$Definition$Intercepted$Definition";
+    private static final String POSTFIX_BEAN_METHOD_DEFINITION = "$Definition$Intercepted";
+
+    private MessageUtils() {
+    }
+
+    /**
+     * Normalization bean class names for logs.
+     *
+     * @param typeString bean class name
+     *
+     * @return normalized bean class name
+     */
+    public static String normalizeBeanClassName(String typeString) {
+        if (typeString.startsWith("$")) {
+            typeString = typeString.substring(1);
+        }
+        if (typeString.endsWith(POSTFIX_BEAN_DEFINITION_REFERENCE)) {
+            typeString = typeString.substring(0, typeString.indexOf(POSTFIX_BEAN_DEFINITION_REFERENCE));
+        } else if (typeString.endsWith(POSTFIX_BEAN_DEFINITION)) {
+            typeString = typeString.substring(0, typeString.indexOf(POSTFIX_BEAN_DEFINITION));
+        } else if (typeString.endsWith(POSTFIX_BEAN_METHOD_DEFINITION)) {
+            typeString = typeString.substring(0, typeString.indexOf(POSTFIX_BEAN_METHOD_DEFINITION));
+        }
+        return typeString;
+    }
+}
diff --git a/inject/src/main/java/io/micronaut/context/exceptions/NonUniqueBeanException.java b/inject/src/main/java/io/micronaut/context/exceptions/NonUniqueBeanException.java
@@ -21,6 +21,8 @@
 import java.util.Collections;
 import java.util.Iterator;
 
+import static io.micronaut.context.MessageUtils.normalizeBeanClassName;
+
 
 /**
  * Exception thrown when a bean is not unique and has multiple possible implementations for a given bean type.
@@ -70,7 +72,7 @@ private static <T> String buildMessage(Iterator<BeanDefinition<T>> possibleCandi
         final StringBuilder message = new StringBuilder("Multiple possible bean candidates found: [");
         while (possibleCandidates.hasNext()) {
             Argument<T> next = possibleCandidates.next().asArgument();
-            message.append(next.getTypeString(true));
+            message.append(normalizeBeanClassName(next.getTypeString(true)));
             if (possibleCandidates.hasNext()) {
                 message.append(", ");
             }