NIFI-14064: Descriptions are not shown for Python processors

[takraj]

Bug's been present since fb2a82c / PR #9288 , which changed the way documentations are generated. The new view dyamically fetches the information to be shown from the NIFI API, which did not return the component tags for Python processors in the manifest. Since the new documentation viewer always expects the tags to be returned, it has errored out when a python component was selected, which resulted in none of the documentation had been shown.

This PR attempts to fix this issue by adding the missing information to the API response.

Summary

NIFI-14064

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 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 mvn clean install -P contrib-check
  • JDK 21

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]

@takraj Can you clarify and add some details about the changes in this pull request? The only runtime code change is the addition of Tags from Python Processors, but the title of the pull request says Descriptions are not shown. The description does appear to be set already in StandardRuntimeManifestService.createExtension().

The test updates appear to be useful, but given the scope of the changes, it would be helpful to revert the import ordering changes.

[takraj]

@exceptionfactory Sure. The referenced PR #9288 changes the way component documentations are generated. From my understanding, earlier these documentations were somehow pre-generated during startup, but now it is loaded dynamically by the documentation view, using the NIFI REST API. Since this PR, when I add a Python processor, and open the doc view, basically only the name, version, and the relationships are shown. On the other hand, it works as expected for normal Java based processors. When I opened the browser's debug console I've spotted some error messages, when selecting any of the Python processors, that were referring to the missing 'tags' key from the API response. I have checked the endpoint manually, and compared the responses for Python and Java processors, and confirmed that some of the keys are missing in the former case. The Python processor had tags defined as well, but they were missing from the API response. And the rest is basically tracing back the code...

[exceptionfactory]

Thanks for the additional background @takraj, that is helpful. For future clarity, summarizing the changes in the PR title and description, as opposed to just mentioning the behavioral bug, would be helpful.

Thanks for reverting the import ordering changes. I noted a few additional adjustments necessary regarding use of some collection classes, and otherwise this looks close to completion.

[exceptionfactory]

Internal Mockito utility classes should never be used. It looks like this can be replaced with Set.of()

[takraj]

Addressed in 030405d

[takraj]

@exceptionfactory I have updated the PR description to reflect my intent.

[exceptionfactory]

Thanks for making the adjustments and clarifications @takraj, looks good! +1 merging