Skip to content

chore: sort disputes by id instead of latest status change #1842

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

Merged
merged 2 commits into from
Jan 22, 2025

Conversation

kemuru
Copy link
Contributor

@kemuru kemuru commented Jan 21, 2025

PR-Codex overview

This PR focuses on modifying GraphQL queries related to disputes by changing the orderBy parameter from lastPeriodChange to disputeID in several queries.

Detailed summary

  • Added disputeID field to the DisputeDetails fragment.
  • Updated casesQueryWhere to order disputes by disputeID.
  • Updated casesQuery to order disputes by disputeID.
  • Updated myCasesQuery to order disputes by disputeID.
  • Updated myCasesQueryWhere to order disputes by disputeID.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features
    • Added disputeID field to dispute details
  • Refactor
    • Updated sorting of disputes to use disputeID instead of lastPeriodChange

Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request introduces a modification to the GraphQL schema and query sorting mechanism in the cases-related queries. A new field disputeID has been added to the DisputeDetails fragment, and the orderBy parameter for several case-related queries has been updated to use disputeID instead of lastPeriodChange. This change impacts the sorting logic for dispute-related data retrieval, shifting the primary ordering criteria from the last period change to the dispute ID.

Changes

File Change Summary
web/src/hooks/queries/useCasesQuery.ts Added disputeID field to DisputeDetails fragment; Modified orderBy parameter in multiple queries from lastPeriodChange to disputeID

Poem

🐰 Disputes in line, now sorted neat
By ID they dance, a rabbit's treat
No more last period's fleeting sway
Dispute ID leads the sorting play
A change so crisp, so clean, so bright! 🔢


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d298b9 and 15488d9.

📒 Files selected for processing (1)
  • web/src/hooks/queries/useCasesQuery.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: Redirect rules - kleros-v2-university
  • GitHub Check: Header rules - kleros-v2-university
  • GitHub Check: Pages changed - kleros-v2-university
  • GitHub Check: Redirect rules - kleros-v2-testnet-devtools
  • GitHub Check: Header rules - kleros-v2-testnet-devtools
  • GitHub Check: Pages changed - kleros-v2-testnet-devtools
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: contracts-testing
  • GitHub Check: SonarCloud
  • GitHub Check: Analyze (javascript)
  • GitHub Check: dependency-review
🔇 Additional comments (4)
web/src/hooks/queries/useCasesQuery.ts (4)

20-20: LGTM! Good addition of the disputeID field.

The addition of disputeID to the fragment is necessary for the new sorting mechanism while maintaining backward compatibility by keeping the lastPeriodChange field.


Line range hint 71-106: LGTM! Clean abstraction in hooks.

The hooks maintain a clean abstraction over the query details, requiring no changes despite the modification in sorting criteria. The default descending order and proper handling of undefined cases are preserved.


38-38: LGTM! Consistent update of sorting criteria across all queries.

The change from lastPeriodChange to disputeID has been consistently applied across all relevant queries.

Let's verify that we haven't missed any queries that need this update:

Also applies to: 46-46, 55-55, 65-65

✅ Verification successful

Different context: User profile queries can keep using lastPeriodChange

The remaining instances of lastPeriodChange are found in user profile-specific queries that serve a different purpose than the cases listing views. These queries are intentionally sorted by last period change to show users their disputes in order of recent activity, which is appropriate for this context.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining queries that might still use lastPeriodChange for sorting
rg -l 'orderBy: lastPeriodChange' --type ts

Length of output: 78


Script:

#!/bin/bash
# Check the context of lastPeriodChange usage in useUser.ts
rg 'orderBy: lastPeriodChange' -B 5 -A 5 web/src/hooks/queries/useUser.ts

Length of output: 504


Line range hint 8-14: Verify GraphQL type generation.

Let's ensure the disputeID field is properly typed in the generated GraphQL types.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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 or @coderabbitai title 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

netlify bot commented Jan 21, 2025

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit 1f7c36f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/6790bec2fd089600086c6afa
😎 Deploy Preview https://deploy-preview-1842--kleros-v2-testnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for kleros-v2-testnet-devtools failed. Why did it fail? →

Name Link
🔨 Latest commit 1f7c36f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/6790bec2e130700009ed3c4b

Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for kleros-v2-university ready!

Name Link
🔨 Latest commit 1f7c36f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/6790bec2cadd49000846890f
😎 Deploy Preview https://deploy-preview-1842--kleros-v2-university.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for kleros-v2-neo ready!

Name Link
🔨 Latest commit 1f7c36f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/6790bec22737120008cad13f
😎 Deploy Preview https://deploy-preview-1842--kleros-v2-neo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@alcercu alcercu left a comment

Choose a reason for hiding this comment

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

lgtm

@alcercu alcercu enabled auto-merge January 22, 2025 09:48
Copy link

codeclimate bot commented Jan 22, 2025

Code Climate has analyzed commit 1f7c36f and detected 6 issues on this pull request.

Here's the issue category breakdown:

Category Count
Duplication 6

View more on Code Climate.

Copy link

@alcercu alcercu added this pull request to the merge queue Jan 22, 2025
Merged via the queue into dev with commit 5f23277 Jan 22, 2025
22 of 27 checks passed
@jaybuidl jaybuidl deleted the chore/sort-disputes-by-id branch May 19, 2025 12:15
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