You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@nifi.apache.org by josephxsxn <gi...@git.apache.org> on 2017/03/10 14:38:08 UTC

[GitHub] nifi pull request #1583: NIFI-1131 renamed relationships

GitHub user josephxsxn opened a pull request:

    https://github.com/apache/nifi/pull/1583

    NIFI-1131 renamed relationships

    Thank you for submitting a contribution to Apache NiFi.
    
    In order to streamline the review of the contribution we ask you
    to ensure the following steps have been taken:
    
    ### For all changes:
    - [ ] Is there a JIRA ticket associated with this PR? Is it referenced 
         in the commit message?
    
    - [ ] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    
    - [ ] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    - [ ] Is your initial contribution a single, squashed commit?
    
    ### For code changes:
    - [ ] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
    - [ ] Have you written or updated unit tests to verify your changes?
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)? 
    - [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
    - [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
    - [ ] If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?
    
    ### For documentation related changes:
    - [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
    
    ### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/josephxsxn/nifi NIFI-1131

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/nifi/pull/1583.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1583
    
----
commit 7a3dc0d96db303837a05ed7be1ddbe1916850d43
Author: Joseph Niemiec <jniemie8>
Date:   2017-03-09T19:48:12Z

    NIFI-1131 renamed relationships

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] nifi issue #1583: NIFI-1131 renamed relationships

Posted by trixpan <gi...@git.apache.org>.

Github user trixpan commented on the issue:

    https://github.com/apache/nifi/pull/1583
  
    @josephxsxn  in light of Joe's comments, would you like to close this PR?
    
    Cheers!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] nifi issue #1583: NIFI-1131 renamed relationships

Posted by josephxsxn <gi...@git.apache.org>.

Github user josephxsxn commented on the issue:

    https://github.com/apache/nifi/pull/1583
  
    Trival change in names didnt impact tests. 


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] nifi issue #1583: NIFI-1131 renamed relationships

Posted by joewitt <gi...@git.apache.org>.

Github user joewitt commented on the issue:

https://github.com/apache/nifi/pull/1583

@josephxsxn unfortunately making the change this way would be rather disruptive to existing flows. We learned this lesson on PropertyDescriptor object and for that we added an additional characteristic called 'displayName'. What I'm suggesting is we do the same for Relationship.

By adding a 'displayName' we can allow developers to change/tweak that over time whereas the 'name' cannot change once it is put out in a release unless the change is made during a major release cycle and even then we should try to minimize the frequency since it can make porting flows harder.

The bottom line is the 'name' is an important part of how we establish the persistent knowledge of a connection between two components. If you look in the flow.xml.gz of a flow with a connection you'll see the 'relationship' and in it is the name of the source processors relationship used in that connection. So, changing the 'name' breaks old flows. We can instead add 'displayName' and now that value is what will show up in the UI but is not what is used for underlying persistence. By default the displayName if not set will be whatever the name was (and vice versa) in the code just like PropertyDescriptor but over time the value of name and displayName can diverge and that will be ok provided the Relationship still means what it meant before.

I'll stop rambling. Does this make sense?

---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---