valb3r / flowable-bpmn-intellij-plugin Goto Github PK

Describe the bug
Reduce contrast in existing Darcula theming and make service tasks look more Darcula as well

Is your feature request related to a problem? Please describe.
We need to handle extensionElements in ServiceTask like mule, camel, etc. tasks and show those extension elements in UI (limit to shallow extension elements)

Describe the solution you'd like
Extension elements handled for:

• business-rule-task
• camel-task
• decision-task
• http-task
• mail-task
• manual-task
• mule-task
• receive-task
• script-task
• service-task
• shell-task
• user-task

Deep extension elements to be handled by:
#125

We need to add support to modify visuals of the BPMN diagram - element positions and arrows linkage + undo/redo - in memory only

• Arrow anchors in-memory persistence after drag
• Snap to service task anchors when dragging
• Remove arrow anchors via menu

Is your feature request related to a problem? Please describe.
As per https://documentation.flowable.com/latest/user/design/bpmn-editor/#service-task
Class:

The fully qualified name of a class which either implements the class JavaDelegate or ActivityBehavior.

Delegate expression:

The fully qualified name of a class which either implements the class JavaDelegate or ActivityBehavior.

Describe the solution you'd like
IntelliJ tooltips and code completion should check for the above facts

Dragging the service task and other similar elements should be done with attached edges

We need to be able to jump to XML line with element declaration (when element is selected) using popup menu or some canvas icon and a hotkey, so that you can jump directly to XML

Is your feature request related to a problem? Please describe.
In order to support manual/3rd party editing of the underlying XML file with process definition, we need to listen for update events in IntelliJ. See:
https://www.jetbrains.org/intellij/sdk/docs/basics/architectural_overview/virtual_file.html#how-do-i-get-notified-when-vfs-changes

Describe the solution you'd like
Listener for drawn XML file change that causes complete update when XML file change was detected

Currently, BPMN diagram is loaded in same thread as ToolWindow invocation. We need to make it as a background process to support large diagrams

Element ID change is a cascading operation and it should be handled properly

• Property changes handling after ID updates
• Cascading to related shapes
• Drag references update after id changed

Describe the bug
After performing multi-select and drag and chaning some element ID, that element can no more drag elements that are attached to it

Describe the bug
Can't edit process name section or documentation section using plugin

Currently, EditorTextField shows error as it expects ';' at the line end. We need to change this behavior - by i.e. switching language text field language or by customizing highlighter

Add support for

<parallelGateway id="parallelGatewayId" name="Parallel gateway name" flowable:async="true">
            <documentation>Parallel gateway docs</documentation>
 </parallelGateway>

Describe the bug
When ID is updated and element name afterwards NPE seem to happen occasionally.

To Reproduce

kotlin.TypeCastException: null cannot be cast to non-null type org.w3c.dom.Element
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.applyPropertyUpdateWithId(FlowableParser.kt:310)
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.doUpdate(FlowableParser.kt:133)
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.parseAndWrite(FlowableParser.kt:115)
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.update(FlowableParser.kt:98)
	at com.valb3r.bpmn.intellij.plugin.events.ProcessModelUpdateEvents.commitToFile(ProcessModelUpdateEvents.kt:62)
	at com.valb3r.bpmn.intellij.plugin.events.ProcessModelUpdateEvents.addPropertyUpdateEvent(ProcessModelUpdateEvents.kt:87)
	at com.valb3r.bpmn.intellij.plugin.properties.PropertiesVisualizer$buildTextField$1.invoke(PropertiesVisualizer.kt:67)
	at com.valb3r.bpmn.intellij.plugin.properties.PropertiesVisualizer$buildTextField$1.invoke(PropertiesVisualizer.kt:17)
	at com.valb3r.bpmn.intellij.plugin.properties.PropertiesVisualizer.clear(PropertiesVisualizer.kt:24)
	at com.valb3r.bpmn.intellij.plugin.render.Canvas.click(Canvas.kt:84)
	at com.valb3r.bpmn.intellij.plugin.MouseEventHandler.mouseClicked(MouseEventHandler.kt:23)
	at java.awt.Component.processMouseEvent(Component.java:6553)
	at javax.swing.JComponent.processMouseEvent(JComponent.java:3325)
	at java.awt.Component.processEvent(Component.java:6315)
	at java.awt.Container.processEvent(Container.java:2239)
	at java.awt.Component.dispatchEventImpl(Component.java:4899)
	at java.awt.Container.dispatchEventImpl(Container.java:2297)
	at java.awt.Component.dispatchEvent(Component.java:4721)
	at java.awt.LightweightDispatcher.retargetMouseEvent(Container.java:4904)
	at java.awt.LightweightDispatcher.processMouseEvent(Container.java:4544)
	at java.awt.LightweightDispatcher.dispatchEvent(Container.java:4476)
	at java.awt.Container.dispatchEventImpl(Container.java:2283)
	at java.awt.Window.dispatchEventImpl(Window.java:2746)
	at java.awt.Component.dispatchEvent(Component.java:4721)
	at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:766)
	at java.awt.EventQueue.access$500(EventQueue.java:98)
	at java.awt.EventQueue$3.run(EventQueue.java:715)
	at java.awt.EventQueue$3.run(EventQueue.java:709)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:74)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:84)
	at java.awt.EventQueue$4.run(EventQueue.java:739)
	at java.awt.EventQueue$4.run(EventQueue.java:737)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:74)
	at java.awt.EventQueue.dispatchEvent(EventQueue.java:736)
	at com.intellij.ide.IdeEventQueue.defaultDispatchEvent(IdeEventQueue.java:974)
	at com.intellij.ide.IdeEventQueue.dispatchMouseEvent(IdeEventQueue.java:912)
	at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:844)
	at com.intellij.ide.IdeEventQueue.lambda$null$8(IdeEventQueue.java:449)
	at com.intellij.openapi.progress.impl.CoreProgressManager.computePrioritized(CoreProgressManager.java:741)
	at com.intellij.ide.IdeEventQueue.lambda$dispatchEvent$9(IdeEventQueue.java:448)
	at com.intellij.openapi.application.impl.ApplicationImpl.runIntendedWriteActionOnCurrentThread(ApplicationImpl.java:831)
	at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:502)
	at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:205)
	at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:116)
	at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:105)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:93)
	at java.awt.EventDispatchThread.run(EventDispatchThread.java:82)

