Add audit logs for approval tasks #31
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![wso2-engineering[bot]](https://avatars.githubusercontent.com/in/1856828?s=60&v=4){kind=small}
| String workflowRequestId = approvalTaskDAO.getWorkflowRequestIdByApprovalTaskId(approvalTaskId); | ||
| String workflowId = approvalTaskDAO.getWorkflowID(approvalTaskId); | ||
|
|
||
| handleApprovalTaskCompletion(approvalTaskId, workflowRequestId, ApprovalTaskServiceImpl.APPROVED); |
There was a problem hiding this comment.
Log Improvement Suggestion No: 2
Suggested change
| handleApprovalTaskCompletion(approvalTaskId, workflowRequestId, ApprovalTaskServiceImpl.APPROVED); | |
| handleApprovalTaskCompletion(approvalTaskId, workflowRequestId, ApprovalTaskServiceImpl.APPROVED); | |
| log.info("Approval task completed. TaskId: " + approvalTaskId + ", WorkflowRequestId: " + workflowRequestId); |
| .workflowRequestId(workflowRequestId) | ||
| .newStatus(WorkflowEngineConstants.TaskStatus.REJECTED.toString()); | ||
| auditLogger.printAuditLog(auditBuilder); | ||
|
|
There was a problem hiding this comment.
Log Improvement Suggestion No: 6
Suggested change
| completeWorkflowRequest(workflowRequestId, REJECTED); | |
| log.info("Workflow request rejected and completed. WorkflowRequestId: " + workflowRequestId); |
|
|
||
| for (String existingApprovalTaskId : existingApprovalTasks) { | ||
| if (existingApprovalTaskId.equals(updatedApprovalTaskId)) { | ||
| if (WorkflowEngineConstants.APPROVER_TYPE_USERS.equals(approverType)) { |
There was a problem hiding this comment.
Log Improvement Suggestion No: 8
Suggested change
| if (WorkflowEngineConstants.APPROVER_TYPE_USERS.equals(approverType)) { | |
| if (WorkflowEngineConstants.APPROVER_TYPE_USERS.equals(approverType)) { | |
| log.debug("Claiming task for user approver type. TaskId: " + updatedApprovalTaskId); |
| .workflowId(workflowId) | ||
| .newStatus(reservedStatus); | ||
| auditLogger.printAuditLog(auditBuilder); | ||
| } else if (WorkflowEngineConstants.APPROVER_TYPE_ROLES.equals(approverType)) { |
There was a problem hiding this comment.
Log Improvement Suggestion No: 9
Suggested change
| } else if (WorkflowEngineConstants.APPROVER_TYPE_ROLES.equals(approverType)) { | |
| } else if (WorkflowEngineConstants.APPROVER_TYPE_ROLES.equals(approverType)) { | |
| log.debug("Claiming task for role approver type. TaskId: " + updatedApprovalTaskId); |
| .workflowId(workflowId) | ||
| .newStatus(blockedStatus); | ||
| auditLogger.printAuditLog(blockedApprovalBuilder); | ||
| } |
There was a problem hiding this comment.
Log Improvement Suggestion No: 10
Suggested change
| } | |
| } else { | |
| log.debug("Blocking all existing tasks for workflow request: " + workflowRequestID); |
Comment on lines
+51
to
+60
| */ | ||
| public void triggerAuditLog(Operation operation, String targetId, Map<String, Object> dataMap) { | ||
|
|
||
| if (operation == null) { | ||
| log.warn("Operation is null. Cannot trigger audit log."); | ||
| return; | ||
| } | ||
| if (StringUtils.isBlank(targetId)) { | ||
| log.warn("Target ID is blank. Cannot trigger audit log."); | ||
| return; |
There was a problem hiding this comment.
Log Improvement Suggestion No: 11
Suggested change
| */ | |
| public void triggerAuditLog(Operation operation, String targetId, Map<String, Object> dataMap) { | |
| if (operation == null) { | |
| log.warn("Operation is null. Cannot trigger audit log."); | |
| return; | |
| } | |
| if (StringUtils.isBlank(targetId)) { | |
| log.warn("Target ID is blank. Cannot trigger audit log."); | |
| return; | |
| public void triggerAuditLog(Operation operation, String targetId, Map<String, Object> dataMap) { | |
| if (operation == null) { | |
| log.warn("Operation is null. Cannot trigger audit log."); | |
| return; | |
| } | |
| if (StringUtils.isBlank(targetId)) { | |
| log.warn("Target ID is blank. Cannot trigger audit log."); | |
| return; | |
| } | |
| if (log.isDebugEnabled()) { | |
| log.debug("Triggering audit log for operation: " + operation.getLogAction() + ", targetId: " + targetId); | |
| } |
| LoggerUtils.getInitiatorType(initiatorId), | ||
| targetId, | ||
| LoggerUtils.Target.ApprovalTask.name(), | ||
| operation.getLogAction()). |
There was a problem hiding this comment.
Log Improvement Suggestion No: 12
Suggested change
| operation.getLogAction()). | |
| LoggerUtils.triggerAuditLogEvent(auditLogBuilder); | |
| if (log.isDebugEnabled()) { | |
| log.debug("Audit log triggered successfully for operation: " + operation.getLogAction()); | |
| } |
Comment on lines
+92
to
+93
| * | ||
| * @return Initiator id despite masking. |
There was a problem hiding this comment.
Log Improvement Suggestion No: 13
Suggested change
| * | |
| * @return Initiator id despite masking. | |
| private String getInitiatorId() { | |
| if (log.isDebugEnabled()) { | |
| log.debug("Getting initiator ID for audit log"); | |
| } |
| if (!isV2AuditLogsEnabled()) { | ||
| if (log.isDebugEnabled()) { | ||
| log.debug("V2 audit logs are disabled. Skipping audit log for operation: " + | ||
| (builder.operation != null ? builder.operation.getLogAction() : "unknown")); |
There was a problem hiding this comment.
Log Improvement Suggestion No: 14
Suggested change
| (builder.operation != null ? builder.operation.getLogAction() : "unknown")); | |
| Map<String, Object> dataMap = builder.buildDataMap(); | |
| if (log.isDebugEnabled()) { | |
| log.debug("Printing audit log for task: " + builder.taskId + ", operation: " + builder.operation.getLogAction()); | |
| } |
Comment on lines
+352
to
+353
| /** | ||
| * Validate required fields. |
There was a problem hiding this comment.
Log Improvement Suggestion No: 15
Suggested change
| /** | |
| * Validate required fields. | |
| private void validate() { | |
| if (log.isDebugEnabled()) { | |
| log.debug("Validating audit log builder data"); | |
| } |
Comment on lines
+355
to
+357
| * @throws IllegalArgumentException if validation fails | ||
| */ | ||
| private void validate() { |
There was a problem hiding this comment.
Log Improvement Suggestion No: 16
Suggested change
| * @throws IllegalArgumentException if validation fails | |
| */ | |
| private void validate() { | |
| if (operation == null) { | |
| log.error("Failed to validate audit log builder: Operation is required"); | |
| throw new IllegalArgumentException("Operation is required for audit logging"); | |
| } |
Comment on lines
+358
to
+360
|
|
||
| if (operation == null) { | ||
| throw new IllegalArgumentException("Operation is required for audit logging"); |
There was a problem hiding this comment.
Log Improvement Suggestion No: 17
Suggested change
| if (operation == null) { | |
| throw new IllegalArgumentException("Operation is required for audit logging"); | |
| if (StringUtils.isBlank(taskId)) { | |
| log.error("Failed to validate audit log builder: Task ID is required"); | |
| throw new IllegalArgumentException("Task ID is required for audit logging"); | |
| } |
There was a problem hiding this comment.
AI Agent Log Improvement Checklist
- The log-related comments and suggestions in this review were generated by an AI tool to assist with identifying potential improvements. Purpose of reviewing the code for log improvements is to improve the troubleshooting capabilities of our products.
- Please make sure to manually review and validate all suggestions before applying any changes. Not every code suggestion would make sense or add value to our purpose. Therefore, you have the freedom to decide which of the suggestions are helpful.
✅ Before merging this pull request:
- Review all AI-generated comments for accuracy and relevance.
- Complete and verify the table below. We need your feedback to measure the accuracy of these suggestions and the value they add. If you are rejecting a certain code suggestion, please mention the reason briefly in the suggestion for us to capture it.
Contributor
Author
|
Integration test runner |
Contributor
Author
|
...ine/src/main/java/org/wso2/carbon/identity/workflow/engine/util/ApprovalTaskAuditLogger.java
Show resolved
Hide resolved
sadilchamishka
approved these changes
Oct 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
$subject
Related Issues
Related PRs
Todo: