Merge pull request #48146 from eniuane/48133

Use DotName.toString() instead of Type.toString()

Author: gsmet

independent-projects/arc/processor/banned-signatures.txt

@@ -0,0 +1,8 @@
+@defaultMessage Don't use Maven classes. They won't be available when using Gradle.
+org.apache.maven.**
+org.codehaus.plexus.**
+
+@defaultMessage Never use Type#toString() as it's almost always the wrong thing to do. Usually org.jboss.jandex.DotName#toString() is what is needed
+org.jboss.jandex.Type#toString()
+
+org.apache.commons.io.** @ Don't use commons-io dependency

independent-projects/arc/processor/pom.xml

@@ -63,5 +63,30 @@
         </dependency>
 
     </dependencies>
-
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>de.thetaphi</groupId>
+                <artifactId>forbiddenapis</artifactId>
+                <executions>
+                    <execution>
+                        <id>verify-forbidden-apis</id>
+                        <configuration>
+                            <signaturesFiles>
+                                <signaturesFile>./banned-signatures.txt</signaturesFile>
+                            </signaturesFiles>
+                            <ignoreSignaturesOfMissingClasses>true</ignoreSignaturesOfMissingClasses>
+                            <suppressAnnotations>
+                                <annotation>**.SuppressForbidden</annotation>
+                            </suppressAnnotations>
+                        </configuration>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/ClientProxyGenerator.java

@@ -174,7 +174,7 @@ Collection<Resource> generate(BeanInfo bean, String beanClassName,
 
             // Exceptions
             for (Type exception : method.exceptions()) {
-                forward.addException(exception.toString());
+                forward.addException(exception.name().toString());
             }
             // Method params
             ResultHandle[] params = new ResultHandle[method.parametersCount()];

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/ComponentsProviderGenerator.java

@@ -551,6 +551,7 @@ void invokeAddMethod() {
         }
 
         @Override
+        @SuppressForbidden(reason = "Using Type.toString() to build an informative message")
         void addComponentInternal(BeanInfo removedBean) {
 
             ResultHandle removedBeansHandle = addMethod.getMethodParam(0);
@@ -654,11 +655,13 @@ public void initialize(MethodCreator method) {
         }
 
         @Override
+        @SuppressForbidden(reason = "Using Type.toString() to build an informative message")
         public ResultHandle get(org.jboss.jandex.Type type, BytecodeCreator bytecode) {
             return bytecode.invokeInterfaceMethod(MethodDescriptors.MAP_GET, mapHandle, bytecode.load(type.toString()));
         }
 
         @Override
+        @SuppressForbidden(reason = "Using Type.toString() to build an informative message")
         public void put(org.jboss.jandex.Type type, ResultHandle value, BytecodeCreator bytecode) {
             bytecode.invokeInterfaceMethod(MethodDescriptors.MAP_PUT, mapHandle, bytecode.load(type.toString()), value);
         }

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/InvokerGenerator.java

@@ -791,6 +791,7 @@ static class CandidateMethods {
             this.invoker = invoker;
         }
 
+        @SuppressForbidden(reason = "Using Type.toString() to build an informative message")
         CandidateMethod resolve() {
             if (matching.size() == 1) {
                 return matching.get(0);

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/ObserverGenerator.java

@@ -94,6 +94,7 @@ public ObserverGenerator(AnnotationLiteralProcessor annotationLiterals, Predicat
      *
      * @param observer
      */
+    @SuppressForbidden(reason = "Using Type.toString() to build an informative message")
     void precomputeGeneratedName(ObserverInfo observer) {
         // The name of the generated class differs:
         // "org.acme.Foo_Observer_fooMethod_hash" for normal observer where hash represents the signature of the observer method

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/SubclassGenerator.java

@@ -714,7 +714,7 @@ private void processDecorator(DecoratorInfo decorator, BeanInfo bean, Type provi
             MethodCreator forward = delegateSubclass.getMethodCreator(methodDescriptor);
             // Exceptions
             for (Type exception : method.exceptions()) {
-                forward.addException(exception.toString());
+                forward.addException(exception.name().toString());
             }
 
             ResultHandle ret = null;

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/SuppressForbidden.java

@@ -0,0 +1,15 @@
+package io.quarkus.arc.processor;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Used to suppress forbidden-apis errors inside the element it's added to.
+ */
+@Retention(RetentionPolicy.CLASS)
+@Target({ ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
+public @interface SuppressForbidden {
+    String reason();
+}

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/bcextensions/TypeImpl.java

@@ -12,6 +12,8 @@
 
 import org.jboss.jandex.DotName;
 
+import io.quarkus.arc.processor.SuppressForbidden;
+
 abstract class TypeImpl<JandexType extends org.jboss.jandex.Type> extends AnnotationTargetImpl implements Type {
     final JandexType jandexType;
 
@@ -108,6 +110,7 @@ public Collection<AnnotationInfo> annotations() {
     }
 
     @Override
+    @SuppressForbidden(reason = "Using Type.toString() to build an informative message")
     public String toString() {
         return jandexType.toString();
     }