Add diagnostic/logging messages for annotation processor (Azure#45116)

Author: samvaity

sdk/clientcore/annotation-processor-test/src/main/java/io/clientcore/annotation/processor/test/implementation/SimpleXmlSerializableService.java

@@ -67,8 +67,6 @@ static SimpleXmlSerializableService getNewInstance(HttpPipeline pipeline) {
     /**
      * Retrieves an invalid XML payload.
      * @param contentType The content type of the invalid XML payload.
-     *
-     * @param contentType The content type of the XML payload.
      * @return The retrieved invalid XML payload.
      */
     @HttpRequestInformation(method = HttpMethod.GET, path = "getInvalidXml", expectedStatusCodes = { 200 })

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/AnnotationProcessor.java

@@ -36,6 +36,7 @@
 import javax.lang.model.element.ExecutableElement;
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.element.VariableElement;
+import javax.tools.Diagnostic;
 
 /**
  * Annotation processor that generates client code based on annotated interfaces.
@@ -56,18 +57,28 @@ public SourceVersion getSupportedSourceVersion() {
 
     @Override
     public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
-        // We iterate through each interface annotated with @ServiceInterface separately.
-        // This outer for-loop is not strictly necessary, as we only have one annotation that we care about
-        // (@ServiceInterface), but we'll leave it here for now
-        annotations.stream()
-            .map(roundEnv::getElementsAnnotatedWith)
-            .flatMap(Set::stream)
+        // Gather all elements to process
+        Set<? extends Element> elementsToProcess = annotations.stream()
+            .flatMap(annotation -> roundEnv.getElementsAnnotatedWith(annotation).stream())
             .filter(element -> element.getKind().isInterface())
-            .forEach(element -> {
-                if (element.getAnnotation(ServiceInterface.class) != null) {
-                    this.processServiceInterface(element);
-                }
-            });
+            .collect(Collectors.toSet());
+
+        if (elementsToProcess.isEmpty()) {
+            // No interfaces to process in this round; skip logging
+            return false;
+        }
+
+        processingEnv.getMessager()
+            .printMessage(Diagnostic.Kind.NOTE,
+                "[Clientcore SDK AnnotationProcessor] Starting annotation processing for service interfaces.");
+
+        for (Element element : elementsToProcess) {
+            this.processServiceInterface(element);
+        }
+
+        processingEnv.getMessager()
+            .printMessage(Diagnostic.Kind.NOTE,
+                "[Clientcore SDK AnnotationProcessor] Completed annotation processing.");
 
         return true;
     }
@@ -76,7 +87,9 @@ private void processServiceInterface(Element serviceInterface) {
         if (serviceInterface == null || serviceInterface.getKind() != ElementKind.INTERFACE) {
             throw new IllegalArgumentException("Invalid service interface provided.");
         }
-
+        processingEnv.getMessager()
+            .printMessage(Diagnostic.Kind.NOTE,
+                "Generating client implementation for: " + serviceInterface.asType().toString());
         TemplateInput templateInput = new TemplateInput();
 
         // Determine the fully qualified name (FQN) and package name
@@ -124,8 +137,6 @@ private void processServiceInterface(Element serviceInterface) {
 
         // Process the template
         TemplateProcessor.getInstance().process(templateInput, processingEnv);
-
-        // Additional formatting or logging if necessary
     }
 
     private void addImports(TemplateInput templateInput) {
@@ -177,13 +188,13 @@ private HttpRequestContext createHttpRequestContext(ExecutableElement requestMet
             } else if (headerParam != null) {
                 // Only add header param if the key is not already present (e.g., set by static header params)
                 String key = headerParam.value();
-                if (method.getHeaders() == null || !method.getHeaders().containsKey(key)) {
+                if (!method.getHeaders().containsKey(key)) {
                     method.addHeader(headerParam.value(), param.getSimpleName().toString());
                 }
             } else if (queryParam != null) {
                 // Only add query param if the key is not already present (e.g., set by static query params)
                 String key = queryParam.value();
-                if (method.getQueryParams() == null || !method.getQueryParams().containsKey(key)) {
+                if (!method.getQueryParams().containsKey(key)) {
                     method.addQueryParam(key, param.getSimpleName().toString(), queryParam.multipleQueryParams(),
                         !queryParam.encoded());
                 }
@@ -205,7 +216,7 @@ private HttpRequestContext createHttpRequestContext(ExecutableElement requestMet
         return method;
     }
 
-    private static String getHost(HttpRequestContext method) {
+    private String getHost(HttpRequestContext method) {
         String path = method.getPath();
         // Set the path after host, concatenating the path segment in the host.
         if (path != null && !path.isEmpty() && !"/".equals(path)) {

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/templating/JavaParserTemplateProcessor.java

@@ -49,6 +49,7 @@
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.type.TypeKind;
 import javax.lang.model.type.TypeMirror;
+import javax.tools.Diagnostic;
 
 import static io.clientcore.annotation.processor.utils.ResponseHandler.generateResponseHandling;
 
@@ -102,8 +103,11 @@ public void process(TemplateInput templateInput, ProcessingEnvironment processin
         addCopyrightComments();
         setPackageDeclaration(packageName);
         createClass(serviceInterfaceImplShortName, serviceInterfaceShortName, templateInput, processingEnv);
-
+        processingEnv.getMessager()
+            .printMessage(Diagnostic.Kind.NOTE, "Writing generated source file for: " + serviceInterfaceImplShortName);
         writeFile(packageName, serviceInterfaceImplShortName, processingEnv);
+        processingEnv.getMessager()
+            .printMessage(Diagnostic.Kind.NOTE, "Completed code generation for: " + serviceInterfaceImplShortName);
     }
 
     void addImports(TemplateInput templateInput) {
@@ -260,7 +264,9 @@ private void writeFile(String packageName, String serviceInterfaceImplShortName,
             fileWriter.write(compilationUnit.toString());
             fileWriter.flush();
         } catch (IOException e) {
-            e.printStackTrace();
+            processingEnv.getMessager()
+                .printMessage(Diagnostic.Kind.ERROR, "Failed to write generated source file for "
+                    + serviceInterfaceImplShortName + ": " + e.getMessage());
         }
     }
 

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/utils/RequestBodyHandler.java

@@ -30,7 +30,7 @@ public final class RequestBodyHandler {
      * @param body The BlockStmt to which the statements are added.
      * @param requestBody The request body context containing parameter type and content type.
      * @param processingEnv The processing environment providing utility methods for operating on program elements and types.
-     * @return true if serialization format is set and used in the request body, false otherwise.
+     * @return true if a serialization format is set and used in the request body, false otherwise.
      */
     public static boolean configureRequestBody(BlockStmt body, HttpRequestContext.Body requestBody,
         ProcessingEnvironment processingEnv) {
@@ -83,17 +83,6 @@ public static void addBinaryDataRequestBody(BlockStmt body, String parameterName
             + "httpRequest.setBody(binaryData); }"));
     }
 
-    /**
-     * Adds a JSON request body to the HTTP request.
-     *
-     * @param body The block statement to which the request body is added.
-     * @param parameterName The name of the parameter.
-     */
-    public static void addJsonRequestBody(BlockStmt body, String parameterName) {
-        body.addStatement(StaticJavaParser.parseStatement(
-            String.format("httpRequest.setBody(BinaryData.fromObject(%s, jsonSerializer));", parameterName)));
-    }
-
     /**
      * Checks if the given parameter type is a byte array.
      *

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/utils/ResponseHandler.java

@@ -34,7 +34,7 @@ public final class ResponseHandler {
      * @param body the method builder to append generated code.
      * @param returnType the return type of the method.
      * @param method whether request options are used.
-     * @param serializationFormatSet indicates if serialization format is set.
+     * @param serializationFormatSet indicates if a serialization format is set.
      */
     public static void generateResponseHandling(BlockStmt body, TypeMirror returnType, HttpRequestContext method,
         boolean serializationFormatSet) {

sdk/clientcore/annotation-processor/src/test/java/io/clientcore/annotation/processor/mocks/MockProcessingEnvironment.java

@@ -6,11 +6,15 @@
 import javax.annotation.processing.Messager;
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.SourceVersion;
+import javax.lang.model.element.AnnotationMirror;
+import javax.lang.model.element.AnnotationValue;
+import javax.lang.model.element.Element;
 import javax.lang.model.util.Elements;
 import javax.lang.model.util.Types;
 import java.util.Collections;
 import java.util.Locale;
 import java.util.Map;
+import javax.tools.Diagnostic;
 
 /**
  * Mock implementation of {@link ProcessingEnvironment}.
@@ -41,7 +45,7 @@ public Map<String, String> getOptions() {
 
     @Override
     public Messager getMessager() {
-        return null;
+        return new MockMessager();
     }
 
     @Override
@@ -78,4 +82,27 @@ public SourceVersion getSourceVersion() {
     public Locale getLocale() {
         return null;
     }
+
+    private static class MockMessager implements Messager {
+        @Override
+        public void printMessage(Diagnostic.Kind kind, CharSequence msg) {
+            // No-op for mock
+        }
+
+        @Override
+        public void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e) {
+            // No-op for mock
+        }
+
+        @Override
+        public void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a) {
+            // No-op for mock
+        }
+
+        @Override
+        public void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a,
+            AnnotationValue v) {
+            // No-op for mock
+        }
+    }
 }