github-actions[bot] commented on code in PR #41484: URL: https://github.com/apache/beam/pull/41484#discussion_r4634509163
########## sdks/rust/beam/core/src/coders/traits.rs: ########## @@ -0,0 +1,225 @@ +/* + * 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. + */ + +//! Core traits and context definitions for Beam coders. + +use std::sync::Arc; +use thiserror::Error; + +/// Error encountered during element encoding or decoding. +#[derive(Error, Debug)] +pub enum CoderError { + #[error("IO error during encoding/decoding: {0}")] + Io(#[from] std::io::Error), + #[error("UTF-8 decoding error: {0}")] + Utf8(#[from] std::string::FromUtf8Error), + #[error("Schema error during encoding/decoding: {0}")] + Schema(#[from] crate::schema::SchemaError), + #[error("Decoding format error: {0}")] + Format(String), + /// Error from a runner state stream backing a state-backed iterable. + #[error("{0}")] + StateStream(String), +} + +/// Position of an element in the byte stream, which sets how it is delimited. In `Nested` +/// context (inside a tuple, a KV or a stream), a variable-length element must have a length +/// prefix. In `WholeStream` context, the element extends to the end of the stream. +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum Context { + WholeStream, + Nested, +} + +/// Maps each reader schema field to its position in a writer schema. +#[derive(Clone, Debug, PartialEq, Eq)] +pub enum FieldMap { + /// The writer schema has the wire layout of the reader type. + Same, + /// For each reader field, the writer field index, or `None` for an absent nullable field. + /// The `Arc` lets a lazy iterable decoder share the map with no copy. + ByName(Arc<[Option<usize>]>), +} + +/// Keeps the [`FieldMap`] of one type for the last writer schema. A hit costs one pointer +/// compare, so call [`get`](Self::get) for each element. +#[derive(Clone, Debug, Default)] +pub struct FieldMapCache { + resolved: Option<(Arc<crate::schema::Schema>, Option<FieldMap>)>, +} + +impl FieldMapCache { + pub fn new() -> Self { + Self::default() + } + + /// Returns [`DefaultCoder::resolve_field_map`] of `T` for `schema`. Resolves again only + /// when `schema` is a different `Arc`. Returns `Ok(None)` when `schema` is `None` or `T` + /// has no field map. + pub fn get<T: DefaultCoder>( + &mut self, + schema: Option<&Arc<crate::schema::Schema>>, + ) -> Result<Option<&FieldMap>, crate::schema::SchemaError> { + let Some(schema) = schema else { + return Ok(None); + }; + let resolved = match self.resolved.take() { + Some((cached, map)) if Arc::ptr_eq(&cached, schema) => (cached, map), + Some(_) | None => (Arc::clone(schema), T::resolve_field_map(schema)?), + }; + Ok(self.resolved.insert(resolved).1.as_ref()) + } + + /// Decodes one element of `T` from `bytes` with the field map for `schema`. + pub fn decode<T: DefaultCoder>( + &mut self, + bytes: &[u8], + schema: Option<&Arc<crate::schema::Schema>>, + state_reader: Option<&Arc<dyn super::iterable::StateStreamReader>>, + ) -> Result<T, CoderError> { + let map = self.get::<T>(schema)?; + T::decode_with_context(bytes, schema, map, state_reader) + } +} + +/// Encodes and decodes values of type `T` in a Beam wire format. +pub trait Coder<T>: Send + Sync + 'static { + /// Returns the Runner API coder URN, standard or custom. + fn urn(&self) -> &'static str; + + fn encode(&self, value: &T, writer: &mut Vec<u8>, context: Context) -> Result<(), CoderError>; + + fn decode(&self, reader: &mut &[u8], context: Context) -> Result<T, CoderError>; +} + +/// Records coders in the Runner API pipeline components. +pub trait CoderRegistry { + fn register_coder(&self, urn: &str, component_coder_ids: Vec<String>) -> String; + + fn register_coder_with_payload( Review Comment: **🟡 Medium**: `CoderRegistry::register_coder_with_payload` defaults to discarding `payload` (`let _ = payload;`) and delegating to `register_coder`. If a `CoderRegistry` implementor only implements the required `register_coder` method and forgets to override `register_coder_with_payload`, any coder that requires a payload (such as `RowCoder` carrying its serialized `Schema` proto) will silently register without its payload and produce an invalid Runner API pipeline graph. Consider making `register_coder_with_payload` the required method on `CoderRegistry` and providing a default implementation for `register_coder` that delegates via `self.register_coder_with_payload(urn, component_coder_ids, Vec::new())`. ########## sdks/rust/beam/core/Cargo.toml: ########## @@ -0,0 +1,42 @@ +# 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. + +[package] +name = "apache-beam-core" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +repository.workspace = true +description = "Core abstractions and pipeline model for Apache Beam Rust SDK" + +[lib] +name = "beam" + +[dependencies] +chrono = { workspace = true } +beam_model = { workspace = true } +prost = { workspace = true } +serde = { workspace = true } +thiserror = { workspace = true } + +[dev-dependencies] +beam = { package = "apache-beam-core", path = "." } Review Comment: **🟢 Low**: Because `[lib]` already sets `name = "beam"` (line 28), integration tests and doctests in `apache-beam-core` automatically have access to the crate as `beam` without needing this self-referential path entry in `[dev-dependencies]`. Keeping a self-dependency here adds a circular entry in `Cargo.lock` and causes `cargo publish` to fail when the version is not yet published. ########## sdks/rust/beam/core/src/schema/proto.rs: ########## @@ -0,0 +1,324 @@ +/* + * 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 std::sync::Arc; + +use beam_model::pipeline as proto; + +use super::error::SchemaError; +use super::types::{AtomicType, Field, FieldType, Schema, SchemaOption, TypeInfo, TypedValue}; + +impl From<AtomicType> for proto::AtomicType { + fn from(t: AtomicType) -> Self { + match t { + AtomicType::Byte => proto::AtomicType::Byte, + AtomicType::Int16 => proto::AtomicType::Int16, + AtomicType::Int32 => proto::AtomicType::Int32, + AtomicType::Int64 => proto::AtomicType::Int64, + AtomicType::Float => proto::AtomicType::Float, + AtomicType::Double => proto::AtomicType::Double, + AtomicType::String => proto::AtomicType::String, + AtomicType::Boolean => proto::AtomicType::Boolean, + AtomicType::Bytes => proto::AtomicType::Bytes, + } + } +} + +impl TryFrom<proto::AtomicType> for AtomicType { + type Error = SchemaError; + + fn try_from(t: proto::AtomicType) -> Result<Self, Self::Error> { + match t { + proto::AtomicType::Byte => Ok(Self::Byte), + proto::AtomicType::Int16 => Ok(Self::Int16), + proto::AtomicType::Int32 => Ok(Self::Int32), + proto::AtomicType::Int64 => Ok(Self::Int64), + proto::AtomicType::Float => Ok(Self::Float), + proto::AtomicType::Double => Ok(Self::Double), + proto::AtomicType::String => Ok(Self::String), + proto::AtomicType::Boolean => Ok(Self::Boolean), + proto::AtomicType::Bytes => Ok(Self::Bytes), + proto::AtomicType::Unspecified => Err(SchemaError::ProtoConversion( + "Unspecified atomic type".into(), + )), + } + } +} + +impl From<FieldType> for proto::FieldType { + fn from(ft: FieldType) -> Self { + Self::from(&ft) + } +} + +impl From<&FieldType> for proto::FieldType { + fn from(ft: &FieldType) -> Self { + let type_info = match &ft.type_info { + TypeInfo::Atomic(at) => { + proto::field_type::TypeInfo::AtomicType(proto::AtomicType::from(*at) as i32) + } + TypeInfo::Array(elem) => { + proto::field_type::TypeInfo::ArrayType(Box::new(proto::ArrayType { + element_type: Some(Box::new(proto::FieldType::from(elem.as_ref()))), + })) + } + TypeInfo::Iterable(elem) => { + proto::field_type::TypeInfo::IterableType(Box::new(proto::IterableType { + element_type: Some(Box::new(proto::FieldType::from(elem.as_ref()))), + })) + } + TypeInfo::Map(k, v) => proto::field_type::TypeInfo::MapType(Box::new(proto::MapType { + key_type: Some(Box::new(proto::FieldType::from(k.as_ref()))), + value_type: Some(Box::new(proto::FieldType::from(v.as_ref()))), + })), + TypeInfo::Row(schema) => proto::field_type::TypeInfo::RowType(proto::RowType { + schema: Some(proto::Schema::from(schema.as_ref())), + }), + TypeInfo::Logical { + urn, + payload, + representation, + argument, + } => { + let (argument_type, argument) = argument + .as_ref() + .map(|argument| { + let TypedValue { field_type, value } = argument.as_ref(); + (Box::new(proto::FieldType::from(field_type)), value.clone()) + }) + .unzip(); + proto::field_type::TypeInfo::LogicalType(Box::new(proto::LogicalType { + urn: urn.clone(), + payload: payload.clone(), + representation: Some(Box::new(proto::FieldType::from(representation.as_ref()))), + argument_type, + argument: argument.flatten(), + })) + } + }; + + proto::FieldType { + nullable: ft.nullable, + type_info: Some(type_info), + } + } +} + +impl TryFrom<proto::FieldType> for FieldType { + type Error = SchemaError; + + fn try_from(ft: proto::FieldType) -> Result<Self, Self::Error> { + let Some(type_info) = ft.type_info else { + return Err(SchemaError::ProtoConversion( + "Missing type_info in FieldType".into(), + )); + }; + + let info = match type_info { + proto::field_type::TypeInfo::AtomicType(raw) => { + let proto_atomic = proto::AtomicType::try_from(raw).map_err(|_| { + SchemaError::ProtoConversion(format!("Unknown atomic type: {raw}")) + })?; + TypeInfo::Atomic(AtomicType::try_from(proto_atomic)?) + } + proto::field_type::TypeInfo::ArrayType(arr) => { + let elem = arr.element_type.ok_or_else(|| { + SchemaError::ProtoConversion("Missing array element type".into()) + })?; + TypeInfo::Array(Box::new(FieldType::try_from(*elem)?)) + } + proto::field_type::TypeInfo::IterableType(iter) => { + let elem = iter.element_type.ok_or_else(|| { + SchemaError::ProtoConversion("Missing iterable element type".into()) + })?; + TypeInfo::Iterable(Box::new(FieldType::try_from(*elem)?)) + } + proto::field_type::TypeInfo::MapType(m) => { + let key = m + .key_type + .ok_or_else(|| SchemaError::ProtoConversion("Missing map key type".into()))?; + let val = m + .value_type + .ok_or_else(|| SchemaError::ProtoConversion("Missing map value type".into()))?; + TypeInfo::Map( + Box::new(FieldType::try_from(*key)?), + Box::new(FieldType::try_from(*val)?), + ) + } + proto::field_type::TypeInfo::RowType(r) => { + let s = r.schema.ok_or_else(|| { + SchemaError::ProtoConversion("Missing nested row schema".into()) + })?; + TypeInfo::Row(Arc::new(Schema::try_from(s)?)) + } + proto::field_type::TypeInfo::LogicalType(logical) => { + let proto::LogicalType { + urn, + payload, + representation, + argument_type, + argument, + } = *logical; + let rep = representation.ok_or_else(|| { + SchemaError::ProtoConversion("Missing logical representation type".into()) + })?; + let argument = argument_type + .map(|argument_type| { + FieldType::try_from(*argument_type).map(|field_type| TypedValue { + field_type, + value: argument, + }) + }) + .transpose()?; + TypeInfo::Logical { + urn, + payload, + representation: Box::new(FieldType::try_from(*rep)?), + argument: argument.map(Box::new), + } + } + }; + + Ok(FieldType::new(info, ft.nullable)) + } +} + +impl From<Field> for proto::Field { + fn from(f: Field) -> Self { + Self::from(&f) + } +} + +impl From<&Field> for proto::Field { + fn from(f: &Field) -> Self { + proto::Field { + name: f.name.clone(), + description: f.description.clone().unwrap_or_default(), + r#type: Some(proto::FieldType::from(&f.field_type)), + id: f.id.unwrap_or_default(), + encoding_position: f.encoding_position.unwrap_or_default(), + options: f.options.iter().map(Into::into).collect(), + } + } +} + +impl TryFrom<proto::Field> for Field { + type Error = SchemaError; + + /// Position 0 is the proto3 default, so only [`Schema::try_from`] can keep `Some(0)`. + fn try_from(f: proto::Field) -> Result<Self, Self::Error> { + let field_type = f.r#type.ok_or_else(|| { + SchemaError::ProtoConversion(format!("Missing type for field {}", f.name)) + })?; + Ok(Field { + name: f.name, + description: (!f.description.is_empty()).then_some(f.description), + field_type: FieldType::try_from(field_type)?, + id: (f.id != 0).then_some(f.id), + encoding_position: (f.encoding_position != 0).then_some(f.encoding_position), + options: options_from_proto(f.options)?, + }) + } +} + +impl From<Schema> for proto::Schema { + fn from(s: Schema) -> Self { + Self::from(&s) + } +} + +impl From<&Schema> for proto::Schema { + fn from(s: &Schema) -> Self { + proto::Schema { Review Comment: **🟡 Medium**: There is an inconsistency between `Schema::new` (`types.rs:268`) and `TryFrom<proto::Schema>` when `encoding_position` is only partially populated or when `encoding_positions_set` is `false`: 1. `Schema::new` sets `encoding_positions_set = fields.iter().any(|f| f.encoding_position.is_some())`. If some fields have `Some(_)` and others have `None`, converting to `proto::Schema` serializes the `None` fields as `0` (`unwrap_or_default()`) with `encoding_positions_set = true`, and converting back here turns all of those `None` fields into `Some(0)`. 2. Conversely, if an incoming `proto::Schema` has `encoding_positions_set == false` but a field has a non-zero `encoding_position`, `Field::try_from` (line 212) sets `encoding_position: Some(f.encoding_position)`, resulting in a `Schema` where `encoding_positions_set` is `false` yet fields have `Some(_)`. Consider setting `encoding_position` strictly based on `positions_set` (i.e., `positions_set.then_some(position)`) and either requiring all fields to have `encoding_position` set in `Schema::new` (`fields.iter().all(...)`) or validating consistency. -- 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]
