add closestEndDate sort type

[RamRamez]

• fix order of polls returned in "explore all" view #103

Summary by CodeRabbit

• New Features

  • Added a new option to sort polls by the closest end date.

• Refactor

  • Improved and clarified sorting logic for polls, streamlining queries for combined active and ended poll results.

[coderabbitai]

"""

Walkthrough

A new sorting option, CLOSEST_END_DATE, was added to the PollSortBy enum. The getPolls method in PollService was refactored to handle this and other dual-filter dual-sort cases by introducing a private helper method that queries active and ended polls separately, combines, paginates, and maps vote status before returning results.

Changes

File(s)	Change Summary
src/poll/Poll.dto.ts	Added CLOSEST_END_DATE = 'closestEndDate' to the PollSortBy enum.
src/poll/poll.service.ts	Added private method executeQueryPollWithDualSorting; refactored getPolls to use this method for END_DATE, PARTICIPANT_COUNT, and CLOSEST_END_DATE sorting cases.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant PollService
    participant Database

    Client->>PollService: getPolls(sortBy: CLOSEST_END_DATE)
    PollService->>Database: Query active polls (order by endDate ASC)
    PollService->>Database: Query ended polls (order by endDate DESC)
    PollService->>PollService: Combine and paginate results
    PollService->>PollService: Map vote status
    PollService->>Client: Return sorted polls with total count

Loading

Possibly related PRs

• trending polls should show active polls first #117: Extended and refined the dual-query sorting logic in getPolls and the PollSortBy enum, directly related to this PR’s approach.
• Add get poll details #20: Introduced GetPollsDto and major changes to getPolls filtering, pagination, and sorting, foundational to this PR’s modifications.
• fix: explore all polls order #111: Refactored getPolls for dual-query sorting by end date, closely connected to the current dual-filter dual-sort refactoring.

Suggested reviewers

• Meriem-BM

Poem

🐇
A hop, a skip, a sort anew—
Closest end date, now in view!
Polls arranged from near to far,
Endings tracked just where they are.
With code so clear, we leap ahead,
Sorting rabbits, well and fed!

"""

---

📜 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 359cd25 and 137f93b.

📒 Files selected for processing (1)

• src/poll/poll.service.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/poll/poll.service.ts

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

src/poll/poll.service.ts (1)

442-492: CLOSEST_END_DATE implementation is functionally correct.

The new sorting logic properly handles:

• Active polls ordered by closest ending date (ascending)
• Ended polls ordered by most recently ended (descending)
• Consistent transaction pattern and pagination logic

However, note that this implementation ignores the sortOrder parameter, which might be unexpected behavior compared to other sort types.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c9b1035 and 359cd25.

📒 Files selected for processing (2)

• src/poll/Poll.dto.ts (1 hunks)
• src/poll/poll.service.ts (1 hunks)

🔇 Additional comments (1)

src/poll/Poll.dto.ts (1)

20-20: LGTM! Clean enum extension.

The new CLOSEST_END_DATE enum value follows consistent naming conventions and properly supports the enhanced sorting functionality.