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

[GSoC'24] Keyboard Shortcuts Customization, Cypress Tests #8343

Merged
merged 7 commits into from
Aug 31, 2024

Conversation

tahamukhtar20
Copy link
Contributor

@tahamukhtar20 tahamukhtar20 commented Aug 24, 2024

Motivation and context

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

    • Enhanced user interface for the Shortcuts Settings component, improving organization and styling.
    • Introduction of a comprehensive suite of end-to-end tests for customizable keyboard shortcuts, ensuring robust functionality and user experience.
  • Bug Fixes

    • Improved handling of shortcut registration and conflict resolution, enhancing usability.
  • Documentation

    • Added tests that cover various functionalities related to shortcut management, contributing to better reliability and user guidance.

Copy link
Contributor

coderabbitai bot commented Aug 24, 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 enhancements to the ShortcutsSettingsComponent by adding new class names for improved styling and organization. Additionally, a new file for Cypress end-to-end tests is created, covering functionalities related to customizable keyboard shortcuts, including searching, registering, and modifying shortcuts, as well as testing interactions in various annotation modes.

Changes

Files Change Summary
cvat-ui/src/components/header/settings-modal/shortcut-settings.tsx Added new class names for the modal confirmation dialog, list items, and restore button for styling.
tests/cypress/e2e/features/shortcuts.js Introduced end-to-end tests for customizable keyboard shortcuts, covering search, registration, and default restoration functionalities.

Poem

In the meadow where shortcuts play,
A rabbit hops, hip-hip-hooray!
With new styles bright and neat,
Our settings dance, oh what a treat!
Testing paths, both near and far,
Custom keys, our guiding star! 🐇✨


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>.
    • 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 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.

@tahamukhtar20 tahamukhtar20 changed the title chore: push test files via upload [GSoC'24] Keyboard Shortcuts Customization, Cypress Tests Aug 24, 2024
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/shortcuts.js Outdated Show resolved Hide resolved
@tahamukhtar20 tahamukhtar20 marked this pull request as ready for review August 29, 2024 10:30
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: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9fc70ef and ab95ac7.

Files selected for processing (2)
  • cvat-ui/src/components/header/settings-modal/shortcut-settings.tsx (3 hunks)
  • tests/cypress/e2e/features/shortcuts.js (1 hunks)
Files skipped from review due to trivial changes (1)
  • cvat-ui/src/components/header/settings-modal/shortcut-settings.tsx
Additional comments not posted (9)
tests/cypress/e2e/features/shortcuts.js (9)

1-6: LGTM!

The file header and reference types are correctly included.


7-21: LGTM!

The context block and constants are correctly defined.


22-57: LGTM!

The task and storage objects are correctly defined.


59-68: LGTM!

The before hook is correctly implemented.


96-101: LGTM!

The function is correctly implemented.


124-126: LGTM!

The after hook is correctly implemented.


70-94: Reduce usage of .ant- classes.

The function is correctly implemented but uses .ant- classes. It is better to add unique cvat- classes to different elements.

-const searchItemClass = search === 'description' ? '.cvat-shortcuts-settings-item-title' : '.cvat-shortcuts-settings-item-description';
+const searchItemClass = search === 'description' ? '.cvat-shortcuts-settings-item-title' : '.cvat-shortcuts-settings-item-description';

Likely invalid or redundant comment.


128-137: Reduce usage of .ant- classes.

The test cases are correctly implemented but use .ant- classes. It is better to add unique cvat- classes to different elements.

-cy.get('.cvat-shortcuts-settings-search input').should('exist').and('be.visible');
+cy.get('.cvat-shortcuts-settings-search input').should('exist').and('be.visible');

Likely invalid or redundant comment.


140-153: Reduce usage of .ant- classes.

The test case is correctly implemented but uses .ant- classes. It is better to add unique cvat- classes to different elements.

-cy.get('.cvat-shortcuts-settings-collapse').should('exist').and('be.visible');
+cy.get('.cvat-shortcuts-settings-collapse').should('exist').and('be.visible');

Likely invalid or redundant comment.

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

sonarcloud bot commented Aug 31, 2024

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.56%. Comparing base (ad8ceea) to head (a310823).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8343      +/-   ##
===========================================
+ Coverage    83.47%   83.56%   +0.08%     
===========================================
  Files          396      396              
  Lines        41830    41830              
  Branches      3881     3881              
===========================================
+ Hits         34919    34954      +35     
+ Misses        6911     6876      -35     
Components Coverage Δ
cvat-ui 79.53% <ø> (+0.17%) ⬆️
cvat-server 87.14% <ø> (ø)

@bsekachev bsekachev merged commit cb6c50f into cvat-ai:develop Aug 31, 2024
33 checks passed
bschultz96 pushed a commit to bschultz96/cvat that referenced this pull request Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants