Adding a registry that maps command names to their flags #4332

uglide · 2025-10-20T10:42:46Z

Introduces command flags to simplify command routing.

Copilot

Pull Request Overview

This PR introduces a command flags feature to the Jedis library by adding a static registry that maps Redis command names to their flags. The implementation retrieves command metadata from a Redis server and automatically generates flag mappings.

Adds a code generator that connects to Redis servers to extract command metadata and generate flag mappings
Implements a static command flags registry in CommandObject.java with comprehensive command coverage
Provides a getFlags() method for runtime flag lookup with optimized memory usage through shared EnumSet instances

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
src/test/java/redis/clients/jedis/codegen/README.md	Documentation for the command flags registry generator tool
src/test/java/redis/clients/jedis/codegen/CommandFlagsRegistryGenerator.java	Code generator that retrieves Redis command metadata and updates the static registry
src/main/java/redis/clients/jedis/CommandObject.java	Core implementation with CommandFlag enum, static registry, and getFlags() method
pom.xml	Maven configuration to exclude code generators from test execution

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/test/java/redis/clients/jedis/codegen/CommandFlagsRegistryGenerator.java

src/main/java/redis/clients/jedis/CommandObject.java

github-actions · 2025-10-20T12:19:41Z

Test Results

281 files +1 281 suites +1 11m 41s ⏱️ -6s
10 197 tests +9 9 132 ✅ - 591 1 065 💤 +600 0 ❌ ±0
2 712 runs +9 2 712 ✅ + 9 0 💤 ± 0 0 ❌ ±0

Results for commit fdf00b5. ± Comparison against base commit 4776709.

This pull request skips 600 tests.

redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[1] ‑ testHgetdel
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[1] ‑ testHgetdelBinary
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[1] ‑ testHgetex
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[1] ‑ testHgetexBinary
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[1] ‑ testHsetex
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[1] ‑ testHsetexBinary
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[2] ‑ testHgetdel
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[2] ‑ testHgetdelBinary
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[2] ‑ testHgetex
redis.clients.jedis.commands.commandobjects.CommandObjectsHashCommandsTest[2] ‑ testHgetexBinary
…

♻️ This comment has been updated with latest results.

ggivo

Looks good.

For better traceability, I would suggest placing the generated code in a dedicated file.
Additionally, wrapping command metadata in in an interface (CommandMetadataRegistry.getFlag()) and providing it as an configurabel instance within CommandObject would be beneficial. The auto-generated registry can serve as the default, but users could replace it with a custom implementation if needed — for example, dynamically loading it from the server or providing a user-defined version.

atakavci

Adding the version of server - the generator running against- as part of generated content would be nice as well.

atakavci · 2025-10-20T13:59:35Z

src/main/java/redis/clients/jedis/CommandObject.java


 public class CommandObject<T> {

+    /**


lets not do this and put everything into a seperate completely auto-generate class like CommandFlagRegistry or some provider class,, and use generated content at once without need of regex or any other searching/parsing. Then just consume it from CommandObject as needed.

- Add new interface and move CommandFlag enum there - Generate StaticCommandFlagsRegistry instead of embedding generated code into CommandObject - Allow passing custom CommandFlagsRegistry to ClusterClientBuilder

ggivo · 2025-10-29T05:57:20Z

src/main/java/redis/clients/jedis/StaticCommandFlagsRegistry.java

+  public EnumSet<CommandFlag> getFlags(ProtocolCommand cmd) {
+    byte[] raw = cmd.getRaw();
+    String commandName = SafeEncoder.encode(raw).toUpperCase();
+    return COMMAND_FLAGS_REGISTRY.getOrDefault(commandName, EMPTY_FLAGS);
+  }


This does not seem to work for subcommands like "CLUSTER INFO", "CONFIG GET" ...
In this case, ProtocolCommand is actually only "CLUSTER"

I've addressed this problem. See my latest commit ff09e22

… im/introduce-command-flags

…atic registry

… im/introduce-command-flags

ggivo · 2025-11-05T07:40:57Z

@uglide
I suggest also separating generated code (populating the StaticRegistry) from actual implmenattion so it is easier for maintaining in future
You can check PR with proposal against your branch here : : #4345

…rom actual implementation (#4345) * (clean up) Extract generated registry initialization * regenerate after clean up * reformat

ggivo

LGTM

Add commands flags based on static map

91bb8b1

uglide requested a review from Copilot October 20, 2025 10:42

Copilot AI reviewed Oct 20, 2025

View reviewed changes

uglide added 2 commits October 20, 2025 12:59

Clean up CommandFlagsRegistryGenerator

a70d8c9

more fixes to CommandFlagsRegistryGenerator

51c62d5

uglide force-pushed the im/introduce-command-flags branch from e8157fa to 51c62d5 Compare October 20, 2025 10:59

uglide mentioned this pull request Oct 20, 2025

Align Search APIs and behaviour with Redis 8.0+ #4173

Open

Merge branch 'master' into im/introduce-command-flags

b96f9f7

ggivo reviewed Oct 20, 2025

View reviewed changes

atakavci reviewed Oct 20, 2025

View reviewed changes

uglide and others added 3 commits October 24, 2025 17:08

Introduce CommandFlagsRegistry interface

acb6cfd

- Add new interface and move CommandFlag enum there - Generate StaticCommandFlagsRegistry instead of embedding generated code into CommandObject - Allow passing custom CommandFlagsRegistry to ClusterClientBuilder

Fix formatting

6b0efcc

Merge branch 'master' into im/introduce-command-flags

879cb0b

ggivo reviewed Oct 29, 2025

View reviewed changes

uglide and others added 7 commits November 3, 2025 09:48

Add support for sub-commands

ff09e22

Merge remote-tracking branch 'origin/im/introduce-command-flags' into…

bd77e1d

… im/introduce-command-flags

Use CommandArguments in the interface and hierarchical approach in st…

09d63d5

…atic registry

Expose get() on CommandArguments for cleaner code

5d37c0d

Merge branch 'master' into im/introduce-command-flags

946f02a

Use byte array based look up to improve performance

8646d1e

Merge remote-tracking branch 'origin/im/introduce-command-flags' into…

c7672dc

… im/introduce-command-flags

ggivo and others added 3 commits November 5, 2025 09:56

(clean up) Separate generated command flags registry initialisation f…

bb7bb39

…rom actual implementation (#4345) * (clean up) Extract generated registry initialization * regenerate after clean up * reformat

Clean up StaticCommandFlagsRegistry

2a0ee21

Merge branch 'master' into im/introduce-command-flags

fdf00b5

uglide merged commit dea46c5 into master Nov 5, 2025
15 checks passed

uglide deleted the im/introduce-command-flags branch November 5, 2025 10:09

ggivo reviewed Nov 5, 2025

View reviewed changes

ggivo changed the title ~~Add commands flags based on static map~~ Adding a registry that maps command names to their flags Nov 20, 2025

ggivo added this to the 7.1.0 milestone Nov 20, 2025

Adding a registry that maps command names to their flags #4332

Adding a registry that maps command names to their flags #4332

Uh oh!

Conversation

uglide commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

ggivo left a comment

Choose a reason for hiding this comment

Uh oh!

atakavci left a comment

Choose a reason for hiding this comment

Uh oh!

atakavci Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

uglide Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

ggivo Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

uglide Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

ggivo commented Nov 5, 2025

Uh oh!

Uh oh!

ggivo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

uglide commented Oct 20, 2025 •

edited

Loading

github-actions bot commented Oct 20, 2025 •

edited

Loading