Feature request: Discrepancies in behavior of graph builder and engine compiler

[akphi]

Similar requests

• I have searched and found no existing similar requests

How are you using Studio?

No response

What problems are you trying to solve?

We build the graph of meta-models, so does engine, but since we support edition, sometimes, we are stricter or less strict about several checks. This is a mega-thread to keep track of these cases:

• Feature request: Properly handle duplicated attributes (in enumerations, classes, associations, profiles...) #660
• Bug: Mismatch in Studio and Engine handling of unresolved class mapping ID #880

It's not wrong per se for our graph builder to fail, however, for users who migrated from Pure IDE to Legend Studio this could be a blocker since they don't have an environment to fix these errors productively.

Note that we think these strict checks should still be present in Studio, we should eventually make these hard fails in even engine rather than softening them because these are not something users should or should not do, not must not do, as such, we will keep this thread open till we completely pass migration phase and start to tighten graph builder checks again.

Describe the solution you would like to see implemented

The strategy we agreed upon is to relax our graph-builder and not to hard-fail on these errors, but only issue warnings, see #883. Engine will now detect these issues and return them as warnings and we will block users from saving should we detect these kinds of problems in users' model

• Change engine to return this as a warning as part of the compilation result - @pierredebelen
• Disable saving when there are warnings - @MauricioUyaguari and I think this is too disruptive at the moment and so we won't do it in the first go.
• Show a tab for problems in auxiliary panel for warnings found. We can also show somewhere in the UI that we have warnings, for this to work, we need to show it in the status bar somewhere (see vscode) and consider doing something similar to what we have in Feature request: Support change detection in query builder #1368 - e.g. every time we hit F9, store a hashcode
• Unlike form mode where there's no good way to reveal these warnings, in text mode we can support showing these warnings in yellow squiggle underlines (i.e. markers), and allow clicking from the auxiliary panel to go to error based on source information
• We should have an application flag/config to enable throwing these errors in graph-builder: these errors are the ones mentioned above, this way, we could test these validations better. In production environment, we could turn this flag off so we don't throw error, otherwise, we will just print warning about this - i.e. strict-mode

Describe alternatives you have considered

No response

Documentation, Design, Adoption, Migration Strategy

No response

Contribution

• I would like to work on this feature