szaszm commented on code in PR #1866: URL: https://github.com/apache/nifi-minifi-cpp/pull/1866#discussion_r1760014731
########## extensions/standard-processors/processors/SplitRecord.cpp: ########## @@ -0,0 +1,125 @@ +/** + * 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. + */ +#include "SplitRecord.h" + +#include "core/Resource.h" +#include "nonstd/expected.hpp" + +namespace org::apache::nifi::minifi::processors { +namespace { +template<typename RecordSetIO> +std::shared_ptr<RecordSetIO> getRecordSetIO(core::ProcessContext& context, const core::PropertyReference& property) { + std::string service_name; + if (context.getProperty(property, service_name) && !IsNullOrEmpty(service_name)) { + auto record_set_io = std::dynamic_pointer_cast<RecordSetIO>(context.getControllerService(service_name)); + if (!record_set_io) + return nullptr; + return record_set_io; + } + return nullptr; +} +} // namespace + +SplitRecord::SplitRecord(std::string_view name, const utils::Identifier& uuid) + : Processor(name, uuid), logger_{core::logging::LoggerFactory<SplitRecord>::getLogger(uuid)} {} + +void SplitRecord::initialize() { + setSupportedProperties(Properties); + setSupportedRelationships(Relationships); +} + +void SplitRecord::onSchedule(core::ProcessContext& context, core::ProcessSessionFactory&) { + record_set_reader_ = getRecordSetIO<core::RecordSetReader>(context, SplitRecord::RecordReader); + if (!record_set_reader_) { + throw minifi::Exception(ExceptionType::PROCESS_SCHEDULE_EXCEPTION, "Record Reader set is missing or invalid"); + } + record_set_writer_ = getRecordSetIO<core::RecordSetWriter>(context, SplitRecord::RecordWriter); + if (!record_set_writer_) { + throw minifi::Exception(ExceptionType::PROCESS_SCHEDULE_EXCEPTION, "Record Writer set is missing or invalid"); + } +} + +nonstd::expected<std::size_t, std::string> SplitRecord::readRecordsPerSplit(core::ProcessContext& context, const std::shared_ptr<core::FlowFile>& original_flow_file) { Review Comment: The flow file should be passed by reference, not a shared_ptr. Ideally the unexpected type of the result would be something more lightweight, like an enum or std::error_code. Converting them to an error message could be done separately. ########## extensions/standard-processors/processors/SplitRecord.h: ########## @@ -0,0 +1,88 @@ +/** + * 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. + */ +#pragma once + +#include "core/Annotation.h" +#include "core/Processor.h" +#include "core/ProcessContext.h" +#include "core/ProcessSession.h" +#include "core/ProcessSessionFactory.h" +#include "core/PropertyDefinition.h" +#include "core/PropertyDefinitionBuilder.h" +#include "core/RelationshipDefinition.h" +#include "core/logging/Logger.h" +#include "controllers/RecordSetReader.h" +#include "controllers/RecordSetWriter.h" + +namespace org::apache::nifi::minifi::processors { + +class SplitRecord : public core::Processor { + public: + EXTENSIONAPI static constexpr const char* Description = "Splits up an input FlowFile that is in a record-oriented data format into multiple smaller FlowFiles"; + + EXTENSIONAPI static constexpr auto RecordReader = core::PropertyDefinitionBuilder<>::createProperty("Record Reader") + .withDescription("Specifies the Controller Service to use for reading incoming data") + .isRequired(true) + .withAllowedTypes<minifi::core::RecordSetReader>() + .build(); + EXTENSIONAPI static constexpr auto RecordWriter = core::PropertyDefinitionBuilder<>::createProperty("Record Writer") + .withDescription("Specifies the Controller Service to use for writing out the records") + .isRequired(true) + .withAllowedTypes<minifi::core::RecordSetWriter>() + .build(); + EXTENSIONAPI static constexpr auto RecordsPerSplit = core::PropertyDefinitionBuilder<>::createProperty("Records Per Split") + .withDescription("Specifies how many records should be written to each 'split' or 'segment' FlowFile") + .isRequired(true) + .supportsExpressionLanguage(true) + .build(); + + EXTENSIONAPI static constexpr auto Properties = std::to_array<core::PropertyReference>({ + RecordReader, + RecordWriter, + RecordsPerSplit + }); + + EXTENSIONAPI static constexpr auto Failure = core::RelationshipDefinition{"failure", + "If a FlowFile cannot be transformed from the configured input format to the configured output format, the unchanged FlowFile will be routed to this relationship."}; + EXTENSIONAPI static constexpr auto Splits = core::RelationshipDefinition{"splits", + "The individual 'segments' of the original FlowFile will be routed to this relationship."}; + EXTENSIONAPI static constexpr auto Original = core::RelationshipDefinition{"original", + "Upon successfully splitting an input FlowFile, the original FlowFile will be sent to this relationship."}; + EXTENSIONAPI static constexpr auto Relationships = std::array{Failure, Splits, Original}; + + EXTENSIONAPI static constexpr bool SupportsDynamicProperties = false; + EXTENSIONAPI static constexpr bool SupportsDynamicRelationships = false; + EXTENSIONAPI static constexpr core::annotation::Input InputRequirement = core::annotation::Input::INPUT_REQUIRED; + EXTENSIONAPI static constexpr bool IsSingleThreaded = false; + + ADD_COMMON_VIRTUAL_FUNCTIONS_FOR_PROCESSORS Review Comment: Check out the AbstractProcessor CRTP class I made a while ago. It's meant to get the same thing done, but without macros. ########## extensions/standard-processors/processors/SplitRecord.cpp: ########## @@ -0,0 +1,125 @@ +/** + * 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. + */ +#include "SplitRecord.h" + +#include "core/Resource.h" +#include "nonstd/expected.hpp" + +namespace org::apache::nifi::minifi::processors { +namespace { +template<typename RecordSetIO> +std::shared_ptr<RecordSetIO> getRecordSetIO(core::ProcessContext& context, const core::PropertyReference& property) { + std::string service_name; + if (context.getProperty(property, service_name) && !IsNullOrEmpty(service_name)) { + auto record_set_io = std::dynamic_pointer_cast<RecordSetIO>(context.getControllerService(service_name)); + if (!record_set_io) + return nullptr; + return record_set_io; + } + return nullptr; +} +} // namespace + +SplitRecord::SplitRecord(std::string_view name, const utils::Identifier& uuid) + : Processor(name, uuid), logger_{core::logging::LoggerFactory<SplitRecord>::getLogger(uuid)} {} + +void SplitRecord::initialize() { + setSupportedProperties(Properties); + setSupportedRelationships(Relationships); +} + +void SplitRecord::onSchedule(core::ProcessContext& context, core::ProcessSessionFactory&) { + record_set_reader_ = getRecordSetIO<core::RecordSetReader>(context, SplitRecord::RecordReader); + if (!record_set_reader_) { + throw minifi::Exception(ExceptionType::PROCESS_SCHEDULE_EXCEPTION, "Record Reader set is missing or invalid"); + } + record_set_writer_ = getRecordSetIO<core::RecordSetWriter>(context, SplitRecord::RecordWriter); + if (!record_set_writer_) { + throw minifi::Exception(ExceptionType::PROCESS_SCHEDULE_EXCEPTION, "Record Writer set is missing or invalid"); + } +} + +nonstd::expected<std::size_t, std::string> SplitRecord::readRecordsPerSplit(core::ProcessContext& context, const std::shared_ptr<core::FlowFile>& original_flow_file) { + std::string value; + std::size_t records_per_split = 0; + if (context.getProperty(RecordsPerSplit, value, original_flow_file.get())) { + if (!core::Property::StringToInt(value, records_per_split)) { + return nonstd::make_unexpected("Failed to convert Records Per Split property to an integer"); + } else if (records_per_split < 1) { + return nonstd::make_unexpected("Records per split should be set to a number larger than 0"); + } + } else { + return nonstd::make_unexpected("Records per split should be set to a valid number larger than 0"); + } + return records_per_split; +} + +void SplitRecord::onTrigger(core::ProcessContext& context, core::ProcessSession& session) { + const auto original_flow_file = session.get(); + if (!original_flow_file) { + yield(); + return; + } + + auto records_per_split = readRecordsPerSplit(context, original_flow_file); + if (!records_per_split) { + logger_->log_error("Failed to read Records Per Split property: {}", records_per_split.error()); + session.transfer(original_flow_file, Failure); + return; + } + + auto record_set = record_set_reader_->read(original_flow_file, session); + if (!record_set) { + logger_->log_error("Failed to read record set from flow file: {}", record_set.error().message()); + session.transfer(original_flow_file, Failure); + return; + } + + std::size_t current_index = 0; + const auto fragment_identifier = utils::IdGenerator::getIdGenerator()->generate().to_string(); + std::size_t fragment_index = 0; + std::size_t fragment_count = record_set->size() / records_per_split.value() + (record_set->size() % records_per_split.value() == 0 ? 0 : 1); Review Comment: ```suggestion const auto fragment_count = utils::intdiv_ceil(record_set->size(), records_per_split.value()); ``` ########## extensions/standard-processors/processors/SplitRecord.cpp: ########## @@ -0,0 +1,125 @@ +/** + * 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. + */ +#include "SplitRecord.h" + +#include "core/Resource.h" +#include "nonstd/expected.hpp" + +namespace org::apache::nifi::minifi::processors { +namespace { +template<typename RecordSetIO> +std::shared_ptr<RecordSetIO> getRecordSetIO(core::ProcessContext& context, const core::PropertyReference& property) { + std::string service_name; + if (context.getProperty(property, service_name) && !IsNullOrEmpty(service_name)) { + auto record_set_io = std::dynamic_pointer_cast<RecordSetIO>(context.getControllerService(service_name)); + if (!record_set_io) + return nullptr; + return record_set_io; + } + return nullptr; +} +} // namespace + +SplitRecord::SplitRecord(std::string_view name, const utils::Identifier& uuid) + : Processor(name, uuid), logger_{core::logging::LoggerFactory<SplitRecord>::getLogger(uuid)} {} + +void SplitRecord::initialize() { + setSupportedProperties(Properties); + setSupportedRelationships(Relationships); +} + +void SplitRecord::onSchedule(core::ProcessContext& context, core::ProcessSessionFactory&) { + record_set_reader_ = getRecordSetIO<core::RecordSetReader>(context, SplitRecord::RecordReader); + if (!record_set_reader_) { + throw minifi::Exception(ExceptionType::PROCESS_SCHEDULE_EXCEPTION, "Record Reader set is missing or invalid"); + } + record_set_writer_ = getRecordSetIO<core::RecordSetWriter>(context, SplitRecord::RecordWriter); + if (!record_set_writer_) { + throw minifi::Exception(ExceptionType::PROCESS_SCHEDULE_EXCEPTION, "Record Writer set is missing or invalid"); + } +} + +nonstd::expected<std::size_t, std::string> SplitRecord::readRecordsPerSplit(core::ProcessContext& context, const std::shared_ptr<core::FlowFile>& original_flow_file) { + std::string value; + std::size_t records_per_split = 0; + if (context.getProperty(RecordsPerSplit, value, original_flow_file.get())) { + if (!core::Property::StringToInt(value, records_per_split)) { + return nonstd::make_unexpected("Failed to convert Records Per Split property to an integer"); + } else if (records_per_split < 1) { + return nonstd::make_unexpected("Records per split should be set to a number larger than 0"); + } + } else { + return nonstd::make_unexpected("Records per split should be set to a valid number larger than 0"); + } + return records_per_split; +} + +void SplitRecord::onTrigger(core::ProcessContext& context, core::ProcessSession& session) { + const auto original_flow_file = session.get(); + if (!original_flow_file) { + yield(); + return; + } + + auto records_per_split = readRecordsPerSplit(context, original_flow_file); + if (!records_per_split) { + logger_->log_error("Failed to read Records Per Split property: {}", records_per_split.error()); + session.transfer(original_flow_file, Failure); + return; + } + + auto record_set = record_set_reader_->read(original_flow_file, session); + if (!record_set) { + logger_->log_error("Failed to read record set from flow file: {}", record_set.error().message()); + session.transfer(original_flow_file, Failure); + return; + } + + std::size_t current_index = 0; + const auto fragment_identifier = utils::IdGenerator::getIdGenerator()->generate().to_string(); + std::size_t fragment_index = 0; + std::size_t fragment_count = record_set->size() / records_per_split.value() + (record_set->size() % records_per_split.value() == 0 ? 0 : 1); + while (current_index < record_set->size()) { + auto split_flow_file = session.create(original_flow_file.get()); + if (!split_flow_file) { + logger_->log_error("Failed to create a new flow file for record set"); + session.transfer(original_flow_file, Failure); + return; + } + + core::RecordSet slice_record_set; Review Comment: ```suggestion core::RecordSet slice_record_set; slice_record_set.reserve(*records_per_split); ``` ########## extensions/standard-processors/processors/SplitRecord.cpp: ########## Review Comment: I'd prefer removing the redundant namespace and scope prefixes. All of the grayed out text (except legacy enums like ExceptionType) on the screenshot, + more elsewhere.  -- 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]
