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 router page placeholder and useblock error, switch block render error #990

Conversation

rhlin
Copy link
Collaborator

@rhlin rhlin commented Jan 2, 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

  1. 修正useBlock 的地址栏堆栈同步函数错误
  2. 优化路由占位符画布显示名称
  3. 修正从编辑页面切换到区块的时候使用的pageContext上下文不对问题
  4. 解决css重复渲染两次

What is the current behavior?

能正常切换到区块

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced page context management with more flexible state handling
    • Improved routing view placeholder text for better clarity
  • Bug Fixes

    • Adjusted style initialization logic for page components
    • Updated schema setting mechanism to support optional page ID
  • Refactor

    • Simplified ancestors data access in renderer component
    • Modified history event publishing mechanism
    • Refined page context and active state determination
  • Chores

    • Updated internal function signatures and method implementations

Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (3)
  • refactor/develop
  • ospp-*
  • release/*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request introduces modifications across several files in the canvas rendering and routing system. The changes primarily focus on refining context and state management, particularly in how pages are rendered and how their schemas are handled. Key modifications include updates to page context logic, routing view placeholders, schema setting mechanisms, and the introduction of an ancestors variable in the renderer component. The changes aim to provide more flexible handling of page states and improve the overall rendering process.

Changes

File Change Summary
packages/canvas/render/src/RenderMain.ts - Updated pageContext setting logic
- Modified pageContext.active determination
- Restructured setCurrentSchema and setCurrentMethod assignments
packages/canvas/render/src/builtin/CanvasRouterView.vue - Updated placeholder text for routing context
packages/canvas/render/src/material-function/page-getter.ts - Removed initStyle(key, data?.css) call in updateSchema
packages/canvas/render/src/page-block-function/schema.ts - Added optional pageId parameter to setSchema function
packages/canvas/render/src/render.ts - Added ancestors injected dependency
- Updated ancestors handling in render function
packages/plugins/block/src/composable/useBlock.js - Renamed postHistoryChanged to postLocationHistoryChanged

Sequence Diagram

sequenceDiagram
    participant Renderer
    participant PageContext
    participant SchemaManager
    participant RouterView

    Renderer->>PageContext: Set context based on props
    PageContext-->>Renderer: Return active page context
    Renderer->>SchemaManager: Update schema and methods
    SchemaManager-->>Renderer: Confirm schema update
    Renderer->>RouterView: Render with updated context
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • hexqi

Poem

🐰 Rendering rabbit hops with glee,
Through contexts and schemas, wild and free!
Routes shift and change, a playful dance,
Code evolves with each subtle glance.
Ancestors whisper, components sing,
A canvas of magic that rendering brings! 🎨


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.

@gene9831
Copy link
Collaborator

gene9831 commented Jan 3, 2025

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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/render/src/render.ts (1)

251-251: Consider verifying the new key usage for sub-routes/pages.
Using the entire ancestors array as the key value could be too broad. If ancestors changes frequently, it might cause unnecessary unmounts/remounts for child components.

Also applies to: 255-255

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9e94f30 and 9a94ca6.

📒 Files selected for processing (6)
  • packages/canvas/render/src/RenderMain.ts (4 hunks)
  • packages/canvas/render/src/builtin/CanvasRouterView.vue (1 hunks)
  • packages/canvas/render/src/material-function/page-getter.ts (0 hunks)
  • packages/canvas/render/src/page-block-function/schema.ts (2 hunks)
  • packages/canvas/render/src/render.ts (2 hunks)
  • packages/plugins/block/src/composable/useBlock.js (2 hunks)
💤 Files with no reviewable changes (1)
  • packages/canvas/render/src/material-function/page-getter.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/canvas/render/src/builtin/CanvasRouterView.vue
🔇 Additional comments (9)
packages/canvas/render/src/page-block-function/schema.ts (2)

33-33: Ensure correct handling of the optional pageId.
This new parameter could introduce subtle issues if it’s not consistently passed or validated.


76-76: Confirm that pageId is correctly utilized when setting page-level CSS.
Since pageId is optional, confirm no null or undefined usage in setPagecss.

packages/canvas/render/src/RenderMain.ts (5)

141-142: Verify the condition for using activePageContext.
Replacing !pageIdFromPath with props.entry may alter how page contexts are determined. Ensure this change aligns with all scenarios, especially nested or child pages.


146-148: Check the updated page activation logic.
The new assignments to pageContext.pageId and pageContext.active rely on either props.pageId or the absence of pageIdFromPath. Confirm that these conditions correctly reflect the intended active page.

Also applies to: 158-158


169-177: Verify the dynamic useSchema calls for nested contexts.
Here we differentiate between “active” and “inactive” schema references. Confirm that re-initializing schema, state, and methods does not conflict with existing contexts.

Also applies to: 185-185


202-202: Validate method updates in watch handler.
The watch on schema.methods calls setCurrentMethod with a forced re-initialization. Make sure no unexpected side effects occur with nested or shared methods.


209-224: Review the watcher for props.active and props.renderSchema.
When active becomes false, the call to setCurrentSchema(renderSchema, props.pageId) might override the current schema unexpectedly. Check if this is intentional or if additional guard conditions are needed.

Also applies to: 225-225, 227-229

packages/canvas/render/src/render.ts (1)

232-235: Nice addition of ancestors.
Injecting and exposing ancestors provides valuable context for hierarchical rendering. Ensure that ancestors updates do not trigger excessive re-renders.

Also applies to: 239-239

packages/plugins/block/src/composable/useBlock.js (1)

34-34: Confirm references to the updated publish topic.
Renaming the publish topic from historyChanged to locationHistoryChanged may require updates in other files to avoid broken subscriptions.

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