Skip to content

Conversation

@HalilFocic
Copy link

@HalilFocic HalilFocic commented Nov 23, 2024

Body of processEvent funciton inside VertexHandle was missing setPosition call that will properly update the values inside CellStyle This ensures the shape's internal lines are redrawn correctly during hnadle movements.

Before this change, dragging the custom handles did not update the shape's divider positions due to the missing setPosition call.

PR Checklist

  • Addresses an existing open issue: Fixes [BUG] Not possible to resize the inner rectangle in the Handles story #481 .
  • You have discussed this issue with the maintainers of maxGraph, and you are assigned to the issue.
  • The scope of the PR is sufficiently narrow to be examined in a single session. A PR covering several issues must be split into separate PRs. Do not create a large PR, otherwise it cannot be reviewed and you will be asked to split it later or the PR will be closed.
  • I have added tests to prove my fix is effective or my feature works. This can be done in the form of automatic tests in packages/core/_tests_ or a new or altered Storybook story in packages/html/stories (an existing story may also demonstrate the change).
  • I have provided screenshot/videos to demonstrate the change. If no releavant, explain why.
  • I have added or edited necessary documentation, or no docs changes are needed.
  • The PR title follows the "Conventional Commits" guidelines.

Overview

Main issue was missing setPosition function call that was missing from processChange event. This line was present inside mxGraph code, it probably got overlooked while migrating the code. Adding this line back caused the custom setPosition function written inside story to be triggered and position the label lines correctly.

After change:

inner-rectangle.mov

Notes

ℹ️ This change only reflects the inner rectangle issue,not rotating handle being misaligned, that was fixed in other PR.

Summary by CodeRabbit

  • New Features

    • Enhanced the Vertex Handle functionality to update its position based on mouse interactions and current state during event processing.
  • Bug Fixes

    • Improved responsiveness of the Vertex Handle during user interactions.

Body of processEvent funciton inside VertexHandle was missing setPosition call that will properly update the values inside CellStyle
This ensures the shape's internal lines are redrawn correctly during hnadle movements.

Before this change, dragging the custom handles did not update the shape's divider positions due to the missing setPosition call.
@coderabbitai
Copy link

coderabbitai bot commented Nov 23, 2024

Walkthrough

The changes in this pull request involve a modification to the processEvent method of the VertexHandle class in the VertexHandle.ts file. A new line has been added to call the setPosition method, which updates the position of the handle based on the current state and mouse interaction. No alterations were made to the declarations of exported or public entities.

Changes

File Path Change Summary
packages/core/src/view/cell/VertexHandle.ts Modified processEvent method to include a call to setPosition with updated parameters.

Assessment against linked issues

Objective Addressed Explanation
Be able to resize the inner rectangle in the Handles story (#481)

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 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.

Copy link

@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

🧹 Outside diff range and nitpick comments (1)
packages/core/src/view/cell/VertexHandle.ts (1)

132-133: Consider adding tests to prevent regression.

Since this was a bug fix for handle movement behavior, it would be valuable to add tests that verify:

  1. The setPosition is called during handle movement
  2. The shape's internal lines update correctly
  3. The divider positions update properly during drag operations

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 988ff48 and a0f858b.

📒 Files selected for processing (1)
  • packages/core/src/view/cell/VertexHandle.ts (1 hunks)
🔇 Additional comments (1)
packages/core/src/view/cell/VertexHandle.ts (1)

132-132: LGTM! This fixes the handle position update issue.

The addition of setPosition call correctly addresses the bug where handle movements weren't properly updating the shape's internal lines and divider positions.

Let's verify this fixes issue #481 by checking for similar patterns in the codebase:

✅ Verification successful

The setPosition call addition follows the correct pattern and fixes the issue

The verification confirms:

  • VertexHandle is the base class implementing the setPosition method
  • The method is properly called within processEvent after calculating the new point position
  • The pattern is consistent with how custom handles are processed in both VertexHandler and EdgeHandler
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for similar handle implementations to confirm the pattern
# Look for other vertex handle implementations that use setPosition
ast-grep --pattern 'class $_ extends VertexHandle {
  $$$
  setPosition($_, $_, $_) {
    $$$
  }
}'

# Look for other handle processEvent implementations
ast-grep --pattern 'processEvent($_) {
  $$$
  setPosition($_, $_, $_)
  $$$
}'

Length of output: 184


Script:

#!/bin/bash
# Let's try a different approach to verify the pattern

# First, let's find all handle-related files
fd "Handle\.ts$" --type f

# Then, let's look for setPosition usage patterns in handle files
rg "setPosition\(" -A 3 --type ts

# Also check for processEvent implementations
rg "processEvent\(" -A 5 --type ts

# Look for the base VertexHandle class definition
rg "class VertexHandle" -A 10 --type ts

Length of output: 4069

alpha2
)
);
this.setPosition(this.state.getPaintBounds(), pt, me);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: Good catch. This seems to have been removed by mistake in a3102af.
This line existed prior this commit and in the original mxGraph code

https://github.com/jgraph/mxgraph/blob/ff141aab158417bd866e2dfebd06c61d40773cd2/javascript/src/js/handler/mxHandle.js#L101-L105

@tbouffard tbouffard changed the title fix(vertex-handler): add missing setPosition call inside processEvent fix(VertexHandler): add missing setPosition call in processEvent Nov 24, 2024
@tbouffard tbouffard changed the title fix(VertexHandler): add missing setPosition call in processEvent fix(VertexHandle): add missing setPosition call in processEvent Nov 24, 2024
Copy link
Member

@tbouffard tbouffard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for this contribution.
✔️ Tested locally

@tbouffard tbouffard merged commit 0137167 into maxGraph:main Nov 24, 2024
5 checks passed
@tbouffard tbouffard added the bug Something isn't working label Nov 27, 2024
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.

[BUG] Not possible to resize the inner rectangle in the Handles story

2 participants