Skip to content

Update historic incident api to include root cause incident message #5134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update historic incident api to include root cause incident message #5134

wants to merge 2 commits into from

Conversation

kmannuru
Copy link
Contributor

@kmannuru kmannuru commented May 2, 2025 •
edited
Loading

Issue: #2697

@joaquinfelici joaquinfelici requested a review from HeleneW-dot May 2, 2025 13:54
@HeleneW-dot
Copy link
Contributor

HeleneW-dot commented May 5, 2025 •
edited
Loading

Hi @kmannuru ,
Thank you for your contribution. I noticed there is no issue created for this PR, could you please create one that describes the required changes as well as the use case/motivation, and then link it in the PR description? This will also help give me more context for the review.
Thanks!
Helene

@kmannuru
Copy link
Contributor Author

kmannuru commented May 8, 2025

Hi @kmannuru , Thank you for your contribution. I noticed there is no issue created for this PR, could you please create one that describes the required changes as well as the use case/motivation, and then link it in the PR description? This will also help give me more context for the review. Thanks! Helene

@HeleneW-dot I've attached the issue related to the change. #2697. Please help review when you get a chance. Thanks.

@HeleneW-dot HeleneW-dot mentioned this pull request Oct 14, 2022
Open
@HeleneW-dot HeleneW-dot added ci:h2 Runs the builds for the H2 database. ci:rest-api Runs extra builds for the REST API (currently only WLS compatibility builds). ci:tomcat Runs the builds for the Tomcat application server. labels May 16, 2025
HeleneW-dot
HeleneW-dot requested changes May 16, 2025
View reviewed changes
Copy link
Contributor

@HeleneW-dot HeleneW-dot left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @kmannuru ,
Thanks for linking the ticket and picking up this feature request 💪
I have now finally had time to review the PR.

I have reviewed the changes and locally tested them and it looks good!
I only have one requets which is to add more test cases, specifically cases that cover real deployment data where a model is deployed, incidents are created and then we check that the query retrieves the correct incident data. At the moment the added test cases are only asserting on mocked responses.
You can have a look at existing test cases in HistoricIncidentTest as examples here.

Summary:
👍 Reviewed code changes look good
👍 openAPI updates included
👍 Manually tested by me locally
👍 CI: QueryTests exist on mocked incident responses
🚫 CI: No test for real deployment data.
🚫 PR CI: I think I have to duplicate the branch to run the PR CI jobs. @HeleneW-dot will do this do next once changes have been implemented

engine/src/main/resources/org/camunda/bpm/engine/impl/mapping/entity/HistoricIncident.xml
@@ -388,23 +388,29 @@
<result property="removalTime" column="REMOVAL_TIME_" jdbcType="TIMESTAMP"/>
</resultMap>

<resultMap id="historicIncidentResultWithRootCauseIncidentMessageMap" type="org.camunda.bpm.engine.impl.persistence.entity.HistoricIncidentEntity" extends="historicIncidentResultMap">
<result property="rootCauseIncidentMessage" column="ROOT_CAUSE_INCIDENT_MESSAGE_" jdbcType="VARCHAR"/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick:
to keep consistent and short lets also abbreviate message here like in the other message field:

Suggested change
<result property="rootCauseIncidentMessage" column="ROOT_CAUSE_INCIDENT_MESSAGE_" jdbcType="VARCHAR"/>
<result property="rootCauseIncidentMessage" column="ROOT_CAUSE_INCIDENT_MSG_" jdbcType="VARCHAR"/>

@HeleneW-dot
Copy link
Contributor

Hi @kmannuru ,
Just checking in on this one, have you seen my review suggestions? It would be great to see this implemented.
Thanks! Helene

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HeleneW-dot HeleneW-dot HeleneW-dot requested changes

Assignees

@kmannuru kmannuru

Labels
ci:h2 Runs the builds for the H2 database. ci:rest-api Runs extra builds for the REST API (currently only WLS compatibility builds). ci:tomcat Runs the builds for the Tomcat application server.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kmannuru @HeleneW-dot