Currently, elements are rendered purely in functional style. We need to make object-oriented rendering instead.

We need to support persistence to XML of changes done in memory

• Drop new sequence arrows at randomized location for easy grabbing
• Do not allow to change edge origin as it declares the type of an edge
• Assign targetRef for sequence element on drag end if anchor exists
• Properties persistence
• BPMN elements added/removed persistence
• Edge elements persistence
• Diagram flow persistence

Is your feature request related to a problem? Please describe.
A quote from Flowable docs:

It is possible to configure Service Tasks in four ways:
    Use a Value Expression.
    Specifying a class that implements JavaDelegate or ActivityBehavior.
    Evaluating an expression that resolves to a delegation object.
    Invoking a method expression.

Currently, we support:
Evaluating an expression that resolves to a delegation object.

Describe the solution you'd like
Expand code navigation with:

• Use a Value Expression.
• Specifying a class that implements JavaDelegate or ActivityBehavior.
• Invoking a method expression.

Is your feature request related to a problem? Please describe.
Need to complete undo/redo functionality in plugin as well

Describe the solution you'd like
Undo/redo buttons in plugin UI

We need to add support to:

1. Imply that call activity executes some process (to be able to provide this process name)
2. Expand and collapse the implied process within call activity

Is your feature request related to a problem? Please describe.
Certain ServiceTask customizations like camelTask use extensionElements to supply additional properties

Describe the solution you'd like
Read/Write support for extension elements

Is your feature request related to a problem? Please describe.
Create a demo playground repository for feature demonstration and debugging

Describe the solution you'd like
Demo GitHub repository with small project to show how stuff works

Is your feature request related to a problem? Please describe.
Add capability to show context varibles in debugging mode

Is your feature request related to a problem? Please describe.
CI/CD pipeline to run test and publish artifacts

Describe the solution you'd like
GitHub Actions CI/CD runner

Is your feature request related to a problem? Please describe.
Add support to select default flow element of the gateway

Describe the solution you'd like
Display default outgoing gateway route and selector for it

I haven't looked at the code and how everything is done.

It would be great if the id, name and documentation are displayed for every element. For example this with a user task and boundary signal.

Not sure if you are using your own parser of the XML or you are reusing the BpmnModel from Flowable. If you are reusing the BpmnModel you might benefit of not needing to do the parsing yourself and you can focus on the drawing and displaying the information.

Describe the bug
Changing element ID when it is used as default gateway reference keeps old ID

