NIFI-15671 - Flow import/export with stateful components state#10986
Open
pvillard31 wants to merge 2 commits intoapache:mainfrom
Open
NIFI-15671 - Flow import/export with stateful components state#10986pvillard31 wants to merge 2 commits intoapache:mainfrom
pvillard31 wants to merge 2 commits intoapache:mainfrom
Conversation
Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>
bobpaulin
reviewed
Apr 22, 2026
Contributor
bobpaulin
left a comment
There was a problem hiding this comment.
@pvillard31 This looks like an important change. Working on running some tests with this locally. Provided a few code comments for now.
|
|
||
| final StateManagerProvider stateManagerProvider = context.getStateManagerProvider(); | ||
| if (stateManagerProvider == null) { | ||
| LOG.debug("StateManagerProvider is not available; skipping state restoration for component {}", componentId); |
Contributor
There was a problem hiding this comment.
This makes sense that not having the state manager provider will prevent us from being able to import state. Not blocking the import make sense since the user may want to proceed with out it. However I would challenge if this should be logged only at debug. Shouldn't the user be notified if they were expecting to import state but it was not? These seems like it would very likely impact the behavior after the flow is started. I'd consider this may be a WARN level event.
|
|
||
| final ConfigurableComponent component = componentNode.getComponent(); | ||
| if (component == null) { | ||
| LOG.debug("Component {} is not available; skipping state restoration", componentId); |
|
|
||
| final Stateful stateful = component.getClass().getAnnotation(Stateful.class); | ||
| if (stateful == null) { | ||
| LOG.debug("Component {} ({}) is not annotated with @Stateful; skipping state restoration", componentId, component.getClass().getSimpleName()); |
| if (supportedScopes.contains(Scope.LOCAL) && componentState.getLocalNodeStates() != null && !componentState.getLocalNodeStates().isEmpty()) { | ||
| final int localNodeOrdinal = context.getLocalNodeOrdinal(); | ||
| if (localNodeOrdinal < 0) { | ||
| LOG.debug("Local node ordinal is not set; skipping local state restoration for component {}", componentId); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
NIFI-15671 - Flow import/export with stateful components state
This extends the JSON-based "Download flow definition" / "Upload flow definition" workflow to optionally include component state (processors and controller services annotated with
@Stateful). A newincludeComponentStatequery parameter on the download endpoint controls this. The feature does not apply to registry-based flow versioning.Key behavioral decisions:
GET /process-groups/{id}/download?includeComponentState=trueincludes state; the default isfalse, preserving backward compatibility. The existingObjectMapperconfiguration (FAIL_ON_UNKNOWN_PROPERTIES = false) means older NiFi versions silently ignore the new field.FlowMappingOptions.DEFAULT_OPTIONS(used by the registry path) hasmapComponentState=false. This is architecturally enforced, not just a convention.409 Conflict. This guarantees state consistency.WRITEpermission on the process group (accessing state requires write access). Without state, onlyREADis needed.PUTandPOST .../replace-requests) reject any flow definition containing component state with400 Bad Request, because replacing an existing group produces a mix of new/updated/unchanged components where selective state restoration would be confusing.address:port.Ssource nodes and the destination cluster hasDconnected nodes:S <= Dis allowed (extra nodes get no state),S > Dis rejected with409 Conflict.includeReferencedServices=true, controller services from parent groups are included for wiring but their state is set to null — state export is scoped to the target group only.@Statefulcomponents get state. Non-stateful components always have nullcomponentState, even whenincludeComponentState=true.Note: UI changes would be as part of a follow-up effort.
Tracking
Please complete the following tracking steps prior to pull request creation.
Issue Tracking
Pull Request Tracking
NIFI-00000NIFI-00000VerifiedstatusPull Request Formatting
mainbranchVerification
Please indicate the verification steps performed prior to pull request creation.
Build
./mvnw clean install -P contrib-checkLicensing
LICENSEandNOTICEfilesDocumentation