ryerraguntla commented on code in PR #4401: URL: https://github.com/apache/iggy/pull/4401#discussion_r4180753197
########## gateways/kafka/src/protocol/handlers/list_groups.rs: ########## @@ -0,0 +1,188 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +//! `ListGroups` (API key 16). +//! +//! Lists the groups this coordinator holds. v4+ `states_filter` and v5 `types_filter` keep a +//! group only when the filter is empty or one entry matches, case-insensitively, after trim. +//! A filter value this coordinator does not use matches nothing, so the group is left out and +//! the response error stays 0. Kafka 4.0's `listGroups` does the same ("if invalid, no groups +//! are returned"). + +use bytes::Bytes; +use kafka_protocol::messages::list_groups_response::ListedGroup; +use kafka_protocol::messages::{GroupId, ListGroupsRequest, ListGroupsResponse}; +use kafka_protocol::protocol::StrBytes; + +use crate::error::Result; +use crate::group::GroupListing; +use crate::protocol::api::{ + API_KEY_LIST_GROUPS, ApiVersionRange, ERROR_INVALID_REQUEST, ERROR_UNSUPPORTED_VERSION, + GatewayState, HandleOutcome, is_supported_version, +}; +use crate::protocol::bounds_guard::validate_list_groups_shape; +use crate::protocol::handlers::{ + decode_guarded, encode_message, respond_or_close, unsupported_version_response, +}; +use crate::protocol::header::response_header_version; + +pub const RANGE: ApiVersionRange = ApiVersionRange { + api_key: API_KEY_LIST_GROUPS, + min_version: 0, + max_version: 5, +}; + +/// `ListGroups` v5 `group_type` for the classic protocol this coordinator runs. +const CLASSIC_GROUP_TYPE: &str = "classic"; + +pub async fn handle(state: &GatewayState, api_version: i16, body: Bytes) -> HandleOutcome { + if !is_supported_version(API_KEY_LIST_GROUPS, api_version) { + return unsupported_version_response(API_KEY_LIST_GROUPS, api_version, |version| { + encode_error_response(version, ERROR_UNSUPPORTED_VERSION) + }); + } + let request = match decode_guarded::<ListGroupsRequest>(api_version, body, |version, body| { + validate_list_groups_shape(version, body, state.max_frame_size) + }) { + Ok(request) => request, + Err(error) => { + // debug!, not warn!: attacker-controlled, not operator-actionable. + tracing::debug!(%error, api_version, "Failed to decode ListGroups request"); + return respond_or_close( + encode_error_response(api_version, ERROR_INVALID_REQUEST), + "ListGroups", + ); + } + }; + + let listings: Vec<GroupListing> = state + .groups + .list_groups() + .await + .into_iter() + .filter(|group| { + selected(&request.states_filter, group.state) + && selected(&request.types_filter, CLASSIC_GROUP_TYPE) + }) + .collect(); + // `protocol_type` is echoed for every group. The shape guard never sees that list, so a + // coordinator holding many long types can still outgrow the frame. Price it before encode. + let encoded_bytes = list_response_frame_len(api_version, &listings); + if encoded_bytes > state.max_frame_size { + tracing::warn!( + encoded_bytes, + max_frame_size = state.max_frame_size, + "ListGroups response would exceed max_frame_size; closing connection" + ); + return HandleOutcome::Close; + } + let groups = listings.into_iter().map(listed_group).collect(); + respond_or_close(encode_response(api_version, groups), "ListGroups") +} + +fn selected(filter: &[StrBytes], value: &str) -> bool { + filter.is_empty() + || filter + .iter() + .any(|wanted| wanted.as_str().trim().eq_ignore_ascii_case(value)) +} + +/// Header plus body, the length `send_response` writes and `read_frame` compares to +/// `max_frame_size`. +fn list_response_frame_len(version: i16, groups: &[GroupListing]) -> usize { + let flexible = version >= 3; + let mut total = if response_header_version(API_KEY_LIST_GROUPS, version) >= 1 { + 5 + } else { + 4 + }; + if version >= 1 { + total += 4; + } + total += 2; + total += if flexible { + kafka_compact_prefix(groups.len()) + } else { + 4 + }; + for group in groups { + total = total.saturating_add(listed_group_len(version, group)); + } + if flexible { + total += 1; + } + total +} + +fn listed_group_len(version: i16, group: &GroupListing) -> usize { + let flexible = version >= 3; + let mut total = kafka_string_len(flexible, group.group_id.len()); + total += kafka_string_len(flexible, group.protocol_type.len()); + if version >= 4 { + total += kafka_string_len(true, group.state.len()); + } + if version >= 5 { + total += kafka_string_len(true, CLASSIC_GROUP_TYPE.len()); + } + if flexible { + total += 1; + } + total +} + +fn kafka_compact_prefix(len: usize) -> usize { Review Comment: Fixed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
