chore: Moving the util for grouping & sorting entity list to a common folder

[ankitakinger]

Description

Moving the util for grouping & sorting entity list to a common folder so that it can be re-used in other IDEs.

Fixes #38906

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13527015959
Commit: cab5b52
Cypress dashboard.
Tags: @tag.All
Spec:

---

Tue, 25 Feb 2025 18:29:03 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• Refactor
  • Introduced a utility function for grouping and sorting entity items, improving organization and maintainability.
  • Updated selectors to utilize the new grouping and sorting utility, enhancing code structure.
• Style
  • Adjusted spacing between list items in both the JavaScript and Query explorers for a more balanced layout.

[coderabbitai]

Walkthrough

The pull request introduces a new utility module that provides a function for grouping and sorting entity items. Existing selectors have been refactored to import and use this centralized function instead of implementing it locally. Additionally, the PR updates the component spacing in both JS and Query explorers and adjusts the import/export of the ListQuery component. Overall, the changes reorganize the code into more modular and maintainable units without altering the external behavior.

Changes

File(s)	Change Summary
app/client/src/IDE/utils/groupAndSortEntitySegmentList.ts	Added a new utility function groupAndSortEntitySegmentList and exported type EditorSegmentList for grouping and sorting entity items.
app/client/src/ce/selectors/appIDESelectors.ts	Removed local grouping and sorting logic, now importing groupAndSortEntitySegmentList from the new utility module.
app/client/src/pages/AppIDE/components/JSExplorer/JSSegmentList.tsx, app/client/src/pages/AppIDE/components/QueryExplorer/QuerySegmentList.tsx	Changed the Flex component’s gap property from "spaces-4" to "spaces-3" to adjust spacing.
app/client/src/pages/AppIDE/components/QueryExplorer/Explorer.tsx, app/client/src/pages/AppIDE/components/QueryExplorer/index.tsx	Updated the import/export of ListQuery from ./List to ./QuerySegmentList to reflect the module reorganization.
app/client/src/ce/selectors/appIDESelectors.test.ts	Updated import path for groupAndSortEntitySegmentList to an absolute path from the utility module.

Sequence Diagram(s)

sequenceDiagram
    participant Selector as Selector/Component
    participant Util as groupAndSortEntitySegmentList
    participant Lodash as Lodash Utilities

    Selector->>Util: Call groupAndSortEntitySegmentList(items)
    Util->>Lodash: groupBy(items, group property)
    Lodash-->>Util: Return grouped items
    Util->>Lodash: sortBy(items, title)
    Lodash-->>Util: Return sorted items
    Util-->>Selector: Return grouped & sorted list

Loading

Possibly related PRs

• chore: Improve code #38622: The changes in the main PR are related to the modifications of the groupAndSortEntitySegmentList function and the EditorSegmentList type, which are directly referenced in the retrieved PR's updates to the import statements in the selectors.
• perf: entity group items filter utility refactor #38108: The changes in the main PR are related to the modifications in the retrieved PR as both involve the introduction and utilization of utility functions for handling entity items, specifically focusing on grouping and filtering functionalities.
• chore: Move entities/IDE/constants #39064: The changes in the main PR are related to the modifications in the retrieved PR as both involve the groupAndSortEntitySegmentList function and the EditorSegmentList type, with the main PR introducing them and the retrieved PR removing them while updating their usage.

Suggested labels

Enhancement

Suggested reviewers

• hetunandu

Poem

Code now dances in a tidy space,
Grouping and sorting with a graceful pace.
Modules refactored, spacing aligned—
A structured flow that’s well-defined.
Cheers to progress; our code shines bright! ✨

Keep coding and let brilliance ignite!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eafe509 and cab5b52.

📒 Files selected for processing (1)

• app/client/src/ce/selectors/appIDESelectors.test.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• app/client/src/ce/selectors/appIDESelectors.test.ts

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: perform-test / rts-build / build
• GitHub Check: perform-test / server-build / server-unit-tests
• GitHub Check: client-unit-tests / client-unit-tests
• GitHub Check: client-lint / client-lint
• GitHub Check: client-prettier / prettier-check
• GitHub Check: client-build / client-build
• GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies

---

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

• 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.
  • 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.

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.