Skip to content

feat(bit): add BYTE/BIT option support for BITPOS command #3460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gongna-au wants to merge 3 commits into
base: unstable
Choose a base branch
from
+235 −26
Open

feat(bit): add BYTE/BIT option support for BITPOS command #3460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35e5084
feat(bit): add BYTE/BIT option support for BITPOS command (Redis 7.0+)
Apr 23, 2026
17bd362
Merge branch 'unstable' into feat-bitpos-byte-bit-option
jihuayu Apr 24, 2026
b5b37b0
Merge branch 'unstable' into feat-bitpos-byte-bit-option
jihuayu Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 18 additions & 26 deletions src/commands/cmd_bit.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,39 +156,31 @@ class CommandBitPos : public Commander {
using Commander::Parse;

Status Parse(const std::vector<std::string> &args) override {
if (args.size() >= 4) {
auto parse_start = ParseInt<int64_t>(args[3], 10);
if (!parse_start) {
return {Status::RedisParseErr, errValueNotInteger};
}
auto parse_bit = ParseInt<int>(args[2], 10);
if (!parse_bit || (*parse_bit != 0 && *parse_bit != 1)) {
return {Status::RedisParseErr, "The bit argument must be 1 or 0."};
}
bit_ = (*parse_bit == 1);

start_ = *parse_start;
if (args.size() >= 4) {
start_ = GET_OR_RET(ParseInt<int64_t>(args[3], 10));
}

if (args.size() >= 5) {
auto parse_stop = ParseInt<int64_t>(args[4], 10);
if (!parse_stop) {
return {Status::RedisParseErr, errValueNotInteger};
}

stop_ = GET_OR_RET(ParseInt<int64_t>(args[4], 10));
stop_given_ = true;
stop_ = *parse_stop;
}

if (args.size() >= 6 && util::EqualICase(args[5], "BIT")) {
is_bit_index_ = true;
}

auto parse_arg = ParseInt<int64_t>(args[2], 10);
if (!parse_arg) {
return {Status::RedisParseErr, errValueNotInteger};
}
if (*parse_arg == 0) {
bit_ = false;
} else if (*parse_arg == 1) {
bit_ = true;
} else {
return {Status::RedisParseErr, "The bit argument must be 1 or 0."};
if (args.size() == 6) {
if (util::EqualICase(args[5], "BIT")) {
is_bit_index_ = true;
} else if (util::EqualICase(args[5], "BYTE")) {
is_bit_index_ = false;
} else {
return {Status::RedisParseErr, errInvalidSyntax};
}
} else if (args.size() > 6) {
return {Status::RedisParseErr, errInvalidSyntax};
}

return Commander::Parse(args);
Expand Down
217 changes: 217 additions & 0 deletions tests/gocase/unit/type/bitmap/bitmap_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,223 @@ func TestBitmap(t *testing.T) {
require.EqualValues(t, 2, cmd.Val())
})

t.Run("BITPOS BYTE option produces same result as default byte-indexed mode", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x00\xff\xf0", 0).Err())
byteResult := rdb.BitPos(ctx, "mykey", 1, 1)
require.NoError(t, byteResult.Err())
explicitByte := rdb.BitPosSpan(ctx, "mykey", 1, 1, -1, "byte")
require.NoError(t, explicitByte.Err())
require.EqualValues(t, byteResult.Val(), explicitByte.Val())
})

t.Run("BITPOS BYTE option is case-insensitive", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x00\xff\xf0", 0).Err())
lower, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, -1, "byte").Int64()
require.NoError(t, err)
upper, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, -1, "BYTE").Int64()
require.NoError(t, err)
require.EqualValues(t, lower, upper)
})

t.Run("BITPOS BIT vs BYTE gives different results for same range", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x00\xff\xf0", 0).Err())
bitResult := rdb.BitPosSpan(ctx, "mykey", 1, 0, 15, "bit")
require.NoError(t, bitResult.Err())
require.EqualValues(t, 8, bitResult.Val())
byteResult := rdb.BitPosSpan(ctx, "mykey", 1, 0, 15, "byte")
require.NoError(t, byteResult.Err())
require.EqualValues(t, 8, byteResult.Val())
bitResult2 := rdb.BitPosSpan(ctx, "mykey", 1, 0, 7, "bit")
require.NoError(t, bitResult2.Err())
require.EqualValues(t, -1, bitResult2.Val())
byteResult2 := rdb.BitPosSpan(ctx, "mykey", 1, 0, 7, "byte")
require.NoError(t, byteResult2.Err())
require.EqualValues(t, 8, byteResult2.Val())
})

t.Run("BITPOS rejects invalid option", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, -1, "INVALID").Err()
require.Error(t, err)
})

t.Run("BITPOS rejects extra arguments after BYTE/BIT", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, -1, "BIT", "extra").Err()
require.Error(t, err)
})

t.Run("BITPOS rejects BIT unit without end offset", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x80", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, "BIT").Err()
require.ErrorContains(t, err, "not started as an integer")
})

t.Run("BITPOS rejects BYTE unit without end offset", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x80", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, "BYTE").Err()
require.ErrorContains(t, err, "not started as an integer")
})

t.Run("BITPOS rejects non-integer bit argument", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x80", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", "x").Err()
require.ErrorContains(t, err, "The bit argument must be 1 or 0")
})

t.Run("BITPOS rejects non-integer bit argument with BIT unit", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x80", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", "x", 0, 0, "BIT").Err()
require.ErrorContains(t, err, "The bit argument must be 1 or 0")
})

t.Run("BITPOS rejects bit argument of 2", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", 2).Err()
require.ErrorContains(t, err, "The bit argument must be 1 or 0")
})

t.Run("BITPOS rejects bit argument of -1", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", -1).Err()
require.ErrorContains(t, err, "The bit argument must be 1 or 0")
})

t.Run("BITPOS rejects non-integer start offset", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", 1, "abc").Err()
require.ErrorContains(t, err, "not started as an integer")
})

t.Run("BITPOS rejects non-integer end offset", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff", 0).Err())
err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, "abc").Err()
require.ErrorContains(t, err, "not started as an integer")
})

t.Run("BITPOS bit=1 with nonexistent key returns -1", func(t *testing.T) {
require.NoError(t, rdb.Del(ctx, "nosuchkey").Err())
val, err := rdb.Do(ctx, "BITPOS", "nosuchkey", 1).Int64()
require.NoError(t, err)
require.EqualValues(t, -1, val)
})

t.Run("BITPOS bit=0 with nonexistent key returns 0", func(t *testing.T) {
require.NoError(t, rdb.Del(ctx, "nosuchkey").Err())
val, err := rdb.Do(ctx, "BITPOS", "nosuchkey", 0).Int64()
require.NoError(t, err)
require.EqualValues(t, 0, val)
})

t.Run("BITPOS BYTE with negative start", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\x00\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 0, -2, -1, "BYTE").Int64()
require.NoError(t, err)
require.EqualValues(t, 8, val)
})

t.Run("BITPOS BIT with negative start and end", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\x00\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 0, -16, -9, "BIT").Int64()
require.NoError(t, err)
require.EqualValues(t, 8, val)
})

t.Run("BITPOS returns -1 when start > end after normalization", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\x00\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 2, 1, "BYTE").Int64()
require.NoError(t, err)
require.EqualValues(t, -1, val)
})

t.Run("BITPOS BIT returns -1 when start > end after normalization", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\x00\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 16, 8, "BIT").Int64()
require.NoError(t, err)
require.EqualValues(t, -1, val)
})

t.Run("BITPOS BYTE bit=0 with all-ones string and explicit end returns -1", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\xff\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 0, 0, 2, "BYTE").Int64()
require.NoError(t, err)
require.EqualValues(t, -1, val)
})

t.Run("BITPOS BIT bit=0 with all-ones string and explicit end returns -1", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\xff\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 0, 0, 23, "BIT").Int64()
require.NoError(t, err)
require.EqualValues(t, -1, val)
})

t.Run("BITPOS BYTE bit=0 without end extends past string (finds trailing zero)", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\xff\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 0).Int64()
require.NoError(t, err)
require.EqualValues(t, 24, val)
})

t.Run("BITPOS BYTE with end beyond string length clamps correctly", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x00\xff\x00", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, 100, "BYTE").Int64()
require.NoError(t, err)
require.EqualValues(t, 8, val)
})

t.Run("BITPOS BIT with end beyond string length clamps correctly", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x00\xff\x00", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 0, 999, "BIT").Int64()
require.NoError(t, err)
require.EqualValues(t, 8, val)
})

t.Run("BITPOS BYTE with only start argument", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x00\x00\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 2).Int64()
require.NoError(t, err)
require.EqualValues(t, 16, val)
})

t.Run("BITPOS BYTE with start past string returns -1 for bit=1", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 5).Int64()
require.NoError(t, err)
require.EqualValues(t, -1, val)
})

t.Run("BITPOS on wrong type returns WRONGTYPE error", func(t *testing.T) {
require.NoError(t, rdb.Del(ctx, "mylist").Err())
require.NoError(t, rdb.LPush(ctx, "mylist", "a").Err())
err := rdb.Do(ctx, "BITPOS", "mylist", 1).Err()
require.ErrorContains(t, err, "WRONGTYPE")
})

t.Run("BITPOS BYTE bit=0 finds first zero in middle byte", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\x0f\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 0, 0, 2, "BYTE").Int64()
require.NoError(t, err)
require.EqualValues(t, 8, val)
})

t.Run("BITPOS BIT bit=0 finds first zero within bit range", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\xff\x0f\xff", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 0, 8, 15, "BIT").Int64()
require.NoError(t, err)
require.EqualValues(t, 8, val)
})

t.Run("BITPOS BIT single bit precision check", func(t *testing.T) {
require.NoError(t, rdb.Set(ctx, "mykey", "\x00\x80", 0).Err())
val, err := rdb.Do(ctx, "BITPOS", "mykey", 1, 8, 8, "BIT").Int64()
require.NoError(t, err)
require.EqualValues(t, 8, val)

val, err = rdb.Do(ctx, "BITPOS", "mykey", 1, 9, 15, "BIT").Int64()
require.NoError(t, err)
require.EqualValues(t, -1, val)
})

/* Test cases adapted from redis test cases : https://github.com/redis/redis/blob/unstable/tests/unit/bitops.tcl
*/
t.Run("BITPOS bit=0 with empty key returns 0", func(t *testing.T) {
Expand Down
Loading