Skip to content

Commit

Permalink
Add FUNCTION STATS command. (#333)
Browse files Browse the repository at this point in the history 
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
  • Loading branch information
@Yury-Fridlyand
Yury-Fridlyand committed Jun 14, 2024
1 parent 850fc10 commit 18faa06
Show file tree
Hide file tree
Showing 16 changed files with 739 additions and 34 deletions.
261 changes: 261 additions & 0 deletions glide-core/src/client/value_conversion.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ pub(crate) enum ExpectedReturnType<'a> {
ArrayOfMemberScorePairs,
ZMPopReturnType,
KeyWithMemberAndScore,
FunctionStatsReturnType,
}

pub(crate) fn convert_to_expected_type(
Expand Down Expand Up @@ -442,6 +443,87 @@ pub(crate) fn convert_to_expected_type(
)
.into()),
},
// `FUNCTION STATS` returns nested maps with different types of data
/* RESP2 response example
1) "running_script"
2) 1) "name"
2) "<function name>"
3) "command"
4) 1) "fcall"
2) "<function name>"
... rest `fcall` args ...
5) "duration_ms"
6) (integer) 24529
3) "engines"
4) 1) "LUA"
2) 1) "libraries_count"
2) (integer) 3
3) "functions_count"
4) (integer) 5
1) "running_script"
2) (nil)
3) "engines"
4) ...
RESP3 response example
1# "running_script" =>
1# "name" => "<function name>"
2# "command" =>
1) "fcall"
2) "<function name>"
... rest `fcall` args ...
3# "duration_ms" => (integer) 5000
2# "engines" =>
1# "LUA" =>
1# "libraries_count" => (integer) 3
2# "functions_count" => (integer) 5
*/
// First part of the response (`running_script`) is converted as `Map[str, any]`
// Second part is converted as `Map[str, Map[str, int]]`
ExpectedReturnType::FunctionStatsReturnType => match value {
// TODO reuse https://github.com/Bit-Quill/glide-for-redis/pull/331 and https://github.com/aws/glide-for-redis/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::Array(mut array) if array.len() == 4 => {
let mut result: Vec<(Value, Value)> = Vec::with_capacity(2);
let running_script_info = array.remove(1);
let running_script_converted = match running_script_info {
Value::Nil => Ok(Value::Nil),
Value::Array(inner_map_as_array) => {
convert_array_to_map_by_type(inner_map_as_array, None, None)
}
_ => Err((ErrorKind::TypeError, "Response couldn't be converted").into()),
};
result.push((array.remove(0), running_script_converted?));
let Value::Array(engines_info) = array.remove(1) else {
return Err((ErrorKind::TypeError, "Incorrect value type received").into());
};
let engines_info_converted = convert_array_to_map_by_type(
engines_info,
Some(ExpectedReturnType::BulkString),
Some(ExpectedReturnType::Map {
key_type: &None,
value_type: &None,
}),
);
result.push((array.remove(0), engines_info_converted?));

Ok(Value::Map(result))
}
_ => Err((ErrorKind::TypeError, "Response couldn't be converted").into()),
},
}
}

Expand Down Expand Up @@ -740,6 +822,7 @@ pub(crate) fn expected_type_for_cmd(cmd: &Cmd) -> Option<ExpectedReturnType> {
b"FUNCTION LIST" => Some(ExpectedReturnType::ArrayOfMaps(
&ExpectedReturnType::ArrayOfMaps(&ExpectedReturnType::StringOrSet),
)),
b"FUNCTION STATS" => Some(ExpectedReturnType::FunctionStatsReturnType),
_ => None,
}
}
Expand Down Expand Up @@ -1297,6 +1380,184 @@ 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![
Value::BulkString(b"name".into()),
Value::BulkString(b"<function name>".into()),
Value::BulkString(b"command".into()),
Value::Array(vec![
Value::BulkString(b"fcall".into()),
Value::BulkString(b"<function name>".into()),
Value::BulkString(b"... rest `fcall` args ...".into()),
]),
Value::BulkString(b"duration_ms".into()),
Value::Int(24529),
]),
];

let resp2_response_empty_first_part_data =
vec![Value::BulkString(b"running_script".into()), Value::Nil];

let resp2_response_second_part_data = vec![
Value::BulkString(b"engines".into()),
Value::Array(vec![
Value::BulkString(b"LUA".into()),
Value::Array(vec![
Value::BulkString(b"libraries_count".into()),
Value::Int(3),
Value::BulkString(b"functions_count".into()),
Value::Int(5),
]),
]),
];
let resp2_response_with_non_empty_first_part = Value::Array(
[
resp2_response_non_empty_first_part_data.clone(),
resp2_response_second_part_data.clone(),
]
.concat(),
);

let resp2_response_with_empty_first_part = Value::Array(
[
resp2_response_empty_first_part_data.clone(),
resp2_response_second_part_data.clone(),
]
.concat(),
);

let resp2_cluster_response = Value::Map(vec![
(
Value::BulkString(b"node1".into()),
resp2_response_with_non_empty_first_part.clone(),
),
(
Value::BulkString(b"node2".into()),
resp2_response_with_empty_first_part.clone(),
),
(
Value::BulkString(b"node3".into()),
resp2_response_with_empty_first_part.clone(),
),
]);

let resp3_response_non_empty_first_part_data = vec![(
Value::BulkString(b"running_script".into()),
Value::Map(vec![
(
Value::BulkString(b"name".into()),
Value::BulkString(b"<function name>".into()),
),
(
Value::BulkString(b"command".into()),
Value::Array(vec![
Value::BulkString(b"fcall".into()),
Value::BulkString(b"<function name>".into()),
Value::BulkString(b"... rest `fcall` args ...".into()),
]),
),
(Value::BulkString(b"duration_ms".into()), Value::Int(24529)),
]),
)];

let resp3_response_empty_first_part_data =
vec![(Value::BulkString(b"running_script".into()), Value::Nil)];

let resp3_response_second_part_data = vec![(
Value::BulkString(b"engines".into()),
Value::Map(vec![(
Value::BulkString(b"LUA".into()),
Value::Map(vec![
(Value::BulkString(b"libraries_count".into()), Value::Int(3)),
(Value::BulkString(b"functions_count".into()), Value::Int(5)),
]),
)]),
)];

let resp3_response_with_non_empty_first_part = Value::Map(
[
resp3_response_non_empty_first_part_data.clone(),
resp3_response_second_part_data.clone(),
]
.concat(),
);

let resp3_response_with_empty_first_part = Value::Map(
[
resp3_response_empty_first_part_data.clone(),
resp3_response_second_part_data.clone(),
]
.concat(),
);

let resp3_cluster_response = Value::Map(vec![
(
Value::BulkString(b"node1".into()),
resp3_response_with_non_empty_first_part.clone(),
),
(
Value::BulkString(b"node2".into()),
resp3_response_with_empty_first_part.clone(),
),
(
Value::BulkString(b"node3".into()),
resp3_response_with_empty_first_part.clone(),
),
]);

let conversion_type = Some(ExpectedReturnType::FunctionStatsReturnType);
// resp2 -> resp3 conversion with non-empty `running_script` block
assert_eq!(
convert_to_expected_type(
resp2_response_with_non_empty_first_part.clone(),
conversion_type
),
Ok(resp3_response_with_non_empty_first_part.clone())
);
// resp2 -> resp3 conversion with empty `running_script` block
assert_eq!(
convert_to_expected_type(
resp2_response_with_empty_first_part.clone(),
conversion_type
),
Ok(resp3_response_with_empty_first_part.clone())
);
// resp2 -> resp3 cluster response
assert_eq!(
convert_to_expected_type(resp2_cluster_response.clone(), conversion_type),
Ok(resp3_cluster_response.clone())
);
// resp3 -> resp3 conversion with non-empty `running_script` block
assert_eq!(
convert_to_expected_type(
resp3_response_with_non_empty_first_part.clone(),
conversion_type
),
Ok(resp3_response_with_non_empty_first_part.clone())
);
// resp3 -> resp3 conversion with empty `running_script` block
assert_eq!(
convert_to_expected_type(
resp3_response_with_empty_first_part.clone(),
conversion_type
),
Ok(resp3_response_with_empty_first_part.clone())
);
// resp3 -> resp3 cluster response
assert_eq!(
convert_to_expected_type(resp3_cluster_response.clone(), conversion_type),
Ok(resp3_cluster_response.clone())
);
}

