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

[WEB-2889] fix: global views sorting when hyper model is enabled. #6280

Merged
merged 1 commit into from
Dec 27, 2024

Conversation

prateekshourya29
Copy link
Member

@prateekshourya29 prateekshourya29 commented Dec 26, 2024

Description

In this PR, I have fixed the issue with sorting in global views when hyper mode is enabled.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

  • Before
Screen.Recording.2024-12-26.at.10.01.05.PM.mov
  • After
Screen.Recording.2024-12-26.at.9.59.15.PM.mov

Summary by CodeRabbit

  • New Features

    • Enhanced initial state for display filters in the Workspace View Form to align with the spreadsheet layout.
    • Improved issue ordering logic based on project context in the Base Issues Store.
  • Bug Fixes

    • Addressed issues with display filters and ordering when specific layout types are applied.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Walkthrough

The pull request introduces modifications to two files: web/core/components/workspace/views/form.tsx and web/core/store/issue/helpers/base-issues.store.ts. The changes focus on adjusting how display filters are computed and how issues are ordered based on the project layout type, specifically for the spreadsheet view. The modifications aim to refine the behavior of workspace view forms and issue ordering in the application.

Changes

File Change Summary
web/core/components/workspace/views/form.tsx Updated defaultValues to use getComputedDisplayFilters with EIssueLayoutTypes.SPREADSHEET for display filters
web/core/store/issue/helpers/base-issues.store.ts Modified orderBy computed property to set "sort_order" when projectId is defined and layout is not spreadsheet

Sequence Diagram

sequenceDiagram
    participant WorkspaceViewForm
    participant BaseIssuesStore
    participant Router

    WorkspaceViewForm->>BaseIssuesStore: Set display filters
    Router->>BaseIssuesStore: Provide project context
    BaseIssuesStore->>BaseIssuesStore: Compute orderBy based on layout
Loading

Possibly related PRs

Suggested labels

🐛bug, 🌐frontend

Suggested reviewers

  • rahulramesha
  • SatishGandham

Poem

🐰 Hop, hop, through code's green lane,
Spreadsheet views now dance with gain,
Filters computed, orders align,
A rabbit's touch makes logic shine!
Coding magic, pure and bright! 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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.

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

🧹 Nitpick comments (2)
web/core/components/workspace/views/form.tsx (2)

7-7: **Use a descriptive comment or section heading for constants imports **

It's good to keep imports grouped logically. Adding a small comment or heading (e.g., // Constants) above constants imports like EIssueLayoutTypes can improve clarity and maintainability.


35-37: **Consider making the layout type configurable **

Hardcoding the layout as EIssueLayoutTypes.SPREADSHEET is fine for now but may limit reusability. If future requirements mandate dynamic layouts, consider passing this value as a prop or context to keep the component flexible.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 756a71c and 8ce97f9.

📒 Files selected for processing (2)
  • web/core/components/workspace/views/form.tsx (2 hunks)
  • web/core/store/issue/helpers/base-issues.store.ts (1 hunks)
🔇 Additional comments (1)
web/core/store/issue/helpers/base-issues.store.ts (1)

Line range hint 300-304: **Ensure consistent sorting across different layouts **

The snippet forces orderBy to "sort_order" unless the layout is EIssueLayoutTypes.SPREADSHEET. This logic likely fixes the reported bug but might affect other layouts if combined with user-defined ordering. Recommend verifying that:

  1. Non-spreadsheet layouts still work with the intended custom ordering when localDBEnabled is false.
  2. No unintended overrides occur when toggling hyper mode on or off.

Run the following script to locate any references or test coverage for this condition:

✅ Verification successful

Let me gather more information about the sorting logic.


Let me gather more information about the special ordering logic.


Based on the analysis of the code, I can now provide a definitive response about the sorting behavior.

**Special ordering behavior is correctly implemented across layouts **

The code implements consistent sorting behavior with proper handling of sort_order across different layouts:

  1. For non-spreadsheet layouts when localDBEnabled is true, the code forces sort_order for special ordering fields (labels, assignees, etc.) defined in SPECIAL_ORDER_BY. This is intentional and correct behavior to maintain consistent manual ordering in local database mode.

  2. The spreadsheet layout is explicitly excluded from this override (layout !== EIssueLayoutTypes.SPREADSHEET) because:

    • Spreadsheet view needs to maintain its own column-based sorting capabilities
    • The SPECIAL_ORDER_BY mapping is specifically designed for list/kanban/calendar views where manual ordering makes sense
  3. The implementation properly handles:

    • Manual ordering through sort_order field
    • Special ordering fields through SPECIAL_ORDER_BY mapping
    • Layout-specific sorting requirements
    • Local database mode vs server mode sorting

The code's behavior aligns with the intended functionality and doesn't require any changes.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 1) Search for tests or usage references of 'orderBy' logic.
# 2) Provide context around localDBEnabled usage.

rg -A 5 'orderBy("' 
rg -A 5 'localDBEnabled'

Length of output: 7625


Script:

#!/bin/bash
# Search for SPECIAL_ORDER_BY and related sorting logic
rg -A 5 'SPECIAL_ORDER_BY'

# Search for orderBy related patterns in issue store
ast-grep --pattern 'orderBy = $$$'
ast-grep --pattern 'orderBy: $$$'

# Search for layout related code
rg -A 5 'EIssueLayoutTypes'

Length of output: 66517


Script:

#!/bin/bash
# Search for special ordering logic in query constructor
rg -A 10 'getOrderByFragment' web/core/local-db/utils/query-constructor.ts

# Search for sort_order related code
rg -A 5 'sort_order'

Length of output: 74426

@pushya22 pushya22 merged commit 4159d12 into preview Dec 27, 2024
12 of 14 checks passed
@pushya22 pushya22 deleted the fix/global-views-sorting branch December 27, 2024 07:33
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.

3 participants