code clean up and optimization

[OchiengPaul442]

Summary of Changes (What does this PR do?)

Summary by CodeRabbit

• New Features

  • Enhanced formatting for field values in the CustomFields component.
  • Improved organization name handling in the DataDownload component for consistent API calls.

• Bug Fixes

  • Addressed case sensitivity issues by converting organization names to lowercase in API calls.
  • Ensured default organization is set correctly when clearing selections.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes introduce a new function, formatFieldValue, to the CustomFields component, enhancing how field values are formatted based on their IDs. The DataDownload component is also updated to ensure that organization names are consistently formatted in lowercase when fetching data. The modifications include updates to state management and event handlers to utilize the new formatting function, ensuring a cohesive user experience.

Changes

File Path	Change Summary
platform/src/common/components/Modal/dataDownload/components/CustomFields.jsx	Added formatFieldValue function for conditional formatting based on field ID; updated state and event handlers to use this function.
platform/src/common/components/Modal/dataDownload/modules/DataDownload.jsx	Modified useEffect to convert organization names to lowercase for API calls; updated handleClearSelection for default organization handling.

Possibly related PRs

• [Analytics] Format organisation dropdown text to uppercase #2308: This PR modifies the formatName function in CustomFields.jsx to support various text formats, including uppercase, which directly relates to the changes made in the main PR where the formatFieldValue function is introduced for similar formatting purposes.
• Analytics updates #2326: This PR also updates the CustomFields component, enhancing the formatName function and ensuring proper formatting based on the id prop, which aligns with the main PR's focus on formatting field values conditionally based on the field ID.

Suggested reviewers

• Baalmart
• Codebmk

Poem

In fields where values play and dance,
A format change gives them a chance.
From upper case to lowercase sway,
CustomFields now shine in a new way!
With data downloads, clear and bright,
Our components now feel just right! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 32339bb and 9655528.

📒 Files selected for processing (1)

• platform/src/common/components/Modal/dataDownload/components/CustomFields.jsx (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• platform/src/common/components/Modal/dataDownload/components/CustomFields.jsx

---

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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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 or @coderabbitai title 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: 0

🧹 Outside diff range and nitpick comments (2)

platform/src/common/components/Modal/dataDownload/components/CustomFields.jsx (1)

17-27: LGTM! Consider adding input validation.

The formatFieldValue function is well-implemented with clear documentation. However, it might benefit from input validation similar to formatName.

 const formatFieldValue = (value, fieldId, textFormat) => {
+  if (typeof value !== 'string' || !value) return value;
   if (fieldId === 'organization') {
     return value.toUpperCase();
   }
   return formatName(value, textFormat);
 };

platform/src/common/components/Modal/dataDownload/modules/DataDownload.jsx (1)

123-125: Consider adding error handling for empty organization name.

While converting organization name to lowercase is good for consistency, we should handle cases where the organization name might be undefined.

 dispatch(
-  fetchSitesSummary({ group: formData.organization.name.toLowerCase() }),
+  fetchSitesSummary({ 
+    group: formData.organization?.name?.toLowerCase() || 'default'
+  }),
 );

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5c35a1d and 32339bb.

📒 Files selected for processing (2)

• platform/src/common/components/Modal/dataDownload/components/CustomFields.jsx (4 hunks)
• platform/src/common/components/Modal/dataDownload/modules/DataDownload.jsx (1 hunks)

🔇 Additional comments (3)

platform/src/common/components/Modal/dataDownload/components/CustomFields.jsx (3)

47-47: LGTM! Robust state initialization.

The defensive initialization with empty defaults for id and name prevents potential undefined errors when options array is empty.

---

58-58: LGTM! Consistent formatting implementation.

The handleSelect function correctly uses formatFieldValue to maintain consistent formatting across the component.

---

74-76: LGTM! UI formatting is consistent.

The component consistently applies formatting across both input field and dropdown, ensuring a uniform display of values.

Also applies to: 101-101

[github-actions]

New next-platform changes available for preview here

[github-actions]

New next-platform changes available for preview here