fix: correct Editor cycleAttribute and swapStyles methods #871

tbouffard · 2025-07-10T14:07:51Z

Fix the implementation of the 2 methods that were declaring ts-ignore whereas there were real problems.
Notice that the implementation of swapStyles in mxGraph was buggy (the same as the previous maxGraph implementation).

Also update some JSDoc and remove some extra eslint ignores in Stylesheet.

Summary by CodeRabbit

Bug Fixes
- Improved the reliability of style swapping and attribute cycling in the editor, ensuring correct behavior under various conditions.
Tests
- Added new tests to verify the behavior of attribute cycling in the editor, covering scenarios with different attribute states.
Style
- Refined code comments and formatting for clarity and consistency.
- Removed unnecessary ESLint disable comments.

Fix the implementation of the 2 methods that were declaring ts-ignore whereas there were real problems. Notice that the implementation of swapStyles in mxGraph was buggy (the same as the previous maxGraph implementation). Also update some JSDoc and remove some extra eslint ignores in `Stylesheet`.

coderabbitai · 2025-07-10T14:07:59Z

Walkthrough

The updates introduce additional test cases for the cycleAttribute method in the Editor class, refine type annotations and method signatures in the Editor implementation, improve internal API usage, fix minor comment typos, and remove unnecessary ESLint comments in the Stylesheet module and a test file. No changes were made to the declarations of exported entities except for some type updates in Editor.

Changes

File(s)	Change Summary
packages/core/tests/editor/Editor.test.ts	Added tests for `cycleAttribute` method covering different scenarios; imported `Cell` for testing.
packages/core/src/editor/Editor.ts	Refined type annotations (`cycleAttributeName`), updated method signatures (`swapStyles`), improved internal API usage, fixed comment typo.
packages/core/src/view/style/Stylesheet.ts	Removed ESLint disable comments from `getDefaultVertexStyle` and `getDefaultEdgeStyle` methods.
packages/core/tests/serialization/serialization.xml.test.ts	Removed ESLint disable comment for non-null assertion in `getParent` function; no logic change.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite
    participant Editor
    participant Cell

    TestSuite->>Editor: set cycleAttributeName (nullish or string)
    TestSuite->>Cell: create Cell instance
    TestSuite->>Editor: call cycleAttribute(Cell)
    alt cycleAttributeName is nullish
        Editor-->>Cell: style remains unchanged
    else cycleAttributeName is set
        Editor->>Editor: consumeCycleAttribute()
        alt returns value
            Editor-->>Cell: update style with new attribute
        else returns undefined
            Editor-->>Cell: style remains unchanged
        end
    end

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.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-10T15_03_09_359Z-debug-0.log

📜 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 9da3e78 and 313f0f2.

📒 Files selected for processing (1)

packages/core/__tests__/serialization/serialization.xml.test.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

packages/core/tests/serialization/serialization.xml.test.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: build (ubuntu-24.04)
GitHub Check: build (macos-14)
GitHub Check: build (windows-2022)
GitHub Check: build

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

sonarqubecloud · 2025-07-10T15:02:26Z

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 added the bug Something isn't working label Jul 10, 2025

tbouffard added 2 commits July 10, 2025 16:27

improve type of Editor.cycleAttributeName

9da3e78

remove extra eslint disable

313f0f2

tbouffard merged commit ed5982f into main Jul 10, 2025
7 checks passed

tbouffard deleted the fix/Editor_cycleAttribute branch July 10, 2025 15:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: correct Editor cycleAttribute and swapStyles methods #871

fix: correct Editor cycleAttribute and swapStyles methods #871

Uh oh!

tbouffard commented Jul 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 10, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sonarqubecloud bot commented Jul 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

fix: correct Editor cycleAttribute and swapStyles methods #871

fix: correct Editor cycleAttribute and swapStyles methods #871

Uh oh!

Conversation

tbouffard commented Jul 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sonarqubecloud bot commented Jul 10, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tbouffard commented Jul 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)