Changed hierarchy schema for microplan

[rachana-egov]

Summary by CodeRabbit

• New Features

  • Integrated context management in UploadDataCustom and UserUpload components for improved state handling.
  • Enhanced error handling for file uploads in UploadDataCustom.

• Improvements

  • Updated data fetching logic to utilize the new context state, allowing for more dynamic data management across components.
  • Refined error handling in fetchData to provide clearer messages based on the new state variable.

• Bug Fixes

  • Adjusted error messages in fetchData to reflect changes in state management.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to three JavaScript files within the microplan package. The Module.js file updates the data fetching logic to retrieve boundary hierarchy data from the "HCM-ADMIN-CONSOLE" module instead of "hcm-microplanning." The UploadDataCustom.js and UserUpload.js components have been altered to utilize a new context state variable, hierarchyType, replacing the previous reliance on boundaryHierarchy. These updates affect various data handling processes, including fetching, generating data, and error handling during file uploads.

Changes

File Path	Change Summary
health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/Module.js	Updated data fetching logic to retrieve HierarchySchema from "HCM-ADMIN-CONSOLE" instead of "hcm-microplanning." Modified selection logic to filter items based on type. Updated setLowestHierarchy function to retrieve lowestHierarchy from the new structure.
health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UploadDataCustom.js	Added useMyContext import and replaced boundaryHierarchy with state?.hierarchyType in multiple functions. Updated useEffect hooks and error handling for file uploads.
health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js	Integrated useMyContext and replaced boundaryHierarchy with state?.hierarchyType in various locations. Adjusted error handling and onSubmit function to utilize the new state.

Possibly related PRs

• Microplan upload #1489: Changes in UploadDataCustom.js related to data fetching and handling logic for file uploads.
• Update UploadDataCustom.js #1493: Updates to UploadDataCustom.js enhancing file upload and validation logic.
• Update UploadDataCustom.js #1524: Further refinements in UploadDataCustom.js for handling uploaded files and state management.
• Update UploadDataCustom.js #1528: Significant modifications to UploadDataCustom.js, including data generation logic and error handling.
• Update UserUpload.js #1886: Corrections in UserUpload.js that involve adjustments to variable declarations impacting data uploads.

Suggested reviewers

• nipunarora-eGov

🐰 In the land of code where rabbits play,
New logic blooms, brightening the day.
From "hcm" to "HCM" the data now flows,
With context in hand, our knowledge grows!
Uploads are smoother, errors are few,
Hopping along, we bring changes anew! 🐇✨

---

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: 7

🧹 Outside diff range comments (5)

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

Based on the gathered evidence, I can now provide the final response:

Add validation for hierarchyType to prevent API failures

The code shows that hierarchyType is used in multiple API calls without proper validation, and the current error handling only catches general API errors. Since hierarchyType is a required parameter for the resource data API, we should validate it before making the API call.

• Add validation in fetchData function before calling useResourceData
• Current error handling in the component only logs errors or shows generic messages
• The state's hierarchyType is used in multiple API endpoints making it a critical parameter

The review comment's concern is valid and the suggested fix to add validation before the API call would prevent potential API failures and provide better user feedback. The refactoring suggestion provided in the original review comment is appropriate and should be implemented.

🔗 Analysis chain

Line range hint 74-78: Verify error handling for missing hierarchyType

The fetchData function uses state?.hierarchyType without validating its presence, which could lead to API failures.

Add validation before the API call:

  try {
+   if (!state?.hierarchyType) {
+     throw new Error(t("HIERARCHY_TYPE_REQUIRED"));
+   }
    const temp = await Digit.Hooks.campaign.useResourceData(
      uploadedFile,
      state?.hierarchyType,
      type,
      tenantId,

---

Let me gather more context about the error handling in these components.

---

Let me check how the hierarchyType is being set and used in these components.

---

Let me try one more search with corrected patterns.

---

Let me check one final thing about error handling in this component.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for other instances where hierarchyType is required in API calls
rg -A 2 "hierarchyType:\s*[^,]*state\?\.hierarchyType" .

Length of output: 2900

---

Script:

#!/bin/bash
# Check for any existing error handling or validation for hierarchyType
ast-grep --pattern 'if (!state?.hierarchyType) {
  $$$
}'

# Check the component's structure and state initialization
ast-grep --pattern 'const [$_,$_] = useState({
  $$$
  hierarchyType: $_,
  $$$
});'

# Look for any translations related to hierarchy type errors
rg "HIERARCHY_TYPE" .

Length of output: 5662

---

Script:

#!/bin/bash
# Check the component initialization and how hierarchyType is set
rg -A 5 "const \[state, setState\]" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

# Check for any error handling in the component
rg -A 5 "catch\s*\([^)]*\)\s*{" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

# Check how the useResourceData hook is implemented
ast-grep --pattern 'useResourceData = async ($$$) => {
  $$$
}'

Length of output: 437

---

Script:

#!/bin/bash
# Check the component initialization and state management
rg -B 2 -A 5 "setState" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

# Check for error handling with fixed pattern
rg -B 2 -A 5 "catch.*{" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

# Check the function implementation
rg -B 2 -A 10 "const fetchData" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

Length of output: 916

---

Script:

#!/bin/bash
# Check for error handling with fixed pattern
rg -B 2 -A 5 "} catch \(" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

# Check if there's any validation before using hierarchyType
rg -B 5 -A 2 "useResourceData" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

# Check how hierarchyType is initialized
rg -B 5 "hierarchyType:" ./health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js

Length of output: 2881

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

Line range hint 74-85: Include type and onSelect in useEffect dependency array

The useEffect hook depends on type and onSelect, but they are not included in the dependency array. Omitting them may lead to stale closures or unexpected behavior when these values change.

Update the dependency array as follows:

 useEffect(() => {
     enrichFileDetails(uploadedFile);
     if (type === "facilityWithBoundary") {
         onSelect("uploadFacility", { uploadedFile, isError, isValidation, apiError, isSuccess });
     } else if (type === "boundary") {
         onSelect("uploadBoundary", { uploadedFile, isError, isValidation, apiError, isSuccess });
     } else {
         onSelect("uploadUser", { uploadedFile, isError, isValidation, apiError, isSuccess });
     }
     onSelect(props.props.name, { uploadedFile, isError, isValidation, apiError, isSuccess })
- }, [uploadedFile, isError, isValidation, apiError, isSuccess]);
+ }, [uploadedFile, isError, isValidation, apiError, isSuccess, type, onSelect]);

---

Line range hint 422-555: Include missing dependencies in useEffect dependency array

The useEffect hook relies on variables (state, uploadedFile, isSuccess, type, tenantId, id, baseTimeOut) that are not included in its dependency array. This may cause stale data or unexpected behavior because the effect won't re-run when these variables change.

Update the dependency array to include all external variables used inside the effect:

 useEffect(() => {
     const fetchData = async () => {
         // function code
     };
     fetchData();
- }, [errorsType]);
+ }, [errorsType, state, uploadedFile, isSuccess, type, tenantId, id, baseTimeOut]);

---

Line range hint 241-283: Enhance error handling in onBulkUploadSubmit

In the onBulkUploadSubmit function, the error handling currently displays a generic error message upon failure. Providing more detailed error information can help users understand what went wrong.

Modify the catch block to use the specific error message:

 catch (error) {
-   setShowToast({ key: "error", label: t("HCM_ERROR_FILE_UPLOAD_FAILED") });
+   const message = error?.message || t("HCM_ERROR_FILE_UPLOAD_FAILED");
+   setShowToast({ key: "error", label: message });
 }

---

Line range hint 1-600: Consider refactoring large component for better maintainability

The UploadDataCustom component is quite large and contains multiple responsibilities. Refactoring it into smaller, reusable components or custom hooks can improve readability and maintainability.

Consider extracting parts like file upload handling, API calls, and data processing into separate components or hooks.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 2bf688a and acf4d97.

📒 Files selected for processing (3)

• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/Module.js (1 hunks)
• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UploadDataCustom.js (6 hunks)
• health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js (10 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

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

Pattern **/*.js: check

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

Pattern **/*.js: check

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

Pattern **/*.js: check

🔇 Additional comments (6)

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

Line range hint 44-52: Implementation follows React best practices

The data fetching and state management implementation is well-structured:

• Clean separation of concerns using custom hooks
• Proper error handling with loading states
• Efficient data flow through context

---

44-44: 🧹 Nitpick (assertive)

Consider making the schema code configurable

The schema code "BASE_MASTER_DATA_INITIAL" is currently hardcoded. Consider making it configurable through environment variables or configuration files for better flexibility across different environments.

- },{schemaCode:"BASE_MASTER_DATA_INITIAL"});
+ },{schemaCode: Digit.Configs.getMasterDataSchema() || "BASE_MASTER_DATA_INITIAL"});

Likely invalid or redundant comment.

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

6-6: Import useMyContext correctly added

The import statement for useMyContext is correctly added, and the import path appears accurate.

---

18-18: State extraction from context is appropriate

Successfully extracting state using the useMyContext() hook ensures that the component has access to the necessary context state.

---

Line range hint 122-143: Ensure state?.hierarchyType is defined before usage

When using state?.hierarchyType in the generateData function, ensure that state and hierarchyType are appropriately initialized to prevent potential undefined or null errors during runtime.

---

Line range hint 122-569: Verify all references to boundaryHierarchy are updated

Ensure that all references to boundaryHierarchy have been replaced with state?.hierarchyType throughout the codebase to maintain consistency and prevent potential bugs.

Run the following script to search for remaining occurrences:

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between acf4d97 and 82dedf6.

📒 Files selected for processing (1)

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

🧰 Additional context used

📓 Path-based instructions (1)

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

Pattern **/*.js: check

🔇 Additional comments (6)

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

254-256: Previous review comment is still valid

The Template configuration needs consistent null checking for all parameters.

---

267-269: Previous review comment is still valid

The downloadTemplate function needs loading state management and proper error handling.

---

332-341: Previous review comment is still valid

The generateData function needs improved error handling and user feedback.

---

364-364: Previous review comment is still valid

The useEffect dependency array and error handling recommendations are still applicable.

---

382-384: ⚠️ Potential issue

Previous review comment is still valid

The issue with duplicate campaignId in the request body needs to be addressed.

  ResourceDetails: {
    tenantId: Digit.ULBService.getCurrentTenantId(),
    type: "user",
    fileStoreId: fileId,
    hierarchyType: state?.hierarchyType,
    campaignId: id,
    action: "create",
-   campaignId: id,  // Remove duplicate
    additionalDetails: {
      source: "microplan",
      fileName: fileName,
    },
  },

🧰 Tools

🪛 Biome (1.9.4)

[error] 383-383: This property value named campaignId is later overwritten by an object member with the same name.

Overwritten with this value.

If an object property with the same name is defined multiple times (except when combining a getter with a setter), only the last definition makes it into the object and previous definitions are ignored.
Unsafe fix: Remove this property value named campaignId

(lint/suspicious/noDuplicateObjectKeys)

---

71-71: 🛠️ Refactor suggestion

Add null check for hierarchyType in resource data fetch

The resource data fetch should handle cases where hierarchyType is undefined.

-          state?.hierarchyType,
+          state?.hierarchyType || "",

Likely invalid or redundant comment.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 82dedf6 and ae1a4ee.

📒 Files selected for processing (1)

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

🧰 Additional context used

📓 Path-based instructions (1)

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

Pattern **/*.js: check

📓 Learnings (1)

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

Learnt from: rachana-egov
PR: egovernments/DIGIT-Frontend#1925
File: health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js:267-269
Timestamp: 2024-11-28T11:34:27.480Z
Learning: In the `downloadTemplate` function of `health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/components/UserUpload.js`, the scenario where `state?.hierarchyType` is undefined will not occur.

🔇 Additional comments (6)

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

9-9: LGTM: Context integration looks good

The integration of the context provider through useMyContext is clean and follows React best practices.

Also applies to: 24-24

---

71-71: LGTM: Resource data fetching implementation is correct

The update to use state?.hierarchyType in the useResourceData hook is consistent with the context migration.

---

254-256: LGTM: Template configuration is properly updated

The Template object correctly uses state?.hierarchyType for the API parameters.

---

267-269: LGTM: Download template implementation is robust

The downloadTemplate function correctly uses state?.hierarchyType and includes proper error handling.

---

364-364: LGTM: Effect dependencies are correctly updated

The useEffect hook's dependency array is properly updated to include state?.hierarchyType.

---

382-382: LGTM: Submit implementation is complete

The onSubmit function correctly uses state?.hierarchyType and includes comprehensive error handling.