Skip to content
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.

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

Feat: Display total no. of entities with heading in Organization #10092

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

AdityaJ2305
Copy link
Contributor

@AdityaJ2305 AdityaJ2305 commented Jan 22, 2025

Proposed Changes

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

Release Notes

  • New Features

    • Added count badges to various organization-related pages (Users, Patients, Facilities, Organization View).
    • Introduced a more flexible localization strategy for entity counts.
  • Improvements

    • Enhanced UI with dynamic count displays for entities, showing "Loading..." when data is unavailable.
    • Improved header layouts across organization pages for better visual representation.
    • Generalized count representation for different entity types, allowing for broader application.
  • Localization

    • Updated translation strings to support generic entity counting.
    • Replaced user-specific count translations with a more flexible format.

@AdityaJ2305 AdityaJ2305 requested a review from a team as a code owner January 22, 2025 06:26
Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Warning

Rate limit exceeded

@AdityaJ2305 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 3 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 27d4b0e and 95c0ec3.

📒 Files selected for processing (1)
  • public/locale/en.json (2 hunks)

Walkthrough

This pull request introduces a consistent approach to displaying entity counts across various organization-related tabs. The changes involve modifying localization files and updating multiple components to include a Badge that shows the count of entities (facilities, patients, users, organizations). The implementation generalizes the count display mechanism, moving from user-specific to a more flexible entity-count approach. The changes aim to provide a uniform user interface that clearly shows the number of entities in different sections.

Changes

File Change Summary
public/locale/en.json Replaced user-specific count entries with generalized entity_count_one and entity_count_other localization strings.
src/components/Facility/FacilityUsers.tsx Updated to use generalized entity count translation.
src/pages/Organization/OrganizationFacilities.tsx Added Badge component to display facility count.
src/pages/Organization/OrganizationPatients.tsx Added Badge component to display patient count.
src/pages/Organization/OrganizationUsers.tsx Added Badge component to display user count.
src/pages/Organization/OrganizationView.tsx Modified header to include a badge for child organization count.

Assessment against linked issues

