feature: handle RediSearch Dialect 3 in repositories (add @UseDialect…

… annotation for repo methods) - (resolves gh-476)

redis-om-spring/src/main/java/com/redis/om/spring/annotations/Dialect.java

@@ -0,0 +1,16 @@
+package com.redis.om.spring.annotations;
+
+public enum Dialect {
+  ONE(1),
+  TWO(2),
+  THREE(3);
+
+  private final int value;
+  Dialect(int value) {
+    this.value = value;
+  }
+
+  public int getValue() {
+    return value;
+  }
+}

redis-om-spring/src/main/java/com/redis/om/spring/annotations/UseDialect.java

@@ -0,0 +1,12 @@
+package com.redis.om.spring.annotations;
+
+
+
+import java.lang.annotation.*;
+
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+public @interface UseDialect {
+  Dialect dialect() default Dialect.ONE;
+}

redis-om-spring/src/main/java/com/redis/om/spring/repository/query/RediSearchQuery.java

@@ -3,6 +3,7 @@
 import com.github.f4b6a3.ulid.Ulid;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import com.google.gson.JsonArray;
 import com.redis.om.spring.RedisOMProperties;
 import com.redis.om.spring.annotations.*;
 import com.redis.om.spring.indexing.RediSearchIndexer;
@@ -85,6 +86,7 @@ public class RediSearchQuery implements RepositoryQuery {
   private Boolean aggregationVerbatim;
   private Gson gson;
   private boolean isNullParamQuery;
+  private Dialect dialect = Dialect.ONE;
 
   @SuppressWarnings("unchecked")
   public RediSearchQuery(//
@@ -123,6 +125,13 @@ public RediSearchQuery(//
 
     try {
       java.lang.reflect.Method method = repoClass.getMethod(queryMethod.getName(), params);
+
+      // set dialect if @UseDialect is present
+      if (method.isAnnotationPresent(UseDialect.class)) {
+        UseDialect dialectAnnotation = method.getAnnotation(UseDialect.class);
+        this.dialect = dialectAnnotation.dialect();
+      }
+
       if (method.isAnnotationPresent(com.redis.om.spring.annotations.Query.class)) {
         com.redis.om.spring.annotations.Query queryAnnotation = method.getAnnotation(
             com.redis.om.spring.annotations.Query.class);
@@ -475,10 +484,14 @@ private Object executeQuery(Object[] parameters) {
       }
     }
 
+    // Set query dialect
+    query.dialect(dialect.getValue());
+
     SearchResult searchResult = ops.search(query);
 
     // what to return
     Object result = null;
+
     if (queryMethod.getReturnedObjectType() == SearchResult.class) {
       result = searchResult;
     } else if (queryMethod.isPageQuery()) {
@@ -509,7 +522,11 @@ private Object parseDocumentResult(redis.clients.jedis.search.Document doc) {
 
     Gson gsonInstance = getGson();
 
-    return gsonInstance.fromJson(SafeEncoder.encode((byte[]) doc.get("$")), domainType);
+    return switch (dialect) {
+      case ONE, TWO -> gsonInstance.fromJson(SafeEncoder.encode((byte[]) doc.get("$")), domainType);
+      case THREE -> gsonInstance.fromJson(
+          gsonInstance.fromJson(SafeEncoder.encode((byte[]) doc.get("$")), JsonArray.class).get(0), domainType);
+    };
   }
 
   private Object executeDeleteQuery(Object[] parameters) {
@@ -538,6 +555,9 @@ private Object executeDeleteQuery(Object[] parameters) {
     aggregation.sortBy(aggregationSortedFields.toArray(new SortedField[] {}));
     aggregation.limit(0, redisOMProperties.getRepository().getQuery().getLimit());
 
+    // Set query dialect
+    aggregation.dialect(dialect.getValue());
+
     // Execute the aggregation query
     AggregationResult aggregationResult = ops.aggregate(aggregation);
 
@@ -655,6 +675,9 @@ private Object executeAggregation(Object[] parameters) {
       }
     }
 
+    // Set query dialect
+    aggregation.dialect(dialect.getValue());
+
     // execute the aggregation
     AggregationResult aggregationResult = ops.aggregate(aggregation);
 
@@ -836,6 +859,9 @@ private Object executeNullQuery(Object[] parameters) {
       }
     }
 
+    // Set query dialect
+    aggregation.dialect(dialect.getValue());
+
     // Execute the aggregation query
     AggregationResult aggregationResult = ops.aggregate(aggregation);
 

redis-om-spring/src/main/java/com/redis/om/spring/repository/query/RedisEnhancedQuery.java

@@ -89,6 +89,7 @@ public class RedisEnhancedQuery implements RepositoryQuery {
   private Long aggregationTimeout;
   private Boolean aggregationVerbatim;
   private boolean isNullParamQuery;
+  private Dialect dialect = Dialect.ONE;
 
   @SuppressWarnings("unchecked")
   public RedisEnhancedQuery(QueryMethod queryMethod, //
@@ -126,6 +127,13 @@ public RedisEnhancedQuery(QueryMethod queryMethod, //
 
     try {
       java.lang.reflect.Method method = repoClass.getDeclaredMethod(queryMethod.getName(), params);
+
+      // set dialect if @UseDialect is present
+      if (method.isAnnotationPresent(UseDialect.class)) {
+        UseDialect dialectAnnotation = method.getAnnotation(UseDialect.class);
+        this.dialect = dialectAnnotation.dialect();
+      }
+
       if (method.isAnnotationPresent(com.redis.om.spring.annotations.Query.class)) {
         com.redis.om.spring.annotations.Query queryAnnotation = method.getAnnotation(
             com.redis.om.spring.annotations.Query.class);
@@ -475,8 +483,12 @@ private Object executeQuery(Object[] parameters) {
       }
     }
 
+    // Set query dialect
+    query.dialect(dialect.getValue());
+
     SearchResult searchResult = ops.search(query);
 
+    // what to return
     Object result;
 
     if (queryMethod.getReturnedObjectType() == SearchResult.class) {
@@ -536,6 +548,9 @@ private Object executeDeleteQuery(Object[] parameters) {
     aggregation.sortBy(aggregationSortedFields.toArray(new SortedField[] {}));
     aggregation.limit(0, redisOMProperties.getRepository().getQuery().getLimit());
 
+    // Set query dialect
+    aggregation.dialect(dialect.getValue());
+
     // Execute the aggregation query
     AggregationResult aggregationResult = ops.aggregate(aggregation);
 
@@ -669,6 +684,9 @@ private Object executeAggregation(Object[] parameters) {
       }
     }
 
+    // Set query dialect
+    aggregation.dialect(dialect.getValue());
+
     // execute the aggregation
     AggregationResult aggregationResult = ops.aggregate(aggregation);
 
@@ -844,6 +862,9 @@ private Object executeNullQuery(Object[] parameters) {
       }
     }
 
+    // Set query dialect
+    aggregation.dialect(dialect.getValue());
+
     // Execute the aggregation query
     AggregationResult aggregationResult = ops.aggregate(aggregation);
 

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

@@ -0,0 +1,51 @@
+package com.redis.om.spring.annotations.document;
+
+import com.redis.om.spring.AbstractBaseDocumentTest;
+import com.redis.om.spring.fixtures.document.model.TestResultRedisModel;
+import com.redis.om.spring.fixtures.document.repository.TestResultRedisRepository;
+import com.redis.om.spring.search.stream.EntityStream;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
+import redis.clients.jedis.JedisPooled;
+import redis.clients.jedis.UnifiedJedis;
+
+import java.util.Objects;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class DialectThreeTest extends AbstractBaseDocumentTest {
+
+  @Autowired
+  TestResultRedisRepository testResultRedisRepository;
+
+  @Autowired
+  JedisConnectionFactory jedisConnectionFactory;
+
+  @Autowired
+  EntityStream es;
+
+  private UnifiedJedis jedis;
+
+  @BeforeEach
+  void cleanUp() {
+    flushSearchIndexFor(TestResultRedisModel.class);
+
+    if (testResultRedisRepository.count() == 0) {
+      testResultRedisRepository.save(TestResultRedisModel.of(123L, "123-123-123-123-123", "9_TNR290INP\\-WEE2024011124\\.xml", "REJECTED"));
+      testResultRedisRepository.save(TestResultRedisModel.of(456L, "456-456-456-456-456", "8_TNR290INP\\-WEE2024011124\\.xml", "ACCEPTED"));
+    }
+
+    jedis = new JedisPooled(Objects.requireNonNull(jedisConnectionFactory.getPoolConfig()),
+        jedisConnectionFactory.getHostName(), jedisConnectionFactory.getPort());
+  }
+
+  @Test
+  void testDialect3() {
+    var results = testResultRedisRepository.findAllByFilenameIs("9_TNR290INP\\-WEE2024011124\\.xml");
+    assertThat(results).hasSize(1);
+    var result = results.iterator().next();
+    assertThat(result.getUuid()).isEqualTo("123-123-123-123-123");
+  }
+}

redis-om-spring/src/test/java/com/redis/om/spring/annotations/hash/DialectThreeTest.java

@@ -0,0 +1,52 @@
+package com.redis.om.spring.annotations.hash;
+
+import com.redis.om.spring.AbstractBaseDocumentTest;
+import com.redis.om.spring.AbstractBaseEnhancedRedisTest;
+import com.redis.om.spring.fixtures.hash.model.TestResultRedisModel;
+import com.redis.om.spring.fixtures.hash.repository.TestResultRedisRepository;
+import com.redis.om.spring.search.stream.EntityStream;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
+import redis.clients.jedis.JedisPooled;
+import redis.clients.jedis.UnifiedJedis;
+
+import java.util.Objects;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class DialectThreeTest extends AbstractBaseEnhancedRedisTest {
+
+  @Autowired
+  TestResultRedisRepository testResultRedisRepository;
+
+  @Autowired
+  JedisConnectionFactory jedisConnectionFactory;
+
+  @Autowired
+  EntityStream es;
+
+  private UnifiedJedis jedis;
+
+  @BeforeEach
+  void cleanUp() {
+    flushSearchIndexFor(TestResultRedisModel.class);
+
+    if (testResultRedisRepository.count() == 0) {
+      testResultRedisRepository.save(TestResultRedisModel.of(123L, "123-123-123-123-123", "9_TNR290INP\\-WEE2024011124\\.xml", "REJECTED"));
+      testResultRedisRepository.save(TestResultRedisModel.of(456L, "456-456-456-456-456", "8_TNR290INP\\-WEE2024011124\\.xml", "ACCEPTED"));
+    }
+
+    jedis = new JedisPooled(Objects.requireNonNull(jedisConnectionFactory.getPoolConfig()),
+        jedisConnectionFactory.getHostName(), jedisConnectionFactory.getPort());
+  }
+
+  @Test
+  void testDialect3() {
+    var results = testResultRedisRepository.findAllByFilenameIs("9_TNR290INP\\-WEE2024011124\\.xml");
+    assertThat(results).hasSize(1);
+    var result = results.iterator().next();
+    assertThat(result.getUuid()).isEqualTo("123-123-123-123-123");
+  }
+}

redis-om-spring/src/test/java/com/redis/om/spring/fixtures/document/model/TestResultRedisModel.java

@@ -0,0 +1,30 @@
+package com.redis.om.spring.fixtures.document.model;
+
+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;
+
+@Data
+@RequiredArgsConstructor(staticName = "of")
+@NoArgsConstructor(force = true)
+@Document("TestResultRedis")
+public class TestResultRedisModel {
+  @Id
+  @Indexed
+  @NonNull
+  private Long id;
+
+  @Indexed
+  @NonNull
+  String uuid;
+
+  @Searchable
+  @NonNull
+  String filename;
+
+  @Indexed
+  @NonNull
+  String status;
+}

redis-om-spring/src/test/java/com/redis/om/spring/fixtures/document/repository/TestResultRedisRepository.java

@@ -0,0 +1,13 @@
+package com.redis.om.spring.fixtures.document.repository;
+
+import com.redis.om.spring.annotations.UseDialect;
+import com.redis.om.spring.annotations.Dialect;
+import com.redis.om.spring.fixtures.document.model.TestResultRedisModel;
+import com.redis.om.spring.repository.RedisDocumentRepository;
+
+import java.util.List;
+
+public interface TestResultRedisRepository extends RedisDocumentRepository<TestResultRedisModel, Long> {
+  @UseDialect(dialect = Dialect.THREE)
+  List<TestResultRedisModel> findAllByFilenameIs(String filename);
+}

redis-om-spring/src/test/java/com/redis/om/spring/fixtures/hash/model/TestResultRedisModel.java

@@ -0,0 +1,34 @@
+package com.redis.om.spring.fixtures.hash.model;
+
+import com.redis.om.spring.annotations.Document;
+import com.redis.om.spring.annotations.Indexed;
+import com.redis.om.spring.annotations.Searchable;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.redis.core.RedisHash;
+
+@Data
+@RequiredArgsConstructor(staticName = "of")
+@NoArgsConstructor(force = true)
+@RedisHash("TestResultRedis")
+public class TestResultRedisModel {
+  @Id
+  @Indexed
+  @NonNull
+  private Long id;
+
+  @Indexed
+  @NonNull
+  String uuid;
+
+  @Searchable
+  @NonNull
+  String filename;
+
+  @Indexed
+  @NonNull
+  String status;
+}

redis-om-spring/src/test/java/com/redis/om/spring/fixtures/hash/repository/TestResultRedisRepository.java

@@ -0,0 +1,15 @@
+package com.redis.om.spring.fixtures.hash.repository;
+
+import com.redis.om.spring.annotations.Dialect;
+import com.redis.om.spring.annotations.UseDialect;
+
+import com.redis.om.spring.fixtures.hash.model.TestResultRedisModel;
+import com.redis.om.spring.repository.RedisDocumentRepository;
+import com.redis.om.spring.repository.RedisEnhancedRepository;
+
+import java.util.List;
+
+public interface TestResultRedisRepository extends RedisEnhancedRepository<TestResultRedisModel, Long> {
+  @UseDialect(dialect = Dialect.THREE)
+  List<TestResultRedisModel> findAllByFilenameIs(String filename);
+}