Undo some of Jedis 5 breaking changes (#3436)

sazzad16 · web-flow · commit 1da50e081806 · 2023-05-24T16:59:52.000+06:00
diff --git a/docs/jedis5-breaking.md b/docs/jedis5-breaking.md
@@ -1,7 +1,5 @@
 # Jedis 5 Breaking Changes
 
-- `StreamConsumersInfo` has been renamed to `StreamConsumerInfo`.
-
 - `bzpopmax(double timeout, byte[]... keys)` now returns `List<Object>` (instead of `List<byte[]>`).
   - This is a three element list where the last element is a `Double`.
 
@@ -12,11 +10,8 @@
 
 - `graphSlowlog(String graphName)` now returns `List<List<Object>>` (instead of `List<List<String>>`).
 
-- `List<Object> getUnflushedObjectMultiBulkReply()` method has been removed from `Connection`.
-  - `Object getUnflushedObject()` method has been added instead.
+- All _payload_ related parameters are removed from _search_ related classes; namely `Document`, `IndexDefinition`, `Query`.
 
-- `STREAM_INFO_FULL` in BuilderFactory has been renamed to `STREAM_FULL_INFO`.
-- `STREAM_CONSUMERS_INFO_LIST` in BuilderFactory has been renamed to `STREAM_CONSUMER_INFO_LIST`.
 - `STREAM_AUTO_CLAIM_ID_RESPONSE` in BuilderFactory has been renamed to `STREAM_AUTO_CLAIM_JUSTID_RESPONSE`.
 
 - Following BuilderFactory implementations have been removed:
diff --git a/src/main/java/redis/clients/jedis/BuilderFactory.java b/src/main/java/redis/clients/jedis/BuilderFactory.java
@@ -1341,27 +1341,29 @@ public String toString() {
     }
   };
 
-  public static final Builder<List<StreamConsumerInfo>> STREAM_CONSUMER_INFO_LIST = new Builder<List<StreamConsumerInfo>>() {
+  // TODO: rename to STREAM_CONSUMER_INFO_LIST ?
+  public static final Builder<List<StreamConsumersInfo>> STREAM_CONSUMERS_INFO_LIST
+      = new Builder<List<StreamConsumersInfo>>() {
 
     Map<String, Builder> mappingFunctions = createDecoderMap();
 
     private Map<String, Builder> createDecoderMap() {
       Map<String, Builder> tempMappingFunctions = new HashMap<>();
-      tempMappingFunctions.put(StreamConsumerInfo.NAME, STRING);
-      tempMappingFunctions.put(StreamConsumerInfo.IDLE, LONG);
-      tempMappingFunctions.put(StreamConsumerInfo.PENDING, LONG);
+      tempMappingFunctions.put(StreamConsumersInfo.NAME, STRING);
+      tempMappingFunctions.put(StreamConsumersInfo.IDLE, LONG);
+      tempMappingFunctions.put(StreamConsumersInfo.PENDING, LONG);
       return tempMappingFunctions;
 
     }
 
     @Override
     @SuppressWarnings("unchecked")
-    public List<StreamConsumerInfo> build(Object data) {
+    public List<StreamConsumersInfo> build(Object data) {
       if (null == data) {
         return null;
       }
 
-      List<StreamConsumerInfo> list = new ArrayList<>();
+      List<StreamConsumersInfo> list = new ArrayList<>();
       List<Object> streamsEntries = (List<Object>) data;
       Iterator<Object> groupsArray = streamsEntries.iterator();
 
@@ -1371,7 +1373,7 @@ public List<StreamConsumerInfo> build(Object data) {
 
         Iterator<Object> consumerInfoIterator = groupInfo.iterator();
 
-        StreamConsumerInfo streamGroupInfo = new StreamConsumerInfo(
+        StreamConsumersInfo streamGroupInfo = new StreamConsumersInfo(
             createMapFromDecodingFunctions(consumerInfoIterator, mappingFunctions));
         list.add(streamGroupInfo);
 
@@ -1475,7 +1477,8 @@ public String toString() {
     }
   };
 
-  public static final Builder<StreamFullInfo> STREAM_FULL_INFO = new Builder<StreamFullInfo>() {
+  // TODO: raname to STREAM_FULL_INFO ?
+  public static final Builder<StreamFullInfo> STREAM_INFO_FULL = new Builder<StreamFullInfo>() {
 
     final Map<String, Builder> mappingFunctions = createDecoderMap();
 
diff --git a/src/main/java/redis/clients/jedis/CommandObjects.java b/src/main/java/redis/clients/jedis/CommandObjects.java
@@ -2564,11 +2564,11 @@ public final CommandObject<Object> xinfoStream(byte[] key) {
   }
 
   public final CommandObject<StreamFullInfo> xinfoStreamFull(String key) {
-    return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL), BuilderFactory.STREAM_FULL_INFO);
+    return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL), BuilderFactory.STREAM_INFO_FULL);
   }
 
   public final CommandObject<StreamFullInfo> xinfoStreamFull(String key, int count) {
-    return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL).add(COUNT).add(count), BuilderFactory.STREAM_FULL_INFO);
+    return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL).add(COUNT).add(count), BuilderFactory.STREAM_INFO_FULL);
   }
 
   public final CommandObject<Object> xinfoStreamFull(byte[] key, int count) {
@@ -2587,8 +2587,8 @@ public final CommandObject<List<Object>> xinfoGroups(byte[] key) {
     return new CommandObject<>(commandArguments(XINFO).add(GROUPS).key(key), BuilderFactory.RAW_OBJECT_LIST);
   }
 
-  public final CommandObject<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {
-    return new CommandObject<>(commandArguments(XINFO).add(CONSUMERS).key(key).add(group), BuilderFactory.STREAM_CONSUMER_INFO_LIST);
+  public final CommandObject<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {
+    return new CommandObject<>(commandArguments(XINFO).add(CONSUMERS).key(key).add(group), BuilderFactory.STREAM_CONSUMERS_INFO_LIST);
   }
 
   public final CommandObject<List<Object>> xinfoConsumers(byte[] key, byte[] group) {
diff --git a/src/main/java/redis/clients/jedis/Connection.java b/src/main/java/redis/clients/jedis/Connection.java
@@ -302,11 +302,15 @@ public List<byte[]> getBinaryMultiBulkReply() {
     return (List<byte[]>) readProtocolWithCheckingBroken();
   }
 
-//  @SuppressWarnings("unchecked")
-//  public List<Object> getUnflushedObjectMultiBulkReply() {
-//    return (List<Object>) readProtocolWithCheckingBroken();
-//  }
-//
+  /**
+   * @deprecated Use {@link Connection#getUnflushedObject()}.
+   */
+  @Deprecated
+  @SuppressWarnings("unchecked")
+  public List<Object> getUnflushedObjectMultiBulkReply() {
+    return (List<Object>) readProtocolWithCheckingBroken();
+  }
+
   @SuppressWarnings("unchecked")
   public Object getUnflushedObject() {
     return readProtocolWithCheckingBroken();
diff --git a/src/main/java/redis/clients/jedis/Jedis.java b/src/main/java/redis/clients/jedis/Jedis.java
@@ -9449,7 +9449,7 @@ public List<StreamGroupInfo> xinfoGroups(String key) {
   }
 
   @Override
-  public List<StreamConsumerInfo> xinfoConsumers(String key, String group) {
+  public List<StreamConsumersInfo> xinfoConsumers(String key, String group) {
     return connection.executeCommand(commandObjects.xinfoConsumers(key, group));
   }
 
diff --git a/src/main/java/redis/clients/jedis/MultiNodePipelineBase.java b/src/main/java/redis/clients/jedis/MultiNodePipelineBase.java
@@ -1613,7 +1613,7 @@ public Response<List<StreamGroupInfo>> xinfoGroups(String key) {
   }
 
   @Override
-  public Response<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {
+  public Response<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {
     return appendCommand(commandObjects.xinfoConsumers(key, group));
   }
 
diff --git a/src/main/java/redis/clients/jedis/Pipeline.java b/src/main/java/redis/clients/jedis/Pipeline.java
@@ -1566,7 +1566,7 @@ public Response<List<StreamGroupInfo>> xinfoGroups(String key) {
   }
 
   @Override
-  public Response<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {
+  public Response<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {
     return appendCommand(commandObjects.xinfoConsumers(key, group));
   }
 
diff --git a/src/main/java/redis/clients/jedis/TransactionBase.java b/src/main/java/redis/clients/jedis/TransactionBase.java
@@ -1662,7 +1662,7 @@ public Response<List<StreamGroupInfo>> xinfoGroups(String key) {
   }
 
   @Override
-  public Response<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {
+  public Response<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {
     return appendCommand(commandObjects.xinfoConsumers(key, group));
   }
 
diff --git a/src/main/java/redis/clients/jedis/UnifiedJedis.java b/src/main/java/redis/clients/jedis/UnifiedJedis.java
@@ -2997,7 +2997,7 @@ public List<StreamGroupInfo> xinfoGroups(String key) {
   }
 
   @Override
-  public List<StreamConsumerInfo> xinfoConsumers(String key, String group) {
+  public List<StreamConsumersInfo> xinfoConsumers(String key, String group) {
     return executeCommand(commandObjects.xinfoConsumers(key, group));
   }
 
diff --git a/src/main/java/redis/clients/jedis/commands/StreamCommands.java b/src/main/java/redis/clients/jedis/commands/StreamCommands.java
@@ -225,10 +225,10 @@ Map.Entry<StreamEntryID, List<StreamEntryID>> xautoclaimJustId(String key, Strin
    * Introspection command used in order to retrieve different information about consumers in the group
    * @param key Stream name
    * @param group Group name
-   * @return List of {@link StreamConsumerInfo} containing information about consumers that belong
+   * @return List of {@link StreamConsumersInfo} containing information about consumers that belong
    * to the the group
    */
-  List<StreamConsumerInfo> xinfoConsumers(String key, String group);
+  List<StreamConsumersInfo> xinfoConsumers(String key, String group);
 
   /**
    * XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]
diff --git a/src/main/java/redis/clients/jedis/commands/StreamPipelineCommands.java b/src/main/java/redis/clients/jedis/commands/StreamPipelineCommands.java
@@ -218,10 +218,10 @@ Response<Map.Entry<StreamEntryID, List<StreamEntryID>>> xautoclaimJustId(String
    * Introspection command used in order to retrieve different information about consumers in the group
    * @param key Stream name
    * @param group Group name
-   * @return List of {@link StreamConsumerInfo} containing information about consumers that belong
+   * @return List of {@link StreamConsumersInfo} containing information about consumers that belong
    * to the the group
    */
-  Response<List<StreamConsumerInfo>> xinfoConsumers(String key, String group);
+  Response<List<StreamConsumersInfo>> xinfoConsumers(String key, String group);
 
   /**
    * XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]
diff --git a/src/main/java/redis/clients/jedis/resps/StreamConsumersInfo.java b/src/main/java/redis/clients/jedis/resps/StreamConsumersInfo.java
@@ -4,10 +4,11 @@
 
 /**
  * This class holds information about a consumer. They can be access via getters. There is also
- * {@link StreamConsumerInfo#getConsumerInfo()}} method that returns a generic {@code Map} in case
+ * {@link StreamConsumersInfo#getConsumerInfo()}} method that returns a generic {@code Map} in case
  * more info are returned from the server.
  */
-public class StreamConsumerInfo {
+// TODO: rename to StreamConsumerInfo ?
+public class StreamConsumersInfo {
 
   public static final String NAME = "name";
   public static final String IDLE = "idle";
@@ -23,7 +24,7 @@ public class StreamConsumerInfo {
   /**
    * @param map contains key-value pairs with consumer info
    */
-  public StreamConsumerInfo(Map<String, Object> map) {
+  public StreamConsumersInfo(Map<String, Object> map) {
     consumerInfo = map;
     name = (String) map.get(NAME);
     idle = (Long) map.get(IDLE);
diff --git a/src/main/java/redis/clients/jedis/search/IndexDefinition.java b/src/main/java/redis/clients/jedis/search/IndexDefinition.java
@@ -16,7 +16,6 @@ public enum Type {
   }
 
   private final Type type;
-  private boolean async = false;
   private String[] prefixes;
   private String filter;
   private String languageField;
@@ -36,15 +35,6 @@ public Type getType() {
     return type;
   }
 
-  public boolean isAsync() {
-    return async;
-  }
-
-  public IndexDefinition setAsync(boolean async) {
-    this.async = async;
-    return this;
-  }
-
   public String[] getPrefixes() {
     return prefixes;
   }
diff --git a/src/test/java/redis/clients/jedis/commands/jedis/StreamsCommandsTest.java b/src/test/java/redis/clients/jedis/commands/jedis/StreamsCommandsTest.java
@@ -802,7 +802,7 @@ public void xinfo() throws InterruptedException {
     Thread.sleep(1);
 
     List<StreamGroupInfo> groupInfo = jedis.xinfoGroups(STREAM_NAME);
-    List<StreamConsumerInfo> consumersInfo = jedis.xinfoConsumers(STREAM_NAME, G1);
+    List<StreamConsumersInfo> consumersInfo = jedis.xinfoConsumers(STREAM_NAME, G1);
 
     // Stream info test
     assertEquals(2L, streamInfo.getStreamInfo().get(StreamInfo.LENGTH));
@@ -838,9 +838,9 @@ public void xinfo() throws InterruptedException {
 
     // Consumer info test
     assertEquals(MY_CONSUMER,
-      consumersInfo.get(0).getConsumerInfo().get(StreamConsumerInfo.NAME));
-    assertEquals(0L, consumersInfo.get(0).getConsumerInfo().get(StreamConsumerInfo.PENDING));
-    assertTrue((Long) consumersInfo.get(0).getConsumerInfo().get(StreamConsumerInfo.IDLE) > 0);
+      consumersInfo.get(0).getConsumerInfo().get(StreamConsumersInfo.NAME));
+    assertEquals(0L, consumersInfo.get(0).getConsumerInfo().get(StreamConsumersInfo.PENDING));
+    assertTrue((Long) consumersInfo.get(0).getConsumerInfo().get(StreamConsumersInfo.IDLE) > 0);
 
     // Using getters
     assertEquals(MY_CONSUMER, consumersInfo.get(0).getName());
@@ -855,7 +855,7 @@ public void xinfo() throws InterruptedException {
     jedis.xreadGroup(G2, MY_CONSUMER2, XReadGroupParams.xReadGroupParams().count(1), streamQeury11);
 
     List<StreamGroupInfo> manyGroupsInfo = jedis.xinfoGroups(STREAM_NAME);
-    List<StreamConsumerInfo> manyConsumersInfo = jedis.xinfoConsumers(STREAM_NAME, G2);
+    List<StreamConsumersInfo> manyConsumersInfo = jedis.xinfoConsumers(STREAM_NAME, G2);
 
     assertEquals(2, manyGroupsInfo.size());
     assertEquals(2, manyConsumersInfo.size());

Original file line number	Diff line number	Diff line change
`@@ -2564,11 +2564,11 @@ public final CommandObject<Object> xinfoStream(byte[] key) {`
`2564`	`2564`	`}`
`2565`	`2565`
`2566`	`2566`	`public final CommandObject<StreamFullInfo> xinfoStreamFull(String key) {`
`2567`		`- return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL), BuilderFactory.STREAM_FULL_INFO);`
	`2567`	`+ return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL), BuilderFactory.STREAM_INFO_FULL);`
`2568`	`2568`	`}`
`2569`	`2569`
`2570`	`2570`	`public final CommandObject<StreamFullInfo> xinfoStreamFull(String key, int count) {`
`2571`		`- return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL).add(COUNT).add(count), BuilderFactory.STREAM_FULL_INFO);`
	`2571`	`+ return new CommandObject<>(commandArguments(XINFO).add(STREAM).key(key).add(FULL).add(COUNT).add(count), BuilderFactory.STREAM_INFO_FULL);`
`2572`	`2572`	`}`
`2573`	`2573`
`2574`	`2574`	`public final CommandObject<Object> xinfoStreamFull(byte[] key, int count) {`
`@@ -2587,8 +2587,8 @@ public final CommandObject<List<Object>> xinfoGroups(byte[] key) {`
`2587`	`2587`	`return new CommandObject<>(commandArguments(XINFO).add(GROUPS).key(key), BuilderFactory.RAW_OBJECT_LIST);`
`2588`	`2588`	`}`
`2589`	`2589`
`2590`		`- public final CommandObject<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {`
`2591`		`- return new CommandObject<>(commandArguments(XINFO).add(CONSUMERS).key(key).add(group), BuilderFactory.STREAM_CONSUMER_INFO_LIST);`
	`2590`	`+ public final CommandObject<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {`
	`2591`	`+ return new CommandObject<>(commandArguments(XINFO).add(CONSUMERS).key(key).add(group), BuilderFactory.STREAM_CONSUMERS_INFO_LIST);`
`2592`	`2592`	`}`
`2593`	`2593`
`2594`	`2594`	`public final CommandObject<List<Object>> xinfoConsumers(byte[] key, byte[] group) {`
Original file line number	Diff line number	Diff line change
`@@ -9449,7 +9449,7 @@ public List<StreamGroupInfo> xinfoGroups(String key) {`
`9449`	`9449`	`}`
`9450`	`9450`
`9451`	`9451`	`@Override`
`9452`		`- public List<StreamConsumerInfo> xinfoConsumers(String key, String group) {`
	`9452`	`+ public List<StreamConsumersInfo> xinfoConsumers(String key, String group) {`
`9453`	`9453`	`return connection.executeCommand(commandObjects.xinfoConsumers(key, group));`
`9454`	`9454`	`}`
`9455`	`9455`
Original file line number	Diff line number	Diff line change
`@@ -1613,7 +1613,7 @@ public Response<List<StreamGroupInfo>> xinfoGroups(String key) {`
`1613`	`1613`	`}`
`1614`	`1614`
`1615`	`1615`	`@Override`
`1616`		`- public Response<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {`
	`1616`	`+ public Response<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {`
`1617`	`1617`	`return appendCommand(commandObjects.xinfoConsumers(key, group));`
`1618`	`1618`	`}`
`1619`	`1619`
Original file line number	Diff line number	Diff line change
`@@ -1566,7 +1566,7 @@ public Response<List<StreamGroupInfo>> xinfoGroups(String key) {`
`1566`	`1566`	`}`
`1567`	`1567`
`1568`	`1568`	`@Override`
`1569`		`- public Response<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {`
	`1569`	`+ public Response<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {`
`1570`	`1570`	`return appendCommand(commandObjects.xinfoConsumers(key, group));`
`1571`	`1571`	`}`
`1572`	`1572`
Original file line number	Diff line number	Diff line change
`@@ -1662,7 +1662,7 @@ public Response<List<StreamGroupInfo>> xinfoGroups(String key) {`
`1662`	`1662`	`}`
`1663`	`1663`
`1664`	`1664`	`@Override`
`1665`		`- public Response<List<StreamConsumerInfo>> xinfoConsumers(String key, String group) {`
	`1665`	`+ public Response<List<StreamConsumersInfo>> xinfoConsumers(String key, String group) {`
`1666`	`1666`	`return appendCommand(commandObjects.xinfoConsumers(key, group));`
`1667`	`1667`	`}`
`1668`	`1668`
Original file line number	Diff line number	Diff line change
`@@ -2997,7 +2997,7 @@ public List<StreamGroupInfo> xinfoGroups(String key) {`
`2997`	`2997`	`}`
`2998`	`2998`
`2999`	`2999`	`@Override`
`3000`		`- public List<StreamConsumerInfo> xinfoConsumers(String key, String group) {`
	`3000`	`+ public List<StreamConsumersInfo> xinfoConsumers(String key, String group) {`
`3001`	`3001`	`return executeCommand(commandObjects.xinfoConsumers(key, group));`
`3002`	`3002`	`}`
`3003`	`3003`