Skip to content

feat(core): explicitly support undefined container in Graph constructor#769

Merged
tbouffard merged 1 commit intomainfrom
feat/Graph_constructor_all_undefined_constructor
Apr 18, 2025
Merged

feat(core): explicitly support undefined container in Graph constructor#769
tbouffard merged 1 commit intomainfrom
feat/Graph_constructor_all_undefined_constructor

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Apr 18, 2025 •
edited by coderabbitai bot
Loading

The Graph constructor already handled undefined container internally, but TypeScript type definitions weren't accurately reflecting this capability.

This change aligns types with implementation, supporting use cases in Editor, GraphCodec, and tests where undefined containers are passed.

Notes

Covers #367

Summary by CodeRabbit

  • Refactor
    • Improved handling of optional parameters when creating graphs, reducing the need for placeholder or dummy arguments.
    • Updated internal logic to create a default container if none is provided.
  • Documentation
    • Enhanced JSDoc comments for improved clarity.

@tbouffard
feat(core): explicitly support undefined container in Graph constructor
3324b1e 
The Graph constructor already handled undefined container internally, but TypeScript type definitions weren't accurately reflecting this capability.
This change aligns types with implementation, supporting use cases in Editor, GraphCodec, and tests where undefined containers are passed.
@tbouffard tbouffard added the enhancement New feature or request label Apr 18, 2025
@coderabbitai
Copy link

coderabbitai bot commented Apr 18, 2025 •
edited
Loading

Walkthrough

The changes update how the Graph class is instantiated across several files by making its container parameter optional. Constructor calls to Graph are refactored to omit unnecessary or forced arguments, using either no parameters or explicit undefined where appropriate. The Graph constructor now creates a default container if none is provided. Related comments and JSDoc are updated for clarity. No changes are made to the external signatures of most public APIs except for the Graph constructor, which now accepts an optional container.

Changes

File(s) Change Summary
packages/core/src/view/Graph.ts Changed Graph constructor: container parameter is now optional; assigns a new div if not provided.
packages/core/__tests__/utils.ts Updated utility functions to instantiate Graph with no arguments or with undefined instead of null!.
packages/core/src/editor/Editor.ts Refactored createGraph method to instantiate Graph with no arguments instead of undefined!.
packages/core/src/serialization/codecs/GraphCodec.ts Updated GraphCodec to instantiate Graph with no arguments; revised associated comment.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Graph

    Caller->>Graph: new Graph([container])

    alt container provided
        Graph->>Graph: this.container = container
    else container not provided
        Graph->>Graph: this.container = document.createElement('div')
    end
Loading

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 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 7cac321 and 3324b1e.

📒 Files selected for processing (4)
  • packages/core/__tests__/utils.ts (1 hunks)
  • packages/core/src/editor/Editor.ts (1 hunks)
  • packages/core/src/serialization/codecs/GraphCodec.ts (1 hunks)
  • packages/core/src/view/Graph.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build
  • GitHub Check: build (windows-2022)
  • GitHub Check: build (ubuntu-22.04)
  • GitHub Check: build (macos-14)
🔇 Additional comments (6)
packages/core/src/view/Graph.ts (2)

497-497: Type signature properly updated to make container parameter optional

The Graph constructor now accepts an optional container parameter, making it more flexible. This allows instantiating a Graph without explicitly providing a container element.

505-505: Good implementation of fallback container creation

The implementation properly handles the case when no container is provided by creating a default div element. This aligns with the updated type signature and ensures backward compatibility.

packages/core/src/editor/Editor.ts (1)

1390-1396: Clean up of forced non-null assertion

The method now properly uses the new Graph constructor signature without the forced non-null assertion, making the code safer and cleaner.

packages/core/src/serialization/codecs/GraphCodec.ts (1)

40-41: Removed unnecessary undefined parameter

The Graph constructor call has been simplified by removing the previously passed dummy variable. The updated comment is also more accurate about the current behavior regarding plugin registration.

packages/core/__tests__/utils.ts (2)

21-21: Improved test utility by removing forced null assertion

The utility function now uses the simplified Graph constructor call without the forced null assertion, making the code cleaner and safer.

23-23: Better parameter handling for plugin-less Graph creation

This function now explicitly passes undefined values instead of using forced null assertions, making it clearer that we're intentionally not providing containers or models but specifically passing an empty plugins array.

✨ 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.
    • 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.
  • @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 Apr 18, 2025

Quality Gate Passed Quality Gate passed

Issues
1 New issue
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 98b35f6 into main Apr 18, 2025
7 checks passed
@tbouffard tbouffard deleted the feat/Graph_constructor_all_undefined_constructor branch April 18, 2025 06:57
@coderabbitai coderabbitai bot mentioned this pull request May 2, 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