Skip to content
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.

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

Value Expression for Script Action #4012

Merged
merged 2 commits into from
Nov 29, 2024

Conversation

GokulBothe99
Copy link
Contributor

@GokulBothe99 GokulBothe99 commented Nov 29, 2024

Thank you for your contribution.
Before submitting this PR, please make sure:

  • PR description and commit message should describe the changes done in this PR
  • Verify the PR is pointing to correct branch i.e. Release or Beta branch if the code fix is for specific release , else point it to master
  • Latest Code from master or specific release branch is merged to your branch
  • No unwanted\commented\junk code is included
  • No new warning upon build solution
  • Code Summary\Comments are added to my code which explains what my code is doing
  • Existing unit test cases are passed
  • New Unit tests are added for your development
  • Sanity Tests are successfully executed for New and Existing Functionality
  • Verify that changes are compatible with all relevant browsers and platforms.
  • After creating pull request there should not be any conflicts
  • Resolve all Codacy comments
  • Builds and checks are passed before PR is sent for review
  • Resolve code review comments
  • Update the Help Library document to match any feature changes

Summary by CodeRabbit

  • New Features

    • Introduced a new script interpreter selection control with an updated tooltip for better user guidance.
    • Enhanced script execution context handling for improved functionality.
  • Bug Fixes

    • Refined error handling related to script execution, ensuring accurate UI updates based on user selections.
  • Refactor

    • Streamlined the logic for managing script interpreters and improved property change notifications for better maintainability.

Copy link
Contributor

coderabbitai bot commented Nov 29, 2024

Walkthrough

The changes in this pull request primarily involve modifications to the user interface and underlying logic of the ActScriptEditPage. The UCFileBrowser control has been replaced with UCValueExpression, and the initialization of the script interpreter has been updated to reflect this change. Additionally, the ScriptInterpreter property in the ActScript class has been enhanced to improve encapsulation and property change notifications. Overall, these updates streamline the handling of script execution contexts and refine user interface interactions.

Changes

File Path Change Summary
Ginger/Ginger/Actions/ActionEditPages/ActScriptEditPage.xaml - Replaced Actions:UCFileBrowser with Actions:UCValueExpression.
- Updated control name to xVScriptInterPreter and added tooltip.
- Visibility of InterpreterPathPanel remains "Collapsed."
Ginger/Ginger/Actions/ActionEditPages/ActScriptEditPage.xaml.cs - Added using directive for Amdocs.Ginger.Common.
- Updated constructor to initialize xVScriptInterPreter with additional parameters.
- Removed JavaScript option from ScriptInterpreterComboBox.
- Modified selection logic in ScriptInterpreterComboBox to adjust visibility of InterpreterPathPanel and populate ScriptNameComboBox based on selected interpreter type.
- Refined error handling methods for script execution.
Ginger/GingerCoreNET/ActionsLib/ActScript.cs - Enhanced ScriptInterpreter property with a backing field and change notification.
- Updated Execute method to use a local variable for script interpreter handling.

Possibly related PRs

Suggested reviewers

  • Maheshkale447

Poem

🐰 In the garden where scripts play,
A new interpreter leads the way.
With a wink and a hop,
The old ways we drop,
As we code through the bright sunny day! 🌼


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 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 or @coderabbitai title 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (5)
Ginger/Ginger/Actions/ActionEditPages/ActScriptEditPage.xaml (2)

17-19: Fix naming inconsistency in control name

The change from UCFileBrowser to UCValueExpression looks good and aligns with the PR objectives. However, there's a naming inconsistency in the control name:

  • 'InterPreter' should be 'Interpreter' to maintain consistent capitalization
-                    <Actions:UCValueExpression x:Name="xVScriptInterPreter"  ToolTip="Select Interpreter according to script." Width="370"/>
+                    <Actions:UCValueExpression x:Name="xVScriptInterpreter"  ToolTip="Select Interpreter according to script." Width="370"/>

18-18: Enhance tooltip message clarity

The current tooltip message could be more descriptive to better guide users.

-                    <Actions:UCValueExpression x:Name="xVScriptInterPreter"  ToolTip="Select Interpreter according to script." Width="370"/>
+                    <Actions:UCValueExpression x:Name="xVScriptInterPreter"  ToolTip="Select the script interpreter path or provide a value expression" Width="370"/>
Ginger/GingerCoreNET/ActionsLib/ActScript.cs (2)

86-103: LGTM! Consider adding null handling.

The property implementation correctly implements change notification. However, consider adding null handling to prevent potential null reference issues.

 public string ScriptInterpreter
 {
     get
     {
         return mScriptInterpreter;
     }
     set
     {
-        if (mScriptInterpreter != value)
+        if (!string.Equals(mScriptInterpreter, value))
         {
             mScriptInterpreter = value;
             OnPropertyChanged(nameof(ScriptInterpreter));
         }
     }
 }

205-207: Improve consistency in null handling and path conversion.

The null checks and path conversion handling should be consistent throughout the code.

-if (!string.IsNullOrEmpty(calculatedScriptInterpreter))
+if (string.IsNullOrEmpty(calculatedScriptInterpreter))
+{
+    Error = "Script interpreter path cannot be empty";
+    return;
+}
+try
 {
     p.StartInfo.FileName = WorkSpace.Instance.Solution.SolutionOperations.ConvertSolutionRelativePath(calculatedScriptInterpreter);
 }
+catch (Exception ex)
+{
+    Error = $"Failed to convert interpreter path: {ex.Message}";
+    return;
+}

-else if (calculatedScriptInterpreter != null && calculatedScriptInterpreter.Contains("cmd.exe"))
+else if (calculatedScriptInterpreter.Contains("cmd.exe"))

Also applies to: 259-264

Ginger/Ginger/Actions/ActionEditPages/ActScriptEditPage.xaml.cs (1)

57-57: Correct the variable name to fix inconsistent capitalization

The variable xVScriptInterPreter has inconsistent capitalization of 'Interpreter'. For consistency and readability, it should be renamed to xVScriptInterpreter.

Apply this diff to correct the variable name:

- xVScriptInterPreter.Init(Context.GetAsContext(actScript.Context), actScript, nameof(ActScript.ScriptInterpreter), true, true, UCValueExpression.eBrowserType.File, "*.*");
+ xVScriptInterpreter.Init(Context.GetAsContext(actScript.Context), actScript, nameof(ActScript.ScriptInterpreter), true, true, UCValueExpression.eBrowserType.File, "*.*");
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 836feb0 and 665632f.

📒 Files selected for processing (3)
  • Ginger/Ginger/Actions/ActionEditPages/ActScriptEditPage.xaml (1 hunks)
  • Ginger/Ginger/Actions/ActionEditPages/ActScriptEditPage.xaml.cs (2 hunks)
  • Ginger/GingerCoreNET/ActionsLib/ActScript.cs (5 hunks)
🔇 Additional comments (2)
Ginger/Ginger/Actions/ActionEditPages/ActScriptEditPage.xaml.cs (2)

20-20: LGTM!

The added using Amdocs.Ginger.Common; directive is appropriate and necessary.


57-57: Use named arguments for boolean parameters to enhance readability

When passing multiple boolean arguments (true, true), consider using

Ginger/GingerCoreNET/ActionsLib/ActScript.cs Show resolved Hide resolved
Ginger/GingerCoreNET/ActionsLib/ActScript.cs Show resolved Hide resolved
@Maheshkale447 Maheshkale447 merged commit 394c177 into master Nov 29, 2024
1 of 2 checks passed
@Maheshkale447 Maheshkale447 deleted the Feature/ScriptAction_FileSelectionOption branch November 29, 2024 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants