Skip to content

feat: support sort by name in issue #1459

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 1 commit into from
Apr 14, 2025
Merged

feat: support sort by name in issue #1459

merged 1 commit into from
Apr 14, 2025

Conversation

jihun
Copy link
Contributor

@jihun jihun commented Apr 11, 2025

  • Support sort by name in issue

Summary by CodeRabbit

  • New Features
    • Enhanced issue sorting: Users can now sort issues by name, providing more flexible organization options.

Copy link

coderabbitai bot commented Apr 11, 2025

Walkthrough

This pull request updates the sorting logic in the findIssuesByProjectIdV2 method of the issue service. The method now includes an additional else if clause to handle cases where the sorting field is name. When the condition is met, the query builder adds an order by clause for issues.name using the provided sort method. No changes were made to the exported or public entities.

Changes

File Path Change Summary
apps/api/src/.../issue.service.ts Added an extra else if clause in the findIssuesByProjectIdV2 method to handle sorting by name.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant IS as IssueService
    participant QB as QueryBuilder

    C->>IS: findIssuesByProjectIdV2(projectId, fieldName, sort)
    alt fieldName equals "name"
        IS->>QB: Add "ORDER BY issues.name" with sort method
    else Other field conditions
        IS->>QB: Process existing sorting logic
    end
    QB-->>IS: Return sorted results
    IS-->>C: Return ordered issues
Loading

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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

@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 (2)
apps/api/src/domains/admin/project/issue/issue.service.ts (2)

264-277: Consider adding support for sorting by other available fields.

While the PR successfully adds sorting by the name field, there are other fields like status, description, and externalIssueId that are available for filtering but not for sorting. For consistency and completeness, you might want to support sorting by these fields as well.

      } else if (fieldName === 'updatedAt') {
        queryBuilder.addOrderBy(`issues.updated_at`, sort[fieldName]);
      } else if (fieldName === 'name') {
        queryBuilder.addOrderBy(`issues.name`, sort[fieldName]);
+     } else if (fieldName === 'status') {
+       queryBuilder.addOrderBy(`issues.status`, sort[fieldName]);
+     } else if (fieldName === 'externalIssueId') {
+       queryBuilder.addOrderBy(`issues.external_issue_id`, sort[fieldName]);
+     } else if (fieldName === 'description') {
+       queryBuilder.addOrderBy(`issues.description`, sort[fieldName]);
      }

264-277: Consider adding a default case for unknown sort fields.

Currently, if an unsupported field is provided for sorting, it's silently ignored. For better error handling, consider adding a default case that either logs a warning or throws an exception for unsupported sort fields.

      } else if (fieldName === 'updatedAt') {
        queryBuilder.addOrderBy(`issues.updated_at`, sort[fieldName]);
      } else if (fieldName === 'name') {
        queryBuilder.addOrderBy(`issues.name`, sort[fieldName]);
+     } else {
+       this.logger.warn(`Unsupported sort field: ${fieldName}`);
      }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bbf0c6f and 52f4a10.

📒 Files selected for processing (1)
  • apps/api/src/domains/admin/project/issue/issue.service.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: integration-test
🔇 Additional comments (1)
apps/api/src/domains/admin/project/issue/issue.service.ts (1)

275-276: Good addition to support name sorting.

The implementation correctly extends the existing sort functionality to include sorting by issue name, following the established pattern for other fields.

@jihun jihun requested a review from chiol April 11, 2025 01:53
Copy link
Contributor

@chiol chiol left a comment

Choose a reason for hiding this comment

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

👍🏼

@jihun jihun merged commit d88fdf3 into dev Apr 14, 2025
7 checks passed
@jihun jihun deleted the feat/support-sort-by-name branch April 14, 2025 07:18
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.

2 participants