refactor: migrate modules.js to TypeScript as modules.ts #602
Conversation
✅ Deploy Preview for circuitverse ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe changes involve deleting the JavaScript file Changes
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes detected. 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
npm error Exit handler never called! ✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
src/simulator/src/modules.ts (2)
41-43: Inefficient collision check – consider Set for O(1) look-ups
doneis used only as a hash-set. Switching toSet<number>yields cleaner code and avoids accidental key coercion.
84-89: RedundantparseIntand potential NaN
sizeis already a number (size?: number). Converting throughStringthenparseIntis unnecessary and can silently turnNaNinto0.- size = parseInt(String(size), 10) + // size is already a number – leave as-is
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/simulator/src/modules.js(0 hunks)src/simulator/src/modules.ts(1 hunks)
💤 Files with no reviewable changes (1)
- src/simulator/src/modules.js
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/simulator/src/modules.ts (3)
src/simulator/src/circuit.ts (1)
Scope(294-515)src/simulator/src/modules/Power.js (1)
height(125-125)src/simulator/src/contention.ts (1)
size(106-108)
| const obj = new modules[this.objectType]( | ||
| this.x, | ||
| this.y, | ||
| this.scope, | ||
| this.direction, | ||
| size, | ||
| this.bitWidth | ||
| ) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Runtime crash if module type not registered
new modules[this.objectType]( … ) assumes the constructor is present. Add a guard to throw a clear error (or no-op) instead of an unhelpful “undefined is not a constructor”.
🤖 Prompt for AI Agents
In src/simulator/src/modules.ts around lines 90 to 97, the code assumes that
modules[this.objectType] is always defined, which can cause a runtime crash if
the module type is not registered. Add a guard before the constructor call to
check if modules[this.objectType] exists; if not, throw a clear error indicating
the module type is unregistered or handle it gracefully with a no-op to prevent
the "undefined is not a constructor" error.
| const height = possibleY + 20 | ||
| if (height > scope.layout.height) { | ||
| const oldHeight = scope.layout.height | ||
| scope.layout.height = height | ||
|
|
||
| for (let i = 0; i < scope.Input.length; i++) { | ||
| if (scope.Input[i].layoutProperties.y === oldHeight) { | ||
| scope.Input[i].layoutProperties.y = scope.layout.height | ||
| } | ||
| } | ||
|
|
||
| for (let i = 0; i < scope.Output.length; i++) { | ||
| if (scope.Output[i].layoutProperties.y === oldHeight) { | ||
| scope.Output[i].layoutProperties.y = scope.layout.height | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Height-adjustment updates miss elements above the old height
Only elements exactly at oldHeight are shifted, but any inputs/outputs that already exceeded oldHeight keep their positions and may now spill outside the new canvas height.
🤖 Prompt for AI Agents
In src/simulator/src/modules.ts around lines 45 to 61, the code only updates
elements whose y position equals oldHeight, missing those positioned above
oldHeight that may now be outside the new height. Modify the condition in both
loops to update elements with y positions greater than or equal to oldHeight,
ensuring all relevant elements are shifted to stay within the updated layout
height.
| for (let i = 0; i < scope.Input.length - 1; i++) { | ||
| if (scope.Input[i].layoutProperties.x === x) { | ||
| done[scope.Input[i].layoutProperties.y] = 1 | ||
| } | ||
| } |
There was a problem hiding this comment.
Off-by-one skips the last input element
for (let i = 0; i < scope.Input.length - 1; i++) never visits scope.Input[scope.Input.length - 1], so the y-coordinate of the last input placed at this x can collide with the new object.
- for (let i = 0; i < scope.Input.length - 1; i++) {
+ for (let i = 0; i < scope.Input.length; i++) {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| for (let i = 0; i < scope.Input.length - 1; i++) { | |
| if (scope.Input[i].layoutProperties.x === x) { | |
| done[scope.Input[i].layoutProperties.y] = 1 | |
| } | |
| } | |
| for (let i = 0; i < scope.Input.length; i++) { | |
| if (scope.Input[i].layoutProperties.x === x) { | |
| done[scope.Input[i].layoutProperties.y] = 1 | |
| } | |
| } |
🤖 Prompt for AI Agents
In src/simulator/src/modules.ts around lines 29 to 33, the for loop uses `i <
scope.Input.length - 1`, which skips the last element of scope.Input. Change the
loop condition to `i < scope.Input.length` to ensure the last input element is
included and its y-coordinate is checked for collisions.
|
@Arnabdaz @niladrix719 pls review the pr , thanks |
Fixes #414
Describe the changes you have made in this PR -
changed the modules.js file to modules.ts file as asked in issue
Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.
Summary by CodeRabbit