Skip to content

fix: canvas actionbar move child can not work#1180

Merged
hexqi merged 1 commit intoopentiny:developfrom
chilingling:fix/selectedToolbarMoveChild
Mar 12, 2025
Merged

fix: canvas actionbar move child can not work#1180
hexqi merged 1 commit intoopentiny:developfrom
chilingling:fix/selectedToolbarMoveChild

Conversation

@chilingling
Copy link
Member

@chilingling chilingling commented Mar 4, 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: #1168

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Integrated an event notification to signal schema changes when rearranging elements on the canvas, ensuring the application remains in sync with updates.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2025

Walkthrough

The change updates the CanvasAction.vue component by adding an import for useMessage from the @opentiny/tiny-engine-meta-register package. A new call to useMessage().publish({ topic: 'schemaChange', data: {} }) is inserted in the moveChild function after swapping elements, notifying other parts of the application about the schema change. The core logic of the function remains unchanged.

Changes

File Summary of Changes
packages/canvas/container/src/components/CanvasAction.vue Added import of useMessage and inserted a publish call for schemaChange in the moveChild function.

Sequence Diagram(s)

sequenceDiagram
    participant CA as CanvasAction Component
    participant UM as useMessage
    participant MB as Message Bus

    CA->>CA: Swap child elements
    CA->>UM: Invoke useMessage()
    UM->>MB: Publish { topic: "schemaChange", data: {} }
Loading

Suggested reviewers

  • hexqi
  • gene9831

Poem

I hopped through lines of code with cheer,
Adding messages to notify far and near.
In each swap, a secret tale flows,
A schema change the system now knows.
With happy hops, my code dearly grows!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/canvas/container/src/components/CanvasAction.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "@typescript-eslint/eslint-plugin".

(The package "@typescript-eslint/eslint-plugin" was not found when loaded as a Node module from the directory "/packages/canvas".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install @typescript-eslint/eslint-plugin@latest --save-dev

The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in "packages/canvas/.eslintrc.cjs » @vue/eslint-config-typescript".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


📜 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 374251e and ac3bb54.

📒 Files selected for processing (1)
  • packages/canvas/container/src/components/CanvasAction.vue (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/canvas/container/src/components/CanvasAction.vue
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

🪧 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.
  • @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 Mar 4, 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/container/src/components/CanvasAction.vue (1)

200-218: Consider adding more context to the schema change notification.

While the fix correctly publishes a message when child elements are moved, the notification contains an empty data object. Including information about what changed would help subscribers respond more effectively.

Consider enhancing the change notification with relevant context:

  moveChild = (list, selected, addend) => {
    if (!list || list.length < 2) {
      return
    }

    const index = list.indexOf(selected)

    if (index > -1) {
      const toIndex = index + addend

      if (toIndex > -1 && toIndex < list.length) {
        // eslint-disable-next-line no-extra-semi
        ;[list[index], list[toIndex]] = [list[toIndex], list[index]]

-        useMessage().publish({ topic: 'schemaChange', data: {} })
+        useMessage().publish({ 
+          topic: 'schemaChange', 
+          data: { 
+            type: 'childMoved',
+            fromIndex: index,
+            toIndex,
+            schema: selected
+          } 
+        })
        updateRect()
      }
    }
  }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9152de2 and 374251e.

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

135-135: Added useMessage import to enable publishing schema changes.

This new import supports the notification mechanism added to the moveChild function.


214-214:

Details

❓ Verification inconclusive

Good fix: Adding schema change notification ensures toolbar updates work properly.

This addition publishes a message to notify other components about schema changes when moving child elements. This is crucial for ensuring that the UI stays synchronized with the underlying data model after element reordering.

Let's verify that all components that manipulate schema elements publish the schema change notification:


🏁 Script executed:

#!/bin/bash
# Description: Check for other methods that manipulate the schema but might be missing schema change notifications

# Look for similar functions that modify children arrays but might not publish schema changes
ast-grep --pattern 'moveChild' | grep -v 'schemaChange'

# Look for other functions that manipulate schema elements
rg -A 5 '\[.*\].*=.*\[.*\]' --type vue --type js | grep -v 'schemaChange'

Length of output: 155


Schema Change Notification Verification – Additional Manual Checks Recommended

The update in packages/canvas/container/src/components/CanvasAction.vue looks solid; adding the schema change notification ensures the UI is kept in sync when child elements are moved. However, the initial verification script produced an error due to the unrecognized “vue” file type. Please re-run checks targeting files with a “.vue” extension (e.g., using rg -g "*.vue" -g "*.js" ...) to confirm that all functions manipulating schema elements (like those using moveChild) include a schemaChange notification.

  • Verify that components (both Vue and JS files) using moveChild or similar schema manipulation methods also publish the schema change notification.
  • Ensure that no omission occurs in other parts of the codebase.

@chilingling chilingling force-pushed the fix/selectedToolbarMoveChild branch from 374251e to ac3bb54 Compare March 7, 2025 07:50
@hexqi hexqi changed the title fix: selected toolbar move child can not work fix: canvas actionbar move child can not work Mar 12, 2025
@hexqi hexqi merged commit e42a185 into opentiny:develop Mar 12, 2025
3 checks passed
1degrees pushed a commit to 1degrees/tiny-engine that referenced this pull request Mar 13, 2025
1degrees pushed a commit to 1degrees/tiny-engine that referenced this pull request Mar 13, 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants