Component for bulk comment update workflow

[rachana-egov]

Summary by CodeRabbit

• New Features

  • Introduced the WorkflowCommentPopUp component for user comments within workflows.
  • Enhanced PopInbox functionality to allow users to select rows and apply actions with comments.

• Bug Fixes

  • Improved state management for selected rows and popup visibility in the PopInbox component.

• Removed Features

  • Deprecated the WorkflowPopUp component to streamline the comment submission process.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

This pull request introduces a new React component, WorkflowCommentPopUp, designed for user comments within a workflow context. It replaces the previously existing WorkflowPopUp component, which has been removed. Additionally, modifications to the PopInbox component have been made to integrate the new comment popup, allowing for better user interaction by enabling comment submissions related to selected workflow actions.

Changes

File	Change Summary
health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js	Added new component WorkflowCommentPopUp for handling user comments in workflows.
health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowPopUp.js	Removed component WorkflowPopUp, which was previously used for user comments.
health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/PopInbox.js	Modified PopInbox to integrate WorkflowCommentPopUp, added state variables for selected rows and popup visibility, and updated rendering logic for user interactions.

Possibly related PRs

• Added updated api for census and workflow integration #1598: This PR introduces an updated API for census and workflow integration, which is relevant as the main PR's WorkflowCommentPopUp component interacts with workflow actions and may utilize the updated API for submitting comments.
• Fixed filter card issue and added check to show validate action only #1600: This PR addresses filter card functionality and includes checks related to actions displayed in the UI, which could be related to how the PopInbox component manages user interactions with the WorkflowCommentPopUp.

Suggested reviewers

• nipunarora-eGov

🐰 In the meadow where comments flow,
A popup blooms, with thoughts to show.
With each new word, a story's spun,
In workflows bright, the fun's begun!
So hop along, and share your say,
With WorkflowComment, brighten the day! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 13

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 7f0c3bd and eb12024.

📒 Files selected for processing (3)

• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1 hunks)
• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowPopUp.js (0 hunks)
• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/PopInbox.js (6 hunks)

💤 Files with no reviewable changes (1)

• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowPopUp.js

🧰 Additional context used

📓 Path-based instructions (2)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1)

Pattern **/*.js: check

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/PopInbox.js (1)

Pattern **/*.js: check

🪛 Biome

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js

[error] 98-98: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

[error] 103-103: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

[error] 59-59: This let declares a variable that is only assigned once.

'updatedItem' is never reassigned.

Safe fix: Use const instead.

(lint/style/useConst)

---

[error] 116-116: Avoid passing children using a prop

The canonical way to pass children in React is to use JSX elements

(lint/correctness/noChildrenProp)

🔇 Additional comments (2)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/PopInbox.js (2)

180-181: Ensure 'handleActionClick' receives the correct action code

After updating the onClick handler, make sure handleActionClick processes the action code correctly.

---

8-8: Import statement is appropriate

The import of WorkflowCommentPopUp is correctly added.

[coderabbitai]

Actionable comments posted: 6

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between eb12024 and f760322.

📒 Files selected for processing (2)

• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1 hunks)
• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/PopInbox.js (6 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1)

Pattern **/*.js: check

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/PopInbox.js (1)

Pattern **/*.js: check

📓 Learnings (1)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1)

Learnt from: rachana-egov
PR: egovernments/DIGIT-Frontend#1612
File: health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js:37-41
Timestamp: 2024-10-22T09:14:46.876Z
Learning: In this project, the `TextArea` component should submit the form when the 'Enter' key is pressed.

🪛 Biome

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js

[error] 94-94: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

[error] 99-99: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

[error] 55-55: This let declares a variable that is only assigned once.

'updatedItem' is never reassigned.

Safe fix: Use const instead.

(lint/style/useConst)

---

[error] 112-112: Avoid passing children using a prop

The canonical way to pass children in React is to use JSX elements

(lint/correctness/noChildrenProp)

🔇 Additional comments (8)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (2)

15-19: Ensure correct usage of useCustomAPIMutationHook with dynamic payload

Currently, requestPayload is set both at the hook initialization and again during mutation. This could lead to confusion or unexpected behavior if the initial payload is not intended to be used. Verify if setting body at both places is necessary.

Consider modifying the hook usage:

 const mutation = Digit.Hooks.useCustomAPIMutationHook({
     url: url,
-    body: requestPayload,
     params: {}
 });

This way, the payload is only provided during mutation:

 await mutation.mutate(
     {
-        body: updatedPayload
+        body: updatedPayload
     },
     {
         onSuccess: (data) => {

Let me know if you would like assistance in verifying this change.

---

15-19: LGTM!

The initialization of the custom API mutation hook is correctly implemented, ensuring that the URL and parameters are properly configured.

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/PopInbox.js (6)

8-8: Import statement added correctly

The import of WorkflowCommentPopUp is appropriate and correctly references the component from the specified path.

---

23-24: Inconsistent naming convention for 'workFlowPopUp'

The state variable workFlowPopUp and its setter setworkFlowPopUp use inconsistent camelCase naming. For consistency and readability, consider renaming them to workflowPopUp and setWorkflowPopUp.

---

95-97: Inconsistent naming convention in 'closePopUp' function

The function closePopUp uses setworkFlowPopUp, which follows inconsistent camelCase naming. To maintain consistency, rename the setter to setWorkflowPopUp.

---

158-158: Clearing 'selectedRows' state appropriately

Resetting selectedRows to an empty array ensures that the selection state is cleared when new data is fetched or filters are applied.

---

185-185: 'selectedRows' is now correctly assigned

The onRowSelect function assigns event?.selectedRows directly to selectedRows, addressing the previous issue of unnecessary array nesting.

---

181-181: Verify the correctness of 'action' in 'handleActionClick'

Ensure that the action parameter passed to handleActionClick correctly represents the intended workflow action. There might be a mismatch if action is derived from an event object rather than the action code.

Run the following script to check how handleActionClick is invoked:

#!/bin/bash
# Description: Verify all invocations of 'handleActionClick' to ensure correct parameters.

# Search for 'handleActionClick' invocations and display the surrounding context.
rg -A 2 -B 2 'handleActionClick\('

This will help confirm that handleActionClick receives the correct action code.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between f760322 and 5691ca3.

📒 Files selected for processing (1)

• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1)

Pattern **/*.js: check

📓 Learnings (1)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (1)

Learnt from: rachana-egov
PR: egovernments/DIGIT-Frontend#1612
File: health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js:37-41
Timestamp: 2024-10-22T09:14:46.876Z
Learning: In this project, the `TextArea` component should submit the form when the 'Enter' key is pressed.

🪛 Biome

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js

[error] 94-94: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

[error] 99-99: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

[error] 55-55: This let declares a variable that is only assigned once.

'updatedItem' is never reassigned.

Safe fix: Use const instead.

(lint/style/useConst)

---

[error] 112-112: Avoid passing children using a prop

The canonical way to pass children in React is to use JSX elements

(lint/correctness/noChildrenProp)

🔇 Additional comments (5)

health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/WorkflowCommentPopUp.js (5)

42-73: setCommentInPayloadForList function correctly updates nested payloads

The function effectively modifies the nested comment field within each item of the list, handling dynamic paths appropriately.

🧰 Tools

🪛 Biome

[error] 55-55: This let declares a variable that is only assigned once.

'updatedItem' is never reassigned.

Safe fix: Use const instead.

(lint/style/useConst)

---

29-34: handleTextAreaChange function handles input changes correctly

The function updates the comment state and resets the error state when the input is non-empty, ensuring proper validation feedback to the user.

---

36-40: handleKeyPress function correctly handles 'Enter' key submission

The function triggers form submission when the 'Enter' key is pressed, aligning with the project's requirement for the TextArea component.

---

15-20: Custom API mutation hook is appropriately configured

The mutation hook is set up correctly with dynamic URL and request payload, facilitating flexible API interactions.

---

107-168: Component rendering and user feedback mechanisms are well-implemented

• The PopUp component is used effectively to display the comment input interface.
• The conditional rendering of the Toast component provides users with success or error feedback.
• The isSubmitting state appropriately disables the submit button during form submission.

🧰 Tools

🪛 Biome

[error] 112-112: Avoid passing children using a prop

The canonical way to pass children in React is to use JSX elements

(lint/correctness/noChildrenProp)