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

danielzhe · 2024-11-22T14:08:22Z

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

…update all references to the old name

danielzhe · 2024-11-22T18:45:14Z

packages/boxed-expression-component/src/expressionVariable/ExpressionVariableMenu.tsx


  const resetFormData = useCallback(() => {
    setExpressionName(selectedExpressionName);
    setDataType(selectedDataType);
  }, [selectedExpressionName, selectedDataType]);

-  // onCancel doens't prevent the onHide call
+  // onCancel doesn't prevent the onHide call


Just a typo.

tiagobento · 2024-11-22T18:55:00Z

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 · 2024-11-25T16:57:29Z

@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 · 2024-11-26T08:51:31Z

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 · 2024-11-26T08:58:57Z

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 · 2024-11-26T09:41:10Z

03

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

jomarko · 2024-11-26T09:46:32Z

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 · 2024-11-26T10:00:08Z

05

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

jomarko · 2024-11-26T10:07:53Z

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 · 2024-11-26T10:14:24Z

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.

- Fixes includes to point to src - Some refactor to reduce nesting

danielzhe · 2024-11-28T20:20:48Z

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

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:
Change applied. Decision tables should be working now
ok
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
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.
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.
ok

jomarko · 2024-11-29T08:42:20Z

@danielzhe thank you for updates

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

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:

packages/dmn-editor/src/refactor/RefactorConfirmationDialog.tsx

Co-authored-by: Kbowers <[email protected]>

danielzhe · 2024-11-29T14:13:22Z

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.

ljmotta

@danielzhe The code looks good. I still didn't finish reviewing all files and test the new feature, but I could see a few things. For the DMN Editor, I could see that many files have the same logic, so why not create a new hook that encapsulate the refactor logic? For instance, the refactor modal and newName states and the applyRename could be returned by this new hook.

  const [isRefactorModalOpen, setIsRefactorModalOpen] = useState(false);
  const [newName, setNewName] = useState("");

// Not sure if this could be add to the hook or not
  const identifierId = useMemo(() => decision["@_id"], [decision]);
  const oldName = useMemo(() => decision["@_label"] ?? decision["@_name"], [decision]);
  const currentName = useMemo(() => {
    return newName === "" ? oldName : newName;
  }, [newName, oldName]);
// End

  const applyRename = useCallback(
    (args: {
      definitions: Normalized<DMN15__tDefinitions>;
      newName: string;
      shouldRenameReferencedExpressions: boolean;
    }) => {
      renameDrgElement({
        ...args,
        index,
        externalDmnModelsByNamespaceMap,
      });
    },
    [externalDmnModelsByNamespaceMap, index]
  );

Another thing that caught my attention was the externalDmnModelsByNamespaceMap creation in many places. Maybe this is the case to add it to the store?

Additionally, I've made some comments inline.

ljmotta · 2024-12-30T21:23:30Z

packages/dmn-editor/stories/misc/empty/Empty.stories.tsx

@@ -23,7 +23,7 @@ import { ns as dmn15ns } from "@kie-tools/dmn-marshaller/dist/schemas/dmn-1_5/ts
 import { generateUuid } from "@kie-tools/boxed-expression-component/dist/api";
 import { DMN15_SPEC } from "@kie-tools/dmn-marshaller/dist/schemas/dmn-1_5/Dmn15Spec";
 import { DmnEditorWrapper, StorybookDmnEditorProps } from "../../dmnEditorStoriesWrapper";
-import { DmnEditor, DmnEditorProps } from "../../../src/DmnEditor";
+import { DmnEditor, DmnEditorProps } from "@kie-tools/dmn-editor/dist/DmnEditor";


ljmotta · 2024-12-30T21:24:54Z

packages/dmn-language-service/src/refactor/IdentifiersRefactor.ts

It's not necessary to create a refactor folder for this file as the name already tells what the file is about.

ljmotta · 2024-12-30T21:25:38Z

packages/dmn-feel-antlr4-parser/src/Uuid.ts

+
+import { v4 as uuid } from "uuid";
+
+export {};


Why this is necessary?

ljmotta · 2024-12-30T22:03:59Z

packages/boxed-expression-component/src/expressionVariable/ExpressionVariableCell.tsx

