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

fix: fix the error of routing bar caused by invalid pageid #1045

Merged

Conversation

gene9831
Copy link
Collaborator

@gene9831 gene9831 commented Jan 15, 2025

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

What is the current behavior?

pageid无效时,控制台会报错
image

Issue Number: N/A

What is the new behavior?

pageid无效时,控制台不会报错

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes
    • Improved route data handling to ensure only valid routes are displayed
    • Enhanced route filtering mechanism to remove undefined or invalid route items

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request modifies the route bar component in the canvas package, specifically updating the watch function that handles pageId. The changes introduce a new filtering mechanism to ensure only valid route data is included in the routes array. The implementation now removes undefined or falsy items during the route mapping process, improving the data integrity of the route generation logic.

Changes

File Change Summary
packages/canvas/route-bar/src/CanvasRouteBar.vue Modified watch function logic for pageId to filter out undefined/falsy route items before constructing routes array

Possibly related PRs

Suggested labels

bug, ready_for_review

Suggested reviewers

  • hexqi
  • rhlin

Poem

🐰 Routing through the canvas maze,
Filtering paths with careful gaze,
No more undefined routes astray,
Clean data leads the rabbit's way!
Hop along the filtered trail 🚀


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.

@github-actions github-actions bot added bug Something isn't working refactor-main refactor/develop branch feature labels Jan 15, 2025
@gene9831 gene9831 changed the base branch from refactor/develop to release/v2.2.0 January 15, 2025 09:55
@github-actions github-actions bot removed the refactor-main refactor/develop branch feature label Jan 15, 2025
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 (1)
packages/canvas/route-bar/src/CanvasRouteBar.vue (1)

70-72: Consider enhancing error handling clarity.

While the current implementation works, consider making the validation more explicit and adding comments to explain the filtering criteria:

 .map((id) => pageSettingState.treeDataMapping[id])
-      .filter((item) => Boolean(item))
+      .filter((item) => {
+        // Filter out undefined/null items that could occur from invalid pageids
+        if (!item) {
+          console.debug(`Skipping invalid page data for tree mapping`)
+          return false
+        }
+        return true
+      })
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a7477a8 and 67a4340.

📒 Files selected for processing (1)
  • packages/canvas/route-bar/src/CanvasRouteBar.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (1)
packages/canvas/route-bar/src/CanvasRouteBar.vue (1)

68-81: LGTM! This effectively handles invalid pageids.

The addition of the filter step successfully prevents errors from undefined or invalid page data, addressing the core issue mentioned in the PR objectives. The route string sanitization is also a good defensive programming practice.

@hexqi hexqi merged commit bacd299 into opentiny:release/v2.2.0 Jan 16, 2025
4 checks passed
hexqi pushed a commit to hexqi/tiny-engine that referenced this pull request Jan 25, 2025
@gene9831 gene9831 deleted the fix/router-bar-invalid-pageid branch February 8, 2025 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants