Add CommandListener interface for monitoring Redis command operations

[senocak]

Since redis-om uses Jedis behind the scenes, there are 2 open pull requests on Jedis repository for a long time to implement listener, I do not think it will be merged very soon. So, implemeted basic listener in each redisearch functionallity to listen the operations

• Add redis command listener jedis#1791
• Redis command listener jedis#1972

Using in client side is very staight forward;

@Component
public class LoggingCommandListener implements CommandListener {
    private static final Logger log = LoggerFactory.getLogger(LoggingUnifiedJedis.class);

    @Override
    public void searchStarted(String indexName, Query q, FTSearchParams params) {
        try {
            final Field field = q.getClass().getDeclaredField("_queryString");
            field.setAccessible(true);
            String queryString = (String) field.get(q);
            log.info("Command Started: FT.SEARCH '{}' '{}'", indexName, queryString);
        } catch (NoSuchFieldException | IllegalAccessException e) {
            log.error("Command started on index: {} (unable to retrieve query string)", indexName);
        }
    }

    @Override
    public void searchFinished(String indexName, Query q, FTSearchParams params, SearchResult searchResult) {
        try {
            final Field field = q.getClass().getDeclaredField("_queryString");
            field.setAccessible(true);
            String queryString = (String) field.get(q);
            log.info("Command Finished: FT.SEARCH '{}' '{}' - Total result: {} ", indexName, queryString, searchResult.getTotalResults());
        } catch (NoSuchFieldException | IllegalAccessException e) {
            log.error("Command started on index: {} (unable to retrieve query string)", indexName);
        }
    }
}

[jit-ci]

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

[senocak]

@foogaro Kindly reminder please!

[bsbodden]

@foogaro Kindly reminder please!

Thanks for the PR, we will likely added to the Spring 4.0.0 upgrade release

[bsbodden]

Hi @senocak, thank you for this contribution! The CommandListener feature is a great addition for observability and debugging Redis operations.

I've reviewed the PR and have a few items that need to be addressed before we can merge:

1. Rebase Required

The PR is based on an older version of main and conflicts with recent changes. When rebased, it should pick up:

• Issue Gson.fromJson fails due to malformed JSON created by StringBuilder for projected string fields with spaces. #676 fix (Gson JSON serialization for projections)
• Issue Fails to create Indexed subfields when indexing reference fields #677 fix (indexed subfields for @reference fields)
• Issue bug: ClassCastException when using AutoComplete with both withScore() and withPayload() options #673 fix (AutoComplete with score and payload)

Please rebase onto the latest main branch.

2. Remove @Component from NoOpCommandListener

The NoOpCommandListener class has both @Component annotation and is created via @Bean @Fallback in the configuration. This creates duplicate bean definitions. Please remove the @Component annotation since the @Bean @Fallback approach is the correct pattern here.

// Remove @Component here
public class NoOpCommandListener implements CommandListener {
}

3. Add Tests for Listener Functionality

The PR adds the feature but doesn't include tests to verify the listener callbacks are actually invoked. Please add a test that:

• Creates a test listener implementation that tracks invocations
• Performs a search operation
• Verifies searchStarted and searchFinished were called with correct parameters

4. Consider Exception Handling (Optional)

Consider wrapping listener invocations in try-catch so that a failing listener doesn't break the actual Redis operation. This would make the feature more robust in production environments.

---

Once these items are addressed, we'll be happy to merge this. Thanks again for the contribution!

[senocak]

Hi @senocak, thank you for this contribution! The CommandListener feature is a great addition for observability and debugging Redis operations.

I've reviewed the PR and have a few items that need to be addressed before we can merge:

1. Rebase Required

The PR is based on an older version of main and conflicts with recent changes. When rebased, it should pick up:

• Issue Gson.fromJson fails due to malformed JSON created by StringBuilder for projected string fields with spaces. #676 fix (Gson JSON serialization for projections)
• Issue Fails to create Indexed subfields when indexing reference fields #677 fix (indexed subfields for @reference fields)
• Issue bug: ClassCastException when using AutoComplete with both withScore() and withPayload() options #673 fix (AutoComplete with score and payload)

Please rebase onto the latest main branch.

2. Remove @Component from NoOpCommandListener

The NoOpCommandListener class has both @Component annotation and is created via @Bean @Fallback in the configuration. This creates duplicate bean definitions. Please remove the @Component annotation since the @Bean @Fallback approach is the correct pattern here.

// Remove @Component here
public class NoOpCommandListener implements CommandListener {
}

3. Add Tests for Listener Functionality

The PR adds the feature but doesn't include tests to verify the listener callbacks are actually invoked. Please add a test that:

• Creates a test listener implementation that tracks invocations
• Performs a search operation
• Verifies searchStarted and searchFinished were called with correct parameters

4. Consider Exception Handling (Optional)

Consider wrapping listener invocations in try-catch so that a failing listener doesn't break the actual Redis operation. This would make the feature more robust in production environments.

Once these items are addressed, we'll be happy to merge this. Thanks again for the contribution!

Thank you @bsbodden I did every item you highlighted. If there is anything else, i surely can make them done.