-          ...variable,
-          "@_name": name,
-          "@_typeRef": typeRef,
+      const variableChangedArgs: ExpressionChangedArgs = {


On other files is used expressionChangedArgs.

ljmotta · 2024-12-30T22:04:14Z

packages/boxed-expression-component/src/expressionVariable/ExpressionVariableMenu.tsx

@@ -100,17 +108,36 @@ export function ExpressionVariableMenu({
  }, [beeGwtService]);

  const saveExpression = useCallback(() => {
-    if (expressionName !== selectedExpressionName || dataType !== selectedDataType) {
-      onVariableUpdated({ name: expressionName, typeRef: dataType });
+    const changes: ExpressionChangedArgs = {


On other files is used expressionChangedArgs.

danielzhe added 2 commits November 19, 2024 20:15

kie-issues#208: Renaming any "NamedElement" on the DMN Editor should …

73496e4

…update all references to the old name

Merge branch 'main' into rename-variables-9.2

36aae9a

tiagobento added the area:dmn label Nov 22, 2024

kie-issues#208: Renaming any "NamedElement" on the DMN Editor should …

de7015e

…update all references to the old name

danielzhe force-pushed the rename-variables-9.2 branch from f04b142 to de7015e Compare November 22, 2024 18:25

danielzhe marked this pull request as ready for review November 22, 2024 18:41

danielzhe requested a review from tiagobento as a code owner November 22, 2024 18:41

danielzhe changed the title ~~[WIP] kie-issues#208: Renaming any "NamedElement" on the DMN Editor should update all references to the old name~~ kie-issues#208: Renaming any "NamedElement" on the DMN Editor should update all references to the old name Nov 22, 2024

danielzhe commented Nov 22, 2024

View reviewed changes

porcelli self-assigned this Nov 23, 2024

jomarko self-requested a review November 25, 2024 09:38

Fix include

2b0a5b3

danielzhe added 2 commits November 26, 2024 17:16

- Fixes issue with Decision Tables

260d504

- Fixes includes to point to src - Some refactor to reduce nesting

Adds cancel to Refactor Confirmation Dialog

329a788

kbowers-ibm reviewed Nov 29, 2024

View reviewed changes

packages/dmn-editor/src/refactor/RefactorConfirmationDialog.tsx Outdated Show resolved Hide resolved

Update packages/dmn-editor/src/refactor/RefactorConfirmationDialog.tsx

170fb15

Co-authored-by: Kbowers <[email protected]>

danielzhe added 2 commits November 29, 2024 15:05

Change text

b695986

Fix test

58d0b7b

License headers

5236f61

ljmotta reviewed Dec 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

danielzhe commented Nov 22, 2024 •

edited

Loading

danielzhe Nov 22, 2024

tiagobento commented Nov 22, 2024

tiagobento commented Nov 25, 2024

jomarko commented Nov 26, 2024

jomarko commented Nov 26, 2024 •

edited

Loading

jomarko commented Nov 26, 2024

jomarko commented Nov 26, 2024

jomarko commented Nov 26, 2024

jomarko commented Nov 26, 2024

jomarko commented Nov 26, 2024

danielzhe commented Nov 28, 2024

jomarko commented Nov 29, 2024

kbowers-ibm left a comment

danielzhe commented Nov 29, 2024

ljmotta left a comment

ljmotta Dec 30, 2024

ljmotta Dec 30, 2024

ljmotta Dec 30, 2024

ljmotta Dec 30, 2024

ljmotta Dec 30, 2024

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

Are you sure you want to change the base?

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

Conversation

danielzhe commented Nov 22, 2024 • edited Loading

danielzhe Nov 22, 2024

Choose a reason for hiding this comment

tiagobento commented Nov 22, 2024

tiagobento commented Nov 25, 2024

jomarko commented Nov 26, 2024

01

jomarko commented Nov 26, 2024 • edited Loading

02

jomarko commented Nov 26, 2024

03

jomarko commented Nov 26, 2024

04

jomarko commented Nov 26, 2024

05

jomarko commented Nov 26, 2024

06

jomarko commented Nov 26, 2024

07

danielzhe commented Nov 28, 2024

jomarko commented Nov 29, 2024

kbowers-ibm left a comment

Choose a reason for hiding this comment

danielzhe commented Nov 29, 2024

ljmotta left a comment

Choose a reason for hiding this comment

ljmotta Dec 30, 2024

Choose a reason for hiding this comment

ljmotta Dec 30, 2024

Choose a reason for hiding this comment

ljmotta Dec 30, 2024

Choose a reason for hiding this comment

ljmotta Dec 30, 2024

Choose a reason for hiding this comment

ljmotta Dec 30, 2024

Choose a reason for hiding this comment

danielzhe commented Nov 22, 2024 •

edited

Loading

jomarko commented Nov 26, 2024 •

edited

Loading