kie-issues#208: Renaming any "NamedElement" on the DMN Editor should update all references to the old name

[danielzhe]

Closes: apache/incubator-kie-issues#208

Some comments about the changes:

• We are tracking now all changes performed in BEE reported to DMN Editor. For now, we only have "special treatment" for the Action.VariableChanged;
• A big part of the changes are related to this. Don't panic. It is just an indentation level that can make the PR bigger than it really is;
• In the lower levels of the code, I refactored from "variable" to "identifier", because those objects are not only variables but identifiers;
• I added documentation to a few methods and classes.

Renaming Data Types

Data.Types.mp4

Renaming BKMs and parameters

Bkm.and.Parameters.mp4

General rename

Some.Renames.mp4

Renaming Included Models name
It does not show the confirmation dialog, because doesn't make sense to not update the references in this case, since this already was the default behavior before this PR (when we renamed a included model, we already updated all the references except the expressions, now we update the expressions).

Included.Models.mp4

[danielzhe]

Just a typo.

[tiagobento]

Thank you for the PR @danielzhe. It's going to take me a few days to go over everything with the care it deserves. Will keep you posted!

[tiagobento]

@danielzhe Storybook is pointing to code using ../src because it is used during development. The changes you introduced will make the development experience much worse, requiring us to rebuild stuff after a change, if I'm not mistaken... can you please check?

[jomarko]

01

Using the feature, came to my mind, maybe we could have a third action button 'Cancel', like do nothing? During my testing I was in situation oh, I want to double-check what I will do, so I just wanted to cancel the operation.

[jomarko]

02

The feature seems to not work in decision tables.

In the attached table there is input node IDAnyStruct. This node has a data type set to a custom structure with three fields: A, B and C. Once I renamed A, B or C on the Data Types tab, the occurrences in the decision table were not updated.

I think that at least the row 2 should be updated. I slightly think also decision table header row should be, however that may be very tricky and if we decide to implement, maybe in a separate ticket? I am not sure about the second point.

The same seems to be reproducible if the user is renaming for example the some identifier while in or satisfies expression is a decision table and has an occurrence of the identifier some.

[jomarko]

03

FYI, I didn't check this feature with the List expression because of apache/incubator-kie-issues#1635

[jomarko]

04

Question, should this feature work for BKM node and Invocation expression. Imagine this model:

Where internally the Invocation says it invokes mybkm node.

However if user renames the mybkm to mybkm renamed the Invocation remains the same (notice mybkm in last screenshot):

[jomarko]

05

We have an issue editor allows to define two function parameters with the same name, then renaming does not work.

[jomarko]

06

Is there a way to disable this feature? Committing the rename action starts to be slower, so I expect some user may ask to disable this feature in their environment.

[jomarko]

07

During included models review, I found this apache/incubator-kie-issues#1636, however I think I didn't find issue related to changes of #2760.

[danielzhe]

Thank you for your review, @jomarko !
About the points you commented:

1. I made a new screen with a X in the top corner, where we can cancel the change, like discussed in the private chat. Here is the print:
   
2. Change applied. Decision tables should be working now
3. ok
4. That field is not "expression aware", it is just a text box. We have two tickets to address that, so it is not covered in this:
   a. Invocation Expressions on DMN Editor's Boxed Expression Editor should have autocomplete features on the "function name" header incubator-kie-issues#205
   b. DMN Editor: Request for better support for invocation boxed expression incubator-kie-issues#276
5. As discussed in private chat, that is something that depends on user. We can't (shouldn't) not allow the user to rename it if the name is duplicated. It is up to the user. Once the parameters have duplicated names, there is no way for us to know which one is which inside the expression.
6. No, we don't have. We had a discussion about this and we come to idea to add the confirmation dialog instead an option to disable/enable it, remember? I didn't found out any slow down using the feature. If you can provide some reproducible steps, we can check it.
7. ok

[jomarko]

@danielzhe thank you for updates

I think 1. and 2. works now pretty well.

6. I used this file. Once I rename something there is ~1 second until new modal appears. Once I click rename in that modal, it also takes ~1. I am not saying it is a blocker, I understand that it may be complicated (long time) operation to compute indexes, find identifiers etc. Just want to avoid situation in past in 7.x or 8.x stream, where users working with large models (100+ nodes) were unable even open the model. That is why I asked about possibility to turn off the feature. However, my issue may be local, caused my by laptop, memory parameters and settings. I do not know.

Untitled (2).dmn.txt

[kbowers-ibm]

Hi Daniel,
Thanks for the PR - it looks great! Just a minor comment from my side regarding the message:

[danielzhe]

Hi Daniel, Thanks for the PR - it looks great! Just a minor comment from my side regarding the message:

Thank you for your suggestion! It's always good to have a native English speaker to improve our messages. I'll update the text of the buttons too to match the new message.