Skip to content

[WEB-1995] fix: searched page redirection from command palette.#5170

Merged
SatishGandham merged 2 commits intopreviewfrom
fix/pages-search
Jul 19, 2024
Merged

[WEB-1995] fix: searched page redirection from command palette.#5170
SatishGandham merged 2 commits intopreviewfrom
fix/pages-search

Conversation

@prateekshourya29
Copy link
Member

@prateekshourya29 prateekshourya29 commented Jul 19, 2024

Problem

When attempting to visit a page from the command palette search results, an error displays: "Project doesn't exist."

Solution

This issue arose because the API response for page search results recently changed to return an array of project IDs instead of a single ID. However, the redirection logic has not been updated to handle this new format.

Media

  • Before

    Screen.Recording.2024-07-19.at.12.16.56.PM.mov
  • After

    Screen.Recording.2024-07-19.at.12.16.11.PM.mov

Issue link: WEB-1995

Summary by CodeRabbit

  • New Features

    • Enhanced the command palette to support multiple project IDs associated with workspace pages, improving flexibility in handling project data.
    • Improved routing capabilities in the Command Palette Search Results component, enabling context-sensitive navigation based on selected project IDs.
  • Bug Fixes

    • Corrected the structure of the path function to accommodate updates in workspace page data handling.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 19, 2024

Walkthrough

The recent updates enhance the commandGroups functionality by refining the path method's parameter type, allowing for better integration with the updated data model. This change supports handling multiple project IDs, enabling more dynamic routing in the CommandPaletteSearchResults component. Overall, these modifications improve user navigation and the interaction between workspace and project data.

Changes

Files Change Summary
web/core/components/command-palette/helpers.tsx
web/core/components/command-palette/actions/search-results.tsx
Updated path method to accept IWorkspacePageSearchResult and multiple project IDs. Enhanced CommandPaletteSearchResults to utilize projectId in routing, improving navigation context.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CommandPalette
    participant PageHandler

    User->>CommandPalette: Invoke command with page data
    CommandPalette->>PageHandler: Call path(page: IWorkspacePageSearchResult, projectId)
    PageHandler->>PageHandler: Retrieve project_ids
    PageHandler->>CommandPalette: Return updated path
    CommandPalette->>User: Display updated command results
Loading

Poem

🐇 In the land of code where rabbits play,
We’ve spruced up paths in a clever way!
With project IDs now a splendid array,
Hopping through data, we’ll never delay.
Oh, joy in the updates, let’s cheer and sway! 🎉


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 075b8ef and 5a070bd.

Files selected for processing (1)
  • web/core/components/command-palette/helpers.tsx (1 hunks)
Additional comments not posted (1)
web/core/components/command-palette/helpers.tsx (1)

76-77: Ensure project_ids array is populated.

The change to handle an array of project IDs is correct. However, it is important to ensure that the project_ids array is always populated to avoid potential errors.

Consider adding a check to handle cases where the project_ids array might be empty or undefined.

-  `/${page?.workspace__slug}/projects/${page?.project_ids?.[0]}/pages/${page?.id}`
+  `/${page?.workspace__slug}/projects/${page?.project_ids?.length ? page.project_ids[0] : 'default_project_id'}/pages/${page?.id}`

path: (page: IWorkspaceDefaultSearchResult) =>
`/${page?.workspace__slug}/projects/${page?.project_id}/pages/${page?.id}`,
path: (page: IWorkspacePageSearchResult) =>
`/${page?.workspace__slug}/projects/${page?.project_ids?.[0]}/pages/${page?.id}`,
Copy link
Contributor

Choose a reason for hiding this comment

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

If the use is already in a project, lets open that project level link.

@SatishGandham SatishGandham added this to the v0.23-dev milestone Jul 19, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5a070bd and dd078bd.

Files selected for processing (2)
  • web/core/components/command-palette/actions/search-results.tsx (3 hunks)
  • web/core/components/command-palette/helpers.tsx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • web/core/components/command-palette/helpers.tsx
Additional comments not posted (4)
web/core/components/command-palette/actions/search-results.tsx (4)

4-4: LGTM! Importing useParams is appropriate.

The addition of useParams from next/navigation is necessary for accessing URL parameters.


19-21: LGTM! Using useAppRouter and useParams is appropriate.

These hooks are necessary for obtaining the router instance and URL parameters, respectively.


23-23: LGTM! Converting routerProjectId to a string is appropriate.

This ensures that projectId is in the correct format for use in the redirection logic.


39-39: LGTM! Updating router.push to include projectId is appropriate.

This change ensures that the redirection logic correctly handles multiple project IDs.

@SatishGandham SatishGandham merged commit 44a0ff5 into preview Jul 19, 2024
@SatishGandham SatishGandham deleted the fix/pages-search branch July 19, 2024 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🐛bug Something isn't working 🌐frontend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants