fix(story): correctly set the perimeter on labels at page load

[HalilFocic]

PR Checklist

• Addresses an existing open issue: fixes [BUG] PerimeterOnLabelBounds story: perimeter not on the label bounds at story load #545
• 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). Use the existing PerimeterOnLabelBounds.stories
• 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

Storybook rendering caused this issue, nothing in core code has been changed, only the setTimeout has been added.
Video of how it works with this change:

The function getPerimeterPoint was being called before anything was painted on canvas and caused getBBox function to return 0 values.

bounds.mov

Notes

Fixes: #545

Summary by CodeRabbit

• Bug Fixes

  • Introduced a temporary delay in the graph update process to improve compatibility with Storybook.

• Documentation

  • Added a warning comment regarding the temporary nature of the setTimeout implementation.

[coderabbitai]

Walkthrough

The pull request modifies the PerimeterOnLabelBounds story by wrapping the batchUpdate method call within a setTimeout function, introducing a 200 milliseconds delay before execution. This change addresses compatibility issues with Storybook and maintains the existing logic for inserting vertices and edges. A comment indicates that this solution is temporary and should not be used in production environments.

Changes

File	Change Summary
packages/html/stories/PerimeterOnLabelBounds.stories.ts	Wrapped the batchUpdate call in a setTimeout with a 200 ms delay to address compatibility issues.

Assessment against linked issues

Objective	Addressed	Explanation
The terminals should be on the right perimeters at story load (#545)	❓	It is unclear if the change resolves the bug.

Possibly related PRs

• fix(VertexHandle): add missing setPosition call in processEvent #583: Modifications to the processEvent method in the VertexHandle class, potentially impacting graph update functionalities similar to the batchUpdate changes.

Suggested reviewers

• tbouffard

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)

packages/html/stories/PerimeterOnLabelBounds.stories.ts (1)

Line range hint 44-63: Document the label bounds growth value

The 3px growth value for label bounds appears to be a magic number. Consider documenting why this specific value was chosen or making it configurable.

 if (perimeter && terminal?.text?.boundingBox) {
   // Adds a small border to the label bounds
+  // Note: 3px growth provides sufficient padding to prevent edge-label overlap
+  // while maintaining visual clarity
   const b = terminal.text.boundingBox.clone();
   b.grow(3);

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 62d4c8f and f175e6f.

📒 Files selected for processing (1)

• packages/html/stories/PerimeterOnLabelBounds.stories.ts (1 hunks)

🔇 Additional comments (1)

packages/html/stories/PerimeterOnLabelBounds.stories.ts (1)

112-133: Verify similar patterns in other stories

Let's check if other stories might need similar fixes or already have better solutions implemented.

[tbouffard]

LGTM, tested locally. Thanks for the contribution.