[jira] [Comment Edited] (NIFIREG-77) Allow a user to see the changes created by the currently loaded version

["Danny Lane (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NIFIREG-77?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16316920#comment-16316920 ] 

Danny Lane edited comment on NIFIREG-77 at 1/8/18 8:57 PM:
-----------------------------------------------------------

I've spent some time looking at the code in NiFi that is used to detect the local changes to a flow.
I was thinking about an endpoint in NiFi Registry in the BucketFlowResource, something along the lines of
{code:java}
/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}
{code}

(versionB could be optional and default to N-1 if omitted)
I've attached a mock of one possible location for invoking the diff from the registry UI. Clicking the 'View Changes' link could display a modal similar to the current 'Show Local Changes' model in NiFi, or it could display the grid inline. There a probably a number of options for the UX here.

The API response for the {{local-modifications}} endpoint in NiFi seems like a good way of returning the diff so I think it might be a good idea to try and keep the registry response to a similar structure. 

Once the diff API is in place it would be available for NiFi to invoke and display a similar screen for changes on its side. 

I'd be happy to try and put this in place if there are no objections?

!Suggestion for diff UX.png!


was (Author: dannylane):
I've spent some time looking at the code in NiFi that is used to detect the local changes to a flow.
I was thinking about an endpoint in NiFi Registry in the BucketFlowResource, something along the lines of
{code:java}
/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}
{code}

(versionB could be optional and default to N-1 if omitted)
I've attached a mock of one possible location for invoking the diff from the registry UI. Clicking the 'View Changes' link could display a modal similar to the current 'Show Local Changes' model in NiFi, or it could display the grid inline. There a probably a number of options for the UX here.

The API response for the {{local-modifications}} endpoint in NiFi seems like a good way of returning the diff so I think it might be a good idea to try and keep the registry response to a similar structure. 

Once the diff API is in place it would be available for NiFi to invoke and display a similar screen for changes on its side. 

!Suggestion for diff UX.png!

> Allow a user to see the changes created by the currently loaded version
> -----------------------------------------------------------------------
>
>                 Key: NIFIREG-77
>                 URL: https://issues.apache.org/jira/browse/NIFIREG-77
>             Project: NiFi Registry
>          Issue Type: Improvement
>    Affects Versions: 0.1.0
>            Reporter: Joseph Percivall
>            Priority: Critical
>         Attachments: Suggestion for diff UX.png
>
>
> As a user, I would like to see the changes that are included in a particular version. More specifically, if I'm on an old version and I upgrade to a version written by someone else, I have no way to know what changes occurred during that version upgrade.
> A simple solution would be to utilize the same logic which displays the current differences between local and stored in the registry and use that to show the differences between the current version N and version N-1. The user could then change between versions to see the changes that happened as part of that version.
> An even better solution (from a DFM perspective) would be to be able to see the changes within any version (not just the most recent). That way a DFM wouldn't have to stop the flow for an extended period of time to view the changes/differences in different versions but I think that'd be more work.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)