Update the AsthmaRecommendedArticle component to support localization.

greinard commented 1 month ago

Overview

This branch updates the AsthmaRecommendedArticle component so that it supports localization of the recommended article titles and subtitles.

Translations were generated using ChatGPT.

I will revert the snapshot version prior to merging.

Security

REMINDER: All file contents are public.

[x] I have ensured no secure credentials or sensitive information remain in code, metadata, comments, etc.
- [x] Please verify that you double checked that .storybook/preview.js does not contain your participant access key details.
- [x] There are no temporary testing changes committed such as API base URLs, access tokens, print/log statements, etc.
[x] These changes do not introduce any security risks, or any such risks have been properly mitigated.

Describe briefly what security risks you considered, why they don't apply, or how they've been mitigated.

Checklist

Testing

[ ] MyDataHelps iOS app
[ ] MyDataHelps Android app
[ ] MyDataHelps website

Documentation

[x] I have added relevant Storybook updates to this PR as well.

Summary by CodeRabbit

New Features
- Updated version of the application includes specific enhancements related to asthma translations.
- Improved localization for asthma-related articles, including new titles and subtitles in multiple languages (German, English, Spanish, French, Italian, Dutch, Polish, Portuguese).
- Enhanced preview capabilities for the AsthmaRecommendedArticle component with a new 'live' option.
Bug Fixes
- Streamlined the process for creating resource definitions for asthma articles, enhancing overall performance and maintainability.
Documentation
- Expanded educational content on asthma management, providing users with comprehensive resources and guidelines related to asthma care.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent update focuses on enhancing asthma management resources within the application. It includes updating the version for the @careevolution/mydatahelps-ui package and significant modifications to the AsthmaRecommendedArticle component. Changes include the addition of a libraryBaseUrl prop, an expanded preview state, and a refactor of the createResourceDefinition function to improve localization for article titles and subtitles.

Changes

Files	Change Summary
`package.json`	Updated version from `2.31.0` to `2.28.1-AsthmaTranslations.3`.
`src/components/asthma/components/AsthmaRecommendedArticle/AsthmaRecommendedArticle.tsx`	Refactored `createResourceDefinition` function to simplify parameters and improve localization logic for article titles and subtitles. Updated URL construction for localized content.
`src/components/asthma/components/AsthmaRecommendedArticle/AsthmaRecommendedArticle.stories.tsx`	Modified `render` function to include `libraryBaseUrl` prop and expanded preview options from two to three.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant LanguageService
    participant ArticleService

    User->>UI: Request asthma management articles
    UI->>LanguageService: Retrieve current language
    LanguageService-->>UI: Current language set
    UI->>ArticleService: Fetch localized articles
    ArticleService-->>UI: Return articles with titles/subtitles
    UI-->>User: Display articles

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

greinard commented 1 month ago

I would like to merge this within the next couple of days if someone has a few minutes for a review.

Thank you!

greinard commented 1 month ago

Just based on code review, this looks ok; but I don't see any real easy way to test or verify this via Story, because both the article chosen relies on live data (Story shows placeholder data) and we also don't have a very easy way to switch languages via Story.

So maybe a loaded question - but how did you verify all of these changes?

The conditional logic has thus far been tested using the DryRun Asthma Tool environment. I think we'll probably test a couple of those conditions again after this update to ensure things are still working as expected, but no logical changes were intended with this PR, just the translations. That said, I will add an item to my personal to-do list to come back and add some unit testing for this logic.

For the translations, I had just commented out a few lines in the story/component to simulate a "live" state within the storybook and then adjusted the selected language. I didn't exhaustively test all the translations. I just verified that the translation was taking place. The Spanish translations themselves are undergoing a separate review within the Asthma Tool library feature (same translations are duplicated here). However, I don't have a good way to verify the translations to the other languages short of the few spot checks I ran back through Google translate. All were originally generated using ChatGPT.

I have reworked the component a tad and updated the storybook such that it now uses a real example for the default preview state and supports a live state (if you have an Asthma Tool participant access token).

CareEvolution / MyDataHelpsUI