hubcio commented on code in PR #1679: URL: https://github.com/apache/iggy/pull/1679#discussion_r2051079828
########## sdk/src/models/messaging/message_view.rs: ########## @@ -0,0 +1,196 @@ +/* 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. + */ + +use super::message_header::*; +use super::HeaderValue; +use super::{message_header_view::IggyMessageHeaderView, HeaderKey}; +use crate::error::IggyError; +use crate::prelude::BytesSerializable; +use crate::prelude::IggyByteSize; +use crate::prelude::Sizeable; +use crate::utils::checksum; +use bytes::{Bytes, BytesMut}; +use std::{collections::HashMap, iter::Iterator}; + +/// A immutable view of a message. +#[derive(Debug)] +pub struct IggyMessageView<'a> { + buffer: &'a [u8], + payload_offset: usize, + user_headers_offset: usize, +} + +impl<'a> IggyMessageView<'a> { + /// Creates a new immutable message view from a buffer. + pub fn new(buffer: &'a [u8]) -> Self { + let header_view = IggyMessageHeaderView::new(&buffer[IGGY_MESSAGE_HEADER_RANGE]); + let payload_len = header_view.payload_length(); + let payload_offset = IGGY_MESSAGE_HEADER_SIZE; + let headers_offset = payload_offset + payload_len; + + Self { + buffer, + payload_offset, + user_headers_offset: headers_offset, + } + } + + /// Returns an immutable header view. + pub fn header(&self) -> IggyMessageHeaderView<'_> { + IggyMessageHeaderView::new(&self.buffer[0..IGGY_MESSAGE_HEADER_SIZE]) + } + + /// Returns an immutable slice of the user headers. + pub fn user_headers(&self) -> Option<&[u8]> { + if self.header().user_headers_length() > 0 { + let header_length = self.header().user_headers_length(); + let end_offset = self.user_headers_offset + header_length; + + if end_offset <= self.buffer.len() { + Some(&self.buffer[self.user_headers_offset..end_offset]) + } else { + tracing::error!( + "Header length in message exceeds buffer bounds: length={}, buffer_remaining={}", + header_length, + self.buffer.len() - self.user_headers_offset + ); + None + } + } else { + None + } + } + + /// Return instantiated user headers map + pub fn user_headers_map(&self) -> Result<Option<HashMap<HeaderKey, HeaderValue>>, IggyError> { + if let Some(headers) = self.user_headers() { + let headers_bytes = Bytes::copy_from_slice(headers); + + match HashMap::<HeaderKey, HeaderValue>::from_bytes(headers_bytes) { + Ok(h) => Ok(Some(h)), + Err(e) => { + tracing::error!( + "Error parsing headers: {}, header_length={}", + e, + self.header().user_headers_length() + ); + + Ok(None) + } + } + } else { + Ok(None) + } + } + + /// Returns the size of the entire message. + pub fn size(&self) -> usize { + let header_view = self.header(); + IGGY_MESSAGE_HEADER_SIZE + header_view.payload_length() + header_view.user_headers_length() + } + + /// Returns a reference to the payload portion. + pub fn payload(&self) -> &[u8] { + let header_view = self.header(); + let payload_len = header_view.payload_length(); + &self.buffer[self.payload_offset..self.payload_offset + payload_len] + } + + /// Validates that the message view is properly formatted and has valid data. + pub fn validate(&self) -> Result<(), IggyError> { + if self.buffer.len() < IGGY_MESSAGE_HEADER_SIZE { + return Err(IggyError::InvalidMessagePayloadLength); + } + + let header = self.header(); + let payload_len = header.payload_length(); + let user_headers_len = header.user_headers_length(); + let total_size = IGGY_MESSAGE_HEADER_SIZE + payload_len + user_headers_len; + + if self.buffer.len() < total_size { + return Err(IggyError::InvalidMessagePayloadLength); + } + Ok(()) + } + + /// Validates that the message view has a valid checksum. + /// This should be called only on server side. + pub fn calculate_checksum(&self) -> u64 { + let checksum_field_size = size_of::<u64>(); // Skip checksum field for checksum calculation + let size = self.size() - checksum_field_size; + let data = &self.buffer[checksum_field_size..checksum_field_size + size]; + + // TODO(hubcio): checksum field is 64 bits, but actual checksum is 32 bits (crc32fast) + // in future, we should change it to cryptographic safe hash + u64::from(checksum::calculate(data)) + } +} + +impl BytesSerializable for IggyMessageView<'_> { + fn to_bytes(&self) -> Bytes { + panic!("should not be used") Review Comment: we can do it later ;) -- 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]