kotlin.TypeCastException: null cannot be cast to non-null type org.w3c.dom.Node
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.applyBpmnElementRemoved(FlowableParser.kt:223)
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.doUpdate(FlowableParser.kt:130)
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.parseAndWrite(FlowableParser.kt:115)
	at com.valb3r.bpmn.intellij.plugin.flowable.parser.FlowableParser.update(FlowableParser.kt:98)
	at com.valb3r.bpmn.intellij.plugin.events.ProcessModelUpdateEvents.commitToFile(ProcessModelUpdateEvents.kt:62)
	at com.valb3r.bpmn.intellij.plugin.events.ProcessModelUpdateEvents.addPropertyUpdateEvent(ProcessModelUpdateEvents.kt:87)
	at com.valb3r.bpmn.intellij.plugin.properties.PropertiesVisualizer$buildTextField$2.invoke(PropertiesVisualizer.kt:72)
	at com.valb3r.bpmn.intellij.plugin.properties.PropertiesVisualizer$buildTextField$2.invoke(PropertiesVisualizer.kt:17)
	at com.valb3r.bpmn.intellij.plugin.properties.PropertiesVisualizer.notifyDeFocusElement(PropertiesVisualizer.kt:61)
	at com.valb3r.bpmn.intellij.plugin.properties.PropertiesVisualizer.visualize(PropertiesVisualizer.kt:39)
	at com.valb3r.bpmn.intellij.plugin.render.Canvas.click(Canvas.kt:83)
	at com.valb3r.bpmn.intellij.plugin.MouseEventHandler.mouseClicked(MouseEventHandler.kt:23)
	at java.awt.Component.processMouseEvent(Component.java:6553)
	at javax.swing.JComponent.processMouseEvent(JComponent.java:3325)
	at java.awt.Component.processEvent(Component.java:6315)
	at java.awt.Container.processEvent(Container.java:2239)
	at java.awt.Component.dispatchEventImpl(Component.java:4899)
	at java.awt.Container.dispatchEventImpl(Container.java:2297)
	at java.awt.Component.dispatchEvent(Component.java:4721)
	at java.awt.LightweightDispatcher.retargetMouseEvent(Container.java:4904)
	at java.awt.LightweightDispatcher.processMouseEvent(Container.java:4544)
	at java.awt.LightweightDispatcher.dispatchEvent(Container.java:4476)
	at java.awt.Container.dispatchEventImpl(Container.java:2283)
	at java.awt.Window.dispatchEventImpl(Window.java:2746)
	at java.awt.Component.dispatchEvent(Component.java:4721)
	at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:766)
	at java.awt.EventQueue.access$500(EventQueue.java:98)
	at java.awt.EventQueue$3.run(EventQueue.java:715)
	at java.awt.EventQueue$3.run(EventQueue.java:709)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:74)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:84)
	at java.awt.EventQueue$4.run(EventQueue.java:739)
	at java.awt.EventQueue$4.run(EventQueue.java:737)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:74)
	at java.awt.EventQueue.dispatchEvent(EventQueue.java:736)
	at com.intellij.ide.IdeEventQueue.defaultDispatchEvent(IdeEventQueue.java:974)
	at com.intellij.ide.IdeEventQueue.dispatchMouseEvent(IdeEventQueue.java:912)
	at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:844)
	at com.intellij.ide.IdeEventQueue.lambda$null$8(IdeEventQueue.java:449)
	at com.intellij.openapi.progress.impl.CoreProgressManager.computePrioritized(CoreProgressManager.java:741)
	at com.intellij.ide.IdeEventQueue.lambda$dispatchEvent$9(IdeEventQueue.java:448)
	at com.intellij.openapi.application.impl.ApplicationImpl.runIntendedWriteActionOnCurrentThread(ApplicationImpl.java:831)
	at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:502)
	at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:205)
	at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:116)
	at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:105)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:93)
	at java.awt.EventDispatchThread.run(EventDispatchThread.java:82)

Is your feature request related to a problem? Please describe.
UI test suite

Test cases

• Basic rendering
• Rendering of actions for the selected element
• Removing elements
• Adding sequence flow element
• Adding service task and dragging sequence on it
• Dragging sequence element directly to target
• Dragging sequence element to target with intermediate stop
• Adding waypoint to a sequence element
• Adding multiple waypoints to a sequence element
• Dragging element with sequence elements attached
• Renaming element ID cascades
• Renaming element ID cascades and location is followed
• Selecting all elements with a rectangle and dragging them
• Selecting service task element and edge with a rectangle and dragging it
• Removing service task works
• Removing edge element works
• Removing waypoint works

BPMN element that is associated with sequenceFlow is not removed, only Diagram element is removed

Describe the bug
Currently, when a new waypoint element is added edge structure gets hidden. We need to keep edge structure visible

Just wanted to say thanks for the work, ad keep it up!

You might want to add a pattern page or something where you'd get some funding :)

Sorry for polluting the issue tracker :)

Capability to show at which bpmn element are you now when working with debugger within IDEA

We need to support multiple processes/diagrams definition in XML file

