filter properties of type class (#1619)

Author: graemerocher

openapi/src/main/java/io/micronaut/openapi/visitor/AbstractOpenApiVisitor.java

@@ -54,6 +54,7 @@
 import io.micronaut.inject.ast.GenericPlaceholderElement;
 import io.micronaut.inject.ast.MemberElement;
 import io.micronaut.inject.ast.PropertyElement;
+import io.micronaut.inject.ast.PropertyElementQuery;
 import io.micronaut.inject.ast.TypedElement;
 import io.micronaut.inject.ast.WildcardElement;
 import io.micronaut.inject.visitor.VisitorContext;
@@ -2721,8 +2722,17 @@ private void populateSchemaProperties(OpenAPI openAPI, VisitorContext context, E
         if (classElement != null && !ClassUtils.isJavaLangType(classElement.getName())) {
             List<PropertyElement> beanProperties;
             try {
-                beanProperties = classElement.getBeanProperties().stream()
-                    .filter(p -> !"groovy.lang.MetaClass".equals(p.getType().getName()))
+                beanProperties = classElement.getBeanProperties(
+                        PropertyElementQuery.of(classElement)
+                            .excludedAnnotations(Set.of(
+                                Hidden.class.getName(),
+                                JsonIgnore.class.getName()
+                            ))
+                    ).stream()
+                    .filter(p ->
+                        !"groovy.lang.MetaClass".equals(p.getType().getName())
+                            && !"java.lang.Class".equals(p.getType().getName())
+                    )
                     .toList();
             } catch (Exception e) {
                 warn("Error with getting properties for class " + classElement.getName() + ": " + e + "\n" + Utils.printStackTrace(e), context, classElement);
@@ -2794,14 +2804,7 @@ private void processPropertyElements(OpenAPI openAPI, VisitorContext context, El
         }
 
         for (TypedElement publicField : publicFields) {
-            boolean isHidden = getAnnotationMetadata(publicField).booleanValue(io.swagger.v3.oas.annotations.media.Schema.class, PROP_HIDDEN).orElse(false);
-            var jsonAnySetterAnn = getAnnotation(publicField, JsonAnySetter.class);
-            if (isAnnotationPresent(publicField, JsonIgnore.class)
-                || isAnnotationPresent(publicField, Hidden.class)
-                || (jsonAnySetterAnn != null && jsonAnySetterAnn.booleanValue("enabled").orElse(true))
-                || isHidden) {
-                continue;
-            }
+            if (isHiddenElement(publicField)) continue;
 
             var isGetterOverridden = false;
             JavadocDescription fieldJavadoc = null;
@@ -2849,6 +2852,17 @@ private void processPropertyElements(OpenAPI openAPI, VisitorContext context, El
         }
     }
 
+    private static boolean isHiddenElement(TypedElement elementType) {
+        boolean isHidden = getAnnotationMetadata(elementType)
+            .booleanValue(io.swagger.v3.oas.annotations.media.Schema.class, PROP_HIDDEN).orElse(false);
+        var jsonAnySetterAnn = getAnnotation(elementType, JsonAnySetter.class);
+        return elementType.getType().isAssignable(Class.class)
+                || isAnnotationPresent(elementType, JsonIgnore.class)
+                || isAnnotationPresent(elementType, Hidden.class)
+                || (jsonAnySetterAnn != null && jsonAnySetterAnn.booleanValue("enabled").orElse(true))
+                || isHidden;
+    }
+
     private boolean allowedByJsonView(TypedElement publicField, String[] classLvlJsonViewClasses, ClassElement jsonViewClassEl, VisitorContext context) {
         String[] fieldJsonViewClasses = getAnnotationMetadata(publicField).stringValues(JsonView.class);
         if (ArrayUtils.isEmpty(fieldJsonViewClasses)) {

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiClassPropertySpec.groovy

@@ -0,0 +1,77 @@
+package io.micronaut.openapi.visitor
+
+import io.micronaut.openapi.AbstractOpenApiTypeElementSpec
+import io.swagger.v3.oas.models.OpenAPI
+
+class OpenApiClassPropertySpec extends AbstractOpenApiTypeElementSpec {
+    void "test class property is not exposed"() {
+
+        when:
+        buildBeanDefinition("test.MyBean", '''
+package test;
+
+import io.micronaut.core.annotation.Introspected;
+import io.micronaut.http.HttpResponse;
+import io.micronaut.http.MediaType;
+import io.micronaut.http.annotation.*;
+
+import io.swagger.v3.oas.annotations.Hidden;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import jakarta.validation.constraints.*;
+
+@Controller
+class PersonController {
+
+    @Get("/person/{name}")
+    HttpResponse<Person> get(@NotBlank String name) {
+        return HttpResponse.ok();
+    }
+}
+
+/**
+ * The person information.
+ */
+@Introspected
+class Person {
+
+    private String name;
+    private Class<?> personClass;
+    public String getName() {
+        return name;
+    }
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public void setPersonClass(Class<?> personClass) {
+        this.personClass = personClass;
+    }
+
+    public Class<?> getPersonClass() {
+        return personClass;
+    }
+}
+
+@jakarta.inject.Singleton
+public class MyBean {}
+
+''')
+
+        then:
+        OpenAPI openAPI = Utils.testReference
+        openAPI?.paths?.get("/person/{name}")?.get
+        openAPI.components.schemas["Person"]
+        openAPI.components.schemas["Person"].type == "object"
+
+        openAPI.components.schemas["Person"].properties
+        openAPI.components.schemas["Person"].properties.size() == 1
+
+        openAPI.components.schemas["Person"].properties["name"]
+    }
+}