NIFI-12456 Enabled JsonTreeReader and JsonPathReader to parse JSON leniently.

[dan-s1]

Summary

NIFI-12456
The changes in this PR now allow for JsonTreeReader and JsonPathReader to parse incoming JSON leniently which includes allowing

• Java comments (/**/ and //)
• Yaml comments (start of line begins with #)
• leading plus sign in numbers (e.g. +123)
• leading zeros in numbers (e.g. 0001)
• "missing" decimal numbers to end with a decimal point (e.g. 123.)
• "missing value" in an array (i.e. sequence of two commas, without value in-between e.g. ["A",,"C"]),
• trailing comma in an array or member in an object
• use of single quotes for quoting strings (i.e. use of an apostrophe)
• use of unquoted field names

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

• Apache NiFi Jira issue created

Pull Request Tracking

• Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
• Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000
• Pull request contains commits signed with a registered key indicating Verified status

Pull Request Formatting

• Pull Request based on current revision of the main branch
• Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

• Build completed using ./mvnw clean install -P contrib-check
  • JDK 21
  • JDK 25

Licensing

• New dependencies are compatible with the Apache License 2.0 according to the License Policy
• New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

• Documentation formatting appears as expected in rendered files

[exceptionfactory]

Thanks for working on this configuration option @dan-s1. The general approach looks clear, I provided some recommendations on naming.

[dan-s1]

@exceptionfactory I have made all the changes you requested. I am concerned though that the configuration for the YamlTreeReader is now awkward since it extends JsonTreeReader. The property Parsing Strategy is not relevant to YamlTreeReader since Yaml parsing does not support these features. Even the original Allow Comment does not make sense since SnakeYaml (the implementation we use for Yaml parsing) supports parsing comments when one plans to preserve them, but by default it ignores comments as seen in the javadocs. Hence since we are not preserving them we shouldn't need any option to keep them.
The whole reason we had YamlTreeReader extend JsonTreeReader was to not have to duplicate code as the JSON code could drive the Yaml parsing. But the property Parsing Strategy should not be included.

Is the only way possible to remove Parsing Strategy in getSupportedPropertyDescriptors() with code like below?

@Override
    protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
        
        final List<PropertyDescriptor> supportedPropertyDescriptors = new ArrayList<>(super.getSupportedPropertyDescriptors());
        supportedPropertyDescriptors.remove(AbstractJsonRowRecordReader.PARSING_STRATEGY);
        
        return  supportedPropertyDescriptors;
    }

I am assuming I cannot simply remove them in migrateProperties.

So I added that code. Please let me know if that is okay.

[dan-s1]

@exceptionfactory I believe I addressed all the issues you had brought up. Is there anything else you would like me to change for this PR?

[exceptionfactory]

Thanks for making the updates and also adjusting the YAML Reader. The general approach looks good. I noted a few remaining minor things, and then this should be ready to go.

[exceptionfactory]

It looks like this should fall back to "false" to reflect the default behavior.

Suggested change

	final String allowCommentsRawValue = config.getRawPropertyValue(AbstractJsonRowRecordReader.OBSOLETE_ALLOW_COMMENTS).orElse("");
	final String allowCommentsRawValue = config.getRawPropertyValue(AbstractJsonRowRecordReader.OBSOLETE_ALLOW_COMMENTS).orElse(Boolean.FALSE.toString());

[exceptionfactory]

Suggested change

	final String allowCommentsRawValue = config.getRawPropertyValue(AbstractJsonRowRecordReader.OBSOLETE_ALLOW_COMMENTS).orElse("");
	final String allowCommentsRawValue = config.getRawPropertyValue(AbstractJsonRowRecordReader.OBSOLETE_ALLOW_COMMENTS).orElse(Boolean.FALSE.toString());

[exceptionfactory]

Is this necessary? It is not part of the existing version, so it should not need to be removed in the migrate method.