#[test]
fn convert_smismember() {
assert!(matches!(
Expand Down
1 change: 1 addition & 0 deletions glide-core/src/protobuf/redis_request.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ enum RequestType {
XLen = 159;
Sort = 160;
FunctionKill = 161;
FunctionStats = 162;
LSet = 165;
XDel = 166;
XRange = 167;
Expand Down
3 changes: 3 additions & 0 deletions glide-core/src/request_type.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ pub enum RequestType {
XLen = 159,
Sort = 160,
FunctionKill = 161,
FunctionStats = 162,
LSet = 165,
XDel = 166,
XRange = 167,
Expand Down Expand Up @@ -359,6 +360,7 @@ impl From<::protobuf::EnumOrUnknown<ProtobufRequestType>> for RequestType {
ProtobufRequestType::PExpireTime => RequestType::PExpireTime,
ProtobufRequestType::XLen => RequestType::XLen,
ProtobufRequestType::FunctionKill => RequestType::FunctionKill,
ProtobufRequestType::FunctionStats => RequestType::FunctionStats,
ProtobufRequestType::LSet => RequestType::LSet,
ProtobufRequestType::XDel => RequestType::XDel,
ProtobufRequestType::XRange => RequestType::XRange,
Expand Down Expand Up @@ -544,6 +546,7 @@ impl RequestType {
RequestType::PExpireTime => Some(cmd("PEXPIRETIME")),
RequestType::XLen => Some(cmd("XLEN")),
RequestType::FunctionKill => Some(get_two_word_command("FUNCTION", "KILL")),
RequestType::FunctionStats => Some(get_two_word_command("FUNCTION", "STATS")),
RequestType::LSet => Some(cmd("LSET")),
RequestType::XDel => Some(cmd("XDEL")),
RequestType::XRange => Some(cmd("XRANGE")),
Expand Down
11 changes: 11 additions & 0 deletions java/client/src/main/java/glide/api/BaseClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,17 @@ protected Map<String, Object>[] handleFunctionListResponse(Object[] response) {
return data;
}

/** Process a <code>FUNCTION STATS</code> standalone response. */
protected Map<String, Map<String, Object>> handleFunctionStatsResponse(
Map<String, Map<String, Object>> response) {
Map<String, Object> runningScriptInfo = response.get("running_script");
if (runningScriptInfo != null) {
Object[] command = (Object[]) runningScriptInfo.get("command");
runningScriptInfo.put("command", castArray(command, String.class));
}
return response;
}

@Override
public CompletableFuture<Long> del(@NonNull String[] keys) {
return commandManager.submitNewCommand(Del, keys, this::handleLongResponse);
Expand Down
9 changes: 9 additions & 0 deletions java/client/src/main/java/glide/api/RedisClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static redis_request.RedisRequestOuterClass.RequestType.FunctionKill;
import static redis_request.RedisRequestOuterClass.RequestType.FunctionList;
import static redis_request.RedisRequestOuterClass.RequestType.FunctionLoad;
import static redis_request.RedisRequestOuterClass.RequestType.FunctionStats;
import static redis_request.RedisRequestOuterClass.RequestType.Info;
import static redis_request.RedisRequestOuterClass.RequestType.LastSave;
import static redis_request.RedisRequestOuterClass.RequestType.Lolwut;
Expand Down Expand Up @@ -283,4 +284,12 @@ public CompletableFuture<Boolean> copy(
public CompletableFuture<String> functionKill() {
return commandManager.submitNewCommand(FunctionKill, new String[0], this::handleStringResponse);
}

@Override
public CompletableFuture<Map<String, Map<String, Object>>> functionStats() {
return commandManager.submitNewCommand(
FunctionStats,
new String[0],
response -> handleFunctionStatsResponse(handleMapResponse(response)));
}
}
Loading

0 comments on commit 18faa06

Please sign in to comment.