Execution is null when calling /message to correlate

vikkee · September 10, 2024, 4:49pm

Checking in here to see if this is a known bug, there is been some change between 7.19 and 7.21 flavors that isn’t documented.

The execution object is ‘null’ when calling /message to correlate a intermediate message event. Shouldn’t this be populated when resultType=Execution?

Here is what I see on 7.19, where execution is populated with all details for same bpmn model.

Test Message Correlation 7.19 vs 7.21.bpmn (3.9 KB)

Attaching the .bpmn sample from the tests.

vikkee · September 10, 2024, 5:01pm

I was in the wrong repo, after a bit more searching I see the following issue which seems identical to our findings:

github.com/camunda/camunda-bpm-platform

During message correlation with `resultEnabled`, wrong entity is populated when "resultType": "Execution"

opened 10:10AM - 30 Apr 24 UTC

closed 10:05AM - 23 May 24 UTC

yanavasileva

type:bug scope:core-api group:support version:7.22.0 version:7.21.2 version:7.22.0-alpha2

### Environment (Required on creation) REST API 7.21.0+ ### Description (Requir…ed on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket) Perform message correlation with `resultEnabled` and expected `resultType: Execution` The `resultType` isn't considered, always the `processInstance` entity is returned. ### Steps to reproduce (Required on creation) Get the example from here: https://jira.camunda.com/browse/SUPPORT-21725?focusedCommentId=347192&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-347192 1. start the application: `mvn spring-boot:run` 2. send request for message correlation to start process instance (expected return type: process defintion) ``` curl --location 'http://localhost:8080/engine-rest/message' \ --header 'Content-Type: application/json' \ --data '{ "messageName": "startPM", "resultEnabled": true }' ``` 3. send another request for message correlation ``` curl --location 'http://localhost:8080/engine-rest/message' \ --header 'Content-Type: application/json' \ --data '{ "messageName": "startESP", "resultEnabled": true }' ``` ### Observed Behavior (Required on creation) The response contains `resultType: Execution` and `execution: null`. ``` [ { "resultType": "Execution", "execution": null, "processInstance": { "links": [], "id": "aa79036a-06d6-11ef-a3f3-00ff18b69f72", "definitionId": "81d0b026-06d6-11ef-a3f3-00ff18b69f72", "businessKey": null, "caseInstanceId": null, "ended": false, "suspended": false, "tenantId": null } } ] ``` ### Expected behavior (Required on creation) The response contains `resultType: Execution` and the execution dto is populated. ``` [ { "resultType": "Execution", "execution": { "id": "99e27609-06d9-11ef-a41a-00ff18b69f72", "processInstanceId": "99e27609-06d9-11ef-a41a-00ff18b69f72", "ended": false, "tenantId": null }, "processInstance": null } ] ``` (created with 7.20) ### Root Cause (Required on prioritization) Since 7.21.0 the process instance is populated in the result all the time so it can be used in the user operation logs. The REST API, doesn't consider the `returnType` but checks if the process instance is present: https://github.com/camunda/camunda-bpm-platform/blob/master/engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/message/MessageCorrelationResultDto.java#L41-L44 (even thought the execution is also present) ### Solution Ideas * In the REST API, populate the process instance/execution dto after considering the `resultType`. ### Hints ### Links - created on behalf of https://jira.camunda.com/browse/SUPPORT-21725 - caused by https://github.com/camunda/camunda-bpm-platform/commit/a6793fd06b3778c017130b671fc739cd20c53299 - https://github.com/camunda/camunda-bpm-platform/pull/4014#discussion_r1440510738 ### Breakdown  ```[tasklist] ### Pull Requests - [ ] https://github.com/camunda/camunda-bpm-platform/pull/4321 - [ ] https://github.com/camunda/camunda-bpm-platform-maintenance/pull/1221 ``` ### Dev2QA handover - [ ] Does this ticket need a QA test and the testing goals are not clear from the description? Add a [Dev2QA handover comment](https://confluence.camunda.com/display/AP/Handover+Dev+-%3E+Testing)

Status shows fixed as part of 7.22.

system · December 9, 2024, 5:01pm

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.