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: optimize block code saving and publishing logic #996

Open
wants to merge 5 commits into
base: refactor/develop
Choose a base branch
from

Conversation

SonyLeo
Copy link
Contributor

@SonyLeo SonyLeo commented Jan 7, 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?

区块修改后可以直接发布,也会显示发布成功,但是实际没有保存,必须先保存后发布,逻辑混乱

Issue Number: N/A

What is the new behavior?

区块修改并发布时,在勾选 发布成功后保存最新数据 并确认后,Toobar 区域 代码保存按钮 状态同步改变,

正常实现区块代码保存和发布

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Enhanced block deployment dialog with a new computed property for block comparison and improved state saving functionality.
    • Improved block dependency generation with added input validation to ensure proper handling of child components.
  • Bug Fixes

    • Added safety check to prevent potential errors during block dependency processing.

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

Walkthrough

The pull request introduces modifications to two files: BlockDeployDialog.vue and blockSetting.jsx. In BlockDeployDialog.vue, a new useCanvas function is imported and integrated into the deployment process, allowing for saving the state after block deployment when the user opts to do so. Additionally, a computed property isSameBlock is added to enhance the logic for saving the latest data upon successful deployment. In blockSetting.jsx, a defensive programming approach is added to the generateBlockDeps function by checking if the children parameter is an array before processing, improving the function's robustness against potential errors.

Changes

File Change Summary
packages/common/component/BlockDeployDialog.vue - Added useCanvas import
- Introduced setSaved constant in setup
- Added isSameBlock computed property
- Updated deployBlock to conditionally save state
packages/plugins/block/src/js/blockSetting.jsx - Added array type check for children in generateBlockDeps
- Improved error handling in dependency generation

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • hexqi
  • chilingling

Poem

🐰 A rabbit's tale of code so neat,
Deploying blocks with logic sweet.
Checking arrays with careful might,
Saving state, making logic bright.
Code refactored, bugs take flight! 🚀


📜 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 b7e350f and a870123.

📒 Files selected for processing (1)
  • packages/common/component/BlockDeployDialog.vue (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/common/component/BlockDeployDialog.vue
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

Finishing Touches

  • 📝 Generate Docstrings

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 7, 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/plugins/block/src/js/blockSetting.jsx (1)

649-654: Add error logging for missing components.

While the defensive programming is good, silently returning when a component is missing could make debugging difficult. Consider logging a warning message.

  if (Array.isArray(children)) {
    children.forEach((child) => {
      const component = useMaterial().getMaterial(child.componentName)

-     if (!component) return
+     if (!component) {
+       console.warn(`Component not found: ${child.componentName}`)
+       return
+     }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a14a508 and acca71f.

📒 Files selected for processing (2)
  • packages/common/component/BlockDeployDialog.vue (3 hunks)
  • packages/plugins/block/src/js/blockSetting.jsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (4)
packages/common/component/BlockDeployDialog.vue (2)

84-84: LGTM: Import added for useCanvas.

The import is correctly added to support the new save state synchronization feature.


175-176: LGTM: Save state synchronization implemented correctly.

The implementation properly synchronizes the save state after successful block publication when the user opts to save the latest data. This fixes the issue where changes weren't being saved despite showing a successful publication status.

Also applies to: 191-193

packages/plugins/block/src/js/blockSetting.jsx (2)

655-677: LGTM: Robust dependency collection logic.

The implementation correctly handles:

  • NPM package information extraction
  • Component name mapping
  • Version tracking
  • CSS dependencies collection

680-685: LGTM: Proper recursive traversal.

The recursive call to process child components is correctly implemented with proper boundary checks.

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/common/component/BlockDeployDialog.vue (1)

196-198: Consider adding error handling for setSaved.

While the logic correctly combines the save preference with block matching, consider wrapping the setSaved call in a try-catch block to handle potential errors gracefully.

-          if (formState.needToSave && isSameBlock.value) {
-            setSaved(true)
-          }
+          if (formState.needToSave && isSameBlock.value) {
+            try {
+              setSaved(true)
+            } catch (error) {
+              useNotify({
+                type: 'error',
+                message: '更新保存状态失败'
+              })
+            }
+          }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2b2a8af and b7e350f.

📒 Files selected for processing (1)
  • packages/common/component/BlockDeployDialog.vue (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (4)
packages/common/component/BlockDeployDialog.vue (4)

74-74: LGTM! Import statements are well-organized.

The new imports for Vue's computed API and Tiny Engine's hooks (useBlock, useCanvas) are correctly added and align with the component's enhanced functionality.

Also applies to: 84-84


175-176: LGTM! Canvas hook is properly integrated.

The setSaved function is correctly destructured from the useCanvas hook, enabling proper synchronization of the save button state.


177-180: LGTM! Block comparison logic is robust.

The isSameBlock computed property correctly implements the suggested check to ensure save state is only updated for the currently edited block. The use of optional chaining (?.) provides good null safety.


196-198: Tests needed for the new save state logic.

The PR mentions that tests haven't been added. Consider adding unit tests to verify:

  1. Save state is updated only when both conditions are met
  2. Save state remains unchanged for non-matching blocks
  3. Error handling behavior (after implementing the suggested try-catch)

Would you like me to help generate test cases for these scenarios?

chilingling
chilingling previously approved these changes Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants