Skip to content
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

Jump to bottom

Fix value conversion for CONFIG GET. #2381

Open
wants to merge 1 commit into
base: release-1.2
Choose a base branch
from
Open

Fix value conversion for CONFIG GET. #2381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

#### Fixes

* Core: Fix RESP2 multi-node response from cluster ([#2381](https:/valkey-io/valkey-glide/pull/2381))

#### Operational Enhancements

* Java: Add modules CI ([#2388](https:/valkey-io/valkey-glide/pull/2388), [#2404](https:/valkey-io/valkey-glide/pull/2404), [#2416](https:/valkey-io/valkey-glide/pull/2416))
Expand Down
84 changes: 45 additions & 39 deletions glide-core/src/client/value_conversion.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ pub(crate) enum ExpectedReturnType<'a> {
key_type: &'a Option<ExpectedReturnType<'a>>,
value_type: &'a Option<ExpectedReturnType<'a>>,
},
// Second parameter is a function which returns true if value needs to be converted
SingleOrMultiNode(
&'a Option<ExpectedReturnType<'a>>,
Option<fn(Value) -> bool>,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how difficult it would be to change, but generally you should prefer taking a generic implementing a closure trait like F: Fn(Value) -> bool if possible because plain function pointers can't capture their environment like closures can. We don't really need the extra flexibility for our existing cases, so this isn't critical to do. Might not be worth making this change if it involves an extra Box alloc, but maybe worth a try at least.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean something like this?

pub(crate) enum ExpectedReturnType<'a, F: Fn(Value) -> bool> {
    Map {
        key_type: &'a Option<ExpectedReturnType<'a, F>>,
        value_type: &'a Option<ExpectedReturnType<'a, F>>,
    },
    // Second parameter is a function which returns true if value needs to be converted
    SingleOrMultiNode(
        &'a Option<ExpectedReturnType<'a, F>>,
        Option<F>,
    ),
...

(I also need to update all references to ExpectedReturnType type)
Or

pub(crate) enum ExpectedReturnType<'a> {
    Map {
        key_type: &'a Option<ExpectedReturnType<'a>>,
        value_type: &'a Option<ExpectedReturnType<'a>>,
    },
    // Second parameter is a function which returns true if value needs to be converted
    SingleOrMultiNode(
        &'a Option<ExpectedReturnType<'a>>,
        Option<&'a dyn Fn(Value) -> bool>,
    ),
...

),
MapOfStringToDouble,
Double,
Boolean,
Expand Down Expand Up @@ -275,12 +280,6 @@ pub(crate) fn convert_to_expected_type(
},
ExpectedReturnType::Lolwut => {
match value {
// cluster (multi-node) response - go recursive
Value::Map(map) => convert_map_entries(
map,
Some(ExpectedReturnType::BulkString),
Some(ExpectedReturnType::Lolwut),
),
// RESP 2 response
Value::BulkString(bytes) => {
let text = std::str::from_utf8(&bytes).unwrap();
Expand Down Expand Up @@ -555,19 +554,7 @@ pub(crate) fn convert_to_expected_type(
// Second part is converted as `Map[str, Map[str, int]]`
ExpectedReturnType::FunctionStatsReturnType => match value {
// TODO reuse https:/Bit-Quill/glide-for-redis/pull/331 and https:/valkey-io/valkey-glide/pull/1489
Value::Map(map) => {
if map[0].0 == Value::BulkString(b"running_script".into()) {
// already a RESP3 response - do nothing
Ok(Value::Map(map))
} else {
// cluster (multi-node) response - go recursive
convert_map_entries(
map,
Some(ExpectedReturnType::BulkString),
Some(ExpectedReturnType::FunctionStatsReturnType),
)
}
}
Value::Map(map) => Ok(Value::Map(map)),
Value::Array(mut array) if array.len() == 4 => {
let mut result: Vec<(Value, Value)> = Vec::with_capacity(2);
let running_script_info = array.remove(1);
Expand Down Expand Up @@ -892,6 +879,19 @@ pub(crate) fn convert_to_expected_type(
)
.into()),
}
ExpectedReturnType::SingleOrMultiNode(value_type, value_checker) => match value {
Value::Map(ref map) => match value_checker {
Some(func) => {
if !map.is_empty() && func(map[0].clone().1) {
convert_to_expected_type(value, Some(ExpectedReturnType::Map { key_type: &None, value_type }))
} else {
Ok(value)
}
}
None => convert_to_expected_type(value, Some(ExpectedReturnType::Map { key_type: &None, value_type })),
}
_ => convert_to_expected_type(value, *value_type),
}
}
}

Expand Down Expand Up @@ -1140,10 +1140,17 @@ pub(crate) fn expected_type_for_cmd(cmd: &Cmd) -> Option<ExpectedReturnType> {

// TODO use enum to avoid mistakes
match command.as_slice() {
b"HGETALL" | b"CONFIG GET" | b"FT.CONFIG GET" | b"HELLO" => Some(ExpectedReturnType::Map {
b"HGETALL" | b"FT.CONFIG GET" | b"HELLO" => Some(ExpectedReturnType::Map {
key_type: &None,
value_type: &None,
}),
b"CONFIG GET" => Some(ExpectedReturnType::SingleOrMultiNode(
&Some(ExpectedReturnType::Map {
key_type: &None,
value_type: &None,
}),
Some(|val| matches!(val, Value::Array(_))),
)),
b"XCLAIM" => {
if cmd.position(b"JUSTID").is_some() {
Some(ExpectedReturnType::ArrayOfStrings)
Expand Down Expand Up @@ -1227,11 +1234,17 @@ pub(crate) fn expected_type_for_cmd(cmd: &Cmd) -> Option<ExpectedReturnType> {
None
}
}
b"LOLWUT" => Some(ExpectedReturnType::Lolwut),
b"LOLWUT" => Some(ExpectedReturnType::SingleOrMultiNode(
&Some(ExpectedReturnType::Lolwut),
None,
)),
b"FUNCTION LIST" => Some(ExpectedReturnType::ArrayOfMaps(&Some(
ExpectedReturnType::ArrayOfMaps(&Some(ExpectedReturnType::StringOrSet)),
))),
b"FUNCTION STATS" => Some(ExpectedReturnType::FunctionStatsReturnType),
b"FUNCTION STATS" => Some(ExpectedReturnType::SingleOrMultiNode(
&Some(ExpectedReturnType::FunctionStatsReturnType),
Some(|val| matches!(val, Value::Array(_))),
)),
b"GEOSEARCH" => {
if cmd.position(b"WITHDIST").is_some()
|| cmd.position(b"WITHHASH").is_some()
Expand Down Expand Up @@ -1688,17 +1701,14 @@ mod tests {

#[test]
fn convert_lolwut() {
assert!(matches!(
expected_type_for_cmd(redis::cmd("LOLWUT").arg("version").arg("42")),
Some(ExpectedReturnType::Lolwut)
));

let unconverted_string : String = "\x1b[0;97;107m \x1b[0m--\x1b[0;37;47m \x1b[0m--\x1b[0;90;100m \x1b[0m--\x1b[0;30;40m \x1b[0m".into();
let expected: String = "\u{2591}--\u{2592}--\u{2593}-- ".into();
let mut cmd = redis::cmd("LOLWUT");
let conversion_type = expected_type_for_cmd(cmd.arg("version").arg("42"));

let converted_1 = convert_to_expected_type(
Value::BulkString(unconverted_string.clone().into_bytes()),
Some(ExpectedReturnType::Lolwut),
conversion_type,
);
assert_eq!(
Value::BulkString(expected.clone().into_bytes()),
Expand All @@ -1710,7 +1720,7 @@ mod tests {
format: redis::VerbatimFormat::Text,
text: unconverted_string.clone(),
},
Some(ExpectedReturnType::Lolwut),
conversion_type,
);
assert_eq!(
Value::BulkString(expected.clone().into_bytes()),
Expand All @@ -1728,16 +1738,16 @@ mod tests {
Value::BulkString(unconverted_string.clone().into_bytes()),
),
]),
Some(ExpectedReturnType::Lolwut),
conversion_type,
);
assert_eq!(
Value::Map(vec![
(
Value::BulkString("node 1".into()),
Value::SimpleString("node 1".into()),
Value::BulkString(expected.clone().into_bytes())
),
(
Value::BulkString("node 2".into()),
Value::SimpleString("node 2".into()),
Value::BulkString(expected.clone().into_bytes())
),
]),
Expand All @@ -1746,7 +1756,7 @@ mod tests {

let converted_4 = convert_to_expected_type(
Value::SimpleString(unconverted_string.clone()),
Some(ExpectedReturnType::Lolwut),
conversion_type,
);
assert!(converted_4.is_err());
}
Expand Down Expand Up @@ -2256,11 +2266,6 @@ mod tests {

#[test]
fn convert_function_stats() {
assert!(matches!(
expected_type_for_cmd(redis::cmd("FUNCTION").arg("STATS")),
Some(ExpectedReturnType::FunctionStatsReturnType)
));

let resp2_response_non_empty_first_part_data = vec![
Value::BulkString(b"running_script".into()),
Value::Array(vec![
Expand Down Expand Up @@ -2387,7 +2392,8 @@ mod tests {
),
]);

let conversion_type = Some(ExpectedReturnType::FunctionStatsReturnType);
let cmd = redis::cmd("FUNCTION STATS");
let conversion_type = expected_type_for_cmd(&cmd);
// resp2 -> resp3 conversion with non-empty `running_script` block
assert_eq!(
convert_to_expected_type(
Expand Down
21 changes: 21 additions & 0 deletions node/tests/GlideClusterClient.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,27 @@ describe("GlideClusterClient", () => {
TIMEOUT,
);

it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
`config get with wildcard and multi node route %p`,
async (protocol) => {
client = await GlideClusterClient.createClient(
getClientConfigurationOption(cluster.getAddresses(), protocol),
);
const result = await client.configGet(["*file"], {
route: "allPrimaries",
});
Object.values(
result as Record<string, Record<string, GlideString>>,
).forEach((resp) => {
const keys = Object.keys(resp);
expect(keys.length).toBeGreaterThan(5);
expect(keys).toContain("pidfile");
expect(keys).toContain("logfile");
});
},
TIMEOUT,
);

it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
`can send transactions_%p`,
async (protocol) => {
Expand Down
12 changes: 12 additions & 0 deletions python/python/tests/test_async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,6 +753,18 @@ async def test_config_get_set(self, glide_client: TGlideClient):
== OK
)

@pytest.mark.parametrize("cluster_mode", [True])
@pytest.mark.parametrize("protocol", [ProtocolVersion.RESP2, ProtocolVersion.RESP3])
async def test_config_get_with_wildcard_and_multi_node_route(
self, glide_client: GlideClusterClient
):
result = await glide_client.config_get(["*file"], AllPrimaries())
assert isinstance(result, Dict)
for resp in result.values():
assert len(resp) > 5
assert b"pidfile" in resp
assert b"logfile" in resp

@pytest.mark.parametrize("cluster_mode", [True, False])
@pytest.mark.parametrize("protocol", [ProtocolVersion.RESP2, ProtocolVersion.RESP3])
async def test_decr_decrby_existing_key(self, glide_client: TGlideClient):
Expand Down
Loading