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

fix(my-pages): add locale param to oragn donation query #16465

Merged
merged 4 commits into from
Oct 18, 2024

Conversation

disaerna
Copy link
Member

@disaerna disaerna commented Oct 18, 2024

My pages - Health - Organ donation

What

Add missing locale parameter to organ donation query

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features
    • Enhanced the Organ Donation component to support locale-aware donor status queries.
    • Updated the Registration Form to ensure fresh data retrieval by disabling cached results for organ lists.
  • Bug Fixes
    • Improved string formatting for the card text to ensure consistent punctuation.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
germa89 German
@disaerna disaerna added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Oct 18, 2024
@disaerna disaerna requested a review from a team as a code owner October 18, 2024 13:07
Copy link
Contributor

coderabbitai bot commented Oct 18, 2024

Walkthrough

The pull request modifies the OrganDonation component in OrganDonation.tsx by integrating both locale and lang variables from the useLocale hook into the useGetDonorStatusQuery parameters. This change enables the query to be aware of the current locale and language settings. Additionally, the construction of the cardText string is refined to ensure it consistently ends with a period, removing the previous optional chaining operator. The RegistrationForm.tsx file is also updated to include a fetchPolicy option in the useGetOrgansListQuery hook.

Changes

File Path Change Summary
libs/service-portal/health/src/screens/OrganDonation/OrganDonation.tsx - Added locale and lang variables from useLocale hook.
- Updated useGetDonorStatusQuery to include locale and lang in the query variables.
- Adjusted cardText string construction for consistency.
libs/service-portal/health/src/screens/OrganDonationRegistration/RegistrationForm.tsx - Added fetchPolicy: 'no-cache' to useGetOrgansListQuery to ensure fresh data retrieval.

Possibly related PRs

Suggested labels

high priority

Suggested reviewers

  • thorkellmani
  • snaerseljan

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0ed830d and 92d049f.

📒 Files selected for processing (1)
  • libs/service-portal/health/src/screens/OrganDonationRegistration/RegistrationForm.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • libs/service-portal/health/src/screens/OrganDonationRegistration/RegistrationForm.tsx

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

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

🧹 Outside diff range and nitpick comments (2)
libs/service-portal/health/src/screens/OrganDonation/OrganDonation.tsx (2)

20-22: LGTM: Locale parameter added to query

The inclusion of the locale variable in the query parameters successfully implements the PR's main objective. This change enhances the query's ability to handle different locales, improving the overall functionality of the organ donation feature.

As a minor optimization, consider using object shorthand notation:

variables: { locale },

This makes the code slightly more concise while maintaining readability.


32-32: LGTM: Improved string formatting consistency

The modification to always append a period to the cardText string ensures consistent formatting. This change improves the quality of the displayed text by guaranteeing that all sentences end with a period.

For added clarity, consider extracting this string construction logic into a separate function:

const getCardText = (donorStatus) => {
  if (!donorStatus?.isDonor) {
    return formatMessage(m.iAmNotOrganDonorText);
  }
  if (donorStatus.limitations?.hasLimitations) {
    return `${formatMessage(m.iAmOrganDonorWithExceptionsText)} ${donorStatus.limitations.limitedOrgansList?.map((organ) => organ.name).join(', ')}.`;
  }
  return formatMessage(m.iAmOrganDonorText);
};

// Usage
const cardText = getCardText(donorStatus);

This refactoring would improve readability and make the logic easier to test and maintain.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d6b0e01 and a363afa.

📒 Files selected for processing (1)
  • libs/service-portal/health/src/screens/OrganDonation/OrganDonation.tsx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/service-portal/health/src/screens/OrganDonation/OrganDonation.tsx (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
🔇 Additional comments (1)
libs/service-portal/health/src/screens/OrganDonation/OrganDonation.tsx (1)

17-17: LGTM: Locale extraction aligns with PR objective

The addition of locale to the destructured values from useLocale is in line with the PR's goal of adding a locale parameter to the organ donation query. This change enhances the component's ability to handle different locales, improving its reusability across the application.

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.78%. Comparing base (52288e6) to head (92d049f).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16465   +/-   ##
=======================================
  Coverage   36.78%   36.78%           
=======================================
  Files        6833     6833           
  Lines      141431   141431           
  Branches    40278    40310   +32     
=======================================
+ Hits        52026    52027    +1     
+ Misses      89405    89404    -1     
Flag Coverage Δ
air-discount-scheme-backend 54.08% <ø> (ø)
air-discount-scheme-web 0.00% <ø> (ø)
api 3.37% <ø> (ø)
api-catalogue-services 77.85% <ø> (ø)
api-domains-air-discount-scheme 36.93% <ø> (ø)
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 48.48% <ø> (ø)
api-domains-communications 39.90% <ø> (ø)
api-domains-criminal-record 48.00% <ø> (ø)
api-domains-driving-license 44.48% <ø> (ø)
api-domains-education 31.58% <ø> (ø)
api-domains-health-insurance 34.77% <ø> (ø)
api-domains-mortgage-certificate 34.95% <ø> (ø)
api-domains-payment-schedule 41.16% <ø> (ø)
application-api-files 56.86% <ø> (ø)
application-core 71.32% <ø> (ø)
application-system-api 41.37% <ø> (ø)
application-template-api-modules 27.85% <ø> (-0.01%) ⬇️
application-templates-accident-notification 29.27% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 26.34% <ø> (ø)
application-templates-driving-license 18.32% <ø> (ø)
application-templates-estate 12.32% <ø> (ø)
application-templates-example-payment 25.14% <ø> (ø)
application-templates-financial-aid 15.50% <ø> (ø)
application-templates-general-petition 23.44% <ø> (ø)
application-templates-inheritance-report 6.49% <ø> (ø)
application-templates-marriage-conditions 15.17% <ø> (ø)
application-templates-mortgage-certificate 43.82% <ø> (ø)
application-templates-parental-leave 29.96% <ø> (ø)
application-types 6.63% <ø> (ø)
application-ui-components 1.28% <ø> (ø)
application-ui-shell 21.37% <ø> (ø)
auth-admin-web 2.43% <ø> (ø)
auth-nest-tools 29.84% <ø> (ø)
auth-react 22.77% <ø> (ø)
auth-shared 75.00% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
clients-driving-license 40.67% <ø> (ø)
clients-driving-license-book 43.80% <ø> (ø)
clients-financial-statements-inao 49.32% <ø> (ø)
clients-license-client 1.83% <ø> (ø)
clients-middlewares 73.18% <ø> (ø)
clients-regulations 42.80% <ø> (ø)
clients-rsk-company-registry 29.76% <ø> (ø)
clients-rsk-personal-tax-return 38.00% <ø> (ø)
clients-smartsolutions 12.77% <ø> (ø)
clients-syslumenn 49.44% <ø> (ø)
clients-zendesk 54.61% <ø> (ø)
cms 0.42% <ø> (ø)
cms-translations 39.03% <ø> (ø)
content-search-index-manager 95.65% <ø> (ø)
content-search-toolkit 8.16% <ø> (ø)
contentful-apps 5.44% <ø> (ø)
dokobit-signing 63.38% <ø> (ø)
download-service 44.22% <ø> (ø)
email-service 61.13% <ø> (ø)
feature-flags 91.11% <ø> (ø)
file-storage 53.71% <ø> (ø)
financial-aid-backend 56.37% <ø> (ø)
financial-aid-shared 18.94% <ø> (ø)
icelandic-names-registry-backend 53.97% <ø> (ø)
infra-nest-server 48.17% <ø> (ø)
infra-tracing 43.24% <ø> (ø)
island-ui-core 28.39% <ø> (ø)
judicial-system-api 18.37% <ø> (ø)
judicial-system-audit-trail 69.35% <ø> (ø)
judicial-system-backend 55.29% <ø> (ø)
judicial-system-formatters 79.25% <ø> (ø)
judicial-system-message 67.24% <ø> (ø)
judicial-system-message-handler 48.35% <ø> (ø)
judicial-system-scheduler 69.54% <ø> (ø)
judicial-system-types 47.12% <ø> (ø)
judicial-system-web 27.91% <ø> (ø)
license-api 42.62% <ø> (-0.08%) ⬇️
localization 10.15% <ø> (ø)
logging 48.43% <ø> (ø)
message-queue 68.58% <ø> (ø)
nest-audit 68.20% <ø> (ø)
nest-aws 60.29% <ø> (ø)
nest-config 78.44% <ø> (ø)
nest-feature-flags 51.52% <ø> (ø)
nest-problem 45.85% <ø> (ø)
nest-sequelize 94.44% <ø> (ø)
nest-swagger 51.71% <ø> (ø)
nova-sms 62.74% <ø> (ø)
portals-admin-regulations-admin 1.85% <ø> (ø)
portals-core 16.15% <ø> (ø)
reference-backend 49.79% <ø> (ø)
regulations 16.78% <ø> (ø)
residence-history 85.00% <ø> (ø)
services-auth-admin-api 51.93% <ø> (ø)
services-auth-delegation-api 57.36% <ø> (+0.06%) ⬆️
services-auth-ids-api 51.42% <ø> (+0.01%) ⬆️
services-auth-personal-representative 45.14% <ø> (+0.02%) ⬆️
services-auth-personal-representative-public 41.27% <ø> (+0.03%) ⬆️
services-auth-public-api 48.89% <ø> (-0.01%) ⬇️
services-documents 60.58% <ø> (ø)
services-endorsements-api 53.66% <ø> (ø)
services-sessions 65.33% <ø> (ø)
services-university-gateway 48.40% <ø> (-0.03%) ⬇️
services-user-notification 47.02% <ø> (ø)
services-user-profile 62.19% <ø> (ø)
shared-components 27.65% <ø> (ø)
shared-form-fields 31.59% <ø> (ø)
shared-mocking 64.62% <ø> (ø)
shared-pii 92.85% <ø> (ø)
shared-problem 87.50% <ø> (ø)
shared-utils 27.69% <ø> (ø)
skilavottord-ws 24.24% <ø> (ø)
testing-e2e 66.66% <ø> (ø)
web 1.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 52288e6...92d049f. Read the comment docs.

Copy link
Member

@thorkellmani thorkellmani left a comment

Choose a reason for hiding this comment

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

LGTM

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 18, 2024

Datadog Report

All test runs db74ce0 🔗

101 Total Test Services: 0 Failed, 98 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.01%), 2 increased, 197 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-backend 0 0 0 81 0 31.35s N/A Link
air-discount-scheme-web 0 0 0 2 0 8.2s N/A Link
api 0 0 0 4 0 3.06s N/A Link
api-catalogue-services 0 0 0 23 0 12.39s N/A Link
api-domains-air-discount-scheme 0 0 0 6 0 16.97s N/A Link
api-domains-assets 0 0 0 3 0 10.99s N/A Link
api-domains-auth-admin 0 0 0 18 0 11.87s 1 no change Link
api-domains-communications 0 0 0 5 0 35.52s N/A Link
api-domains-criminal-record 0 0 0 5 0 10.86s 1 no change Link
api-domains-driving-license 0 0 0 23 0 28.73s N/A Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-template-api-modules - jest 30.08% (-0.01%) - Details

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

🧹 Outside diff range and nitpick comments (2)
libs/service-portal/health/src/screens/OrganDonationRegistration/RegistrationForm.tsx (2)

40-40: Approved: Addition of fetchPolicy improves data freshness.

The addition of fetchPolicy: 'no-cache' ensures that the organ donation list is always up-to-date, which is crucial for medical information. This change aligns with best practices for data integrity in sensitive applications.

Consider making the fetchPolicy configurable:

const { data, loading } = useGetOrgansListQuery({
  variables: { locale: lang },
  fetchPolicy: process.env.NEXT_PUBLIC_ORGAN_DONATION_FETCH_POLICY || 'no-cache',
});

This approach allows for easy adjustment of the fetch policy based on the environment, enhancing the component's flexibility across different NextJS apps.


Line range hint 1-208: Approved: Well-structured and reusable component implementation.

The Form2 component is well-implemented, adhering to the coding guidelines for libs/**/* files. It demonstrates good practices in terms of reusability, TypeScript usage, and effective tree-shaking. The component structure and logic are clear and maintainable.

To further improve code organization, consider extracting the form submission logic into a custom hook:

const useOrganDonationForm = (lang: string) => {
  const [updateDonorStatus] = useUpdateOrganDonationInfoMutation({
    onCompleted: () => {
      toast.success(formatMessage(messages.registrationComplete))
      navigate(HealthPaths.HealthOrganDonation, { replace: true })
    },
    onError: () => {
      toast.error(formatMessage(messages.registrationFailed))
    },
  });

  const onSubmit = async (e: React.FormEvent<HTMLFormElement>) => {
    e.preventDefault()
    // ... (rest of the submission logic)
  }

  return { onSubmit };
};

This refactoring would enhance the component's readability and make the form submission logic more reusable across different components if needed.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a363afa and 0ed830d.

📒 Files selected for processing (2)
  • libs/service-portal/health/src/screens/OrganDonation/OrganDonation.tsx (2 hunks)
  • libs/service-portal/health/src/screens/OrganDonationRegistration/RegistrationForm.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • libs/service-portal/health/src/screens/OrganDonation/OrganDonation.tsx
🧰 Additional context used
📓 Path-based instructions (1)
libs/service-portal/health/src/screens/OrganDonationRegistration/RegistrationForm.tsx (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants