fix: no metamodel tag fields generated for @indexed Enums (resolves gh-277)

Author: bsbodden

redis-om-spring/src/main/java/com/redis/om/spring/metamodel/MetamodelGenerator.java

@@ -22,9 +22,12 @@
 import javax.lang.model.SourceVersion;
 import javax.lang.model.element.*;
 import javax.lang.model.type.DeclaredType;
+import javax.lang.model.type.TypeKind;
 import javax.lang.model.type.TypeMirror;
+import javax.lang.model.util.Elements;
 import javax.lang.model.util.Types;
 import javax.tools.Diagnostic;
+import javax.tools.Diagnostic.Kind;
 import javax.tools.JavaFileObject;
 import java.io.IOException;
 import java.io.Writer;
@@ -65,7 +68,7 @@ public synchronized void init(ProcessingEnvironment env) {
     processingEnvironment.getTypeUtils();
 
     messager = processingEnvironment.getMessager();
-    messager.printMessage(Diagnostic.Kind.NOTE, "Redis OM Spring Field Generator Processor");
+    messager.printMessage(Diagnostic.Kind.NOTE, "Redis OM Spring Entity Metamodel Generator");
 
     this.objectTypeElement = processingEnvironment.getElementUtils().getTypeElement("java.lang.Object");
   }
@@ -100,6 +103,8 @@ void generateMetaModelClass(final Element annotatedElement) throws IOException {
     final String genEntityName = entityName + "$";
     TypeName entity = TypeName.get(annotatedElement.asType());
 
+    messager.printMessage(Diagnostic.Kind.NOTE, "Generating Entity Metamodel: " + qualifiedGenEntityName);
+
     Map<? extends Element, String> enclosedFields = getInstanceFields(annotatedElement);
 
     final PackageElement packageElement = processingEnvironment.getElementUtils().getPackageOf(annotatedElement);
@@ -232,7 +237,7 @@ private List<Triple<ObjectGraphFieldSpec, FieldSpec, CodeBlock>> processFieldMet
         targetCls = ClassUtils.forName(cls, MetamodelGenerator.class.getClassLoader());
       } catch (ClassNotFoundException cnfe) {
         messager.printMessage(Diagnostic.Kind.WARNING,
-            "Processing class " + entityName + " could not resolve " + cls + " while checking for nested indexables");
+            "Processing class " + entityName + " could not resolve " + cls + " while checking for nested @Indexed");
         fieldMetamodelSpec.addAll(processNestedIndexableFields(entity, chain));
       }
 
@@ -244,6 +249,8 @@ private List<Triple<ObjectGraphFieldSpec, FieldSpec, CodeBlock>> processFieldMet
           case GEO -> targetInterceptor = GeoField.class;
           case VECTOR -> targetInterceptor = VectorField.class;
         }
+      } else if (indexed != null && targetCls == null && isEnum(processingEnv, fieldType)) {
+        targetInterceptor = TextTagField.class;
       } else if (targetCls != null) {
         //
         // Any Character class -> Tag Search Field
@@ -493,8 +500,6 @@ private Map<? extends Element, String> getInstanceFields(Element element) {
         // Todo: Filter out methods that returns void or Void
         .collect(Collectors.toMap(e -> e.getSimpleName().toString(), Function.identity()));
 
-    messager.printMessage(Diagnostic.Kind.NOTE, "getters size() ==> " + getters.size());
-
     final Set<String> isGetters = getters.values().stream()
         // todo: Filter out methods only returning boolean or Boolean
         .map(Element::getSimpleName).map(Object::toString).filter(n -> n.startsWith(IS_PREFIX)).map(n -> n.substring(2))
@@ -790,4 +795,14 @@ public static String replaceIfIllegalJavaIdentifierCharacter(final String word)
   private static final Set<String> JAVA_USED_WORDS_LOWER_CASE = Collections
       .unmodifiableSet(JAVA_USED_WORDS.stream().map(String::toLowerCase).collect(Collectors.toSet()));
 
+  private boolean isEnum(ProcessingEnvironment processingEnv, TypeMirror typeMirror) {
+    Types typeUtils = processingEnv.getTypeUtils();
+
+    Element element = typeUtils.asElement(typeMirror);
+    if (element != null) {
+      return element.getKind() == ElementKind.ENUM;
+    } else {
+      return false;
+    }
+  }
 }

redis-om-spring/src/test/java/com/redis/om/spring/annotations/document/BasicRedisDocumentMappingTest.java

@@ -591,9 +591,9 @@ void testOrderByInMethodName() {
   }
 
   @Test void testEnumsAreIndexed() {
-    DocWithEnum doc1 = DocWithEnum.of(MyJavaEnum.VALUE_1);
-    DocWithEnum doc2 = DocWithEnum.of(MyJavaEnum.VALUE_2);
-    DocWithEnum doc3 = DocWithEnum.of(MyJavaEnum.VALUE_3);
+    DocWithEnum doc1 = DocWithEnum.of(MyJavaEnum.VALUE_1, MyJavaEnum.VALUE_1);
+    DocWithEnum doc2 = DocWithEnum.of(MyJavaEnum.VALUE_2, MyJavaEnum.VALUE_2);
+    DocWithEnum doc3 = DocWithEnum.of(MyJavaEnum.VALUE_3, MyJavaEnum.VALUE_3);
 
     docWithEnumRepository.saveAll(List.of(doc1, doc2, doc3));
 

redis-om-spring/src/test/java/com/redis/om/spring/annotations/document/fixtures/DocWithEnum.java

@@ -2,6 +2,7 @@
 
 import com.redis.om.spring.annotations.Document;
 import com.redis.om.spring.annotations.Indexed;
+import com.redis.om.spring.annotations.Searchable;
 import lombok.*;
 import org.springframework.data.annotation.Id;
 
@@ -17,4 +18,8 @@ public class DocWithEnum {
   @Indexed
   @NonNull
   private MyJavaEnum enumProp;
+
+  @Searchable
+  @NonNull
+  private MyJavaEnum searchableEnumProp;
 }

redis-om-spring/src/test/java/com/redis/om/spring/metamodel/MetamodelGeneratorTest.java

@@ -218,7 +218,7 @@ void testValidDocumentUnindexed(Results results) throws IOException {
   void testValidDocumentIndexedNested(Results results) throws IOException {
     List<String> warnings = getWarningStrings(results);
     assertThat(warnings).hasSize(1).containsOnly(
-        "Processing class ValidDocumentIndexedNested could not resolve valid.Address while checking for nested indexables");
+        "Processing class ValidDocumentIndexedNested could not resolve valid.Address while checking for nested @Indexed");
 
     List<String> errors = getErrorStrings(results);
     assertAll( //