Skip to content

fix(VertexHandler): display overlay when resizing a vertex#673

Merged
tbouffard merged 1 commit intomainfrom
fix/666-VertexHandler_display_overlays_on_resize
Feb 13, 2025
Merged

fix(VertexHandler): display overlay when resizing a vertex#673
tbouffard merged 1 commit intomainfrom
fix/666-VertexHandler_display_overlays_on_resize

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Feb 13, 2025 •
edited by coderabbitai bot
Loading

This was a regression introduced in c84ac31.

Notes

Closes #666

issue_666_fix.webm

Summary by CodeRabbit

  • Refactor
    • Streamlined the logic for preview display to ensure a more consistent visual experience. This update simplifies the conditions for rendering previews, leading to more reliable and accurate presentation across different scenarios without impacting overall functionality.

@tbouffard tbouffard added the bug Something isn't working label Feb 13, 2025
@coderabbitai
Copy link

coderabbitai bot commented Feb 13, 2025 •
edited
Loading

Walkthrough

The change updates the condition in the start method of the VertexHandler class (located in packages/core/src/view/handler/VertexHandler.ts). Previously, the method verified if the client was using SVG, the rotation style was non-zero, and the text node was present and a child of the graph container. The updated condition removes the rotation style check and only verifies that the text node exists and is correctly attached. No alterations were made to the public entities.

Changes

File Change Summary
packages/.../VertexHandler.ts Updated the condition in the start method for setting the preview object's dialect by removing the non-zero rotation style check.

Sequence Diagram(s)

sequenceDiagram
    participant VH as VertexHandler.start
    participant TC as TextNode Check
    participant PD as Preview Dialect Setter

    VH->>+TC: Verify if text node exists and is a child of the graph container
    TC-->>-VH: Return check result
    alt Valid Text Node
        VH->>+PD: Set preview dialect based on text node presence
        PD-->>-VH: Dialect configured
    else Invalid or Missing Text Node
        VH->>+PD: Set default preview dialect
        PD-->>-VH: Default applied
    end
Loading

Possibly related PRs

📜 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 4132bc3 and 6d69a00.

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

692-694: LGTM! The condition simplification looks correct.

The removal of the rotation style check from the condition is appropriate since the overlay should be displayed during vertex resizing regardless of the rotation value. This change fixes the regression by ensuring the preview dialect is set based solely on the text node's presence and its parent container.

692-694:

Details

❓ Verification inconclusive

Verify the preview behavior in different scenarios.

While the change looks correct, please verify the preview behavior in the following scenarios to ensure no regressions:

  1. Resizing vertices with and without rotation
  2. Resizing vertices with and without text
  3. Resizing vertices in different containers

Run this script to find all vertex resizing test cases:

🏁 Script executed:

#!/bin/bash
# Description: Find test files related to vertex resizing and preview behavior

# Search for test files containing vertex resize tests
rg -l "test.*[Vv]ertex.*[Rr]esize|test.*[Rr]esize.*[Vv]ertex" --type ts

Length of output: 73

Action Required: Manually verify vertex preview behavior during resizing

While the code change appears focused and correct, our automated search did not locate any vertex resizing tests. Please ensure that there are no regressions by manually testing the following scenarios:

  • Resizing with Rotation: Confirm that vertices with non-zero rotation correctly display the preview, especially when Client.IS_SVG is true.
  • Resizing with Text: Verify that the preview remains accurate when text is present and that the text node’s parent is correctly attached to the graph container.
  • Container Variations: Check the preview behavior when vertices reside in different container contexts.

Due to the absence of automated test results, extra caution through manual verification is advised.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 13, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@tbouffard tbouffard marked this pull request as ready for review February 13, 2025 07:34
@tbouffard tbouffard mentioned this pull request Feb 13, 2025
Closed
@tbouffard tbouffard merged commit 78f25bd into main Feb 13, 2025
7 checks passed
@tbouffard tbouffard deleted the fix/666-VertexHandler_display_overlays_on_resize branch February 13, 2025 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

bug Something isn't working

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[BUG] Resize outline overlay is not displayed

1 participant

@tbouffard