Merge branch 'master' into 5.2.0

Author: sazzad16

.github/CODEOWNERS

@@ -20,6 +20,8 @@ EVAL
 EVALSHA
 Failback
 Failover
+FTCreateParams
+FTSearchParams
 GSON
 GenericObjectPool
 GenericObjectPoolConfig

.github/wordlist.txt

@@ -55,6 +55,8 @@ jobs:
         env:
           JVM_OPTS: -Xmx3200m
           TERM: dumb
-      - name: Codecov
-        run: |
-          bash <(curl -s https://codecov.io/bash)
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: false
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/integration.yml

@@ -1,6 +1,6 @@
 # RediSearch Jedis Quick Start
 
-To use RediSearch features with Jedis, you'll need to use and implementation of RediSearchCommands.
+To use RediSearch features with Jedis, you'll need to use an implementation of RediSearchCommands.
 
 ## Creating the RediSearch client
 
@@ -22,6 +22,8 @@ JedisCluster client = new JedisCluster(nodes);
 
 ## Indexing and querying
 
+### Indexing
+
 Defining a schema for an index and creating it:
 
 ```java
@@ -37,6 +39,23 @@ IndexDefinition def = new IndexDefinition()
 client.ftCreate("item-index", IndexOptions.defaultOptions().setDefinition(def), sc);
 ```
 
+Alternatively, we can create the same index using FTCreateParams:
+
+```java
+client.ftCreate("item-index",
+
+        FTCreateParams.createParams()
+                .prefix("item:", "product:")
+                .filter("@price>100"),
+
+        TextField.of("title").weight(5.0),
+        TextField.of("body"),
+        NumericField.of("price")
+);
+```
+
+### Inserting
+
 Adding documents to the index:
 
 ```java
@@ -49,18 +68,37 @@ fields.put("price", 1337);
 client.hset("item:hw", RediSearchUtil.toStringMap(fields));
 ```
 
+Another way to insert documents:
+
+```java
+client.hsetObject("item:hw", fields);
+```
+
+### Querying
+
 Searching the index:
 
 ```java
-// creating a complex query
 Query q = new Query("hello world")
         .addFilter(new Query.NumericFilter("price", 0, 1000))
         .limit(0, 5);
 
-// actual search
 SearchResult sr = client.ftSearch("item-index", q);
+```
+
+Alternative searching using FTSearchParams:
 
-// aggregation query
+```java
+SearchResult sr = client.ftSearch("item-index",
+        "hello world",
+        FTSearchParams.searchParams()
+                .filter("price", 0, 1000)
+                .limit(0, 5));
+```
+
+Aggregation query:
+
+```java
 AggregationBuilder ab = new AggregationBuilder("hello")
         .apply("@price/1000", "k")
         .groupBy("@state", Reducers.avg("@k").as("avgprice"))

docs/redisearch.md

@@ -81,21 +81,37 @@ If we want to be able to query this JSON, we'll need to create an index. Let's c
 3. Then we actually create the index, called "student-index", by calling `ftCreate()`.
 
 ```java
-Schema schema = new Schema().addTextField("$.firstName", 1.0).addTextField("$" + ".lastName", 1.0);
+Schema schema = new Schema().addTextField("$.firstName", 1.0).addTextField("$.lastName", 1.0);
 
 IndexDefinition rule = new IndexDefinition(IndexDefinition.Type.JSON)
         .setPrefixes(new String[]{"student:"});
 
 client.ftCreate("student-index", IndexOptions.defaultOptions().setDefinition(rule), schema);
 ```
 
+Alternatively creating the same index using FTCreateParams: 
+
+```java
+client.ftCreate("student-index",
+        FTCreateParams.createParams().on(IndexDataType.JSON).prefix("student:"),
+        TextField.of("$.firstName"), TextField.of("$.lastName"));
+```
+
 With an index now defined, we can query our JSON. Let's find all students whose name begins with "maya":
 
 ```java
-Query q = new Query("@\\$\\" + ".firstName:maya*");
+Query q = new Query("@\\$\\.firstName:maya*");
 SearchResult mayaSearch = client.ftSearch("student-index", q);
 ```
 
+Same query can be done using FTSearchParams:
+
+```java
+SearchResult mayaSearch = client.ftSearch("student-index",
+        "@\\$\\.firstName:maya*",
+        FTSearchParams.searchParams());
+```
+
 We can then iterate over our search results:
 
 ```java

docs/redisjson.md

@@ -598,10 +598,9 @@ public String toString() {
     @Override
     @SuppressWarnings("unchecked")
     public KeyValue<String, Tuple> build(Object data) {
-      List<Object> l = (List<Object>) data; // never null
-      if (l.isEmpty()) {
-        return null;
-      }
+      if (data == null) return null;
+      List<Object> l = (List<Object>) data;
+      if (l.isEmpty()) return null;
       return KeyValue.of(STRING.build(l.get(0)), new Tuple(BINARY.build(l.get(1)), DOUBLE.build(l.get(2))));
     }
 
@@ -615,10 +614,9 @@ public String toString() {
     @Override
     @SuppressWarnings("unchecked")
     public KeyValue<byte[], Tuple> build(Object data) {
-      List<Object> l = (List<Object>) data; // never null
-      if (l.isEmpty()) {
-        return null;
-      }
+      if (data == null) return null;
+      List<Object> l = (List<Object>) data;
+      if (l.isEmpty()) return null;
       return KeyValue.of(BINARY.build(l.get(0)), new Tuple(BINARY.build(l.get(1)), DOUBLE.build(l.get(2))));
     }
 

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

@@ -71,7 +71,7 @@ public Connection(final JedisSocketFactory socketFactory, JedisClientConfig clie
 
   @Override
   public String toString() {
-    return "Connection{" + socketFactory + "}";
+    return getClass().getSimpleName() + "{" + socketFactory + "}";
   }
 
   @Experimental
@@ -80,52 +80,22 @@ public String toIdentityString() {
       return strVal;
     }
 
+    String className = getClass().getSimpleName();
     int id = hashCode();
-    String classInfo = getClass().toString();
 
     if (socket == null) {
-      StringBuilder buf = new StringBuilder(56)
-          .append("[")
-          .append(classInfo)
-          .append(", id: 0x")
-          .append(id)
-          .append(']');
-      return buf.toString();
+      return String.format("%s{id: 0x%X}", className, id);
     }
 
     SocketAddress remoteAddr = socket.getRemoteSocketAddress();
     SocketAddress localAddr = socket.getLocalSocketAddress();
     if (remoteAddr != null) {
-      StringBuilder buf = new StringBuilder(101)
-          .append("[")
-          .append(classInfo)
-          .append(", id: 0x")
-          .append(id)
-          .append(", L:")
-          .append(localAddr)
-          .append(broken ? " ! " : " - ")
-          .append("R:")
-          .append(remoteAddr)
-          .append(']');
-      strVal = buf.toString();
+      strVal = String.format("%s{id: 0x%X, L:%s %c R:%s}", className, id,
+          localAddr, (broken ? '!' : '-'), remoteAddr);
     } else if (localAddr != null) {
-      StringBuilder buf = new StringBuilder(64)
-          .append("[")
-          .append(classInfo)
-          .append(", id: 0x")
-          .append(id)
-          .append(", L:")
-          .append(localAddr)
-          .append(']');
-      strVal = buf.toString();
+      strVal = String.format("%s{id: 0x%X, L:%s}", className, id, localAddr);
     } else {
-      StringBuilder buf = new StringBuilder(56)
-          .append("[")
-          .append(classInfo)
-          .append(", id: 0x")
-          .append(id)
-          .append(']');
-      strVal = buf.toString();
+      strVal = String.format("%s{id: 0x%X}", className, id);
     }
 
     strValActive = broken;
@@ -154,7 +124,7 @@ public void setSoTimeout(int soTimeout) {
       try {
         this.socket.setSoTimeout(soTimeout);
       } catch (SocketException ex) {
-        broken = true;
+        setBroken();
         throw new JedisConnectionException(ex);
       }
     }
@@ -167,7 +137,7 @@ public void setTimeoutInfinite() {
       }
       socket.setSoTimeout(infiniteSoTimeout);
     } catch (SocketException ex) {
-      broken = true;
+      setBroken();
       throw new JedisConnectionException(ex);
     }
   }
@@ -176,7 +146,7 @@ public void rollbackTimeout() {
     try {
       socket.setSoTimeout(this.soTimeout);
     } catch (SocketException ex) {
-      broken = true;
+      setBroken();
       throw new JedisConnectionException(ex);
     }
   }
@@ -243,7 +213,7 @@ public void sendCommand(final CommandArguments args) {
          */
       }
       // Any other exceptions related to connection?
-      broken = true;
+      setBroken();
       throw ex;
     }
   }
@@ -396,7 +366,7 @@ protected void flush() {
     try {
       outputStream.flush();
     } catch (IOException ex) {
-      broken = true;
+      setBroken();
       throw new JedisConnectionException(ex);
     }
   }
@@ -436,7 +406,7 @@ protected void readPushesWithCheckingBroken() {
       broken = true;
       throw new JedisConnectionException("Failed to check buffer on connection.", e);
     } catch (JedisConnectionException exc) {
-      broken = true;
+      setBroken();
       throw exc;
     }
   }
@@ -522,8 +492,8 @@ protected void initializeFromClientConfig(final JedisClientConfig config) {
         }
       }
 
-      // set readonly flag to ALL connections (including master nodes) when enable read from replica
-      if (config.isReadOnlyForReplica()) {
+      // set READONLY flag to ALL connections (including master nodes) when enable read from replica
+      if (config.isReadOnlyForRedisClusterReplicas()) {
         fireAndForgetMsg.add(new CommandArguments(Command.READONLY));
       }
 

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

@@ -26,13 +26,13 @@ public final class DefaultJedisClientConfig implements JedisClientConfig {
 
   private final ClientSetInfoConfig clientSetInfoConfig;
 
-  private final boolean readOnlyForReplica;
+  private final boolean readOnlyForRedisClusterReplicas;
 
   private DefaultJedisClientConfig(RedisProtocol protocol, int connectionTimeoutMillis, int soTimeoutMillis,
       int blockingSocketTimeoutMillis, Supplier<RedisCredentials> credentialsProvider, int database,
       String clientName, boolean ssl, SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
       HostnameVerifier hostnameVerifier, HostAndPortMapper hostAndPortMapper,
-      ClientSetInfoConfig clientSetInfoConfig, boolean readOnlyForReplica) {
+      ClientSetInfoConfig clientSetInfoConfig, boolean readOnlyForRedisClusterReplicas) {
     this.redisProtocol = protocol;
     this.connectionTimeoutMillis = connectionTimeoutMillis;
     this.socketTimeoutMillis = soTimeoutMillis;
@@ -46,7 +46,7 @@ private DefaultJedisClientConfig(RedisProtocol protocol, int connectionTimeoutMi
     this.hostnameVerifier = hostnameVerifier;
     this.hostAndPortMapper = hostAndPortMapper;
     this.clientSetInfoConfig = clientSetInfoConfig;
-    this.readOnlyForReplica = readOnlyForReplica;
+    this.readOnlyForRedisClusterReplicas = readOnlyForRedisClusterReplicas;
   }
 
   @Override
@@ -126,8 +126,8 @@ public ClientSetInfoConfig getClientSetInfoConfig() {
   }
 
   @Override
-  public boolean isReadOnlyForReplica() {
-    return readOnlyForReplica;
+  public boolean isReadOnlyForRedisClusterReplicas() {
+    return readOnlyForRedisClusterReplicas;
   }
 
   public static Builder builder() {
@@ -157,7 +157,7 @@ public static class Builder {
 
     private ClientSetInfoConfig clientSetInfoConfig = ClientSetInfoConfig.DEFAULT;
 
-    private boolean readOnlyForReplicas = false;
+    private boolean readOnlyForRedisClusterReplicas = false;
 
     private Builder() {
     }
@@ -171,7 +171,7 @@ public DefaultJedisClientConfig build() {
       return new DefaultJedisClientConfig(redisProtocol, connectionTimeoutMillis, socketTimeoutMillis,
           blockingSocketTimeoutMillis, credentialsProvider, database, clientName, ssl,
           sslSocketFactory, sslParameters, hostnameVerifier, hostAndPortMapper, clientSetInfoConfig,
-          readOnlyForReplicas);
+          readOnlyForRedisClusterReplicas);
     }
 
     /**
@@ -267,8 +267,8 @@ public Builder clientSetInfoConfig(ClientSetInfoConfig setInfoConfig) {
       return this;
     }
 
-    public Builder readOnlyForReplicas() {
-      this.readOnlyForReplicas = true;
+    public Builder readOnlyForRedisClusterReplicas() {
+      this.readOnlyForRedisClusterReplicas = true;
       return this;
     }
   }
@@ -290,6 +290,6 @@ public static DefaultJedisClientConfig copyConfig(JedisClientConfig copy) {
         copy.getBlockingSocketTimeoutMillis(), copy.getCredentialsProvider(),
         copy.getDatabase(), copy.getClientName(), copy.isSsl(), copy.getSslSocketFactory(),
         copy.getSslParameters(), copy.getHostnameVerifier(), copy.getHostAndPortMapper(),
-        copy.getClientSetInfoConfig(), copy.isReadOnlyForReplica());
+        copy.getClientSetInfoConfig(), copy.isReadOnlyForRedisClusterReplicas());
   }
 }