fix(gsoc'24): Moving a component mess up the connected wires (#3928)

[niladrix719]

Fixes #112

Stability improvements

ref PR - #3928

Summary by CodeRabbit

• New Features

  • Enhanced logic for the propagationDelay property, allowing a value of 0 to be treated distinctly, improving accuracy in simulations.
  • Improved node positioning logic in the Wire class, ensuring more reliable behavior for wire connections in the simulator.

• Bug Fixes

  • Corrected a minor typographical error in the comment for the showError function to enhance clarity.

[coderabbitai]

Walkthrough

The changes introduce modifications to various parts of the codebase, including adjustments to the loadModule function for handling propagationDelay, a correction in a comment within the showError function, and significant logic updates in the Wire class affecting how nodes are created based on their positions. Additionally, an edit icon has been added to custom shortcuts on hover.

Changes

Files	Change Summary
src/simulator/src/data/load.js	Modified the logic for propagationDelay assignment to treat a value of 0 distinctly, ensuring correct handling.
src/simulator/src/utils.ts	Corrected a typographical error in a comment within the showError function.
src/simulator/src/wire.js	Updated logic for creating Node instances based on the positions of node1 and node2, improving accuracy.
...	Added an edit icon on hover in custom shortcuts.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CustomShortcuts
    User->>CustomShortcuts: Hover over shortcut
    CustomShortcuts-->>User: Show edit icon

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add edit icon on hover in custom shortcuts (#112)	✅

🐰 In the code, there’s a delightful cheer,
With icons and changes that bring us good cheer!
The wires now dance in a more perfect way,
While comments are clear, come what may!
Let’s hop through the code, so shiny and bright,
Celebrating changes that feel just right! 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[netlify]

❌ Deploy Preview for circuitverse failed.

Name	Link
🔨 Latest commit	ff78d40
🔍 Latest deploy log	https://app.netlify.com/sites/circuitverse/deploys/66ca34832f3ec50008caba49

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 129048f and ff78d40.

Files selected for processing (3)

• src/simulator/src/data/load.js (1 hunks)
• src/simulator/src/utils.ts (1 hunks)
• src/simulator/src/wire.js (1 hunks)

Files skipped from review due to trivial changes (1)

• src/simulator/src/utils.ts

Additional comments not posted (5)

src/simulator/src/wire.js (4)

118-118: Ensure proper handling of node creation.

The new Node instance creation logic seems correct, but ensure that this.node2.absX() and this.node1.absY() are the intended coordinates.

Verify the correctness of the coordinates used for the new Node instance.

---

123-123: Ensure proper handling of node creation.

The new Node instance creation logic seems correct, but ensure that this.node1.absX() and this.node2.absY() are the intended coordinates.

Verify the correctness of the coordinates used for the new Node instance.

---

130-130: Ensure proper handling of node creation.

The new Node instance creation logic seems correct, but ensure that this.node1.absX() and this.node2.absY() are the intended coordinates.

Verify the correctness of the coordinates used for the new Node instance.

---

135-135: Ensure proper handling of node creation.

The new Node instance creation logic seems correct, but ensure that this.node2.absX() and this.node1.absY() are the intended coordinates.

Verify the correctness of the coordinates used for the new Node instance.

src/simulator/src/data/load.js (1)

59-63: Ensure correct handling of propagationDelay.

The new logic correctly handles the case where data.propagationDelay is 0. Ensure that this change does not introduce any unintended side effects.

Verify that the new logic correctly handles all possible values of data.propagationDelay.