Objective Addressed Explanation
Display total number of entities in Organization tabs [#10087]
Consistent count display across Facilities, Patients, Users, Organizations

Possibly related PRs

Suggested labels

tested, reviewed, changes required

Suggested reviewers

  • rithviknishad

Poem

🐰 Counting entities, oh what delight!
Badges dancing, numbers shining bright
From users to patients, facilities galore
Our UI now speaks with numbers to explore
A rabbit's count of joy, precise and clear! 🔢


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
🪧 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. (Beta)
  • @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.

Copy link

netlify bot commented Jan 22, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 95c0ec3
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/6791010c28e6e70007c3b768
😎 Deploy Preview https://deploy-preview-10092--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (4)
src/pages/Organization/OrganizationView.tsx (2)

54-65: Maintain consistency with heading and translation keys.

The heading shows "organizations" while viewing child organizations, which might be confusing. Consider changing it to "child organizations" or similar for clarity.

-            <h2 className="text-lg font-semibold">{t("organizations")}</h2>
+            <h2 className="text-lg font-semibold">{t("child_organizations")}</h2>

57-58: Extract common Badge styling to a shared component.

The Badge styling is duplicated across all organization pages. Consider creating a shared component to maintain consistency and reduce duplication.

// src/components/Common/EntityCountBadge.tsx
export const EntityCountBadge = ({ count, entity }: { count: number; entity: string }) => (
  <Badge
    className="bg-purple-50 text-purple-700 ml-2 text-sm font-medium rounded-xl px-3 m-3"
    variant="outline"
  >
    {t("entity_count", { count, entity })}
  </Badge>
);

Also applies to: 63-63

src/pages/Organization/OrganizationFacilities.tsx (1)

67-69: Standardize translation key usage.

Use the common entity_count translation key for consistency with other organization pages.

-              {t("facility_count", {
-                count: facilities?.count || 0,
-              })}
+              {t("entity_count", {
+                count: facilities?.count || 0,
+                entity: "Facility"
+              })}
src/pages/Organization/OrganizationPatients.tsx (1)

102-110: Consider adding ARIA label for screen readers.

The Badge component should have an aria-label for better accessibility.

             <Badge
               className="bg-purple-50 text-purple-700 ml-2 text-sm font-medium rounded-xl px-3 m-3"
               variant="outline"
+              aria-label={t("entity_count", {
+                count: patients?.count || 0,
+                entity: "Patient"
+              })}
             >
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f2d856 and 70337a2.

📒 Files selected for processing (6)
  • public/locale/en.json (2 hunks)
  • src/components/Facility/FacilityUsers.tsx (1 hunks)
  • src/pages/Organization/OrganizationFacilities.tsx (2 hunks)
  • src/pages/Organization/OrganizationPatients.tsx (2 hunks)
  • src/pages/Organization/OrganizationUsers.tsx (2 hunks)
  • src/pages/Organization/OrganizationView.tsx (1 hunks)
👮 Files not reviewed due to content moderation or server errors (2)
  • src/components/Facility/FacilityUsers.tsx
  • public/locale/en.json

src/pages/Organization/OrganizationUsers.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
public/locale/en.json (1)

987-988: Consider handling irregular plurals.

The current pluralization simply adds 's' to the entity name, which works for regular English plurals but might not handle irregular cases (e.g., "person" → "people", "facility" → "facilities"). Consider using a more robust pluralization mechanism if irregular plurals are needed.

Example enhancement:

-  "entity_count_other": "{{count}} {{entity}}s",
+  "entity_count_other": "{{count}} {{entityPlural}}"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93a7a72 and 4028c22.

📒 Files selected for processing (6)
  • public/locale/en.json (2 hunks)
  • src/components/Facility/FacilityUsers.tsx (1 hunks)
  • src/pages/Organization/OrganizationFacilities.tsx (2 hunks)
  • src/pages/Organization/OrganizationPatients.tsx (2 hunks)
  • src/pages/Organization/OrganizationUsers.tsx (2 hunks)
  • src/pages/Organization/OrganizationView.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
  • src/pages/Organization/OrganizationFacilities.tsx
  • src/pages/Organization/OrganizationUsers.tsx
  • src/components/Facility/FacilityUsers.tsx
  • src/pages/Organization/OrganizationView.tsx
  • src/pages/Organization/OrganizationPatients.tsx
🔇 Additional comments (1)
public/locale/en.json (1)

987-988: LGTM! Well-designed localization approach.

The new generalized entity count entries provide a flexible and maintainable solution for displaying counts across different types of entities. The implementation follows i18n best practices for handling pluralization.

@AdityaJ2305
Copy link
Contributor Author

Actionable comments posted: 0

🧹 Nitpick comments (1)
📜 Review details

@coderabbitai, how to implement the nitpick comment

@github-actions github-actions bot added needs-triage question Further information is requested labels Jan 22, 2025
Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Tip

For best results, initiate chat on the files or code changes.

@AdityaJ2305 The nitpick comment suggests improving the pluralization handling in public/locale/en.json. Here's how to implement it:

  1. Update the translation keys in public/locale/en.json:
{
  "entity_count_one": "{{count}} {{entity}}",
  "entity_count_other": "{{count}} {{entityPlural}}"
}
  1. When using the translation, provide both singular and plural forms:
t("entity_count", {
  count: facilities?.count || 0,
  entity: "Facility",
  entityPlural: "Facilities"
})

This approach will handle irregular plurals correctly (like "person"/"people") instead of just adding 's' to the singular form. Would you like me to help you implement this change across all the files?

🔗 Analysis chain
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Fetch the review comments from the PR
gh pr view 10092 --json reviews -q '.reviews[].body'

Length of output: 5733

@AdityaJ2305
Copy link
Contributor Author

Tip

For best results, initiate chat on the files or code changes.

@AdityaJ2305 The nitpick comment suggests improving the pluralization handling in public/locale/en.json. Here's how to implement it:

  1. Update the translation keys in public/locale/en.json:
{
  "entity_count_one": "{{count}} {{entity}}",
  "entity_count_other": "{{count}} {{entityPlural}}"
}
  1. When using the translation, provide both singular and plural forms:
t("entity_count", {
  count: facilities?.count || 0,
  entity: "Facility",
  entityPlural: "Facilities"
})

This approach will handle irregular plurals correctly (like "person"/"people") instead of just adding 's' to the singular form. Would you like me to help you implement this change across all the files?

🔗 Analysis chain
🏁 Scripts executed

Hey Team, Do we really need to do that ? It just makes it too complex for simple translation

src/components/Facility/FacilityUsers.tsx Outdated Show resolved Hide resolved
src/pages/Organization/OrganizationFacilities.tsx Outdated Show resolved Hide resolved
src/pages/Organization/OrganizationPatients.tsx Outdated Show resolved Hide resolved
@github-actions github-actions bot added the Deploy-Failed Deplyment is not showing preview label Jan 22, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
src/pages/Organization/OrganizationView.tsx (1)

57-66: Extract Badge styling to a reusable component.

The Badge styling is duplicated across multiple components. Consider extracting it to a reusable component.

Create a new component EntityCountBadge:

// src/components/Common/EntityCountBadge.tsx
interface EntityCountBadgeProps {
  count: number | undefined;
  entity: string;
}

export function EntityCountBadge({ count, entity }: EntityCountBadgeProps) {
  const { t } = useTranslation();
  return (
    <Badge
      className="bg-purple-50 text-purple-700 ml-2 text-sm font-medium rounded-xl px-3 m-3"
      variant="outline"
    >
      {t("entity_count", {
        count: count ?? 0,
        entity,
        defaultValue: "{{count}} {{entity}}"
      })}
    </Badge>
  );
}
🧰 Tools
🪛 GitHub Check: cypress-run (1)

[failure] 61-61:
Argument of type '["entity_count", { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4028c22 and 5a3feb0.

📒 Files selected for processing (5)
  • src/components/Facility/FacilityUsers.tsx (1 hunks)
  • src/pages/Organization/OrganizationFacilities.tsx (2 hunks)
  • src/pages/Organization/OrganizationPatients.tsx (2 hunks)
  • src/pages/Organization/OrganizationUsers.tsx (2 hunks)
  • src/pages/Organization/OrganizationView.tsx (1 hunks)
🧰 Additional context used
🪛 GitHub Check: cypress-run (1)
src/components/Facility/FacilityUsers.tsx

[failure] 76-76:
Argument of type '["entity_count", { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

src/pages/Organization/OrganizationFacilities.tsx

[failure] 68-68:
Argument of type '["facility_count", { count: string | number; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

src/pages/Organization/OrganizationPatients.tsx

[failure] 107-107:
Argument of type '["entity_count", { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

src/pages/Organization/OrganizationUsers.tsx

[failure] 67-67:
Argument of type '["entity_count", { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

src/pages/Organization/OrganizationView.tsx

[failure] 61-61:
Argument of type '["entity_count", { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

🪛 GitHub Actions: Cypress Tests
src/components/Facility/FacilityUsers.tsx

[error] 76-76: Type error: Argument of type '['entity_count', { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'

🔇 Additional comments (2)
src/pages/Organization/OrganizationUsers.tsx (1)

67-71: Same issues as other components.

This component has the same translation type error and Badge styling duplication issues as discussed in previous files.

🧰 Tools
🪛 GitHub Check: cypress-run (1)

[failure] 67-67:
Argument of type '["entity_count", { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

src/pages/Organization/OrganizationPatients.tsx (1)

107-111: Same issues as other components.

This component has the same translation type error and Badge styling duplication issues as discussed in previous files.

🧰 Tools
🪛 GitHub Check: cypress-run (1)

[failure] 107-107:
Argument of type '["entity_count", { count: string | number; entity: string; }]' is not assignable to parameter of type '[key: string | string[], options: TOptionsBase & $Dictionary & { defaultValue: string; }] | [key: string | string[], defaultValue: string, options?: (TOptionsBase & $Dictionary) | undefined] | [key: ...]'.

src/components/Facility/FacilityUsers.tsx Outdated Show resolved Hide resolved
src/pages/Organization/OrganizationFacilities.tsx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deploy-Failed Deplyment is not showing preview needs-triage question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Display Total Number of Entities in Organization Tabs
2 participants