Skip to content

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented May 26, 2025

They cover the main use cases. More tests could be added in the future to cover special cases.

Summary by CodeRabbit

  • Tests
    • Expanded and restructured tests for fit and scaling behavior, adding comprehensive coverage for various container and graph size scenarios, margin options, and scale limits.

They cover the main use cases. More tests could be added in the future to cover special cases.
@tbouffard tbouffard added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label May 26, 2025
@coderabbitai
Copy link

coderabbitai bot commented May 26, 2025

Walkthrough

The test suite for the FitPlugin was extensively expanded and reorganized. New tests were added for both fitCenter and fit methods, covering various scenarios involving container and graph dimensions, margin options, and scale limits. A helper function was introduced to create mock container elements with configurable size properties.

Changes

File(s) Change Summary
packages/core/tests/view/plugins/FitPlugin.test.ts Expanded and restructured tests for FitPlugin, adding detailed cases for fitCenter and fit methods, including margin and scale limits, and introducing a helper for mock containers.

Possibly related PRs

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 warn config production Use --omit=dev instead.
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-05-26T06_56_51_532Z-debug-0.log

✨ 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
Copy link

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)
packages/core/__tests__/view/plugins/FitPlugin.test.ts (1)

20-189: Consider adding explanatory comments for complex expected values.

While the test structure is excellent, the expected values in assertions (scales and translations) are complex calculations that would benefit from brief comments explaining how they were derived. This would improve maintainability and help future developers understand the test logic.

For example:

 const scale = graph.getPlugin<FitPlugin>('fit').fitCenter();
+// Scale: min(16/1000, 16/1000) = 0.016 (pending verification)
 expect(scale).toBe(0.02);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c72ac6e and 22fc76e.

📒 Files selected for processing (1)
  • packages/core/__tests__/view/plugins/FitPlugin.test.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/core/__tests__/view/plugins/FitPlugin.test.ts (1)
packages/core/src/view/plugins/FitPlugin.ts (1)
  • FitPlugin (87-281)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build (windows-2022)
  • GitHub Check: build (ubuntu-22.04)
🔇 Additional comments (11)
packages/core/__tests__/view/plugins/FitPlugin.test.ts (11)

18-18: LGTM: Appropriate import addition.

The Rectangle import is correctly added to support the new test cases that need to set explicit graph bounds.


20-49: Well-designed helper function with good reusability.

The createContainer function effectively creates mock DOM elements with configurable dimension properties. The conditional property setting and use of Object.defineProperty with configurable: true are appropriate for testing scenarios.


51-60: Good baseline test for zero dimensions scenario.

This test properly covers the edge case where graph dimensions are zero, verifying that the scale defaults to 1 and the expected translation values are applied.


78-92: Complex increased scale scenario with margin option.

This test covers scaling up with a custom margin. The expected values (scale: 2.46, translation: 217, -59) should be verified against the fitCenter implementation to ensure the calculation logic is correct.


94-111: Good test for maxFitScale constraint.

This test properly verifies that the maxFitScale property limits the scaling when the calculated scale would exceed the maximum. The setup and assertions are clear and appropriate.


113-121: Appropriate edge case test for fit method.

This test correctly handles the scenario where both container and graph have zero dimensions, expecting no call to scaleAndTranslate which aligns with the fit method's early return logic.


123-137: Test covers basic fit scaling scenario.

The test uses offsetWidth/offsetHeight properties which are correct for the fit method. The expected scale and translation values should be validated against the fit implementation's complex calculation logic.


139-155: Good test for minFitScale constraint.

This test effectively verifies the minFitScale property by using zero container dimensions which would normally result in an invalid scale, but the constraint ensures it's limited to 0.5.


157-171: Test covers increased scale scenario for fit method.

Similar to the fitCenter tests, this covers scaling up when the container is larger than the graph. The calculations should be verified for accuracy.


173-189: Comprehensive test for maxFitScale in fit method.

This test properly verifies that maxFitScale constraints are respected in the fit method, maintaining consistency with the fitCenter tests.


62-76:

Details

❌ Incorrect review comment

Verify the scale calculation for decreased scale scenario.

The test expects a scale of 0.02, but let me verify this calculation:

  • Container client dimensions: 20x20
  • Default margin: 2
  • Effective dimensions: (20-2*2) = 16x16
  • Graph dimensions: 1000x1000
  • Expected scale: min(16/1000, 16/1000) = 0.016

The expected scale of 0.02 seems inconsistent with this calculation.


🏁 Script executed:

#!/bin/bash
# Verify the fitCenter calculation logic in the FitPlugin implementation
echo "Checking fitCenter scale calculation logic..."
ast-grep --pattern 'fitCenter($$$) {
  $$$
  let newScale = $$$;
  $$$
}'

Length of output: 176


🏁 Script executed:

#!/bin/bash
# Locate FitPlugin source file
fit_file=$(rg --files | grep 'FitPlugin.ts$' | head -n1)
echo "FitPlugin file: $fit_file"
echo "---- defaultOptions / margin ----"
rg -n "defaultOptions" -C2 "$fit_file"
echo
echo "---- fitCenter implementation ----"
rg -n "fitCenter" -C10 "$fit_file"

Length of output: 3832


🏁 Script executed:

#!/bin/bash
# Show implementation details around newScale in fitCenter
rg -n fitCenter -C20 packages/core/src/view/plugins/FitPlugin.ts | sed -n '230,280p'
rg -n "scaleAndTranslate" -C5 packages/core/src/view/plugins/FitPlugin.ts

Length of output: 864


The test’s expected scale of 0.02 is correct.
The plugin applies keep2digits (i.e. Number(value.toFixed(2))) after computing 16/1000 = 0.016, which rounds to 0.02. No change is needed.

Likely an incorrect or invalid review comment.

@tbouffard tbouffard merged commit 1fad74b into main May 26, 2025
7 checks passed
@tbouffard tbouffard deleted the test/add_more_tests_to_FitPlugin branch May 26, 2025 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant