README.md

@@ -13,7 +13,7 @@ A fast Golang Redis client that does auto pipelining and supports server-assiste
 * [Server-assisted client-side caching](#server-assisted-client-side-caching)
 * [Generic Object Mapping with client-side caching](./om)
 * [Cache-Aside pattern with client-side caching](./rueidisaside)
-* [Distributed Locks with client side caching](./rueidislock)
+* [Distributed Locks with client-side caching](./rueidislock)
 * [Helpers for writing tests with rueidis mock](./mock)
 * [OpenTelemetry integration](./rueidisotel)
 * [Hooks and other integrations](./rueidishook)
@@ -49,11 +49,11 @@ func main() {
 }
 ```
 
-Checkout more examples: [Command Response Cheatsheet](https://github.com/redis/rueidis#command-response-cheatsheet)
+Check out more examples: [Command Response Cheatsheet](https://github.com/redis/rueidis#command-response-cheatsheet)
 
 ## Developer Friendly Command Builder
 
-`client.B()` is the builder entrypoint to construct a redis command:
+`client.B()` is the builder entry point to construct a redis command:
 
 ![Developer friendly command builder](https://user-images.githubusercontent.com/2727535/209358313-39000aee-eaa4-42e1-9748-0d3836c1264f.gif)\
 <sub>_Recorded by @FZambia [Improving Centrifugo Redis Engine throughput and allocation efficiency with Rueidis Go library
@@ -63,15 +63,15 @@ Once a command is built, use either `client.Do()` or `client.DoMulti()` to send
 
 **You ❗️SHOULD NOT❗️ reuse the command to another `client.Do()` or `client.DoMulti()` call because it has been recycled to the underlying `sync.Pool` by default.**
 
-To reuse a command, use `Pin()` after `Build()` and it will prevent the command being recycled. 
+To reuse a command, use `Pin()` after `Build()` and it will prevent the command from being recycled.
 
 
 ## [Pipelining](https://redis.io/docs/manual/pipelining/)
 
 ### Auto Pipelining
 
 All concurrent non-blocking redis commands (such as `GET`, `SET`) are automatically pipelined,
-which reduces the overall round trips and system calls, and gets higher throughput. You can easily get the benefit
+which reduces the overall round trips and system calls and gets higher throughput. You can easily get the benefit
 of [pipelining technique](https://redis.io/docs/manual/pipelining/) by just calling `client.Do()` from multiple goroutines concurrently.
 For example:
 
@@ -89,7 +89,7 @@ func BenchmarkPipelining(b *testing.B, client rueidis.Client) {
 
 ### Benchmark comparison with go-redis v9
 
-Comparing to go-redis, Rueidis has higher throughput across 1, 8, and 64 parallelism settings.
+Compared to go-redis, Rueidis has higher throughput across 1, 8, and 64 parallelism settings.
 
 It is even able to achieve **~14x** throughput over go-redis in a local benchmark of Macbook Pro 16" M1 Pro 2021. (see `parallelism(64)-key(16)-value(64)-10`)
 
@@ -117,7 +117,7 @@ for _, resp := range client.DoMulti(ctx, cmds...) {
 
 ## [Server-Assisted Client-Side Caching](https://redis.io/docs/manual/client-side-caching/)
 
-The opt-in mode of [server-assisted client-side caching](https://redis.io/docs/manual/client-side-caching/) is enabled by default, and can be used by calling `DoCache()` or `DoMultiCache()` with client-side TTLs specified.
+The opt-in mode of [server-assisted client-side caching](https://redis.io/docs/manual/client-side-caching/) is enabled by default and can be used by calling `DoCache()` or `DoMultiCache()` with client-side TTLs specified.
 
 ```golang
 client.DoCache(ctx, client.B().Hmget().Key("mk").Field("1", "2").Cache(), time.Minute).ToArray()
@@ -126,7 +126,7 @@ client.DoMultiCache(ctx,
     rueidis.CT(client.B().Get().Key("k2").Cache(), 2*time.Minute))
 ```
 
-Cached responses will be invalidated either when being notified by redis servers or when their client side TTLs are reached.
+Cached responses, including Redis Nils, will be invalidated either when being notified by redis servers or when their client-side TTLs are reached. See https://github.com/redis/rueidis/issues/534 for more details.
 
 ### Benchmark
 
@@ -136,15 +136,15 @@ Server-assisted client-side caching can dramatically boost latencies and through
 
 Benchmark source code: https://github.com/rueian/rueidis-benchmark
 
-### Client Side Caching Helpers
+### Client-Side Caching Helpers
 
-Use `CacheTTL()` to check the remaining client side TTL in seconds:
+Use `CacheTTL()` to check the remaining client-side TTL in seconds:
 
 ```golang
 client.DoCache(ctx, client.B().Get().Key("k1").Cache(), time.Minute).CacheTTL() == 60
 ```
 
-Use `IsCacheHit()` to verify that if the response came from the client side memory:
+Use `IsCacheHit()` to verify if the response came from the client-side memory:
 
 ```golang
 client.DoCache(ctx, client.B().Get().Key("k1").Cache(), time.Minute).IsCacheHit() == true
@@ -154,12 +154,12 @@ If the OpenTelemetry is enabled by the `rueidisotel.NewClient(option)`, then the
 * rueidis_do_cache_miss
 * rueidis_do_cache_hits
 
-### MGET/JSON.MGET Client Side Caching Helpers
+### MGET/JSON.MGET Client-Side Caching Helpers
 
-`rueidis.MGetCache` and `rueidis.JsonMGetCache` are handy helpers fetching multiple keys across different slots through the client side caching.
+`rueidis.MGetCache` and `rueidis.JsonMGetCache` are handy helpers fetching multiple keys across different slots through the client-side caching.
 They will first group keys by slot to build `MGET` or `JSON.MGET` commands respectively and then send requests with only cache missed keys to redis nodes.
 
-### Broadcast Mode Client Side Caching
+### Broadcast Mode Client-Side Caching
 
 Although the default is opt-in mode, you can use broadcast mode by specifying your prefixes in `ClientOption.ClientTrackingOptions`:
 
@@ -178,7 +178,7 @@ client.DoCache(ctx, client.B().Get().Key("prefix1:1").Cache(), time.Minute).IsCa
 Please make sure that commands passed to `DoCache()` and `DoMultiCache()` are covered by your prefixes.
 Otherwise, their client-side cache will not be invalidated by redis.
 
-### Client Side Caching with Cache Aside Pattern
+### Client-Side Caching with Cache Aside Pattern
 
 Cache-Aside is a widely used caching strategy.
 [rueidisaside](https://github.com/redis/rueidis/blob/main/rueidisaside/README.md) can help you cache data into your client-side cache backed by Redis. For example:
@@ -202,15 +202,15 @@ val, err := client.Get(context.Background(), time.Minute, "mykey", func(ctx cont
 
 Please refer to the full example at [rueidisaside](https://github.com/redis/rueidis/blob/main/rueidisaside/README.md).
 
-### Disable Client Side Caching
+### Disable Client-Side Caching
 
-Some Redis provider doesn't support client-side caching, ex. Google Cloud Memorystore.
+Some Redis providers don't support client-side caching, ex. Google Cloud Memorystore.
 You can disable client-side caching by setting `ClientOption.DisableCache` to `true`.
 This will also fall back `client.DoCache()` and `client.DoMultiCache()` to `client.Do()` and `client.DoMulti()`.
 
 ## Context Cancellation
 
-`client.Do()`, `client.DoMulti()`, `client.DoCache()` and `client.DoMultiCache()` can return early if the context is canceled or the deadline is reached.
+`client.Do()`, `client.DoMulti()`, `client.DoCache()`, and `client.DoMultiCache()` can return early if the context is canceled or the deadline is reached.
 
 ```golang
 ctx, cancel := context.WithTimeout(context.Background(), time.Second)
@@ -222,45 +222,45 @@ Please note that though operations can return early, the command is likely sent
 
 ## Pub/Sub
 
-To receive messages from channels, `client.Receive()` should be used. It supports `SUBSCRIBE`, `PSUBSCRIBE` and Redis 7.0's `SSUBSCRIBE`:
+To receive messages from channels, `client.Receive()` should be used. It supports `SUBSCRIBE`, `PSUBSCRIBE`, and Redis 7.0's `SSUBSCRIBE`:
 
 ```golang
 err = client.Receive(context.Background(), client.B().Subscribe().Channel("ch1", "ch2").Build(), func(msg rueidis.PubSubMessage) {
     // handle the msg
 })
 ```
 
-The provided handler will be called with received message.
+The provided handler will be called with the received message.
 
 It is important to note that `client.Receive()` will keep blocking until returning a value in the following cases:
-1. return `nil` when received any unsubscribe/punsubscribe message related to the provided `subscribe` command.
+1. return `nil` when receiving any unsubscribe/punsubscribe message related to the provided `subscribe` command.
 2. return `rueidis.ErrClosing` when the client is closed manually.
 3. return `ctx.Err()` when the `ctx` is done.
-4. return non-nil `err` when the provided `subscribe` command failed.
+4. return non-nil `err` when the provided `subscribe` command fails.
 
 While the `client.Receive()` call is blocking, the `Client` is still able to accept other concurrent requests,
-and they are sharing the same tcp connection. If your message handler may take some time to complete, it is recommended
+and they are sharing the same TCP connection. If your message handler may take some time to complete, it is recommended
 to use the `client.Receive()` inside a `client.Dedicated()` for not blocking other concurrent requests.
 
 ### Alternative PubSub Hooks
 
 The `client.Receive()` requires users to provide a subscription command in advance.
-There is an alternative `Dedicatedclient.SetPubSubHooks()` allows users to subscribe/unsubscribe channels later.
+There is an alternative `Dedicatedclient.SetPubSubHooks()` that allows users to subscribe/unsubscribe channels later.
 
 ```golang
 c, cancel := client.Dedicate()
 defer cancel()
 
 wait := c.SetPubSubHooks(rueidis.PubSubHooks{
 	OnMessage: func(m rueidis.PubSubMessage) {
-		// Handle message. This callback will be called sequentially, but in another goroutine.
+		// Handle message. This callback will be called sequentially but in another goroutine.
 	}
 })
 c.Do(ctx, c.B().Subscribe().Channel("ch").Build())
 err := <-wait // disconnected with err
 ```
 
-If the hooks are not nil, the above `wait` channel is guaranteed to be close when the hooks will not be called anymore,
+If the hooks are not nil, the above `wait` channel is guaranteed to be closed when the hooks will not be called anymore,
 and produce at most one error describing the reason. Users can use this channel to detect disconnection.
 
 ## CAS Transaction
@@ -294,7 +294,7 @@ c, cancel := client.Dedicate()
 defer cancel()
 
 c.Do(ctx, c.B().Watch().Key("k1", "k2").Build())
-// do the rest CAS operations with the `client` who occupying a connection 
+// do the rest CAS operations with the `client` who occupies a connection
 ```
 
 However, occupying a connection is not good in terms of throughput. It is better to use [Lua script](#lua-script) to perform
@@ -304,7 +304,7 @@ optimistic locking instead.
 
 The `NewLuaScript` or `NewLuaScriptReadOnly` will create a script which is safe for concurrent usage.
 
-When calling the `script.Exec`, it will try sending `EVALSHA` first and fallback to `EVAL` if the server returns `NOSCRIPT`.
+When calling the `script.Exec`, it will try sending `EVALSHA` first and fall back to `EVAL` if the server returns `NOSCRIPT`.
 
 ```golang
 script := rueidis.NewLuaScript("return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}")
@@ -315,7 +315,7 @@ list, err := script.Exec(ctx, client, []string{"k1", "k2"}, []string{"a1", "a2"}
 ## Streaming Read
 
 `client.DoStream()` and `client.DoMultiStream()` can be used to send large redis responses to an `io.Writer`
-directly without allocating them in the memory. They work by first sending commands to a dedicated connection acquired from a pool,
+directly without allocating them to the memory. They work by first sending commands to a dedicated connection acquired from a pool,
 then directly copying the response values to the given `io.Writer`, and finally recycling the connection.
 
 ```go
@@ -329,7 +329,7 @@ for s.HasNext() {
 ```
 
 Note that these two methods will occupy connections until all responses are written to the given `io.Writer`.
-This can take a long time and hurt performance. Use the normal `Do()` and `DoMulti()` instead unless you want to avoid allocating memory for large redis response.
+This can take a long time and hurt performance. Use the normal `Do()` and `DoMulti()` instead unless you want to avoid allocating memory for a large redis response.
 
 Also note that these two methods only work with `string`, `integer`, and `float` redis responses. And `DoMultiStream` currently
 does not support pipelining keys across multiple slots when connecting to a redis cluster.
@@ -339,7 +339,7 @@ does not support pipelining keys across multiple slots when connecting to a redi
 Each underlying connection in rueidis allocates a ring buffer for pipelining.
 Its size is controlled by the `ClientOption.RingScaleEachConn` and the default value is 10 which results into each ring of size 2^10.
 
-If you have many rueidis connections, you may find that they occupy quite amount of memory.
+If you have many rueidis connections, you may find that they occupy quite an amount of memory.
 In that case, you may consider reducing `ClientOption.RingScaleEachConn` to 8 or 9 at the cost of potential throughput degradation.
 
 You may also consider setting the value of `ClientOption.PipelineMultiplex` to `-1`, which will let rueidis use only 1 connection for pipelining to each redis node.
@@ -381,7 +381,7 @@ client, err := rueidis.NewClient(rueidis.ClientOption{
 
 You can use `ParseURL` or `MustParseURL` to construct a `ClientOption`.
 
-The provided url must be started with either `redis://`, `rediss://` or `unix://`.
+The provided URL must be started with either `redis://`, `rediss://` or `unix://`.
 
 Currently supported url parameters are `db`, `dial_timeout`, `write_timeout`, `addr`, `protocol`, `client_cache`, `client_name`, `max_retries`, and `master_set`.
 
@@ -400,22 +400,22 @@ client, err = rueidis.NewClient(rueidis.MustParseURL("redis://127.0.0.1:26379/0?
 If you want to construct commands that are absent from the command builder, you can use `client.B().Arbitrary()`:
 
 ```golang
-// This will result into [ANY CMD k1 k2 a1 a2]
+// This will result in [ANY CMD k1 k2 a1 a2]
 client.B().Arbitrary("ANY", "CMD").Keys("k1", "k2").Args("a1", "a2").Build()
 ```
 
 ## Working with JSON, Raw `[]byte`, and Vector Similarity Search
 
 The command builder treats all the parameters as Redis strings, which are binary safe. This means that users can store `[]byte`
-directly into Redis without conversion. And the `rueidis.BinaryString` helper can convert `[]byte` to `string` without copy. For example:
+directly into Redis without conversion. And the `rueidis.BinaryString` helper can convert `[]byte` to `string` without copying. For example:
 
 ```golang
 client.B().Set().Key("b").Value(rueidis.BinaryString([]byte{...})).Build()
 ```
 
 Treating all the parameters as Redis strings also means that the command builder doesn't do any quoting, conversion automatically for users.
 
-When working with RedisJSON, users frequently need to prepare JSON string in Redis string. And `rueidis.JSON` can help:
+When working with RedisJSON, users frequently need to prepare JSON strings in Redis strings. And `rueidis.JSON` can help:
 
 ```golang
 client.B().JsonSet().Key("j").Path("$.myStrField").Value(rueidis.JSON("str")).Build()
@@ -434,10 +434,10 @@ n, resp, err := client.Do(ctx, cmd).AsFtSearch()
 
 ## Command Response Cheatsheet
 
-While the command builder is developer friendly, the response parser is a little unfriendly. Developers must know what
+While the command builder is developer-friendly, the response parser is a little unfriendly. Developers must know what
 type of Redis response will be returned from the server beforehand and which parser they should use. Otherwise, it panics. 
 
-It is hard to remember what type of message will be returned and which parsing to used. So, here are some common examples:
+It is hard to remember what type of message will be returned and which parsing to use. So, here are some common examples:
 
 ```golang
 // GET
@@ -518,7 +518,7 @@ for _, user := range users {
 
 ### !!!!!! DO NOT DO THIS !!!!!!
 
-Please make sure that all values in the result have same JSON structure.
+Please make sure that all values in the result have the same JSON structures.
 
 ```golang
 // Set a pure string value
@@ -531,7 +531,7 @@ users := make([]*User, 0)
 if err := rueidis.DecodeSliceOfJSON(client.Do(ctx, client.B().Mget().Key("user1").Build()), &users); err != nil {
 	return err
 }
-// -> Error: invalid character 'u' looking for beginning of value
+// -> Error: invalid character 'u' looking for the beginning of the value
 // in this case, use client.Do(ctx, client.B().Mget().Key("user1").Build()).AsStrSlice()
 ```
 

mock/go.mod

@@ -5,7 +5,7 @@ go 1.20
 replace github.com/redis/rueidis => ../
 
 require (
-	github.com/redis/rueidis v1.0.37
+	github.com/redis/rueidis v1.0.38
 	go.uber.org/mock v0.3.0
 )
 

om/go.mod

@@ -6,7 +6,7 @@ replace github.com/redis/rueidis => ../
 
 require (
 	github.com/oklog/ulid/v2 v2.1.0
-	github.com/redis/rueidis v1.0.37
+	github.com/redis/rueidis v1.0.38
 )
 
 require golang.org/x/sys v0.19.0 // indirect

pipe.go

@@ -21,7 +21,7 @@ import (
 )
 
 const LibName = "rueidis"
-const LibVer = "1.0.37"
+const LibVer = "1.0.38"
 
 var noHello = regexp.MustCompile("unknown command .?(HELLO|hello).?")
 

rueidisaside/go.mod

@@ -6,7 +6,7 @@ replace github.com/redis/rueidis => ../
 
 require (
 	github.com/oklog/ulid/v2 v2.1.0
-	github.com/redis/rueidis v1.0.37
+	github.com/redis/rueidis v1.0.38
 )
 
 require golang.org/x/sys v0.19.0 // indirect

rueidiscompat/adapter.go

@@ -43,7 +43,11 @@ import (
 	"github.com/redis/rueidis/internal/util"
 )
 
-const KeepTTL = -1
+const (
+	KeepTTL           = -1
+	BitCountIndexByte = "BYTE"
+	BitCountIndexBit  = "BIT"
+)
 
 type Cmdable interface {
 	Cache(ttl time.Duration) CacheCompat
@@ -1093,11 +1097,23 @@ func (c *Compat) SetBit(ctx context.Context, key string, offset int64, value int
 }
 
 func (c *Compat) BitCount(ctx context.Context, key string, bitCount *BitCount) *IntCmd {
+
 	var resp rueidis.RedisResult
 	if bitCount == nil {
 		resp = c.client.Do(ctx, c.client.B().Bitcount().Key(key).Build())
-	} else {
+		return newIntCmd(resp)
+	}
+
+	if bitCount.Unit == "" {
 		resp = c.client.Do(ctx, c.client.B().Bitcount().Key(key).Start(bitCount.Start).End(bitCount.End).Build())
+		return newIntCmd(resp)
+	}
+
+	switch bitCount.Unit {
+	case BitCountIndexByte:
+		resp = c.client.Do(ctx, c.client.B().Bitcount().Key(key).Start(bitCount.Start).End(bitCount.End).Byte().Build())
+	case BitCountIndexBit:
+		resp = c.client.Do(ctx, c.client.B().Bitcount().Key(key).Start(bitCount.Start).End(bitCount.End).Bit().Build())
 	}
 	return newIntCmd(resp)
 }
@@ -4584,8 +4600,19 @@ func (c CacheCompat) BitCount(ctx context.Context, key string, bitCount *BitCoun
 	var resp rueidis.RedisResult
 	if bitCount == nil {
 		resp = c.client.DoCache(ctx, c.client.B().Bitcount().Key(key).Cache(), c.ttl)
-	} else {
+		return newIntCmd(resp)
+	}
+
+	if bitCount.Unit == "" {
 		resp = c.client.DoCache(ctx, c.client.B().Bitcount().Key(key).Start(bitCount.Start).End(bitCount.End).Cache(), c.ttl)
+		return newIntCmd(resp)
+	}
+
+	switch bitCount.Unit {
+	case BitCountIndexByte:
+		resp = c.client.DoCache(ctx, c.client.B().Bitcount().Key(key).Start(bitCount.Start).End(bitCount.End).Byte().Cache(), c.ttl)
+	case BitCountIndexBit:
+		resp = c.client.DoCache(ctx, c.client.B().Bitcount().Key(key).Start(bitCount.Start).End(bitCount.End).Bit().Cache(), c.ttl)
 	}
 	return newIntCmd(resp)
 }