Files
go/pipeline_test.go
zeekay 6994cf05aa kv, not redis: rename the package, the extras and the URL scheme
We do not use Redis. The client was a go-redis fork and still said so
everywhere: `package redis`, `redis.NewClient`, `redis://`, `extra/redisotel`.
Consumers wrote `redis.Client` against a Valkey-backed store called KV.

  package redis            -> package kv          (93 decls)
  redis.X                  -> kv.X                (2,794 call sites)
  "redis: …" errors        -> "kv: …"             (206)
  extra/redis{otel,cmd,prometheus,census} -> extra/kv{otel,cmd,prometheus,census}
  redis:// , rediss://     -> kv:// , kvs://      (ParseURL)
  Redis*/‌*Redis* idents    -> KV*/*KV*
  REDIS_VERSION, REDIS_ENDPOINTS_CONFIG_PATH -> KV_*

I previously argued this rename was unsafe because much of it was "wire
contract". That was wrong, and the categorisation shows why: RESP command names
are GET/SET/HSET — they never contain the word. Of 5,771 occurrences only two
kinds were server-visible at all: the ParseURL scheme (we choose what we pass;
our configs already use kv://) and the CLIENT SETINFO lib-name label, which the
server merely records. Nothing here changes a byte of protocol.

Two things deliberately keep the old spelling:
  RediSearch  — names a specific external module the FT.* commands map to.
  StoreDist   — contains the letters by accident (sto-reDis-t), not the word.

Breaking for consumers by design: every import site must move redis.X -> kv.X.
Minor bump, never a major — this module stays v9 forever.
2026-07-26 08:34:19 -07:00

187 lines
4.5 KiB
Go

package kv_test
import (
"errors"
"strconv"
. "github.com/bsm/ginkgo/v2"
. "github.com/bsm/gomega"
"github.com/hanzokv/go/v9"
)
var _ = Describe("pipelining", func() {
var client *kv.Client
var pipe *kv.Pipeline
BeforeEach(func() {
client = kv.NewClient(kvOptions())
Expect(client.FlushDB(ctx).Err()).NotTo(HaveOccurred())
})
AfterEach(func() {
Expect(client.Close()).NotTo(HaveOccurred())
})
It("supports block style", func() {
var get *kv.StringCmd
cmds, err := client.Pipelined(ctx, func(pipe kv.Pipeliner) error {
get = pipe.Get(ctx, "foo")
return nil
})
Expect(err).To(Equal(kv.Nil))
Expect(cmds).To(HaveLen(1))
Expect(cmds[0]).To(Equal(get))
Expect(get.Err()).To(Equal(kv.Nil))
Expect(get.Val()).To(Equal(""))
})
It("exports queued commands", func() {
p := client.Pipeline()
cmds := p.Cmds()
Expect(cmds).To(BeEmpty())
p.Set(ctx, "foo", "bar", 0)
p.Get(ctx, "foo")
cmds = p.Cmds()
Expect(cmds).To(HaveLen(p.Len()))
Expect(cmds[0].Name()).To(Equal("set"))
Expect(cmds[1].Name()).To(Equal("get"))
cmds, err := p.Exec(ctx)
Expect(err).NotTo(HaveOccurred())
Expect(cmds).To(HaveLen(2))
Expect(cmds[0].Name()).To(Equal("set"))
Expect(cmds[0].(*kv.StatusCmd).Val()).To(Equal("OK"))
Expect(cmds[1].Name()).To(Equal("get"))
Expect(cmds[1].(*kv.StringCmd).Val()).To(Equal("bar"))
cmds = p.Cmds()
Expect(cmds).To(BeEmpty())
})
It("pipeline: basic exec", func() {
p := client.Pipeline()
p.Get(ctx, "key")
p.Set(ctx, "key", "value", 0)
p.Get(ctx, "key")
cmds, err := p.Exec(ctx)
Expect(err).To(Equal(kv.Nil))
Expect(cmds).To(HaveLen(3))
Expect(cmds[0].Err()).To(Equal(kv.Nil))
Expect(cmds[1].(*kv.StatusCmd).Val()).To(Equal("OK"))
Expect(cmds[1].Err()).NotTo(HaveOccurred())
Expect(cmds[2].(*kv.StringCmd).Val()).To(Equal("value"))
Expect(cmds[2].Err()).NotTo(HaveOccurred())
})
It("pipeline: exec pipeline when get conn failed", func() {
p := client.Pipeline()
p.Get(ctx, "key")
p.Set(ctx, "key", "value", 0)
p.Get(ctx, "key")
client.Close()
cmds, err := p.Exec(ctx)
Expect(err).To(Equal(kv.ErrClosed))
Expect(cmds).To(HaveLen(3))
for _, cmd := range cmds {
Expect(cmd.Err()).To(Equal(kv.ErrClosed))
}
client = kv.NewClient(kvOptions())
})
assertPipeline := func() {
It("returns no errors when there are no commands", func() {
_, err := pipe.Exec(ctx)
Expect(err).NotTo(HaveOccurred())
})
It("discards queued commands", func() {
pipe.Get(ctx, "key")
pipe.Discard()
cmds, err := pipe.Exec(ctx)
Expect(err).NotTo(HaveOccurred())
Expect(cmds).To(BeNil())
})
It("handles val/err", func() {
err := client.Set(ctx, "key", "value", 0).Err()
Expect(err).NotTo(HaveOccurred())
get := pipe.Get(ctx, "key")
cmds, err := pipe.Exec(ctx)
Expect(err).NotTo(HaveOccurred())
Expect(cmds).To(HaveLen(1))
val, err := get.Result()
Expect(err).NotTo(HaveOccurred())
Expect(val).To(Equal("value"))
})
It("supports custom command", func() {
pipe.Do(ctx, "ping")
cmds, err := pipe.Exec(ctx)
Expect(err).NotTo(HaveOccurred())
Expect(cmds).To(HaveLen(1))
})
It("handles large pipelines", Label("NonKVEnterprise"), func() {
for callCount := 1; callCount < 16; callCount++ {
for i := 1; i <= callCount; i++ {
pipe.SetNX(ctx, strconv.Itoa(i)+"_key", strconv.Itoa(i)+"_value", 0)
}
cmds, err := pipe.Exec(ctx)
Expect(err).NotTo(HaveOccurred())
Expect(cmds).To(HaveLen(callCount))
for _, cmd := range cmds {
Expect(cmd).To(BeAssignableToTypeOf(&kv.BoolCmd{}))
}
}
})
It("should Exec, not Do", func() {
err := pipe.Do(ctx).Err()
Expect(err).To(Equal(errors.New("kv: please enter the command to be executed")))
})
It("should process", func() {
err := pipe.Process(ctx, kv.NewCmd(ctx, "asking"))
Expect(err).To(BeNil())
Expect(pipe.Cmds()).To(HaveLen(1))
})
It("should batchProcess", func() {
err := pipe.BatchProcess(ctx, kv.NewCmd(ctx, "asking"))
Expect(err).To(BeNil())
Expect(pipe.Cmds()).To(HaveLen(1))
pipe.Discard()
Expect(pipe.Cmds()).To(HaveLen(0))
err = pipe.BatchProcess(ctx, kv.NewCmd(ctx, "asking"), kv.NewCmd(ctx, "set", "key", "value"))
Expect(err).To(BeNil())
Expect(pipe.Cmds()).To(HaveLen(2))
})
}
Describe("Pipeline", func() {
BeforeEach(func() {
pipe = client.Pipeline().(*kv.Pipeline)
})
assertPipeline()
})
Describe("TxPipeline", func() {
BeforeEach(func() {
pipe = client.TxPipeline().(*kv.Pipeline)
})
assertPipeline()
})
})