Skip to content

feat!: introduce global config for the Orthogonal connector #678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
tbouffard merged 2 commits into from
Feb 17, 2025
Merged

feat!: introduce global config for the Orthogonal connector #678

tbouffard merged 2 commits into from
Feb 17, 2025

Conversation

@tbouffard
Copy link
Member

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

Introduce a dedicated OrthConnectorConfig global object and its companion reset function.

Also improve the CellStateStyle JSDoc, in particular about the jetty size properties.

BREAKING CHANGES: OrthConnector is now configured with the global OrthConnectorConfig object.
The following properties that were previously hold by EdgeStyle have moved to OrthConnectorConfig:

  • orthBuffer to buffer
  • orthPointsFallback to pointsFallback

Summary by CodeRabbit

  • New Features
    • Introduced a centralized configuration for connector settings, offering enhanced customization.
  • Documentation
    • Updated global configuration guides to include new connector options and reset functionality.
  • Refactor
    • Streamlined internal utilities and migrated connector properties into a unified configuration for improved clarity.
  • Tests
    • Implemented tests to ensure the connector configuration reset works correctly.

@tbouffard
feat!: introduce global config for the Orthogonal connector
d08dc76 
Introduce a dedicated `OrthConnectorConfig` global object and its companion reset function.

Also improve the CellStateStyle JSDoc, in particular about the jetty size properties.

BREAKING CHANGES: `OrthConnector` is now configured with the global `OrthConnectorConfig` object.
The following properties that were previously hold by `EdgeStyle` have moved to `OrthConnectorConfig`:
  - `orthBuffer` to `buffer`
  - `orthPointsFallback` to `pointsFallback`
@tbouffard tbouffard added the enhancement New feature or request label Feb 16, 2025
@coderabbitai
Copy link

coderabbitai bot commented Feb 16, 2025 •
edited
Loading

Warning

Rate limit exceeded

@tbouffard has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between d08dc76 and ee08d40.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)

Walkthrough

This pull request refactors configuration management and internal utility visibility while updating documentation. It marks certain utility functions as private and removes others intended for internal use. The PR introduces a new global configuration object for the orthogonal connector, renaming related properties and adding a reset function. The edge style implementation is updated to use this centralized configuration, and corresponding tests and documentation are added to verify and describe the new behavior.

Changes

File(s) Change Summary
CHANGELOG.md Marked utils.isNullish and utils.isNotNullish as private; removed internal utility functions (utils.getValue, stringUtils.getColor, stringUtils.getNumber, stringUtils.getStringValue); documented property moves for OrthConnector configuration.
packages/core/src/view/style/config.ts, packages/html/.storybook/preview.ts, packages/website/docs/usage/global-configuration.md Introduced new OrthConnectorConfig constant with properties (buffer and pointsFallback) and a resetOrthConnectorConfig method; integrated the reset call into global configuration reset flow; updated documentation with new configuration options and reset functionality (since version 0.16.0).
packages/core/__tests__/view/style/config.test.ts Added a new test to verify that resetOrthConnectorConfig restores OrthConnectorConfig to its default state.
packages/core/src/view/style/EdgeStyle.ts Updated to import and use OrthConnectorConfig instead of static properties; removed orthBuffer and orthPointsFallback from EdgeStyle; adjusted getJettySize and OrthConnector method to use the new configuration.
packages/core/src/types.ts Revised documentation for CellStateStyle: changed default value reference for jettySize from a hardcoded value (10) to OrthConnectorConfig.buffer and added a reference to Graph.defaultLoopStyle for loopStyle.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Storybook Preview
    participant RMG as resetMaxGraphConfigs
    participant ROC as resetOrthConnectorConfig
    participant OGC as OrthConnectorConfig

    Client->>RMG: invoke resetMaxGraphConfigs()
    RMG->>ROC: Call resetOrthConnectorConfig()
    ROC->>OGC: Reset to default values (buffer: 10, pointsFallback: true)
    OGC-->>ROC: Confirmation of reset
    ROC-->>RMG: Reset complete
    RMG-->>Client: Global config reset done
Loading

Possibly related PRs

Suggested labels

documentation

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 17, 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 4082e1f into main Feb 17, 2025
7 checks passed
@tbouffard tbouffard deleted the feat/introduce_OrthConnectorConfig branch February 17, 2025 07:09
This was referenced Feb 18, 2025
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Mar 5, 2025
Merged
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

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard