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

Sort rounds in project page #4813

Merged
merged 3 commits into from
Oct 4, 2024
Merged

Conversation

HrithikSampson
Copy link
Collaborator

@HrithikSampson HrithikSampson commented Oct 3, 2024

relates to #4289

Summary by CodeRabbit

  • New Features
    • Enhanced sorting logic for donation rounds to prioritize both activity status and start date.
  • Bug Fixes
    • Improved rendering logic for the "Recurring Donations" label to accurately reflect the selected state.

Copy link

vercel bot commented Oct 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
giveth-dapps-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 4, 2024 1:26pm

Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

Walkthrough

The changes in this pull request modify the sorting logic of the sortedRounds array in the QfRoundSelector component. The sorting now considers both the isActive status and the beginDate to determine the order of rounds displayed. If two rounds share the same activity status, they are sorted by their start dates in descending order. Additionally, minor adjustments were made to the rendering logic of the TabItem components within SwiperSlide, simplifying the conditional rendering for the "Recurring Donations" label based on the selectedQF state.

Changes

File Path Change Summary
src/components/views/project/projectDonations/QfRoundSelector.tsx Enhanced sorting logic for sortedRounds to include beginDate when isActive is the same; simplified rendering logic for "Recurring Donations" label.

Possibly related PRs

  • Main #4340: The changes in QfRoundSelector.tsx regarding sorting logic may relate to the adjustments in the rendering logic of donation-related components, as both involve enhancing user interaction with donation features.

Poem

🐇 In the garden where donations bloom,
Rounds now sorted, dispelling the gloom.
Active or not, dates lead the way,
Clarity shines in the light of the day.
With each little hop, we cheer and we play! 🎉


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.

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

🧹 Outside diff range and nitpick comments (3)
src/components/views/project/projectDonations/QfRoundSelector.tsx (3)

40-46: Improved sorting logic looks good!

The updated sorting logic correctly prioritizes active rounds and then sorts by beginDate in descending order. This aligns well with the PR objective.

Consider a minor optimization:

 sortedRounds =
   projectData?.qfRounds?.sort((a: IQFRound, b: IQFRound) => {
     const activeFirstCompare = Number(b.isActive) - Number(a.isActive);
     if (activeFirstCompare === 0) {
-      return new Date(b.beginDate) > new Date(a.beginDate) ? 1 : -1;
+      return new Date(b.beginDate).getTime() - new Date(a.beginDate).getTime();
     }
     return activeFirstCompare;
   }) || [];

This change avoids creating unnecessary Date objects and uses getTime() for a more efficient comparison.


Line range hint 114-118: Improved rendering logic for "Recurring Donations" tab

The simplified condition for rendering the "Recurring Donations" label is correct and more intuitive.

For consistency with the QF round tabs, consider updating the rendering logic for both "All Donations" and "Recurring Donations" tabs:

 <SwiperSlide style={{ width: 'auto' }}>
   <TabItem
     $alignItems='center'
     gap='4px'
     onClick={() => {
       setIsRecurringSelected(false);
       setSelectedQF(null);
     }}
     $isSelected={
       selectedQF === null && isRecurringSelected === false
     }
   >
-    {selectedQF === null &&
-    isRecurringSelected === false ? (
+    {selectedQF === null && !isRecurringSelected ? (
       <B>
         {formatMessage({ id: 'label.all_donations' })}
       </B>
     ) : (
       <P>
         {formatMessage({ id: 'label.all_donations' })}
       </P>
     )}
   </TabItem>
 </SwiperSlide>
 <SwiperSlide style={{ width: 'auto' }}>
   <TabItem
     $alignItems='center'
     gap='4px'
     onClick={() => {
       setSelectedQF(null);
       setIsRecurringSelected(true);
     }}
     $isSelected={isRecurringSelected === true}
   >
-    {(projectDonationSwiperState.selectedQF === null) ===
-    null ? (
+    {isRecurringSelected ? (
       <B>Recurring Donations</B>
     ) : (
       <P>Recurring Donations</P>
     )}
   </TabItem>
 </SwiperSlide>

This change makes the rendering logic consistent across all tabs and simplifies the conditions.


Issue Detected: Unintended Condition projectDonationSwiperState.selectedQF === null

The condition projectDonationSwiperState.selectedQF === null is still present in the QfRoundSelector.tsx component. This may lead to inconsistent behavior and should be reviewed to ensure all outdated conditions are properly handled.

  • File: src/components/views/project/projectDonations/QfRoundSelector.tsx
  • Condition: projectDonationSwiperState.selectedQF === null
🔗 Analysis chain

Line range hint 1-190: Overall, the changes look good and align with the PR objective

The sorting logic for rounds has been improved, and the rendering of tabs has been simplified. These changes should effectively sort the rounds on the project page as intended.

To ensure the changes work as expected, please run the following verification steps:

These tests will help ensure that the sorting logic is applied correctly, the isRecurringSelected state is used consistently, and there are no remnants of the old rendering condition.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the changes in QfRoundSelector component

# Test 1: Check if the sorting logic is used correctly
echo "Test 1: Verifying sorting logic usage"
rg --type typescript "projectData\?\.qfRounds\?\.sort\(" src/components/views/project/projectDonations/QfRoundSelector.tsx

# Test 2: Check if isRecurringSelected is used consistently
echo "Test 2: Verifying isRecurringSelected usage"
rg --type typescript "isRecurringSelected" src/components/views/project/projectDonations/QfRoundSelector.tsx

# Test 3: Look for any remaining instances of the old condition
echo "Test 3: Checking for old condition remnants"
rg --type typescript "projectDonationSwiperState\.selectedQF === null" src/components/views/project/projectDonations/QfRoundSelector.tsx

Length of output: 756


Script:

#!/bin/bash
# Description: Re-verify the changes in QfRoundSelector component with corrected rg commands

# Test 1: Check if the sorting logic is used correctly
echo "Test 1: Verifying sorting logic usage"
rg "projectData\?\.qfRounds\?\.sort\(" --type-add 'tsx:*.tsx' --type tsx src/components/views/project/projectDonations/QfRoundSelector.tsx

# Test 2: Check if isRecurringSelected is used consistently
echo "Test 2: Verifying isRecurringSelected usage"
rg "isRecurringSelected" --type-add 'tsx:*.tsx' --type tsx src/components/views/project/projectDonations/QfRoundSelector.tsx

# Test 3: Look for any remaining instances of the old condition
echo "Test 3: Checking for old condition remnants"
rg "projectDonationSwiperState\.selectedQF === null" --type-add 'tsx:*.tsx' --type tsx src/components/views/project/projectDonations/QfRoundSelector.tsx

Length of output: 1137

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1e3a5fd and d7c2c1f.

📒 Files selected for processing (1)
  • src/components/views/project/projectDonations/QfRoundSelector.tsx (1 hunks)

Copy link
Collaborator

@kkatusic kkatusic left a comment

Choose a reason for hiding this comment

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

Nice job @HrithikSampson now we have rounds by date sorted ;)

Copy link
Collaborator

@CarlosQ96 CarlosQ96 left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@HrithikSampson HrithikSampson merged commit 58ebadf into develop Oct 4, 2024
3 checks passed
@HrithikSampson HrithikSampson deleted the sort-rounds-in-project-page branch October 4, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: QA
Development

Successfully merging this pull request may close these issues.

3 participants