Describe the bug
We use UUID for new ID generation strategy, but actually IDs are of NCName type
https://stackoverflow.com/questions/1631396/what-is-an-xsncname-type-and-when-should-it-be-used

To Reproduce
Add any new element - it will have UUID-based ID

We need to add support to add or remove BPMN elements using tool pane on the left of plugin screen.
With undo/redo - in memory only

• Capability to add BPMN element
• Capability to remove BPMN element
• Capability to add edge element

Describe the bug
Change something in the Diagram View and try to undo the change.

Expected behaviour
Be able to undo a change done in the diagram

IntelliJ version (please complete the following information):
IntelliJ IDEA 2020.1.2 Preview (Ultimate Edition)
Build #IU-201.7846.6, built on May 13, 2020

Describe the bug
The formal expression is not wrapped into CDATA

To Reproduce
Store exclusive gateway with formal expression
the result is:

<conditionExpression xsi:type="tFormalExpression">${data.isAvailable(CONTEXT)}</conditionExpression>

conditionExpression should be CDATA

Is your feature request related to a problem? Please describe.
Add ability to select more than 1 element using a rectangular selection area

Describe the solution you'd like
Multi-select with area-like selection tool

Add support for the nested subprocess with (without collapsed subprocess)

Tasks:

• Correct subprocess rendering
• Correct drag end target for elements in the subprocess
• Support for element addition to subprocess
• Support for element removal from subprocess
• Support for element resizing
• Support for subprocess dragging (cascade drag to child elements)
• Correct propagation of added elements in XML
• When the element is dropped in or out from subprocess, its parent should change accordingly
• Selection rectangle should be allowed to start in subprocess
• Prevent selection of children elements with rectangle if parent already selected
• Adding element with right mouse button should select correct parent
• Test with rectangle dragging in subprocess
• Test with single selection dragging in subprocess
• Test with subprocess dragging
• Dumb test for XML update by resize
• Dumb test for XML update by parent change

We need to support dark theme properly

Is your feature request related to a problem? Please describe.
Show names on the outgoing gateway elements

Describe the solution you'd like
Names on outgoing gateway segments and gateways

Support for:

<inclusiveGateway id="inclusiveGatewayId" name="Inclusive gateway name" flowable:async="true">
            <documentation>Inclusive gateway docs</documentation>
</inclusiveGateway>

Describe the bug
When dragging begin/end points of edge elements, shape's key anchor should be shown and they should have greater weight compared to horizontal/vertical anchors

Is your feature request related to a problem? Please describe.
Add support for viewing basic information like ID and documentation for all elements. Also, add the same or similar icons for them as are used in Flowable

• Camel task
• Http task
• Mule task
• Shell task
• Decision task
• Sub process
• Transaction Sub process
• Collapsed sub process
• Event sub process
• Ad hoc subprocess
• Parrallel gateway
• Inclusive gateway
• Event gateway
• Intermediate timer catching event
• Intermediate signal catching event
• Intermediate message catching event
• Intermediate conditional catching event
• Intermediate throwing event
• Intermediate signal throwing event
• Intermediate escalation throwing event
• End error event
• End escalation event
• End cancel event
• End terminate event
• Start timer event
• Start signal event
• Start message event
• Start error event
• Start escalation event
• Start conditional event

Also, element attached events:

• Boundary timer event
• Boundary error event
• Boundary signal event
• Boundary message event
• Boundary cancel event
• Boundary conditional event
• Boundary compensation event

Add support for properties modification and redo/undo - currently only in memory

Is your feature request related to a problem? Please describe.
When selecting multiple elements we need to have ability to remove all selected element.

Is your feature request related to a problem? Please describe.
XML parsing should be tested for updates and read

Test that validates parsing of multiple elements of the same type when they are interlaced

serviceTask
userTask
serviceTask
userTask

Is your feature request related to a problem? Please describe.

One other thing I noticed (not sure if it is related to this) is that the UI is not linked to the BPMN document. It is a dedicated section. Does it make sense to have it as a split view in the same section as the document? Similar to how the markdown support from IntelliJ looks like

Need to check how tightly this functionality will couple the plugin to IDE

Describe the solution you'd like
POC of markdown plugin alike rendering of BPMN diagram

Add support for

 <subProcess id="collapsedSubProcess" name="Collapsed subprocess name" flowable:async="true">
            <documentation>Collapsed sub process docs</documentation>
            <multiInstanceLoopCharacteristics isSequential="false" flowable:collection="COLLECTION" flowable:elementVariable="ELEM_VAR">
                <loopCardinality>12</loopCardinality>
                <completionCondition>completionCondition</completionCondition>
            </multiInstanceLoopCharacteristics>
        </subProcess>