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

sorting btn created #3124

Conversation

gautam-divyanshu
Copy link
Member

@gautam-divyanshu gautam-divyanshu commented Jan 2, 2025

What kind of change does this PR introduce?

Issue Number:

Fixes #

Did you add tests for your changes?

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new SortingButton component for more intuitive organization sorting.
    • Replaced dropdown sorting mechanism with a streamlined button-based approach.
  • Improvements

    • Enhanced sorting functionality with a more modular and reusable interface.
    • Simplified sorting interaction for users by updating test identifiers for sorting options.

The changes improve the organization sorting experience by providing a more direct and user-friendly method of selecting sorting options.

Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Walkthrough

This pull request introduces a new SortingButton component to replace the existing dropdown sorting mechanism in the Organizations list. The changes involve creating a modular, reusable sorting interface in SortingButton.tsx, updating the OrgList.tsx to use this new component, and adjusting the corresponding test suite to match the new test identifiers. The modifications streamline the sorting functionality while maintaining the existing core logic of organization management.

Changes

File Change Summary
src/screens/OrgList/OrgList.test.tsx Updated test IDs from 'latest' to 'Latest' and 'oldest' to 'Earliest'
src/screens/OrgList/OrgList.tsx Removed SortIcon import, integrated new SortingButton component, removed console log from loadMoreOrganizations
src/subComponents/SortingButton.tsx New component created with props for sorting options, selected option, and change handler

Sequence Diagram

sequenceDiagram
    participant User
    participant OrgList
    participant SortingButton
    
    User->>SortingButton: Click to open sorting options
    SortingButton-->>User: Display available sorting options
    User->>SortingButton: Select sorting option
    SortingButton->>OrgList: Trigger onSortChange
    OrgList->>OrgList: Update organizations list order
Loading

Poem

🐰 Hop, hop, sorting with glee,
Buttons dancing, options free!
From dropdown to sleek and bright,
Our org list now shines just right!
Code hops forward, clean and neat 🚀


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1cb8471 and 6781e0f.

📒 Files selected for processing (1)
  • src/subComponents/SortingButton.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/subComponents/SortingButton.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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

Copy link

github-actions bot commented Jan 2, 2025

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

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: 0

🧹 Nitpick comments (3)
src/subComponents/SortingButton.tsx (1)

12-44: Consider adding an accessible label for the dropdown

While there is a title attribute, adding an accessible label (e.g., via aria-label or aria-labelledby linked to a text element) for the dropdown can improve usability for screen readers.

 <Dropdown
   aria-expanded="false"
   title="Sort organizations"
+  aria-label="Sort organizations"
   data-testid="sort"
 >
src/screens/OrgList/OrgList.tsx (1)

355-359: Consider using typed sorting options

Currently, the sorting options are passed as strings from translations: [t('Latest'), t('Earliest')]. If you intend to expand sorting behaviors (e.g. name, location, etc.), consider enumerating or validating these options to prevent typos and improve maintainability.

src/screens/OrgList/OrgList.test.tsx (1)

538-538: Maintain consistency with test IDs

Similar to the 'Latest' test ID, 'Earliest' depends on a potentially dynamic translation. If you ever localize it differently, your test may fail. Consider an approach that decouples display strings from test selectors.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b60c476 and 1cb8471.

📒 Files selected for processing (3)
  • src/screens/OrgList/OrgList.test.tsx (2 hunks)
  • src/screens/OrgList/OrgList.tsx (3 hunks)
  • src/subComponents/SortingButton.tsx (1 hunks)
🔇 Additional comments (3)
src/subComponents/SortingButton.tsx (1)

6-10: Keep interface flexible for future enhancements

This interface is well-defined for the current scenario. If future requirements involve passing additional properties (e.g., labeling text, disabled states), consider making the interface more extensible or including optional fields to accommodate those changes without breaking existing code.

src/screens/OrgList/OrgList.tsx (1)

31-31: Confirm the import path correctness

Ensure that 'subComponents/SortingButton' is the correct relative path. If there's a mismatch in directory structure, this import will fail at runtime.

✅ Verification successful

Import path is correct and verified

The import path 'subComponents/SortingButton' is correct as the file exists at src/subComponents/SortingButton.tsx. Since the import is from src/screens/OrgList/OrgList.tsx, and both files are under the src directory, the relative import path is valid.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify that the SortingButton.tsx file exists under 'subComponents' relative to 'src/screens/OrgList'
fd SortingButton.tsx | grep 'subComponents'

Length of output: 79

src/screens/OrgList/OrgList.test.tsx (1)

526-526: Confirm testing with localized test IDs

The string 'Latest' is used as a test ID. This may differ from the actual text returned by the translator if the locale changes. Consider using static test IDs or a consistent pattern that does not rely on translated text to avoid test breakage across different locales.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 2, 2025
@gautam-divyanshu gautam-divyanshu deleted the rafactorBtn branch January 2, 2025 17:51
Copy link

codecov bot commented Jan 2, 2025

Codecov Report

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

Project coverage is 89.51%. Comparing base (78be925) to head (6781e0f).
Report is 1 commits behind head on develop-postgres.

Files with missing lines Patch % Lines
src/subComponents/SortingButton.tsx 80.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3124       +/-   ##
=====================================================
+ Coverage             23.64%   89.51%   +65.87%     
=====================================================
  Files                   301      323       +22     
  Lines                  7677     8453      +776     
  Branches               1677     1843      +166     
=====================================================
+ Hits                   1815     7567     +5752     
+ Misses                 5738      654     -5084     
- Partials                124      232      +108     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

1 participant