NIFI-14442 Show bundle version changes in versioned flow differences #9967

mosermw · 2025-05-21T21:27:46Z

Summary

This PR collects bundle version differences between a local Versioned Process Group and its FlowRegistry version.
These differences will only appear after another local change has been made. Bundle version differences still do not
count when determining a Versioned Process Group's state.

This does not handle the case when a Versioned Process Group is imported from a FlowRegistry and then local changes
are immediately made. In this scenario, there will be no bundle version differences. This is because that Process Group's
versioned snapshot is modified from what is in the FlowRegistry, to update bundle versions and references to controller services
and parameter providers. However, if you restart NiFi, the PG's versioned snapshot is pulled from the FlowRegisry on
startup, and then bundle version differences will be shown.

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

[n/a] New dependencies are compatible with the Apache License 2.0 according to the License Policy
[n/a] New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

Documentation formatting appears as expected in rendered files

NissimShiman · 2025-06-19T14:36:10Z

Reviewing...

joewitt · 2025-06-19T14:46:30Z

@bbende Can you take a look from a review perspective?

NissimShiman · 2025-06-19T16:13:46Z

I think letting users know that a component bundle update is occurring is a nice addition. Especially the way it is being done conditionally.
I've noticed that the list of local changes has a "Go To" option next to the "Component Bundle Changed" which doesn't lead anywhere. Would it be a big deal to remove that option for this?

Also noticed that if a versioned PG is in flow, NiFi is restarted, PG is updated (and new version pushed to registry) and then is rolled back and then a new change is made (but not committed yet) , the component bundle update does not show up as a local change, but if NiFi is again restarted it will. Is this expected?

...ework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiServiceFacade.java

...fi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java

mosermw · 2025-06-25T17:00:26Z

Thanks for having a look at this PR @NissimShiman

I've noticed that the list of local changes has a "Go To" option next to the "Component Bundle Changed" which doesn't lead anywhere. Would it be a big deal to remove that option for this?

I was able to get something to work, then I noticed there is an open PR for NIFI-14637 that does almost exactly what I was going to do. So I think we can wait for that PR to merge, then I can modify this PR to rebase and take advantage of that code.

Also noticed that if a versioned PG is in flow, NiFi is restarted, PG is updated (and new version pushed to registry) and then is rolled back and then a new change is made (but not committed yet) , the component bundle update does not show up as a local change, but if NiFi is again restarted it will. Is this expected?

Yes it's expected. This is because the ProcessGroup stores a copy of its versioned snapshot, which typically has already been modified from what's in the FlowRegistry.

mosermw · 2025-06-25T20:05:25Z

I've noticed that the list of local changes has a "Go To" option next to the "Component Bundle Changed" which doesn't lead anywhere. Would it be a big deal to remove that option for this?

I was able to get something to work, then I noticed there is an open PR for NIFI-14637 that does almost exactly what I was going to do. So I think we can wait for that PR to merge, then I can modify this PR to rebase and take advantage of that code.

The PR 10028 got merged, so I rebased this PR and added the condition to prevent showing the "Go To" action for bundle version differences.

NissimShiman · 2025-07-01T19:14:17Z

I have tested the "Go To" option will not appear for these changes (and looked over the code as well).
Thank you @mosermw for resolving that.

This now performs as described in the jira (with the known edge case in the comment still present).

This lets the user know in many cases that a bundle version change is about to be persisted to registry, but maybe the edge case could be worked out as well.

More work would be needed so a process group's versioned snapshot should not be modified from what is in the FlowRegistry to make this edge case work as well, but that is a lot of work.

@bbende Is this something that would make sense to be done as part of this PR? or this something that should be left alone?
(and, if it should be left alone, is the PR good as is? If we are OK leaving the edge case out, I am +1 on this.)

exceptionfactory

Thanks for proposing this improvement to highlighting bundle version differences @mosermw. The concept seems useful in some scenarios, but I'm not sure about the implementation, particularly reformatting the structure in the DtoFactory. It seems like this should be implemented elsewhere as part of the comparison process.

exceptionfactory · 2025-09-07T01:28:36Z

...fi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java

       return differencesByComponent.keySet();
   }

+   private static final Pattern DIFFERENCE_DESCRIPTION_PATTERN = Pattern.compile(".*artifact='(.*)'.*version='(.*)'].*version='(.*)']'$");


Introducing this pattern to reformat the description seems potentially brittle. It would be better to either change it elsewhere, or build the description using values available from the FlowDifference.

I appreciate your eyes on this PR @exceptionfactory. This was the least intrusive approach I could think of at the time, but I agree it is potentially brittle. I will see what I can do to make improvements.

Thanks for looking into alternative approaches, sounds good.

I moved this code to the ConciseEvolvingDifferenceDescriptor class where some other difference descriptions are generated, and I do think this made the code cleaner.

Should I rebase this PR onto main, to try to resolve the macos build/test issues in the CI checks? Or can those checks be ignored for now?

Thanks, rebasing would be a good next step.

… but only if versions are not the only differences

…created

exceptionfactory

Thanks for the updates @mosermw. I noted a few minor questions and comments, but this looks closer to completion.

exceptionfactory · 2025-10-11T21:07:37Z

...work/nifi-framework-components/src/main/java/org/apache/nifi/util/FlowDifferenceFilters.java

            || isLogFileSuffixChange(difference);
    }

+    public static boolean isBundleChange(final FlowDifference difference) {


This only seems to be used once, is it necessary?

exceptionfactory · 2025-10-11T21:09:26Z

...fi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java

+       // bundle difference could apply to many components, but use the Process Group identifier as
+       // the Component Identifier here so that many similar component differences can be easily deduped
+       dto.setComponentId(component.getGroupIdentifier());


This seems questionable, would it hide multiple component version differences in a given Process Group?

exceptionfactory · 2025-10-11T21:10:56Z

...fi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java

+
+       if (!differencesByComponent.isEmpty()) {
+           // differences were found, so now let's add back in any BUNDLE_CHANGED differences
+           // since they were initially filtered out as an environment-specific change


Does this mean that bundle changes are no longer considered environment-specific changes?

NissimShiman suggested changes Jun 19, 2025

View reviewed changes

...ework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiServiceFacade.java Show resolved Hide resolved

...fi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java Outdated Show resolved Hide resolved

mosermw force-pushed the NIFI-14442 branch from b391abd to 930fbfd Compare June 25, 2025 20:03

exceptionfactory requested changes Sep 7, 2025

View reviewed changes

mosermw added 3 commits September 10, 2025 21:01

NIFI-14442 Show bundle version changes in versioned flow differences,…

a1e9ad7

… but only if versions are not the only differences

NIFI-14442 prevent the Go To action for bundle version differences

10badd3

NIFI-14442 refactored where BUNDLE_CHANGED difference description is …

d5af28b

…created

mosermw force-pushed the NIFI-14442 branch from 982b09b to d5af28b Compare September 10, 2025 21:02

exceptionfactory reviewed Oct 11, 2025

View reviewed changes

NIFI-14442 Show bundle version changes in versioned flow differences #9967

Are you sure you want to change the base?

NIFI-14442 Show bundle version changes in versioned flow differences #9967

Uh oh!

Conversation

mosermw commented May 21, 2025

Summary

Tracking

Issue Tracking

Pull Request Tracking

Pull Request Formatting

Verification

Build

Licensing

Documentation

Uh oh!

NissimShiman commented Jun 19, 2025

Uh oh!

joewitt commented Jun 19, 2025

Uh oh!

NissimShiman commented Jun 19, 2025

Uh oh!

Uh oh!

Uh oh!

mosermw commented Jun 25, 2025

Uh oh!

mosermw commented Jun 25, 2025

Uh oh!

NissimShiman commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

exceptionfactory left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

exceptionfactory left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

NissimShiman commented Jul 1, 2025 •

edited

Loading