Add ability to ensure sequential completion of survey tasks

felideon commented 3 weeks ago

Overview

Paves way for https://github.com/CareEvolution/MyDataHelpsViewBuilder/issues/111.

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.

No security risks come to mind.

Checklist

Testing

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

Documentation

[x] I have added relevant Storybook updates to this PR as well.
[x] If this feature requires a developer doc update, tag @CareEvolution/api-docs.

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:

Subject-matter experts
Style/editing reviewers
Others requested by the content owner

Summary by CodeRabbit

New Features
- Introduced a new sequential property to enhance task presentation in the survey task components.
- Added a surveyBlocked property to manage user interactions based on survey availability.
- Created a new story for sequential task presentation in the storybook.
Bug Fixes
- Improved control flow to prevent user interactions when a survey task is blocked, enhancing overall user experience.
Style
- Updated cursor behavior for interactive elements to improve user interface clarity.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes introduce a new optional property, sequential, to the SurveyTaskList component and its related stories, allowing for sequential management of survey tasks. Additionally, a surveyBlocked property is added to the SingleSurveyTask component, which controls user interactions based on the survey's availability. CSS modifications enhance the user interface by adjusting cursor behavior for interactive elements. These updates collectively improve the components' functionality and user experience in handling survey tasks.

Changes

File	Change Summary
`src/components/container/SurveyTaskList/SurveyTaskList.*`	Added `sequential` property to `SurveyTaskListProps`, updated logic for task blocking, and modified storybook components to include `sequential`.
`src/components/presentational/SingleSurveyTask/SingleSurveyTask.*`	Introduced `surveyBlocked` property to manage interactions, updated click handlers, and modified story arguments accordingly.
`src/components/presentational/SingleSurveyTask/SingleSurveyTask.css`	Added a new CSS rule for `.mdhui-single-survey-task.incomplete-expanded.active` to enhance cursor behavior.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SurveyTaskList
    participant SingleSurveyTask

    User->>SurveyTaskList: Request to view tasks
    SurveyTaskList->>SingleSurveyTask: Render tasks with sequential and surveyBlocked props
    alt If surveyBlocked is true
        SingleSurveyTask->>User: Disable interaction
    else
        SingleSurveyTask->>User: Enable interaction
    end

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between bd47480a5775910bf50e679ece79aa0b38c74922 and bda9dccd6e5befa1841a3e1b0ca662e96e6a22e5.

Files selected for processing (1)

* src/components/container/SurveyTaskList/SurveyTaskList.stories.tsx (2 hunks)

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

* src/components/container/SurveyTaskList/SurveyTaskList.stories.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 .` - `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.

felideon commented 3 weeks ago

Storybook screenshots:

reneefromhold commented 3 weeks ago

@felideon The way it is implemented, a new view would be needed if there was ever a desire to complete non sequentially. Is that going to be ok?

reneefromhold commented 3 weeks ago

I connected with @felideon on my previous question about how to not make this binary. In the near future, there will be support for filtering tasks in the task list by category. Having options like that will make it easier to support a mix of non seq and sequential on the same view

CareEvolution / MyDataHelpsUI