Fix resume track button

andy1li commented 3 weeks ago

Checklist:

[x] I've thoroughly self-reviewed my changes
[x] I've added tests for my changes, unless they affect admin-only areas (or are otherwise not worth testing)
[x] I've verified any visual changes using Percy (add a commit with [percy] in the message to trigger)

Summary by CodeRabbit

New Features
- Enhanced routing functionality for the Resume Track button, allowing the inclusion of query parameters when transitioning to the course route.
- Added visibility checks and interaction capabilities for the "resume track" button based on user authentication and course progress.
Bug Fixes
- Improved handling of course tracking by ensuring the correct parameters are passed during navigation.
Tests
- Introduced new acceptance tests for the track page functionality, verifying the behavior of the "resume track" button for different user states and course progress.
- Updated test organization for better clarity and structure in acceptance tests related to the track page.
- Enhanced page object functionality with new properties for interacting with and checking the visibility of the "resume track" button.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes involve modifications to the activeCourse getter and handleClicked method in the CourseOverviewResumeTrackButtonComponent class located in app/components/track-page/resume-track-button.ts. The activeCourse getter now filters the user's repositories based on course and language, ensuring that not all stages are complete. The handleClicked method is updated to include an options object with queryParams in the transitionTo call of the router service. Additionally, new acceptance tests are introduced for the track page functionality, and properties are added to the page object for enhanced interaction capabilities.

Changes

File Path	Change Summary
app/components/track-page/resume-track-button.ts	Updated `activeCourse` getter logic and modified `handleClicked()` to include `queryParams` in `transitionTo`.
tests/acceptance/track-page/resume-track-test.js	Introduced new acceptance tests for the "resume track" button based on user authentication and course progress.
tests/acceptance/track-page/view-track-test.js	Updated module name for acceptance tests from `Acceptance \| view-track` to `Acceptance \| track-page \| view-track`.
tests/pages/track-page.js	Added `clickOnResumeTrackButton` and `hasResumeTrackButton` properties to enhance interaction capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Component
    participant Router

    User->>Component: Clicks Resume Track Button
    Component->>Router: transitionTo(courseRoute, { queryParams: { track: languageSlug } })
    Router-->>Component: Route updated with query parameters

🐰 "In the meadow, a button was pressed,
With a click, new paths were blessed.
Query params now dance in the air,
A track for the journey, a route to share!
Hops of joy in the code we see,
A better way to roam, so wild and free!" 🌼

Possibly related PRs

#2013: Modifications to the CourseOverviewResumeTrackButtonComponent, relating to user interface and experience.
#2039: Introduces a dark mode toggle, enhancing user experience and interface consistency.
#2045: Focuses on adding dark mode styles, directly relating to visual presentation aspects.
#2393: Enhancements to the course stage tutorial card, relating to user interface improvements.
#2417: Updates to test runner instructions reflecting user test run status, relevant to user experience.
#2418: Renaming the second stage instructions card for clarity and consistency in the user interface.

Suggested reviewers

rohitpaulk

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 437a97852820af46f2905fa3af4c572dec2c0666 and be1965af7181d16edc39128dc7bf239bf954aa52.

📒 Files selected for processing (1)

* `tests/acceptance/track-page/resume-track-test.js` (1 hunks)

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

* tests/acceptance/track-page/resume-track-test.js

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.

codecov[bot] commented 3 weeks ago

Bundle Report

Changes will increase total bundle size by 1.82kB (0.01%) :arrow_up:. This is within the configured threshold :white_check_mark:

Detailed changes

| Bundle name | Size | Change | | ----------- | ---- | ------ | | client-array-push | 35.87MB | 1.82kB (0.01%) :arrow_up: |

github-actions[bot] commented 3 weeks ago

Test Results

1 files ±0 1 suites ±0 6m 30s ⏱️ +39s 587 tests +3 547 ✅ +3 40 💤 ±0 0 ❌ ±0 602 runs +3 562 ✅ +3 40 💤 ±0 0 ❌ ±0

Results for commit be1965af. ± Comparison against base commit 55acbaff.

This pull request removes 8 and adds 11 tests. Note that renamed tests count towards both.

``` Chrome 131.0 ‑ Acceptance | view-track: it does not show a challenge if it is deprecated Chrome 131.0 ‑ Acceptance | view-track: it excludes alpha courses Chrome 131.0 ‑ Acceptance | view-track: it renders for anonymous user Chrome 131.0 ‑ Acceptance | view-track: it renders for logged-in user Chrome 131.0 ‑ Acceptance | view-track: it renders for logged-in user who has finished one course Chrome 131.0 ‑ Acceptance | view-track: it renders for logged-in user who has started course Chrome 131.0 ‑ Acceptance | view-track: it renders the correct description if the track is Go Chrome 131.0 ‑ Acceptance | view-track: it renders the correct description if the track is not Go ``` ``` Chrome 131.0 ‑ Acceptance | track-page | resume-track: it does not display the resume-track-button for anonymous user Chrome 131.0 ‑ Acceptance | track-page | resume-track: it does not display the resume-track-button for logged-in user who has not started course in the track Chrome 131.0 ‑ Acceptance | track-page | resume-track: it resumes track for logged-in user who has started course in the track Chrome 131.0 ‑ Acceptance | track-page | view-track: it does not show a challenge if it is deprecated Chrome 131.0 ‑ Acceptance | track-page | view-track: it excludes alpha courses Chrome 131.0 ‑ Acceptance | track-page | view-track: it renders for anonymous user Chrome 131.0 ‑ Acceptance | track-page | view-track: it renders for logged-in user Chrome 131.0 ‑ Acceptance | track-page | view-track: it renders for logged-in user who has finished one course Chrome 131.0 ‑ Acceptance | track-page | view-track: it renders for logged-in user who has started course Chrome 131.0 ‑ Acceptance | track-page | view-track: it renders the correct description if the track is Go … ```

:recycle: This comment has been updated with latest results.

codecov[bot] commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.

:white_check_mark: All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
app/components/track-page/resume-track-button.ts	66.66%	0 Missing and 1 partial :warning:

Additional details and impacted files

:loudspeaker: Thoughts on this report? Let us know!

rohitpaulk commented 3 weeks ago

@andy1li let's add a test for this? This is a pretty common user flow, so I think it's worth adding a test to cover this.

codecrafters-io / frontend