Merge pull request #2 from HMubaireek/feat/return-extension-propertie…

…s-documentation-group-elements feat: return group elements, and return extension properties with documentation for elements
HMubaireek · May 6, 2024 · 926ae3a · 926ae3a
2 parents 530ecb4 + 1814d00
commit 926ae3a
Show file tree

Hide file tree

Showing 8 changed files with 90 additions and 24 deletions.
diff --git a/data/src/main/kotlin/io/zeebe/zeeqs/data/entity/BpmnElementType.kt b/data/src/main/kotlin/io/zeebe/zeeqs/data/entity/BpmnElementType.kt
@@ -25,5 +25,6 @@ enum class BpmnElementType {
     BUSINESS_RULE_TASK,
     SCRIPT_TASK,
     SEND_TASK,
-    INCLUSIVE_GATEWAY
+    INCLUSIVE_GATEWAY,
+    GROUP
 }
diff --git a/data/src/main/kotlin/io/zeebe/zeeqs/data/service/BpmnElementExtensionProperties.kt b/data/src/main/kotlin/io/zeebe/zeeqs/data/service/BpmnElementExtensionProperties.kt
@@ -0,0 +1,6 @@
+package io.zeebe.zeeqs.data.service
+
+data class BpmnElementExtensionProperties (
+    val name: String? = null,
+    val value: String? = null,
+)
diff --git a/data/src/main/kotlin/io/zeebe/zeeqs/data/service/BpmnElementInfo.kt b/data/src/main/kotlin/io/zeebe/zeeqs/data/service/BpmnElementInfo.kt
@@ -1,10 +1,14 @@
 package io.zeebe.zeeqs.data.service
 
+import io.camunda.zeebe.model.bpmn.instance.Documentation
+import io.camunda.zeebe.model.bpmn.instance.zeebe.ZeebeProperty
 import io.zeebe.zeeqs.data.entity.BpmnElementType
 
 data class BpmnElementInfo(
         val elementId: String,
         val elementName: String?,
         val elementType: BpmnElementType,
-        val metadata: BpmnElementMetadata
+        val metadata: BpmnElementMetadata,
+        val extensionProperties: Collection<BpmnElementExtensionProperties>?,
+        val documentation: String?
 )
diff --git a/data/src/main/kotlin/io/zeebe/zeeqs/data/service/ProcessInstanceService.kt b/data/src/main/kotlin/io/zeebe/zeeqs/data/service/ProcessInstanceService.kt
@@ -61,7 +61,7 @@ class ProcessInstanceService(
             return filteredProcessInstances;
         }
         else {
-            return processInstancesRepository.findByStateIn(stateIn, PageRequest.of(page, perPage)).toList();
+            return processInstancesRepository.findByProcessDefinitionKeyAndStateIn(processDefinitionKey, stateIn, PageRequest.of(page, perPage)).toList();
         }
     }
 
@@ -72,7 +72,7 @@ class ProcessInstanceService(
         }
 
         else {
-            return processInstancesRepository.countByStateIn(stateIn);
+            return processInstancesRepository.countByProcessDefinitionKeyAndStateIn(processDefinitionKey, stateIn);
         }
     }
 

diff --git a/data/src/main/kotlin/io/zeebe/zeeqs/data/service/ProcessService.kt b/data/src/main/kotlin/io/zeebe/zeeqs/data/service/ProcessService.kt
@@ -20,18 +20,28 @@ class ProcessService(val processRepository: ProcessRepository) {
     @Cacheable(cacheNames = ["bpmnElementInfo"])
     fun getBpmnElementInfo(processDefinitionKey: Long): Map<String, BpmnElementInfo>? {
         return getBpmnModel(processDefinitionKey)
-            ?.let { it.getModelElementsByType(FlowElement::class.java) }
-            ?.map { flowElement ->
-                Pair(
-                    flowElement.id, BpmnElementInfo(
-                        elementId = flowElement.id,
-                        elementName = flowElement.name,
-                        elementType = getBpmnElementType(flowElement),
-                        metadata = getMetadata(flowElement)
-                    )
-                )
-            }
-            ?.toMap()
+                ?.let { model ->
+                    (model.getModelElementsByType(FlowElement::class.java)?.associate { flowElement ->
+                        flowElement.id to BpmnElementInfo(
+                                elementId = flowElement.id,
+                                elementName = flowElement.name,
+                                elementType = getBpmnElementType(flowElement),
+                                metadata = getMetadata(flowElement),
+                                extensionProperties = getExtensionProperties(flowElement),
+                                documentation = getDocumentation(flowElement)
+                        )
+                    }.orEmpty() +
+                            model.getModelElementsByType(Group::class.java)?.associate { groupElement ->
+                                groupElement.id to BpmnElementInfo(
+                                        elementId = groupElement.id,
+                                        elementName = groupElement.category?.value ?: "",
+                                        elementType = getBpmnElementType(groupElement),
+                                        metadata = getMetadata(groupElement),
+                                        extensionProperties = getExtensionProperties(groupElement),
+                                        documentation = getDocumentation(groupElement)
+                                )
+                            }.orEmpty())
+                }
     }
 
     private fun getBpmnModel(processDefinitionKey: Long): BpmnModelInstance? {
@@ -41,7 +51,7 @@ class ProcessService(val processRepository: ProcessRepository) {
             ?.let { Bpmn.readModelFromStream(it) }
     }
 
-    private fun getBpmnElementType(element: FlowElement): BpmnElementType {
+    private fun getBpmnElementType(element: BaseElement): BpmnElementType {
         return when (element.elementType.typeName) {
             BpmnModelConstants.BPMN_ELEMENT_PROCESS -> BpmnElementType.PROCESS
             BpmnModelConstants.BPMN_ELEMENT_SUB_PROCESS -> getBpmnSubprocessType(element)
@@ -63,11 +73,12 @@ class ProcessService(val processRepository: ProcessRepository) {
             BpmnModelConstants.BPMN_ELEMENT_BUSINESS_RULE_TASK -> BpmnElementType.BUSINESS_RULE_TASK
             BpmnModelConstants.BPMN_ELEMENT_SCRIPT_TASK -> BpmnElementType.SCRIPT_TASK
             BpmnModelConstants.BPMN_ELEMENT_INCLUSIVE_GATEWAY -> BpmnElementType.INCLUSIVE_GATEWAY
+            BpmnModelConstants.BPMN_ELEMENT_GROUP -> BpmnElementType.GROUP
             else -> BpmnElementType.UNKNOWN
         }
     }
 
-    private fun getBpmnSubprocessType(element: FlowElement) =
+    private fun getBpmnSubprocessType(element: BaseElement) =
         if (element is SubProcess) {
             if (element.triggeredByEvent()) {
                 BpmnElementType.EVENT_SUB_PROCESS
@@ -78,7 +89,7 @@ class ProcessService(val processRepository: ProcessRepository) {
             BpmnElementType.UNKNOWN
         }
 
-    private fun getMetadata(element: FlowElement): BpmnElementMetadata {
+    private fun getMetadata(element: BaseElement): BpmnElementMetadata {
         return BpmnElementMetadata(
             jobType = element
                 .getSingleExtensionElement(ZeebeTaskDefinition::class.java)
@@ -156,6 +167,19 @@ class ProcessService(val processRepository: ProcessRepository) {
         )
     }
 
+    private fun getExtensionProperties(element: BaseElement): Collection<BpmnElementExtensionProperties>? {
+       return element.extensionElements?.elementsQuery
+                ?.filterByType(ZeebeProperties::class.java)
+                ?.singleResult()
+                ?.properties
+                ?.map { BpmnElementExtensionProperties(name = it.name, value = it.value) }
+    }
+
+
+    private fun getDocumentation(element: BaseElement): String {
+        return element.documentations.joinToString(separator = "") { it.textContent }
+    }
+
     @Cacheable(cacheNames = ["userTaskForm"])
     fun getForm(processDefinitionKey: Long, formKey: String): String? {
         return getBpmnModel(processDefinitionKey)

diff --git a/data/src/test/kotlin/io/zeebe/zeeqs/ProcessServiceTest.kt b/data/src/test/kotlin/io/zeebe/zeeqs/ProcessServiceTest.kt
@@ -52,12 +52,12 @@ class ProcessServiceTest(
             // then
             assertThat(info)
                     .isNotNull()
-                    .contains(entry("s", BpmnElementInfo("s", "start", BpmnElementType.START_EVENT, BpmnElementMetadata())))
-                    .contains(entry("t", BpmnElementInfo("t", "task", BpmnElementType.SERVICE_TASK, BpmnElementMetadata(jobType = "test"))))
+                    .contains(entry("s", BpmnElementInfo("s", "start", BpmnElementType.START_EVENT, BpmnElementMetadata(), listOf(BpmnElementExtensionProperties()), "")))
+                    .contains(entry("t", BpmnElementInfo("t", "task", BpmnElementType.SERVICE_TASK, BpmnElementMetadata(jobType = "test"), listOf(BpmnElementExtensionProperties()), "")))
                     .contains(entry("u", BpmnElementInfo("u", "userTask", BpmnElementType.USER_TASK, BpmnElementMetadata(
-                            userTaskAssignmentDefinition = UserTaskAssignmentDefinition(assignee = "user1", candidateGroups = "group1"))))
+                            userTaskAssignmentDefinition = UserTaskAssignmentDefinition(assignee = "user1", candidateGroups = "group1")), listOf(BpmnElementExtensionProperties()), ""))
                     )
-                    .contains(entry("e", BpmnElementInfo("e", null, BpmnElementType.END_EVENT, BpmnElementMetadata())))
+                    .contains(entry("e", BpmnElementInfo("e", null, BpmnElementType.END_EVENT, BpmnElementMetadata(), listOf(BpmnElementExtensionProperties()), "")))
         }
 
         @Test
@@ -90,7 +90,8 @@ class ProcessServiceTest(
                                                     key = "camunda-forms:bpmn:form_A",
                                                     resource = """{"x":1}"""
                                             )
-                                    )
+                                    ),
+                                    listOf(BpmnElementExtensionProperties()), ""
                             )
                     )
         }

diff --git a/graphql-api/src/main/kotlin/io/zeebe/zeeqs/graphql/resolvers/type/BpmnElementResolver.kt b/graphql-api/src/main/kotlin/io/zeebe/zeeqs/graphql/resolvers/type/BpmnElementResolver.kt
@@ -5,6 +5,7 @@ import io.zeebe.zeeqs.data.entity.ElementInstanceState
 import io.zeebe.zeeqs.data.entity.Process
 import io.zeebe.zeeqs.data.repository.ElementInstanceRepository
 import io.zeebe.zeeqs.data.repository.ProcessRepository
+import io.zeebe.zeeqs.data.service.BpmnElementExtensionProperties
 import io.zeebe.zeeqs.data.service.BpmnElementInfo
 import io.zeebe.zeeqs.data.service.BpmnElementMetadata
 import io.zeebe.zeeqs.data.service.ProcessService
@@ -41,6 +42,21 @@ class BpmnElementResolver(
                 ?: BpmnElementMetadata()
     }
 
+
+    @SchemaMapping(typeName = "BpmnElement", field = "extensionProperties")
+    fun extensionProperties(element: BpmnElement): Collection<BpmnElementExtensionProperties>? {
+        return findElementInfo(element)
+                ?.extensionProperties
+    }
+
+
+    @SchemaMapping(typeName = "BpmnElement", field = "documentation")
+    fun documentation(element: BpmnElement): String? {
+        return findElementInfo(element)
+                ?.documentation
+
+    }
+
     @SchemaMapping(typeName = "BpmnElement", field = "process")
     fun process(element: BpmnElement): Process? {
         return processRepository.findByIdOrNull(element.processDefinitionKey)

diff --git a/graphql-api/src/main/resources/graphql/Element.graphqls b/graphql-api/src/main/resources/graphql/Element.graphqls
@@ -10,6 +10,12 @@ type BpmnElement {
     # the metadata of the BPMN element
     metadata: BpmnElementMetadata!
 
+    # extension properties of the BPMN element
+    extensionProperties:  [BpmnElementExtensionProperties]
+
+    # documentation of the BPMN element
+    documentation: String
+
     # the process that contains the BPMN element
     process: Process
     # the instances of the BPMN element
@@ -46,6 +52,7 @@ enum BpmnElementType {
     SCRIPT_TASK
     SEND_TASK
     INCLUSIVE_GATEWAY
+    GROUP
 }
 
 # Additional metadata that are defined statically on the BPMN element.
@@ -84,4 +91,11 @@ type UserTaskAssignmentDefinition {
     assignee: String
     # the candidate groups
     candidateGroups: String
+}
+
+type BpmnElementExtensionProperties {
+    # the name of property
+    name: String
+    # the value of property
+    value: String
 }