HP-2320: add logic for type and move_type input when move
#182
Conversation
WalkthroughThe pull request introduces enhancements to the part movement functionality across multiple files. The changes focus on improving the validation and user interface for part movements, specifically by adding a new Changes
Sequence DiagramsequenceDiagram
participant User
participant MoveForm
participant MoveTypeDropDown
participant ValidationModel
User->>MoveForm: Initiate Part Move
MoveForm->>MoveTypeDropDown: Select Move Type
MoveTypeDropDown->>ValidationModel: Validate Move Type
ValidationModel-->>MoveForm: Validation Result
MoveForm->>User: Display Move Options
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 1
🧹 Nitpick comments (2)
src/widgets/combo/DestinationCombo.php (1)
36-52: Potential XSS risk by disabling markup escaping.
Since'escapeMarkup'simply returns the passed-in HTML, ensure that the rendered text is sanitized or trusted. Otherwise, it might lead to XSS if the response from the server or any upstream data is not carefully validated.src/widgets/MoveTypeDropDownList.php (1)
20-59: JavaScript block is effective but consider modularizing.
The embedded script correctly handles thedstSelectchanges, but the array of types might benefit from a more concise structure or a dedicated mapping object to reduce repeated string values.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
src/models/Part.php(1 hunks)src/views/part/_move.php(2 hunks)src/views/part/moveByOne.php(3 hunks)src/widgets/MoveTypeDropDownList.php(1 hunks)src/widgets/combo/DestinationCombo.php(2 hunks)
🔇 Additional comments (14)
src/widgets/combo/DestinationCombo.php (2)
15-15: Import statement approved.
The addition ofuse yii\web\JsExpression;aligns perfectly with the usage ingetPluginOptions().
29-29: Confirm that the API endpoint returns thetypefield.
By extending$_returnto includetype, ensure that/stock/move/directions-listactually returns atypefield to avoid undefined index issues.✅ Verification successful
The
typefield usage inDestinationCombois valid and intentional.
The codebase shows that the/stock/move/directions-listendpoint returns structured data with multiple fields, and components can selectively request needed fields. TheSourceComboandDestinationCombowidgets demonstrate this by requesting different fields from the same endpoint.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Checking if 'type' is present in the JSON response from directions-list curl -s "http://localhost:8080/stock/move/directions-list" | jq '.[].type'Length of output: 131
Script:
#!/bin/bash # Find files containing 'directions-list' endpoint definition rg -l "directions-list" # Search for potential controller methods handling this endpoint rg -A 5 "directions-list|getDirections|moveDirections" # Look for any class methods that might be returning direction data ast-grep --pattern 'function $FUNC($$$) { $$$ return $$$; }'Length of output: 75102
Script:
#!/bin/bash # Find ComboSearchAction class definition rg -l "class ComboSearchAction" # Search for get-directions query implementation rg -A 5 "get-directions" # Look for any query/action classes related to directions rg -l "Direction" --type phpLength of output: 1647
src/widgets/MoveTypeDropDownList.php (6)
1-4: Namespace and imports look good.
No issues found with the declared strict types or the namespace block.
10-13: Widget declaration is well-defined.
The class extendsInputWidgetand declares a public$itemsarray, which is appropriate for the dropdown structure.
14-19: Initialization logic is valid but watch for unassigned$id.
You're retrieving the$idviaArrayHelper::getValue($this->options, 'id'). If'id'is missing from$this->options,$idmay benull, causing issues in the subsequent script registration.
61-64: Rendering approach is correct.
Html::activeDropDownListis the standard way to generate a dropdown in Yii, so this is straightforward and maintainable.
65-65: File closing brace is in place.
No issues at the end of the file.
5-9: Imports appear consistent.
Please ensure that unused helpers or classes are removed if they are not utilized.✅ Verification successful
All imports are actively used in the code
InputWidget: Extended by the classInvalidConfigException: Used for error handling ininit()ArrayHelper: Used in bothinit()andrun()methodsHtml: Used inrun()for dropdown list generation🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Searching for references to imported classes within the file ast-grep --pattern $'use $_' --jsonLength of output: 39
Script:
#!/bin/bash # Get the full content of the file cat src/widgets/MoveTypeDropDownList.php # Search for specific usages rg "InvalidConfigException|ArrayHelper|Html|InputWidget" src/widgets/MoveTypeDropDownList.phpLength of output: 2251
src/views/part/_move.php (2)
10-10: Dependency on MoveTypeDropDownList established.
The new widget import is consistent with the rest of the code.
56-56: Widget usage is valid.
Replacing a simple dropdown withMoveTypeDropDownListcentralizes the move-type logic and keeps consistency across views.src/views/part/moveByOne.php (3)
8-8: New widget import recognized.
This ensures the same widget logic for move types is used as in_move.php.
15-20: Doc block improvements.
The added variable annotations increase clarity and maintainability of the code. No issues found.
116-116: Consistent usage ofMoveTypeDropDownList.
Installing and referencing the same widget in both_move.phpandmoveByOne.phpensures consistent move-type handling across different scenarios.src/models/Part.php (1)
142-142: Ensure consistency betweentypeandmove_typeusage.You’ve added
move_typeas a required field for themove-by-onescenario, which aligns with the PR objective. However, in themovescenario, the existing rule requirestyperather thanmove_type. If the new logic mandates consistent usage ofmove_typeacross both flows, consider unifying them or verifying that themovescenario truly requirestyperather thanmove_type.Run the following script to check how
typeandmove_typeare used across all scenarios and ensure the code logic is consistent with your intentions:
| @@ -94,7 +102,7 @@ | |||
| </div> | |||
| <div class="col-md-6"> | |||
| <?php $model->dst_id = null ?> | |||
| <?php if (strstr($this->context->action->id, 'rma') !== false) : ?> | |||
| <?php if (str_contains($this->context->action->id, 'rma')) : ?> | |||
There was a problem hiding this comment.
💡 Codebase verification
PHP 8.0 function used but PHP 7.3 installations are supported
The core package hipanel-core supports PHP ^7.3||^8.0, but str_contains() is only available in PHP 8.0+. This could cause runtime errors in PHP 7.3 environments.
Suggestions:
- Add explicit PHP 8.0+ requirement in this module's composer.json, or
- Use
strpos() !== falseas a PHP 7.3 compatible alternative - Consider using Symfony's polyfill-php80 package for broader compatibility
🔗 Analysis chain
Conditional for RMA combos is appropriate.
Using str_contains requires at least PHP 8.0. Verify the minimum PHP version in composer.json or project config to avoid runtime errors on older PHP versions.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Checking PHP version in composer.json
rg '"php": ".*"'
Length of output: 18
Script:
#!/bin/bash
# Search for composer files and PHP version related configs
fd composer.json
fd composer.lock
fd "^README" -t f
fd Dockerfile
fd "^.php-version$"
Length of output: 135
Script:
#!/bin/bash
# Check content of composer.json and README files
cat composer.json
echo "=== README.md ==="
cat README.md
Length of output: 3712
Script:
#!/bin/bash
# Check hipanel-core package requirements
curl -s https://raw.githubusercontent.com/hiqdev/hipanel-core/master/composer.json | jq .
Length of output: 3882
Summary by CodeRabbit
Release Notes
New Features
Improvements
Technical Updates