Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added regression test for requests page #8608

Merged
merged 12 commits into from
Oct 30, 2024
Merged

Conversation

klakhov
Copy link
Contributor

@klakhov klakhov commented Oct 29, 2024

Motivation and context

Added test for #8575

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Introduced a new test case for handling export request failures on the requests page, ensuring user-friendly error messaging.
  • Bug Fixes

    • Enhanced error handling to prevent UI crashes during export status request failures.

Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a new test case to the Cypress end-to-end testing suite for the requests page. The test, titled "Export task. Request for status fails, UI is not crushing," simulates a scenario where an export status request fails with a 500 error. It checks for the correct error message display, ensures the notification can be closed, and verifies that the requests page remains functional after the error.

Changes

File Change Summary
tests/cypress/e2e/features/requests_page.js Added a new test case for handling export request failures, ensuring UI stability and error messaging.

Poem

In the land of code where rabbits play,
A test was added to brighten the day.
When exports fail and errors arise,
The UI stands firm, much to our surprise!
With messages clear and no crashes in sight,
Our requests page hops on, ready to delight! 🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@klakhov klakhov added the tests label Oct 29, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
tests/cypress/e2e/features/requests_page.js (2)

361-378: LGTM! Well-structured test case for error handling.

The test effectively verifies the UI's resilience when the export status request fails. Good coverage of:

  • Error simulation using cy.intercept
  • Error message verification
  • UI state validation post-error

Consider adding these additional assertions to make the test more robust:

 cy.contains('.cvat-header-button', 'Requests').should('be.visible').click();
 cy.get('.cvat-requests-page').should('be.visible');
+cy.get('.cvat-requests-card').should('exist');
+cy.get('.cvat-request-item-progress-failed').should('exist');

373-374: Verify error message content.

The test should verify the complete error message content to ensure proper error handling.

-cy.contains('Could not export dataset').should('be.visible');
+cy.get('.ant-notification-notice-error')
+    .should('be.visible')
+    .within(() => {
+        cy.contains('Could not export dataset').should('be.visible');
+        cy.contains('Network error').should('be.visible');
+    });
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9982156 and 94ef56c.

📒 Files selected for processing (1)
  • tests/cypress/e2e/features/requests_page.js (1 hunks)

tests/cypress/e2e/features/requests_page.js Show resolved Hide resolved
Copy link

sonarcloud bot commented Oct 30, 2024

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.25%. Comparing base (bce96ea) to head (6c78921).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8608      +/-   ##
===========================================
+ Coverage    74.22%   74.25%   +0.03%     
===========================================
  Files          403      403              
  Lines        43375    43375              
  Branches      3925     3925              
===========================================
+ Hits         32195    32210      +15     
+ Misses       11180    11165      -15     
Components Coverage Δ
cvat-ui 78.69% <ø> (+0.16%) ⬆️
cvat-server 70.47% <ø> (-0.08%) ⬇️

@bsekachev bsekachev merged commit 4d4d8fc into develop Oct 30, 2024
34 checks passed
@klakhov klakhov deleted the kl/requests-crush-test branch November 2, 2024 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants