Skip to content

refactor!: remove unused domUtils.importNodeImplementation#648

Merged
tbouffard merged 2 commits intomainfrom
refactor/remove_unused_domUtils_importNodeImplementation
Jan 28, 2025
Merged

refactor!: remove unused domUtils.importNodeImplementation#648
tbouffard merged 2 commits intomainfrom
refactor/remove_unused_domUtils_importNodeImplementation

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Jan 27, 2025 •
edited by coderabbitai bot
Loading

In mxGraph, it was only used at a single place to "support older versions of IE".
https://github.com/jgraph/mxgraph/blob/ff141aab158417bd866e2dfebd06c61d40773cd2/javascript/src/js/util/mxSvgCanvas2D.js#L1270

BREAKING CHANGES: this function has been removed because it was unused.
It was only used internally in mxGraph and should not have been exposed.

Summary by CodeRabbit

  • Refactor
    • Removed unused importNodeImplementation function for clarity.
    • Replaced EdgeHandler properties with more descriptive global configurations.
    • Simplified node importing logic by using the native importNode method.

@tbouffard
refactor!: remove unused domUtils.importNodeImplementation
d0e9352 
In mxGraph, it was only used at a single place to "support older versions of IE".
https://github.com/jgraph/mxgraph/blob/ff141aab158417bd866e2dfebd06c61d40773cd2/javascript/src/js/util/mxSvgCanvas2D.js#L1270

BREAKING CHANGES: this function has been removed because it was unused.
It was only used internally in `mxGraph` and should not have been exposed.
@tbouffard tbouffard added the refactor Code refactoring label Jan 27, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2025 •
edited
Loading

Walkthrough

The pull request focuses on cleaning up and simplifying the codebase by removing unused or problematic functions and properties. Specifically, the changes involve removing the importNodeImplementation function from domUtils, which was an internal implementation for node importing. Additionally, several properties in the EdgeHandler class are being removed and replaced with more explicit global configurations in EdgeHandlerConfig, improving the clarity and maintainability of the code.

Changes

File Change Summary
packages/core/src/util/domUtils.ts Removed importNodeImplementation function, now relying on native importNode method
EdgeHandler Removed properties:
- addEnabled (replaced by addBendOnShiftClickEnabled)
- removeEnabled (replaced by removeBendOnShiftClickEnabled)
- virtualBendOpacity
- virtualBendsEnabled

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 d0e9352 and 2023040.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md

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.

coderabbitai[bot]
coderabbitai bot reviewed Jan 27, 2025
View reviewed changes
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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

19-19: Enhance the changelog entry with more details.

The breaking change entry should follow the same format as other entries and provide more context for users. Consider the following improvements:

-- `domUtils.importNodeImplementation` has been removed because it was unused. It was only used internally in `mxGraph` and should not have been exposed.
+- `domUtils.importNodeImplementation` has been removed:
+  - This function was only used internally in `mxGraph` to support older versions of IE
+  - It was not intended to be part of the public API
+  - No migration steps are needed as the function was unused
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c116f70 and d0e9352.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • packages/core/src/util/domUtils.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/core/src/util/domUtils.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (windows-2022)

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 27, 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 merged commit b0a40dd into main Jan 28, 2025
6 checks passed
@tbouffard tbouffard deleted the refactor/remove_unused_domUtils_importNodeImplementation branch January 28, 2025 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

refactor Code refactoring

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard