feat: add CommandListener support and NoOpCommandListener implementation for Redis command monitoring

Author: senocak

redis-om-spring/src/main/java/com/redis/om/spring/RedisModulesConfiguration.java

@@ -8,6 +8,8 @@
 import java.util.List;
 import java.util.Set;
 
+import com.redis.om.spring.ops.CommandListener;
+import com.redis.om.spring.ops.NoOpCommandListener;
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -202,6 +204,7 @@ RedisModulesClient redisModulesClient( //
    * @param rmc         the Redis modules client for low-level access
    * @param template    the string Redis template for basic operations
    * @param gsonBuilder the Gson builder for JSON serialization
+   * @param commandListener a command listener for monitoring Redis commands
    * @return the Redis modules operations instance
    */
   @Bean(
@@ -215,10 +218,28 @@ RedisModulesOperations<?> redisModulesOperations( //
       StringRedisTemplate template, //
       @Qualifier(
         "omGsonBuilder"
-      ) GsonBuilder gsonBuilder) {
-    return new RedisModulesOperations<>(rmc, template, gsonBuilder);
+      ) GsonBuilder gsonBuilder, final CommandListener commandListener) {
+    return new RedisModulesOperations<>(rmc, template, gsonBuilder, commandListener);
   }
 
+    /**
+     * Provides a default implementation of the CommandListener bean.
+     * <p>
+     * This method creates a no-operation (NoOp) implementation of the CommandListener interface.
+     * It is used as a fallback when no other CommandListener bean is defined in the application context.
+     * <p>
+     * The {@code @Fallback} annotation ensures that this bean is only used when no other
+     * CommandListener bean is available, allowing developers to override it with a custom implementation if needed.
+     *
+     * @return a NoOpCommandListener instance, which performs no operations.
+     */
+    @Bean
+    @Fallback
+    public CommandListener commandListener() {
+        return new NoOpCommandListener();
+    }
+
+
   /**
    * Creates the JSON operations bean for RedisJSON commands.
    * <p>

redis-om-spring/src/main/java/com/redis/om/spring/ops/NoOpCommandListener.java

@@ -0,0 +1,7 @@
+package com.redis.om.spring.ops;
+
+import org.springframework.stereotype.Component;
+
+@Component
+public class NoOpCommandListener implements  CommandListener {
+}

redis-om-spring/src/main/java/com/redis/om/spring/ops/RedisModulesOperations.java

@@ -9,7 +9,6 @@
 import com.redis.om.spring.ops.pds.*;
 import com.redis.om.spring.ops.search.SearchOperations;
 import com.redis.om.spring.ops.search.SearchOperationsImpl;
-import java.util.Optional;
 
 /**
  * A record that provides centralized access to Redis module operations.
@@ -27,7 +26,7 @@
  * @param client      the Redis modules client for executing commands
  * @param template    the Spring Data Redis template for additional Redis operations
  * @param gsonBuilder the Gson builder for JSON serialization/deserialization configuration
- * @param commandListener An optional command listener for monitoring Redis commands
+ * @param commandListener A command listener for monitoring Redis commands
  *
  * @author Redis OM Spring Team
  * @see JSONOperations
@@ -39,7 +38,7 @@
  * @see TDigestOperations
  */
 public record RedisModulesOperations<K>(RedisModulesClient client, StringRedisTemplate template,
-                                        GsonBuilder gsonBuilder, Optional<CommandListener> commandListener) {
+                                        GsonBuilder gsonBuilder, CommandListener commandListener) {
 
   /**
    * Creates and returns operations for interacting with RedisJSON module.

redis-om-spring/src/main/java/com/redis/om/spring/ops/search/SearchOperationsImpl.java

@@ -2,7 +2,6 @@
 
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.Set;
 import com.redis.om.spring.ops.CommandListener;
 import org.springframework.data.redis.core.StringRedisTemplate;
@@ -40,18 +39,18 @@ public class SearchOperationsImpl<K> implements SearchOperations<K> {
   private final RedisModulesClient modulesClient;
   private final K index;
   private final StringRedisTemplate template;
-  private final Optional<CommandListener> commandListener;
+  private final CommandListener commandListener;
 
   /**
    * Creates a new search operations implementation.
    *
    * @param index         the search index identifier
    * @param modulesClient the Redis modules client for search operations
    * @param template      the string Redis template for additional operations
-   * @param commandListener An optional command listener for monitoring Redis commands
+   * @param commandListener A command listener for monitoring Redis commands
    */
   public SearchOperationsImpl(K index, RedisModulesClient modulesClient, StringRedisTemplate template,
-                              final Optional<CommandListener> commandListener) {
+                              final CommandListener commandListener) {
     this.index = index;
     this.modulesClient = modulesClient;
     this.search = modulesClient.clientForSearch();
@@ -61,90 +60,90 @@ public SearchOperationsImpl(K index, RedisModulesClient modulesClient, StringRed
 
     @Override
     public String createIndex(Schema schema, IndexOptions options) {
-      commandListener.ifPresent(it -> it.createIndexStarted(index.toString(), null, null, schema, options));
+      commandListener.createIndexStarted(index.toString(), null, null, schema, options);
       final String s = search.ftCreate(index.toString(), options, schema);
-      commandListener.ifPresent(it -> it.createIndexFinished(index.toString(), null, null, schema, options, s));
+      commandListener.createIndexFinished(index.toString(), null, null, schema, options, s);
       return s;
     }
 
     @Override
     public String createIndex(FTCreateParams params, List<SchemaField> fields) {
-      commandListener.ifPresent(it -> it.createIndexStarted(index.toString(), params, fields, null, null));
+      commandListener.createIndexStarted(index.toString(), params, fields, null, null);
       final String s = search.ftCreate(index.toString(), params, fields);
-      commandListener.ifPresent(it -> it.createIndexFinished(index.toString(), params, fields, null, null, s));
+      commandListener.createIndexFinished(index.toString(), params, fields, null, null, s);
       return s;
     }
 
     @Override
     @Deprecated
     public SearchResult search(Query q) {
-      commandListener.ifPresent(it -> it.searchStarted(index.toString(), q, null));
+      commandListener.searchStarted(index.toString(), q, null);
       final SearchResult searchResult = search.ftSearch(SafeEncoder.encode(index.toString()), q);
-      commandListener.ifPresent(it -> it.searchFinished(index.toString(), q, null, searchResult));
+      commandListener.searchFinished(index.toString(), q, null, searchResult);
       return searchResult;
     }
 
     @Override
     public SearchResult search(Query q, FTSearchParams params) {
-      commandListener.ifPresent(it -> it.searchStarted(index.toString(), q, null));
+      commandListener.searchStarted(index.toString(), q, null);
       final SearchResult searchResult = search.ftSearch(index.toString(), q.toString(), params);
-      commandListener.ifPresent(it -> it.searchFinished(index.toString(), q, null, searchResult));
+      commandListener.searchFinished(index.toString(), q, null, searchResult);
       return searchResult;
     }
 
     @Override
     public AggregationResult aggregate(AggregationBuilder q) {
-      commandListener.ifPresent(it -> it.aggregateStarted(index.toString(), q));
+      commandListener.aggregateStarted(index.toString(), q);
       final AggregationResult aggregationResult = search.ftAggregate(index.toString(), q);
-      commandListener.ifPresent(it -> it.aggregateFinished(index.toString(), q));
+      commandListener.aggregateFinished(index.toString(), q);
       return aggregationResult;
     }
 
     @Override
     public String cursorDelete(long cursorId) {
-      commandListener.ifPresent(it -> it.cursorDeleteStarted(index.toString(), cursorId));
+      commandListener.cursorDeleteStarted(index.toString(), cursorId);
       final String result = search.ftCursorDel(index.toString(), cursorId);
-      commandListener.ifPresent(it -> it.cursorDeleteFinished(index.toString(), cursorId, result));
+      commandListener.cursorDeleteFinished(index.toString(), cursorId, result);
       return result;
     }
 
   @Override
   public AggregationResult cursorRead(long cursorId, int count) {
-    commandListener.ifPresent(it -> it.cursorReadStarted(index.toString(), cursorId, count));
+    commandListener.cursorReadStarted(index.toString(), cursorId, count);
     final AggregationResult aggregationResult = search.ftCursorRead(index.toString(), cursorId, count);
-    commandListener.ifPresent(it -> it.cursorReadFinished(index.toString(), cursorId, count, aggregationResult));
+    commandListener.cursorReadFinished(index.toString(), cursorId, count, aggregationResult);
     return aggregationResult;
   }
 
   @Override
   public String explain(Query q) {
-    commandListener.ifPresent(it -> it.explainStarted(index.toString(), q));
+    commandListener.explainStarted(index.toString(), q);
     final String s = search.ftExplain(index.toString(), q);
-    commandListener.ifPresent(it -> it.explainFinished(index.toString(), q, s));
+    commandListener.explainFinished(index.toString(), q, s);
     return s;
   }
 
   @Override
   public Map<String, Object> getInfo() {
-    commandListener.ifPresent(it -> it.infoStarted(index.toString()));
+    commandListener.infoStarted(index.toString());
     final Map<String, Object> result = search.ftInfo(index.toString());
-    commandListener.ifPresent(it -> it.infoFinished(index.toString(), result));
+    commandListener.infoFinished(index.toString(), result);
     return result;
   }
 
   @Override
   public String dropIndex() {
-    commandListener.ifPresent(it -> it.dropIndexStarted(index.toString()));
+    commandListener.dropIndexStarted(index.toString());
     final String result = search.ftDropIndex(index.toString());
-    commandListener.ifPresent(it -> it.dropIndexFinished(index.toString(), result));
+    commandListener.dropIndexFinished(index.toString(), result);
     return result;
   }
 
   @Override
   public String dropIndexAndDocuments() {
-    commandListener.ifPresent(it -> it.dropIndexAndDocumentsStarted(index.toString()));
+    commandListener.dropIndexAndDocumentsStarted(index.toString());
     final String result = search.ftDropIndexDD(index.toString());
-    commandListener.ifPresent(it -> it.dropIndexAndDocumentsFinished(index.toString(), result));
+    commandListener.dropIndexAndDocumentsFinished(index.toString(), result);
     return result;
   }
 
@@ -155,9 +154,9 @@ public Long addSuggestion(String key, String suggestion) {
 
   @Override
   public Long addSuggestion(String key, String suggestion, double score) {
-    commandListener.ifPresent(it -> it.addSuggestionStarted(index.toString(), key, suggestion, score));
+    commandListener.addSuggestionStarted(index.toString(), key, suggestion, score);
     final long result = search.ftSugAdd(key, suggestion, score);
-    commandListener.ifPresent(it -> it.addSuggestionFinished(index.toString(), key, suggestion, score, result));
+    commandListener.addSuggestionFinished(index.toString(), key, suggestion, score, result);
     return result;
   }
 
@@ -168,7 +167,7 @@ public List<Suggestion> getSuggestion(String key, String prefix) {
 
   @Override
   public List<Suggestion> getSuggestion(String key, String prefix, AutoCompleteOptions options) {
-    commandListener.ifPresent(it -> it.getSuggestionStarted(index.toString(), key, prefix, options));
+    commandListener.getSuggestionStarted(index.toString(), key, prefix, options);
     Gson gson = modulesClient.gsonBuilder().create();
 
     if (options.isWithScore()) {
@@ -187,7 +186,7 @@ public List<Suggestion> getSuggestion(String key, String prefix, AutoCompleteOpt
                 return new Suggestion(suggestion.getElement(), suggestion.getScore());
             }
         }).toList();
-        commandListener.ifPresent(it -> it.getSuggestionFinished(index.toString(), key, prefix, options, list));
+        commandListener.getSuggestionFinished(index.toString(), key, prefix, options, list);
         return list;
     } else {
       List<String> suggestions = search.ftSugGet(key, prefix, options.isFuzzy(), options.getLimit());
@@ -205,104 +204,104 @@ public List<Suggestion> getSuggestion(String key, String prefix, AutoCompleteOpt
                 return new Suggestion(suggestion);
             }
         }).toList();
-        commandListener.ifPresent(it -> it.getSuggestionFinished(index.toString(), key, prefix, options, list));
+        commandListener.getSuggestionFinished(index.toString(), key, prefix, options, list);
         return list;
     }
   }
 
   @Override
   public Boolean deleteSuggestion(String key, String entry) {
-    commandListener.ifPresent(it -> it.deleteSuggestionStarted(index.toString(), key, entry));
+    commandListener.deleteSuggestionStarted(index.toString(), key, entry);
     final boolean result = search.ftSugDel(key, entry);
-    commandListener.ifPresent(it -> it.deleteSuggestionFinished(index.toString(), key, entry, result));
+    commandListener.deleteSuggestionFinished(index.toString(), key, entry, result);
     return result;
   }
 
   @Override
   public Long getSuggestionLength(String key) {
-    commandListener.ifPresent(it -> it.getSuggestionLengthStarted(index.toString(), key));
+    commandListener.getSuggestionLengthStarted(index.toString(), key);
     final long result = search.ftSugLen(key);
-    commandListener.ifPresent(it -> it.getSuggestionLengthFinished(index.toString(), key, result));
+    commandListener.getSuggestionLengthFinished(index.toString(), key, result);
     return result;
   }
 
   @Override
   public String alterIndex(SchemaField... fields) {
-    commandListener.ifPresent(it -> it.alterIndexStarted(index.toString(), fields));
+    commandListener.alterIndexStarted(index.toString(), fields);
     final String result = search.ftAlter(index.toString(), fields);
-    commandListener.ifPresent(it -> it.alterIndexFinished(index.toString(), fields, result));
+    commandListener.alterIndexFinished(index.toString(), fields, result);
     return result;
   }
 
   @Override
   public String setConfig(String option, String value) {
-    commandListener.ifPresent(it -> it.setConfigStarted(index.toString(), option, value));
+    commandListener.setConfigStarted(index.toString(), option, value);
     final String result = search.ftConfigSet(option, value);
-    commandListener.ifPresent(it -> it.setConfigFinished(index.toString(), option, value, result));
+    commandListener.setConfigFinished(index.toString(), option, value, result);
     return result;
   }
 
   @Override
   public Map<String, Object> getConfig(String option) {
-    commandListener.ifPresent(it -> it.getConfigStarted(index.toString(), option));
+    commandListener.getConfigStarted(index.toString(), option);
     final Map<String, Object> result = search.ftConfigGet(option);
-    commandListener.ifPresent(it -> it.getConfigFinished(index.toString(), option, result));
+    commandListener.getConfigFinished(index.toString(), option, result);
     return result;
   }
 
   @Override
   public Map<String, Object> getIndexConfig(String option) {
-    commandListener.ifPresent(it -> it.getIndexConfigStarted(index.toString(), option));
+    commandListener.getIndexConfigStarted(index.toString(), option);
     final Map<String, Object> result = search.ftConfigGet(index.toString(), option);
-    commandListener.ifPresent(it -> it.getIndexConfigFinished(index.toString(), option, result));
+    commandListener.getIndexConfigFinished(index.toString(), option, result);
     return result;
   }
 
   @Override
   public String addAlias(String name) {
-    commandListener.ifPresent(it -> it.addAliasStarted(index.toString(), name));
+    commandListener.addAliasStarted(index.toString(), name);
     final String result = search.ftAliasAdd(name, index.toString());
-    commandListener.ifPresent(it -> it.addAliasFinished(index.toString(), name, result));
+    commandListener.addAliasFinished(index.toString(), name, result);
     return result;
   }
 
   @Override
   public String updateAlias(String name) {
-    commandListener.ifPresent(it -> it.updateAliasStarted(index.toString(), name));
+    commandListener.updateAliasStarted(index.toString(), name);
     final String result = search.ftAliasUpdate(name, index.toString());
-    commandListener.ifPresent(it -> it.updateAliasFinished(index.toString(), name, result));
+    commandListener.updateAliasFinished(index.toString(), name, result);
     return result;
   }
 
   @Override
   public String deleteAlias(String name) {
-    commandListener.ifPresent(it -> it.deleteAliasStarted(index.toString(), name));
+    commandListener.deleteAliasStarted(index.toString(), name);
     final String result = search.ftAliasDel(name);
-    commandListener.ifPresent(it -> it.deleteAliasFinished(index.toString(), name, result));
+    commandListener.deleteAliasFinished(index.toString(), name, result);
     return result;
   }
 
   @Override
   public String updateSynonym(String synonymGroupId, String... terms) {
-    commandListener.ifPresent(it -> it.updateSynonymStarted(index.toString(), synonymGroupId, terms));
+    commandListener.updateSynonymStarted(index.toString(), synonymGroupId, terms);
     final String result = search.ftSynUpdate(index.toString(), synonymGroupId, terms);
-    commandListener.ifPresent(it -> it.updateSynonymFinished(index.toString(), synonymGroupId, terms, result));
+    commandListener.updateSynonymFinished(index.toString(), synonymGroupId, terms, result);
     return result;
   }
 
   @Override
   public Map<String, List<String>> dumpSynonym() {
-    commandListener.ifPresent(it -> it.dumpSynonymStarted(index.toString()));
+    commandListener.dumpSynonymStarted(index.toString());
     final Map<String, List<String>> result = search.ftSynDump(index.toString());
-    commandListener.ifPresent(it -> it.dumpSynonymFinished(index.toString(), result));
+    commandListener.dumpSynonymFinished(index.toString(), result);
     return result;
   }
 
   @Override
   public Set<String> tagVals(String field) {
-    commandListener.ifPresent(it -> it.tagValsStarted(index.toString(), field));
+    commandListener.tagValsStarted(index.toString(), field);
     final Set<String> result = search.ftTagVals(index.toString(), field);
-    commandListener.ifPresent(it -> it.tagValsFinished(index.toString(), field, result));
+    commandListener.tagValsFinished(index.toString(), field, result);
     return result;
   }