Refactor Facility Export & Add New Sidebar collapse & expand Test

Alokih commented 2 weeks ago

Proposed Changes

Fixes #9043
Task - 1 : Added new test for sidebar collapse
Task - 2: Refactored the existing cypress facility export

@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

New Features
- Introduced a test case to verify the sidebar's collapse and expand functionality.
- Enhanced sidebar interaction with new methods for toggling and verifying visibility of icons and text.
Improvements
- Added data-testid attributes to components for better testability.
- Streamlined CSV download functionality tests to include capacity exports.
Bug Fixes
- Ensured local storage is saved after each test execution.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces modifications to the Cypress end-to-end test suite for the facility homepage, including the addition of a sidebar collapse and expand functionality test. Enhancements to the FacilityHome class allow for improved sidebar interactions. The existing capacity export functionality has been integrated into the facility export test. Additionally, new data-testid attributes have been added to various components to enhance testability.

Changes

File Path	Change Summary
cypress/e2e/facility_spec/FacilityHomepage.cy.ts	Added sidebar collapse/expand test, integrated capacity export into facility export test, moved `afterEach` hook.
cypress/pageobject/Facility/FacilityHome.ts	Added methods for sidebar interactions: `toggleSidebar()`, `verifyIconsAndTextVisible()`, `verifyIconsVisibleAndTextHidden()`, and new selectors for sidebar elements.
src/components/Common/Sidebar/Sidebar.tsx	Added `data-testid="sidebar-toggle"` to the button element in `ToggleShrink`.
src/components/Common/Sidebar/SidebarItem.tsx	Added `data-testid` attributes to `div` and `span` for sidebar icon and text in `SidebarItemBase`.

Assessment against linked issues

Objective	Addressed	Explanation
Refactor the existing facility export and add test for sidebar collapse (9043)	✅
Verify sidebar functionality: icons/text visibility when collapsed/expanded (9043)	✅
Integrate capacity export into facility export functionality (9043)	✅

Possibly related PRs

#9045: This PR adds a new Cypress test suite for the facility notice board functionality, which is related to the changes in the main PR that also involve Cypress tests for the facility homepage, specifically regarding sidebar functionality and notifications.
#9105: This PR focuses on refactoring the advanced filters for the facility homepage, which aligns with the changes in the main PR that also involve enhancements to the functionality of the FacilityHome class and its methods related to the sidebar and filtering capabilities.

Suggested labels

tested

Suggested reviewers

nihal467
khavinshankar

Poem

In the land of tests, where bunnies play,
The sidebar toggles in a joyful way.
With icons shining bright and texts that hide,
Our Cypress tests now take a grand ride!
So hop along, dear friends, and see,
How smoothly our features now can be! 🐇✨

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint
> If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

cypress/e2e/facility_spec/FacilityHomepage.cy.ts
Oops! Something went wrong! :( ESLint: 8.57.1 Error: Failed to load parser '@typescript-eslint/parser' declared in '.eslintrc.json': Cannot find module '@typescript-eslint/parser' Require stack: - /.eslintrc.json at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15) at Function.resolve (node:internal/modules/helpers:145:19) at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46) at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39) at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43) at _normalizeObjectConfigDataBody.next () at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20) at _normalizeObjectConfigData.next () at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28) at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3d06dba1903e6a02dadbb3a2e21e07c2db547434 and 9d65b4fbb2a59a59d2680ae4e23d1d951ef54ce2.

📒 Files selected for processing (1)

* `cypress/e2e/facility_spec/FacilityHomepage.cy.ts` (3 hunks)

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

* cypress/e2e/facility_spec/FacilityHomepage.cy.ts

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` 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://docs.coderabbit.ai) 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.

netlify[bot] commented 2 weeks ago

Deploy Preview for care-ohc ready!

Name	Link
Latest commit	9d65b4fbb2a59a59d2680ae4e23d1d951ef54ce2
Latest deploy log	https://app.netlify.com/sites/care-ohc/deploys/6738958310b28e0008eeb203
Deploy Preview	https://deploy-preview-9066--care-ohc.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions[bot] commented 2 weeks ago

:wave: Hi, @Alokih, Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

This message is automatically generated by prince-chrismc/label-merge-conflicts-action so don't hesitate to report issues/improvements there.

nihal467 commented 1 week ago

@Alokih make the requested changes

Alokih commented 1 week ago

@nihal467 I have my end sem exams going on currently. Can I do it after few days ?

nihal467 commented 9 hours ago

@Alokih that's fine, but can you mention a date when you are expecting to complete it

Alokih commented 2 hours ago

@Alokih that's fine, but can you mention a date when you are expecting to complete it

Tomorrow is the last one , so I will try to complete it by Day after tomorrow.

ohcnetwork / care_fe