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: resolve some schema update issue #956

Merged
merged 3 commits into from
Dec 25, 2024

Conversation

chilingling
Copy link
Member

@chilingling chilingling commented Dec 24, 2024

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. 调整画布宽度时,画布选中框不及时更新的 bug
  2. 空页面的时候,拖拽组件到画布提示两次新建页面的 bug
  3. importSchema 的时候,清空选择
  4. 页面 schema 保存的时候,设置保存状态为 false
  5. 增强 AdvanceConfig 配置对 props 的容错

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

  • New Features

    • Enhanced modal confirmation logic based on canvas history state.
    • Improved canvas responsiveness to size changes with new watcher functionality.
    • Updated schema saving process for better visual feedback on unsaved changes.
  • Bug Fixes

    • Improved error handling in the setLoopKey method with optional chaining.

1. 调整画布宽度时,画布选中框不及时更新的 bug
2. 空页面的时候,拖拽组件到画布提示两次新建页面的 bug
3. importSchema 的时候,清空选择
4. 页面 schema 保存的时候,设置保存状态为 false
5. 增强 AdvanceConfig 配置对 props 的容错
Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

Walkthrough

This pull request introduces several modifications across different components in the canvas and settings modules. The changes primarily focus on enhancing state management, improving error handling, and refining user interaction logic. Key modifications include updating conditional logic in the design canvas, clearing canvas selections during schema import, adding responsiveness to canvas resizing, and improving schema saving mechanisms. The changes aim to make the application more robust and responsive to user actions.

Changes

File Change Summary
packages/canvas/DesignCanvas/src/DesignCanvas.vue Modified watch function condition to skip modal confirmation when history index is zero.
packages/canvas/DesignCanvas/src/api/useCanvas.js Added canvasApi.value?.clearSelect?.() after importing schema to clear canvas selections.
packages/canvas/container/src/components/CanvasResize.vue Added new watcher for sizeStyle to update canvas rectangle dimensions, imported useCanvas.
packages/plugins/schema/src/Main.vue Updated saveSchema method to use setSaved(false), enhanced editor change detection.
packages/settings/events/src/components/AdvanceConfig.vue Added optional chaining to schema.props?.key for improved error handling.

Possibly related PRs

Suggested labels

ready_for_review, refactor-main

Suggested reviewers

  • hexqi

Poem

🐰 In the canvas of code, changes bloom bright,
Selections cleared with optional might,
History watched, modal's dance refined,
A rabbit's touch, logic redesigned!
Hop, hop, hooray for cleaner design! 🎨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a4777d4 and 1c1a65a.

📒 Files selected for processing (1)
  • packages/canvas/DesignCanvas/src/DesignCanvas.vue (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/canvas/DesignCanvas/src/DesignCanvas.vue

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 the bug Something isn't working label Dec 24, 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

🧹 Nitpick comments (1)
packages/settings/events/src/components/AdvanceConfig.vue (1)

138-138: Consider providing a fallback for schema.props to avoid potential undefined behavior.

Optional chaining prevents runtime errors if schema.props is nullish, but you might still end up with an undefined value for newPropsKey. If subsequent code relies on newPropsKey to be a valid object or string, it may cause issues. A simple fallback could be used if that aligns with the intended behavior:

- let newPropsKey = schema.props?.key
+ let newPropsKey = schema.props?.key ?? ''
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 526cfd4 and cfe0555.

📒 Files selected for processing (5)
  • packages/canvas/DesignCanvas/src/DesignCanvas.vue (1 hunks)
  • packages/canvas/DesignCanvas/src/api/useCanvas.js (1 hunks)
  • packages/canvas/container/src/components/CanvasResize.vue (2 hunks)
  • packages/plugins/schema/src/Main.vue (1 hunks)
  • packages/settings/events/src/components/AdvanceConfig.vue (1 hunks)
🔇 Additional comments (5)
packages/canvas/container/src/components/CanvasResize.vue (2)

14-14: Consider code consistency by grouping imports or splitting them.
While there is no pressing issue here, in larger codebases it might be beneficial to keep related hooks or functionalities grouped for readability. The current approach is acceptable, but consider adopting a consistent style across the project.


109-116: Ensure error handling for updateRect calls.
The asynchronous watcher triggers updateRect after nextTick(). If canvasApi.value is not properly initialized or changed, this call may fail silently. Consider adding checks or error handling to track potential issues.

packages/canvas/DesignCanvas/src/DesignCanvas.vue (1)

102-102: Validate condition for historyState?.index === 0.
By adding useHistory().historyState?.index === 0 to the condition, you're bypassing the confirmation modal if the user is on the initial state. Double-check that this logic works as intended, because it could skip important warnings when the user first modifies the canvas.

packages/plugins/schema/src/Main.vue (1)

105-109: Check downstream effects of calling setSaved(false) immediately after schema import.
After calling importSchema(value), marking the schema as unsaved may cause additional UI prompts. Ensure that this aligns with the intended workflow, especially when quickly making multiple imports or partial changes.

packages/canvas/DesignCanvas/src/api/useCanvas.js (1)

521-522: Clear canvas selection for a consistent user experience.
Calling clearSelect after importing a schema is a neat improvement that prevents accidental manipulations of pre-existing selections. Ensure that other events tied to selection states (e.g., metrics or analytics) also reset properly, if applicable.

@hexqi hexqi merged commit bc0eb01 into opentiny:release/v2.1.0 Dec 25, 2024
2 checks passed
chilingling added a commit that referenced this pull request Jan 3, 2025
* fix: resolve some schema update issue

1. 调整画布宽度时,画布选中框不及时更新的 bug
2. 空页面的时候,拖拽组件到画布提示两次新建页面的 bug
3. importSchema 的时候,清空选择
4. 页面 schema 保存的时候,设置保存状态为 false
5. 增强 AdvanceConfig 配置对 props 的容错

* fix: updateRect async change to callback style

* fix: first time enter app should show empty page warning
@coderabbitai coderabbitai bot mentioned this pull request Jan 25, 2025
14 tasks
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