CAUSEWAY-3991: honor Introspection Policy w/ Java Records

Author: andi-huber

api/applib/src/main/java/org/apache/causeway/applib/services/user/RoleMemento.java

@@ -31,6 +31,7 @@
 import org.apache.causeway.applib.CausewayModuleApplib;
 import org.apache.causeway.applib.annotation.DomainObject;
 import org.apache.causeway.applib.annotation.DomainObjectLayout;
+import org.apache.causeway.applib.annotation.Introspection;
 import org.apache.causeway.applib.annotation.Nature;
 import org.apache.causeway.applib.annotation.PriorityPrecedence;
 import org.apache.causeway.applib.annotation.PropertyLayout;
@@ -44,7 +45,8 @@
  */
 @Named(RoleMemento.LOGICAL_TYPE_NAME)
 @DomainObject(
-        nature = Nature.VIEW_MODEL)
+        nature = Nature.VIEW_MODEL,
+        introspection = Introspection.ANNOTATION_OPTIONAL)
 @DomainObjectLayout(
         titleUiEvent = RoleMemento.TitleUiEvent.class
 )
@@ -91,7 +93,7 @@ public RoleMemento(
     // -- OBJECT CONTRACT
 
     @Override
-    public final boolean equals(Object obj) {
+    public final boolean equals(final Object obj) {
         return (obj instanceof RoleMemento other)
             ? name.equals(other.name)
             : false;

commons/src/main/java/org/apache/causeway/commons/internal/reflection/_ClassCache.java

@@ -452,6 +452,8 @@ public void close() throws Exception {
 
     public static boolean methodExcludeFilter(final Method method) {
         return isByteCodeEnhanced(method)
+                || (method.isSynthetic() // exclude private synthetic
+                        && Modifier.isPrivate(method.getModifiers()))
         		|| method.isBridge()
                 || Modifier.isStatic(method.getModifiers())
                 || method.getDeclaringClass().equals(Object.class)

core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/FacetedMethodsBuilder.java

@@ -18,6 +18,7 @@
  */
 package org.apache.causeway.core.metamodel.spec.impl;
 
+import java.lang.annotation.Annotation;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
@@ -33,7 +34,9 @@
 import org.jspecify.annotations.Nullable;
 
 import org.apache.causeway.applib.annotation.Action;
+import org.apache.causeway.applib.annotation.Collection;
 import org.apache.causeway.applib.annotation.Introspection.IntrospectionPolicy;
+import org.apache.causeway.applib.annotation.Property;
 import org.apache.causeway.applib.exceptions.unrecoverable.MetaModelException;
 import org.apache.causeway.commons.collections.Can;
 import org.apache.causeway.commons.internal.base._NullSafe;
@@ -216,6 +219,10 @@ private void createCollectionFacetedMethodsFromAccessors(
         var mmc = getMetaModelContext();
 
         for (final ResolvedMethod accessorMethod : accessorMethods) {
+            if(!satisfiesIntrospectionPolicy(accessorMethod, Collection.class)) {
+                continue;
+            }
+
             if (log.isDebugEnabled()) {
                 log.debug("  identified accessor method representing collection: {}", accessorMethod);
             }
@@ -240,7 +247,9 @@ private void createCollectionFacetedMethodsFromAccessors(
                     .orElse(Object.class);
 
             // skip if class substitutor says so
-            if (classSubstitutorRegistry.getSubstitution(elementType).isNeverIntrospect()) continue;
+            if (classSubstitutorRegistry.getSubstitution(elementType).isNeverIntrospect()) {
+                continue;
+            }
 
             onNewFacetMethod.accept(facetedMethod.withElementType(elementType));
         }
@@ -251,12 +260,18 @@ private void createPropertyFacetedMethodsFromAccessors(
             final Consumer<FacetedMethod> onNewFacetedMethod) throws MetaModelException {
 
         for (final ResolvedMethod accessorMethod : accessorMethods) {
+            if(!satisfiesIntrospectionPolicy(accessorMethod, Property.class)) {
+                continue;
+            }
+
             log.debug("  identified accessor method representing property: {}", accessorMethod);
 
             final Class<?> returnType = accessorMethod.returnType();
 
             // skip if class strategy says so.
-            if (classSubstitutorRegistry.getSubstitution(returnType).isNeverIntrospect()) continue;
+            if (classSubstitutorRegistry.getSubstitution(returnType).isNeverIntrospect()) {
+                continue;
+            }
 
             // create a 1:1 association peer
             var facetedMethod = FacetedMethod
@@ -369,18 +384,32 @@ private boolean isAllParamTypesValid(final MethodFacade actionMethod) {
         return true;
     }
 
+    /**
+     * At time of writing only filtering for Java Records, 
+     * because those have not type-hierarchy 
+     * (except potentially interfaces), 
+     * where the check for explicit annotations is simple.
+     */
+    private <A extends Annotation> boolean satisfiesIntrospectionPolicy(
+            final ResolvedMethod accessorMethod,
+            final Class<A> requiredAnnotationType) {
+        return inspectedTypeSpec.getCorrespondingClass().isRecord()
+                && introspectionPolicy().getMemberAnnotationPolicy().isMemberAnnotationsRequired()
+            ? _Annotations.isPresent(accessorMethod.method(), requiredAnnotationType)
+            : true;
+    }
+
     private boolean representsAction(final ResolvedMethod actionMethod) {
 
         //[CAUSEWAY-3556] if this throws, we have a framework bug (synthetic methods should no longer appear here)
         _Reflect.guardAgainstSynthetic(actionMethod.method());
 
         // ensure we can load returned element type; otherwise ignore method
         var anyLoadedAsNull = TypeExtractor.streamMethodReturn(actionMethod)
-        .map(typeToLoad->specLoaderInternal().loadSpecification(typeToLoad, IntrospectionRequest.TYPE_ONLY))
-        .anyMatch(Objects::isNull);
-        if (anyLoadedAsNull) {
+            .map(typeToLoad->specLoaderInternal().loadSpecification(typeToLoad, IntrospectionRequest.TYPE_ONLY))
+            .anyMatch(Objects::isNull);
+        if (anyLoadedAsNull)
             return false;
-        }
 
         if(isMixinMain(actionMethod)) {
             // we are introspecting a mixin type and its main method,
@@ -431,10 +460,9 @@ private boolean isMixinMain(final ResolvedMethod method) {
                 .orElse(null);
         if(mixinFacet==null) return false;
 
-        if(!inspectedTypeSpec.isFullyIntrospected()) {
+        if(!inspectedTypeSpec.isFullyIntrospected())
             // members are not introspected yet, so make a guess
             return mixinFacet.isCandidateForMain(method);
-        }
 
         return inspectedTypeSpec
                 .lookupMixedInAction(inspectedTypeSpec)