CareEvolution / MyDataHelpsUI

MyDataHelps UI React Component Library
MIT License
1 stars 2 forks source link

Fixes to Basic Points for Badges component #325

Closed reneefromhold closed 1 month ago

reneefromhold commented 1 month ago

Overview

Fixes 1) Title color property was not working 2) Added comments near where the awards url is opened. This came up while developing in Live mode and downstream repos 3) Updated the custom activity to update the custom field with recalculated points. Was previously adding recalculated points to the custom field. Fixes #324

Security

REMINDER: All file contents are public.

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

Checklist

Testing

Documentation

Consider "Squash and merge" as needed to keep the commit history reasonable on main.

Reviewers

Assign to the appropriate reviewer(s). Minimally, a second set of eyes is needed ensure no non-public information is published. Consider also including:

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve modifications to the BasicPointsForBadges component and its associated story file. New properties for customization, including pointsLabelColor, progressBarFillColor, and customField, are added to the Live export in the story file. Additionally, adjustments are made to the activities array, updating existing keys and types, and introducing a new activity. The component's state management and rendering logic are refined, particularly in handling badge awards and points calculation.

Changes

File Change Summary
src/components/container/BasicPointsForBadges/BasicPointsForBadges.stories.tsx - Added properties: pointsLabelColor, progressBarFillColor, customField to Live export.
- Updated activity key from "FitbitSleepData" to "SleepData".
- Updated dailyDataType from DailyDataType.FitbitSleepMinutes to DailyDataType.SleepMinutes.
- Added new activity: key: "CustomField", type: "custom", points: 25, customField: "PersonalGoal".
src/components/container/BasicPointsForBadges/BasicPointsForBadges.tsx - Updated state management for badges and points calculation.
- Changed Title component's color prop to direct assignment.
- Corrected conditional rendering for LoadingIndicator.
src/helpers/BasicPointsAndBadges/CustomActivity.ts - Changed logic in awardCustomActivityPoints to set pointsAwarded directly to newPoints.
- Added interface CustomActivity.
package.json - Version updated from 2.40.0 to 2.40.1-BasicBadgeVB.0.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BasicPointsForBadges
    participant BadgeManager

    User->>BasicPointsForBadges: Trigger badge award
    BasicPointsForBadges->>BadgeManager: Check for new badges
    BadgeManager-->>BasicPointsForBadges: Return badge status
    alt New badges awarded
        BasicPointsForBadges->>BasicPointsForBadges: Wait for few seconds
        BasicPointsForBadges->>User: Open application view for awarding badges
    else No new badges
        BasicPointsForBadges->>BasicPointsForBadges: Set currentState.badges
    end
    BasicPointsForBadges->>BasicPointsForBadges: Calculate newPointTotal
    BasicPointsForBadges->>User: Render updated points and badges

Assessment against linked issues

Objective Addressed Explanation
Configure component against a custom field (324)
Ensure points are awarded correctly based on custom field activities (324)
Restrict earning of points to avoid multiple awards in a day (324) No mechanism implemented to limit point earning.

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between ea2b909c97ac4d994c2ee1e837a742fcb45e1ca7 and de5ea5e25a72d5e67d113fcf88ddcec58578b424.
📒 Files selected for processing (1) * src/components/container/BasicPointsForBadges/BasicPointsForBadges.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * src/components/container/BasicPointsForBadges/BasicPointsForBadges.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 - [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 , 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` 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
reneefromhold commented 1 month ago

@greinard When you have a minute, your concerns should all be addressed. Also, note the update to the calculation for custom type. See issue #324 for discussion