exceptionfactory commented on code in PR #10214: URL: https://github.com/apache/nifi/pull/10214#discussion_r2307424729
########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") Review Comment: The property name and variable should be simplified to align with the interface. ```suggestion public static final PropertyDescriptor MESSAGE_NAME_RESOLVER = new PropertyDescriptor.Builder() .name("Message Name Resolver") ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") Review Comment: ```suggestion .description("Service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + Review Comment: ```suggestion ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + schemaCompiler = null; Review Comment: Is this necessary? Unless closing some resource is needed, this entire method can be removed. ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + schemaCompiler = null; + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + logger.debug("Using message name for schema identifier: {}", schemaDefinition.getIdentifier()); + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategyValue); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); + } + + private RecordReader createProtobufRecordReader(final Map<String, String> variables, final InputStream in, final SchemaDefinition schemaDefinition) throws IOException { + final Schema schema = schemaCompiler.compileOrGetFromCache(schemaDefinition); + final ProtoSchemaParser schemaParser = new ProtoSchemaParser(schema); + final MessageName messageName = messageNameResolver.getMessageName(variables, schemaDefinition, in); + final RecordSchema recordSchema = schemaParser.createSchema(messageName.getFullyQualifiedName()); + return new ProtobufRecordReader(schema, messageName.getFullyQualifiedName(), in, recordSchema); + } + + + private void setupMessageNameResolver(final ConfigurationContext context) { + final MessageNameResolverStrategyName messageNameResolverStrategyName = context.getProperty(MESSAGE_NAME_RESOLVER_STRATEGY).asAllowableValue(MessageNameResolverStrategyName.class); + messageNameResolver = switch (messageNameResolverStrategyName) { + case MESSAGE_NAME_PROPERTY -> new PropertyMessageNameResolver(context); + case MESSAGE_NAME_RESOLVER_SERVICE -> context.getProperty(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE).asControllerService(MessageNameResolver.class); + }; + } + + private SchemaDefinition createSchemaDefinitionFromText(final Map<String, String> variables) throws SchemaNotFoundException { + final String schemaTextString = schemaText.evaluateAttributeExpressions(variables).getValue(); + validateSchemaText(schemaTextString); + + final String sha256hex = sha256Hex(schemaTextString); Review Comment: Minor, but recommend renaming this since this implementation details of the hash are less important: ```suggestion final String hash = getHash(schemaTextString); ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + schemaCompiler = null; + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + logger.debug("Using message name for schema identifier: {}", schemaDefinition.getIdentifier()); + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategyValue); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); Review Comment: This PropertyDescriptor instance can be built once as a static variable and just returned from this method. ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/test/java/org/apache/nifi/services/protobuf/TestStandardProtobufReaderPropertyValidation.java: ########## @@ -0,0 +1,191 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import org.apache.nifi.components.ValidationResult; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_STRATEGY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; +import static org.junit.jupiter.api.Assertions.assertEquals; + +class TestStandardProtobufReaderPropertyValidation extends StandardProtobufReaderTestBase { + + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_REFERENCE_READER_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_REGISTRY, MOCK_SCHEMA_REGISTRY_ID); + runner.setProperty(standardProtobufReader, SCHEMA_REFERENCE_READER, MOCK_SCHEMA_REFERENCE_READER_ID); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE, MOCK_MESSAGE_NAME_RESOLVER_ID); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWithoutMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name is required", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutMessageNameResolver() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name Resolver Service is required", invalidResult.getExplanation()); + } + + @Nested + class SchemaTextPropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_TEXT_PROPERTY); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWhenSchemaTextPropertyRemoved() { // default value of ${proto.schema} + runner.removeProperty(standardProtobufReader, SCHEMA_TEXT); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + } + + @Nested + class SchemaNamePropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_NAME, "Any schema name"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithMessageNameResolver() { // default setting from beforeEach + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + + } + + @Test + void testValidWithMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, MESSAGE_NAME, "Any message name"); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithoutVersionAndBranch() { + runner.removeProperty(standardProtobufReader, SCHEMA_VERSION); + runner.removeProperty(standardProtobufReader, SCHEMA_BRANCH_NAME); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWhenBranchAndVersionSetTogether() { + runner.setProperty(standardProtobufReader, SCHEMA_VERSION, "1"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Schema Branch and Schema Version cannot be specified together", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutSchemaRegistry() { + runner.removeProperty(standardProtobufReader, SCHEMA_REGISTRY); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("The 'Use 'Schema Name' Property' Schema Access Strategy requires that the Schema Registry property be set.", invalidResult.getExplanation()); Review Comment: Message string values should generally not be checked for exact comparison. Recommend changing this to test that the explanation contains some particular string, like `Schema Name` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + schemaCompiler = null; + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + logger.debug("Using message name for schema identifier: {}", schemaDefinition.getIdentifier()); + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategyValue); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); + } + + private RecordReader createProtobufRecordReader(final Map<String, String> variables, final InputStream in, final SchemaDefinition schemaDefinition) throws IOException { + final Schema schema = schemaCompiler.compileOrGetFromCache(schemaDefinition); + final ProtoSchemaParser schemaParser = new ProtoSchemaParser(schema); + final MessageName messageName = messageNameResolver.getMessageName(variables, schemaDefinition, in); + final RecordSchema recordSchema = schemaParser.createSchema(messageName.getFullyQualifiedName()); + return new ProtobufRecordReader(schema, messageName.getFullyQualifiedName(), in, recordSchema); + } + + + private void setupMessageNameResolver(final ConfigurationContext context) { + final MessageNameResolverStrategyName messageNameResolverStrategyName = context.getProperty(MESSAGE_NAME_RESOLVER_STRATEGY).asAllowableValue(MessageNameResolverStrategyName.class); + messageNameResolver = switch (messageNameResolverStrategyName) { + case MESSAGE_NAME_PROPERTY -> new PropertyMessageNameResolver(context); + case MESSAGE_NAME_RESOLVER_SERVICE -> context.getProperty(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE).asControllerService(MessageNameResolver.class); + }; + } + + private SchemaDefinition createSchemaDefinitionFromText(final Map<String, String> variables) throws SchemaNotFoundException { + final String schemaTextString = schemaText.evaluateAttributeExpressions(variables).getValue(); + validateSchemaText(schemaTextString); + + final String sha256hex = sha256Hex(schemaTextString); + final SchemaIdentifier schemaIdentifier = SchemaIdentifier.builder() + .name(sha256hex + PROTO_EXTENSION) + .build(); + + return new StandardSchemaDefinition(schemaIdentifier, schemaTextString, SchemaDefinition.SchemaType.PROTOBUF); + } + + private String sha256Hex(final String input) { + MessageDigest digest; + try { + digest = MessageDigest.getInstance("SHA-256"); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException(e); + } + byte[] hash = digest.digest( + input.getBytes(StandardCharsets.UTF_8)); Review Comment: ```suggestion final byte[] hash = digest.digest(input.getBytes(StandardCharsets.UTF_8)); ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") Review Comment: ```suggestion public static final PropertyDescriptor MESSAGE_NAME_RESOLUTION_STRATEGY = new PropertyDescriptor.Builder() .name("Message Name Resolution Strategy") ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/test/java/org/apache/nifi/services/protobuf/TestStandardProtobufReaderPropertyValidation.java: ########## @@ -0,0 +1,191 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import org.apache.nifi.components.ValidationResult; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_STRATEGY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; +import static org.junit.jupiter.api.Assertions.assertEquals; + +class TestStandardProtobufReaderPropertyValidation extends StandardProtobufReaderTestBase { + + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_REFERENCE_READER_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_REGISTRY, MOCK_SCHEMA_REGISTRY_ID); + runner.setProperty(standardProtobufReader, SCHEMA_REFERENCE_READER, MOCK_SCHEMA_REFERENCE_READER_ID); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE, MOCK_MESSAGE_NAME_RESOLVER_ID); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWithoutMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name is required", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutMessageNameResolver() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name Resolver Service is required", invalidResult.getExplanation()); + } + + @Nested + class SchemaTextPropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_TEXT_PROPERTY); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWhenSchemaTextPropertyRemoved() { // default value of ${proto.schema} + runner.removeProperty(standardProtobufReader, SCHEMA_TEXT); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + } + + @Nested + class SchemaNamePropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_NAME, "Any schema name"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithMessageNameResolver() { // default setting from beforeEach + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + + } + + @Test + void testValidWithMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, MESSAGE_NAME, "Any message name"); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithoutVersionAndBranch() { + runner.removeProperty(standardProtobufReader, SCHEMA_VERSION); + runner.removeProperty(standardProtobufReader, SCHEMA_BRANCH_NAME); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWhenBranchAndVersionSetTogether() { + runner.setProperty(standardProtobufReader, SCHEMA_VERSION, "1"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Schema Branch and Schema Version cannot be specified together", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutSchemaRegistry() { + runner.removeProperty(standardProtobufReader, SCHEMA_REGISTRY); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("The 'Use 'Schema Name' Property' Schema Access Strategy requires that the Schema Registry property be set.", invalidResult.getExplanation()); + } + + @Test + void testValidWithoutSchemaName() { // default property value gets set automatically + runner.removeProperty(standardProtobufReader, SCHEMA_NAME); + runner.assertValid(standardProtobufReader); + } + } + + @Nested + class SchemaReferenceReaderSchemaAccessStrategy { + + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_REFERENCE_READER_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_REGISTRY, MOCK_SCHEMA_REGISTRY_ID); + runner.setProperty(standardProtobufReader, SCHEMA_REFERENCE_READER, MOCK_SCHEMA_REFERENCE_READER_ID); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithMessageNameResolver() { // default setting from beforeEach + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + + } + + @Test + void testValidWithMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, MESSAGE_NAME, "Any message name"); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWithoutSchemaRegistry() { + runner.removeProperty(standardProtobufReader, SCHEMA_REGISTRY); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("The 'Schema Reference Reader' Schema Access Strategy requires that the Schema Registry property be set.", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutSchemaReferenceReader() { + runner.removeProperty(standardProtobufReader, SCHEMA_REFERENCE_READER); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Schema Reference Reader is required", invalidResult.getExplanation()); Review Comment: Should be changed to look for `Schema Reference Reader` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + schemaCompiler = null; + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + logger.debug("Using message name for schema identifier: {}", schemaDefinition.getIdentifier()); + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategyValue); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); + } + + private RecordReader createProtobufRecordReader(final Map<String, String> variables, final InputStream in, final SchemaDefinition schemaDefinition) throws IOException { + final Schema schema = schemaCompiler.compileOrGetFromCache(schemaDefinition); + final ProtoSchemaParser schemaParser = new ProtoSchemaParser(schema); + final MessageName messageName = messageNameResolver.getMessageName(variables, schemaDefinition, in); + final RecordSchema recordSchema = schemaParser.createSchema(messageName.getFullyQualifiedName()); + return new ProtobufRecordReader(schema, messageName.getFullyQualifiedName(), in, recordSchema); + } + + + private void setupMessageNameResolver(final ConfigurationContext context) { + final MessageNameResolverStrategyName messageNameResolverStrategyName = context.getProperty(MESSAGE_NAME_RESOLVER_STRATEGY).asAllowableValue(MessageNameResolverStrategyName.class); + messageNameResolver = switch (messageNameResolverStrategyName) { + case MESSAGE_NAME_PROPERTY -> new PropertyMessageNameResolver(context); + case MESSAGE_NAME_RESOLVER_SERVICE -> context.getProperty(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE).asControllerService(MessageNameResolver.class); + }; + } + + private SchemaDefinition createSchemaDefinitionFromText(final Map<String, String> variables) throws SchemaNotFoundException { + final String schemaTextString = schemaText.evaluateAttributeExpressions(variables).getValue(); + validateSchemaText(schemaTextString); + + final String sha256hex = sha256Hex(schemaTextString); + final SchemaIdentifier schemaIdentifier = SchemaIdentifier.builder() + .name(sha256hex + PROTO_EXTENSION) + .build(); + + return new StandardSchemaDefinition(schemaIdentifier, schemaTextString, SchemaDefinition.SchemaType.PROTOBUF); + } + + private String sha256Hex(final String input) { + MessageDigest digest; + try { + digest = MessageDigest.getInstance("SHA-256"); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException(e); + } + byte[] hash = digest.digest( + input.getBytes(StandardCharsets.UTF_8)); + return HexFormat.of().formatHex(hash); + } + + private SchemaDefinition createSchemaDefinitionFromRegistry(final Map<String, String> variables) throws SchemaNotFoundException, IOException { + final String schemaNameValue = schemaName.evaluateAttributeExpressions(variables).getValue(); + validateSchemaName(schemaNameValue); + + final String schemaBranchNameValue = schemaBranchName.evaluateAttributeExpressions(variables).getValue(); + final String schemaVersionValue = schemaVersion.evaluateAttributeExpressions(variables).getValue(); + + final SchemaIdentifier schemaIdentifier = buildSchemaIdentifier(schemaNameValue, schemaBranchNameValue, schemaVersionValue); + return schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + } + + private SchemaIdentifier buildSchemaIdentifier(final String schemaNameValue, final String schemaBranchNameValue, final String schemaVersionValue) throws SchemaNotFoundException { + final SchemaIdentifier.Builder identifierBuilder = SchemaIdentifier.builder().name(schemaNameValue); + + if (schemaBranchNameValue != null && !schemaBranchNameValue.isBlank()) { + identifierBuilder.branch(schemaBranchNameValue); + } + + if (schemaVersionValue != null && !schemaVersionValue.isBlank()) { + try { + identifierBuilder.version(Integer.valueOf(schemaVersionValue)); + } catch (final NumberFormatException nfe) { + throw new SchemaNotFoundException("Could not retrieve schema with name '%s' because a non-numeric version was supplied '%s'" + .formatted(schemaNameValue, schemaVersionValue), nfe); + } + } + + return identifierBuilder.build(); + } + + private void validateSchemaText(final String schemaTextString) throws SchemaNotFoundException { + if (schemaTextString == null || schemaTextString.isBlank()) { + throw new SchemaNotFoundException("Schema text not found"); + } + } + + private void validateSchemaName(final String schemaNameValue) throws SchemaNotFoundException { + if (schemaNameValue == null || schemaNameValue.isBlank()) { + throw new SchemaNotFoundException("Schema name not provided or is blank"); + } + } + + + enum MessageNameResolverStrategyName implements DescribedValue { + + MESSAGE_NAME_PROPERTY("Message Name Property", "Use the 'Message Name' property value to determine the message name"), + MESSAGE_NAME_RESOLVER_SERVICE("Message Name Resolver Service", "Use a 'Message Name Resolver' controller service to dynamically determine the message name"); Review Comment: ```suggestion MESSAGE_NAME_RESOLVER("Message Name Resolver", "Use a 'Message Name Resolver' service to dynamically determine the message name"); ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + schemaCompiler = null; + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + logger.debug("Using message name for schema identifier: {}", schemaDefinition.getIdentifier()); + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategyValue); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); + } + + private RecordReader createProtobufRecordReader(final Map<String, String> variables, final InputStream in, final SchemaDefinition schemaDefinition) throws IOException { + final Schema schema = schemaCompiler.compileOrGetFromCache(schemaDefinition); + final ProtoSchemaParser schemaParser = new ProtoSchemaParser(schema); + final MessageName messageName = messageNameResolver.getMessageName(variables, schemaDefinition, in); + final RecordSchema recordSchema = schemaParser.createSchema(messageName.getFullyQualifiedName()); + return new ProtobufRecordReader(schema, messageName.getFullyQualifiedName(), in, recordSchema); + } + + + private void setupMessageNameResolver(final ConfigurationContext context) { + final MessageNameResolverStrategyName messageNameResolverStrategyName = context.getProperty(MESSAGE_NAME_RESOLVER_STRATEGY).asAllowableValue(MessageNameResolverStrategyName.class); + messageNameResolver = switch (messageNameResolverStrategyName) { + case MESSAGE_NAME_PROPERTY -> new PropertyMessageNameResolver(context); + case MESSAGE_NAME_RESOLVER_SERVICE -> context.getProperty(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE).asControllerService(MessageNameResolver.class); + }; + } + + private SchemaDefinition createSchemaDefinitionFromText(final Map<String, String> variables) throws SchemaNotFoundException { + final String schemaTextString = schemaText.evaluateAttributeExpressions(variables).getValue(); + validateSchemaText(schemaTextString); + + final String sha256hex = sha256Hex(schemaTextString); + final SchemaIdentifier schemaIdentifier = SchemaIdentifier.builder() + .name(sha256hex + PROTO_EXTENSION) + .build(); + + return new StandardSchemaDefinition(schemaIdentifier, schemaTextString, SchemaDefinition.SchemaType.PROTOBUF); + } + + private String sha256Hex(final String input) { + MessageDigest digest; + try { + digest = MessageDigest.getInstance("SHA-256"); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException(e); + } + byte[] hash = digest.digest( + input.getBytes(StandardCharsets.UTF_8)); + return HexFormat.of().formatHex(hash); + } + + private SchemaDefinition createSchemaDefinitionFromRegistry(final Map<String, String> variables) throws SchemaNotFoundException, IOException { + final String schemaNameValue = schemaName.evaluateAttributeExpressions(variables).getValue(); + validateSchemaName(schemaNameValue); + + final String schemaBranchNameValue = schemaBranchName.evaluateAttributeExpressions(variables).getValue(); + final String schemaVersionValue = schemaVersion.evaluateAttributeExpressions(variables).getValue(); + + final SchemaIdentifier schemaIdentifier = buildSchemaIdentifier(schemaNameValue, schemaBranchNameValue, schemaVersionValue); + return schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + } + + private SchemaIdentifier buildSchemaIdentifier(final String schemaNameValue, final String schemaBranchNameValue, final String schemaVersionValue) throws SchemaNotFoundException { + final SchemaIdentifier.Builder identifierBuilder = SchemaIdentifier.builder().name(schemaNameValue); + + if (schemaBranchNameValue != null && !schemaBranchNameValue.isBlank()) { + identifierBuilder.branch(schemaBranchNameValue); + } + + if (schemaVersionValue != null && !schemaVersionValue.isBlank()) { + try { + identifierBuilder.version(Integer.valueOf(schemaVersionValue)); + } catch (final NumberFormatException nfe) { + throw new SchemaNotFoundException("Could not retrieve schema with name '%s' because a non-numeric version was supplied '%s'" + .formatted(schemaNameValue, schemaVersionValue), nfe); + } + } + + return identifierBuilder.build(); + } + + private void validateSchemaText(final String schemaTextString) throws SchemaNotFoundException { + if (schemaTextString == null || schemaTextString.isBlank()) { + throw new SchemaNotFoundException("Schema text not found"); + } + } + + private void validateSchemaName(final String schemaNameValue) throws SchemaNotFoundException { + if (schemaNameValue == null || schemaNameValue.isBlank()) { + throw new SchemaNotFoundException("Schema name not provided or is blank"); + } + } + + + enum MessageNameResolverStrategyName implements DescribedValue { Review Comment: Recommend adjusting to align with the property name suggestion ```suggestion enum MessageNameResolutionStrategy implements DescribedValue { ``` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/test/java/org/apache/nifi/services/protobuf/TestStandardProtobufReaderPropertyValidation.java: ########## @@ -0,0 +1,191 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import org.apache.nifi.components.ValidationResult; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_STRATEGY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; +import static org.junit.jupiter.api.Assertions.assertEquals; + +class TestStandardProtobufReaderPropertyValidation extends StandardProtobufReaderTestBase { + + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_REFERENCE_READER_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_REGISTRY, MOCK_SCHEMA_REGISTRY_ID); + runner.setProperty(standardProtobufReader, SCHEMA_REFERENCE_READER, MOCK_SCHEMA_REFERENCE_READER_ID); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE, MOCK_MESSAGE_NAME_RESOLVER_ID); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWithoutMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name is required", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutMessageNameResolver() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name Resolver Service is required", invalidResult.getExplanation()); + } + + @Nested + class SchemaTextPropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_TEXT_PROPERTY); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWhenSchemaTextPropertyRemoved() { // default value of ${proto.schema} + runner.removeProperty(standardProtobufReader, SCHEMA_TEXT); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + } + + @Nested + class SchemaNamePropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_NAME, "Any schema name"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithMessageNameResolver() { // default setting from beforeEach + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + + } + + @Test + void testValidWithMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, MESSAGE_NAME, "Any message name"); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithoutVersionAndBranch() { + runner.removeProperty(standardProtobufReader, SCHEMA_VERSION); + runner.removeProperty(standardProtobufReader, SCHEMA_BRANCH_NAME); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWhenBranchAndVersionSetTogether() { + runner.setProperty(standardProtobufReader, SCHEMA_VERSION, "1"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Schema Branch and Schema Version cannot be specified together", invalidResult.getExplanation()); Review Comment: Should be changed to just look for `Schema Branch` ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/test/java/org/apache/nifi/services/protobuf/TestStandardProtobufReaderPropertyValidation.java: ########## @@ -0,0 +1,191 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import org.apache.nifi.components.ValidationResult; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MESSAGE_NAME_RESOLVER_STRATEGY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; +import static org.junit.jupiter.api.Assertions.assertEquals; + +class TestStandardProtobufReaderPropertyValidation extends StandardProtobufReaderTestBase { + + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_REFERENCE_READER_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_REGISTRY, MOCK_SCHEMA_REGISTRY_ID); + runner.setProperty(standardProtobufReader, SCHEMA_REFERENCE_READER, MOCK_SCHEMA_REFERENCE_READER_ID); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE, MOCK_MESSAGE_NAME_RESOLVER_ID); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWithoutMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name is required", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutMessageNameResolver() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE); + runner.removeProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Message Name Resolver Service is required", invalidResult.getExplanation()); + } + + @Nested + class SchemaTextPropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_TEXT_PROPERTY); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWhenSchemaTextPropertyRemoved() { // default value of ${proto.schema} + runner.removeProperty(standardProtobufReader, SCHEMA_TEXT); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + } + + @Nested + class SchemaNamePropertyAccessStrategy { + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_NAME, "Any schema name"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithMessageNameResolver() { // default setting from beforeEach + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + + } + + @Test + void testValidWithMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, MESSAGE_NAME, "Any message name"); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithoutVersionAndBranch() { + runner.removeProperty(standardProtobufReader, SCHEMA_VERSION); + runner.removeProperty(standardProtobufReader, SCHEMA_BRANCH_NAME); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWhenBranchAndVersionSetTogether() { + runner.setProperty(standardProtobufReader, SCHEMA_VERSION, "1"); + runner.setProperty(standardProtobufReader, SCHEMA_BRANCH_NAME, "Any branch"); + + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("Schema Branch and Schema Version cannot be specified together", invalidResult.getExplanation()); + } + + @Test + void testInvalidWithoutSchemaRegistry() { + runner.removeProperty(standardProtobufReader, SCHEMA_REGISTRY); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("The 'Use 'Schema Name' Property' Schema Access Strategy requires that the Schema Registry property be set.", invalidResult.getExplanation()); + } + + @Test + void testValidWithoutSchemaName() { // default property value gets set automatically + runner.removeProperty(standardProtobufReader, SCHEMA_NAME); + runner.assertValid(standardProtobufReader); + } + } + + @Nested + class SchemaReferenceReaderSchemaAccessStrategy { + + @BeforeEach + void beforeEach() { + runner.setProperty(standardProtobufReader, SCHEMA_ACCESS_STRATEGY, SCHEMA_REFERENCE_READER_PROPERTY); + runner.setProperty(standardProtobufReader, SCHEMA_REGISTRY, MOCK_SCHEMA_REGISTRY_ID); + runner.setProperty(standardProtobufReader, SCHEMA_REFERENCE_READER, MOCK_SCHEMA_REFERENCE_READER_ID); + // Ensure configuration is valid before running tests + runner.assertValid(standardProtobufReader); + } + + @Test + void testValidWithMessageNameResolver() { // default setting from beforeEach + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + + } + + @Test + void testValidWithMessageNameProperty() { + runner.setProperty(standardProtobufReader, MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY); + runner.setProperty(standardProtobufReader, MESSAGE_NAME, "Any message name"); + enableAllControllerServices(); + runner.assertValid(standardProtobufReader); + } + + @Test + void testInvalidWithoutSchemaRegistry() { + runner.removeProperty(standardProtobufReader, SCHEMA_REGISTRY); + final ValidationResult invalidResult = verifyExactlyOneValidationError(); + + assertEquals("The 'Schema Reference Reader' Schema Access Strategy requires that the Schema Registry property be set.", invalidResult.getExplanation()); Review Comment: Should be changed to look for `Schema Reference Reader` without the entire string. ########## nifi-extension-bundles/nifi-protobuf-bundle/nifi-protobuf-services/src/main/java/org/apache/nifi/services/protobuf/StandardProtobufReader.java: ########## @@ -0,0 +1,306 @@ +/* + * 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 org.apache.nifi.services.protobuf; + +import com.squareup.wire.schema.Schema; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnDisabled; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.components.DescribedValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.PropertyValue; +import org.apache.nifi.context.PropertyContext; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.schema.access.SchemaNotFoundException; +import org.apache.nifi.schemaregistry.services.MessageName; +import org.apache.nifi.schemaregistry.services.MessageNameResolver; +import org.apache.nifi.schemaregistry.services.SchemaDefinition; +import org.apache.nifi.schemaregistry.services.SchemaReferenceReader; +import org.apache.nifi.schemaregistry.services.SchemaRegistry; +import org.apache.nifi.schemaregistry.services.StandardMessageNameFactory; +import org.apache.nifi.schemaregistry.services.StandardSchemaDefinition; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.SchemaRegistryService; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.SchemaIdentifier; +import org.apache.nifi.services.protobuf.schema.ProtoSchemaParser; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; + +import static org.apache.nifi.expression.ExpressionLanguageScope.FLOWFILE_ATTRIBUTES; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_ACCESS_STRATEGY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_BRANCH_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_NAME_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REFERENCE_READER_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_REGISTRY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_TEXT_PROPERTY; +import static org.apache.nifi.schema.access.SchemaAccessUtils.SCHEMA_VERSION; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_PROPERTY; +import static org.apache.nifi.services.protobuf.StandardProtobufReader.MessageNameResolverStrategyName.MESSAGE_NAME_RESOLVER_SERVICE; + +@Tags({"protobuf", "record", "reader", "parser"}) +@CapabilityDescription(""" + Parses Protocol Buffers messages from binary format into NiFi Records. \ + Supports multiple schema access strategies including inline schema text, schema registry lookup, \ + and schema reference readers. + Protobuf reader needs to know the Proto schema message name in order to deserialize the binary payload correctly. \ + The name of this message can be determined statically using 'Message Name' property, \ + or dynamically, using a Message Name Resolver service.""") + +public class StandardProtobufReader extends SchemaRegistryService implements RecordReaderFactory { + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_STRATEGY = new PropertyDescriptor.Builder() + .name("Message Name Resolver Strategy") + .description("Strategy for determining the Protocol Buffers message name for processing") + .required(true) + .allowableValues(MESSAGE_NAME_PROPERTY, MESSAGE_NAME_RESOLVER_SERVICE) + .defaultValue(MESSAGE_NAME_PROPERTY) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME = new PropertyDescriptor.Builder() + .name("Message Name") + .description("Fully qualified name of the Protocol Buffers message including its package (eg. mypackage.MyMessage).") + .required(true) + .expressionLanguageSupported(FLOWFILE_ATTRIBUTES) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_PROPERTY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE = new PropertyDescriptor.Builder() + .name("Message Name Resolver Service") + .description("Controller service that dynamically resolves Protocol Buffer message names from FlowFile content or attributes") + .required(true) + .identifiesControllerService(MessageNameResolver.class) + .dependsOn(MESSAGE_NAME_RESOLVER_STRATEGY, MESSAGE_NAME_RESOLVER_SERVICE) + .build(); + + private static final String PROTO_EXTENSION = ".proto"; + + private volatile ProtobufSchemaCompiler schemaCompiler; + private volatile MessageNameResolver messageNameResolver; + private volatile SchemaReferenceReader schemaReferenceReader; + private volatile SchemaRegistry schemaRegistry; + private volatile String schemaAccessStrategyValue; + private volatile PropertyValue schemaText; + private volatile PropertyValue schemaName; + private volatile PropertyValue schemaBranchName; + private volatile PropertyValue schemaVersion; + + + @OnEnabled + public void onEnabled(final ConfigurationContext context) { + super.storeSchemaAccessStrategy(context); + setupMessageNameResolver(context); + schemaAccessStrategyValue = context.getProperty(SCHEMA_ACCESS_STRATEGY).getValue(); + schemaReferenceReader = context.getProperty(SCHEMA_REFERENCE_READER).asControllerService(SchemaReferenceReader.class); + schemaRegistry = context.getProperty(SCHEMA_REGISTRY).asControllerService(SchemaRegistry.class); + schemaName = context.getProperty(SCHEMA_NAME); + schemaText = context.getProperty(SCHEMA_TEXT); + schemaBranchName = context.getProperty(SCHEMA_BRANCH_NAME); + schemaVersion = context.getProperty(SCHEMA_VERSION); + schemaCompiler = new ProtobufSchemaCompiler(getIdentifier(), getLogger()); + + } + + @OnDisabled + public void onDisabled(final ConfigurationContext context) { + schemaCompiler = null; + } + + @Override + public RecordReader createRecordReader(final Map<String, String> variables, final InputStream in, final long inputLength, final ComponentLog logger) throws IOException, SchemaNotFoundException { + if (SCHEMA_TEXT_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromText(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_NAME_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaDefinition schemaDefinition = createSchemaDefinitionFromRegistry(variables); + return createProtobufRecordReader(variables, in, schemaDefinition); + } else if (SCHEMA_REFERENCE_READER_PROPERTY.getValue().equals(schemaAccessStrategyValue)) { + final SchemaIdentifier schemaIdentifier = schemaReferenceReader.getSchemaIdentifier(variables, in); + final SchemaDefinition schemaDefinition = schemaRegistry.retrieveSchemaDefinition(schemaIdentifier); + logger.debug("Using message name for schema identifier: {}", schemaDefinition.getIdentifier()); + return createProtobufRecordReader(variables, in, schemaDefinition); + } + + throw new SchemaNotFoundException("Unsupported schema access strategy: " + schemaAccessStrategyValue); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(super.getSupportedPropertyDescriptors()); + properties.add(MESSAGE_NAME_RESOLVER_STRATEGY); + properties.add(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE); + properties.add(MESSAGE_NAME); + return properties; + } + + @Override + protected PropertyDescriptor buildSchemaTextProperty() { + return new PropertyDescriptor.Builder() + .fromPropertyDescriptor(SCHEMA_TEXT) + .required(true) + .clearValidators() + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .defaultValue("${proto.schema}") + .description("The text of a Proto 3 formatted Schema") + .build(); + } + + private RecordReader createProtobufRecordReader(final Map<String, String> variables, final InputStream in, final SchemaDefinition schemaDefinition) throws IOException { + final Schema schema = schemaCompiler.compileOrGetFromCache(schemaDefinition); + final ProtoSchemaParser schemaParser = new ProtoSchemaParser(schema); + final MessageName messageName = messageNameResolver.getMessageName(variables, schemaDefinition, in); + final RecordSchema recordSchema = schemaParser.createSchema(messageName.getFullyQualifiedName()); + return new ProtobufRecordReader(schema, messageName.getFullyQualifiedName(), in, recordSchema); + } + + + private void setupMessageNameResolver(final ConfigurationContext context) { + final MessageNameResolverStrategyName messageNameResolverStrategyName = context.getProperty(MESSAGE_NAME_RESOLVER_STRATEGY).asAllowableValue(MessageNameResolverStrategyName.class); + messageNameResolver = switch (messageNameResolverStrategyName) { + case MESSAGE_NAME_PROPERTY -> new PropertyMessageNameResolver(context); + case MESSAGE_NAME_RESOLVER_SERVICE -> context.getProperty(MESSAGE_NAME_RESOLVER_CONTROLLER_SERVICE).asControllerService(MessageNameResolver.class); + }; + } + + private SchemaDefinition createSchemaDefinitionFromText(final Map<String, String> variables) throws SchemaNotFoundException { + final String schemaTextString = schemaText.evaluateAttributeExpressions(variables).getValue(); + validateSchemaText(schemaTextString); + + final String sha256hex = sha256Hex(schemaTextString); + final SchemaIdentifier schemaIdentifier = SchemaIdentifier.builder() + .name(sha256hex + PROTO_EXTENSION) + .build(); + + return new StandardSchemaDefinition(schemaIdentifier, schemaTextString, SchemaDefinition.SchemaType.PROTOBUF); + } + + private String sha256Hex(final String input) { Review Comment: ```suggestion private String getHash(final String input) { ``` -- 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]
