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

Action output values user preferences #3916

Conversation

GokulBothe99
Copy link
Contributor

@GokulBothe99 GokulBothe99 commented Sep 20, 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

    • Enhanced user preferences for grid column visibility in the Action Edit Page.
    • Added a new property to user profiles to store column visibility preferences.
  • Bug Fixes

    • Improved logic for checkbox visibility based on user preferences.
  • Refactor

    • Cleaned up and optimized methods for better performance.

Copy link
Contributor

coderabbitai bot commented Sep 20, 2024

Warning

Rate limit exceeded

@GokulBothe99 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 30 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between f25c1de and c5629fc.

Walkthrough

The changes involve enhancements to the ActionEditPage.xaml.cs and UserProfile.cs files, focusing on user preferences for column visibility in a grid view. Key modifications include the introduction of a new variable in the ActionEditPage class for storing user preferences and updates to checkbox logic and grid column definitions. Additionally, a new property in the UserProfile class is introduced to persist these preferences, improving the handling of user settings and the visibility of grid columns.

Changes

File Path Change Summary
Ginger/Ginger/Actions/ActionEditPage.xaml.cs - Added string? columnPreferences for user preferences.
- Updated grid column definitions and checkbox logic.
- Enhanced visibility logic for checkboxes and grid columns based on user preferences.
Ginger/GingerCoreCommon/UserCofig/UserProfile.cs - Added public string ActionOutputValueUserPreferences property with serialization attributes.

Possibly related PRs

  • Action output values grid redesign #3900: This PR involves managing the visibility of columns in a grid view through a multi-select combo box, which directly relates to the changes made in the ActionEditPage.xaml.cs regarding user preferences for column visibility.
  • UI alignment Changes output values grid #3903: This PR modifies the grid column definitions and the logic within the SetActReturnValuesGrid and ColumnMultiSelectComboBox_ItemCheckBoxClick methods, which are also updated in the main PR to enhance the handling of user preferences and checkbox visibility.

🐰 In the meadow, changes bloom,
Columns dance, dispelling gloom.
Checkboxes gleam with user choice,
In the grid, they now rejoice!
Preferences stored, neat and bright,
A happy rabbit hops with delight! 🌼


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: 6

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b14bbbc and b9606a4.

Files selected for processing (2)
  • Ginger/Ginger/Actions/ActionEditPage.xaml.cs (5 hunks)
  • Ginger/GingerCoreCommon/UserCofig/UserProfile.cs (1 hunks)
Additional comments not posted (2)
Ginger/GingerCoreCommon/UserCofig/UserProfile.cs (1)

569-585: LGTM!

The new ActionOutputValueUserPreferences property is implemented correctly:

  • It follows the standard pattern for properties with backing fields.
  • The [IsSerializedForLocalRepository] attribute is used appropriately to enable serialization and provide a default value.
  • The getter and setter are implemented correctly.
  • The OnPropertyChanged method is called in the setter to notify any bound UI elements of changes.

The property allows storing user preferences for action output values, with a consistent initial state ensured by the default value. The property change notification enables the UI to react to changes in the preferences.

Ginger/Ginger/Actions/ActionEditPage.xaml.cs (1)

1073-1080: Remove redundant checkbox creation for "Description"

The creation of a CheckBox for "Description" and invoking CheckBox_Click appears redundant since the selection state has already been set in the loop above. Consider removing this code to avoid unnecessary operations.

Apply this diff to remove the redundant code:

- // Creating the CheckBox for "Description"
- CheckBox descriptionCheckBox = new CheckBox
- {
-     IsChecked = GetBooleanValue(columnPreferencesArray[0])
- };
-
- columnMultiSelectComboBox.CheckBox_Click(descriptionCheckBox, null);

Likely invalid or redundant comment.

Ginger/Ginger/Actions/ActionEditPage.xaml.cs Outdated Show resolved Hide resolved
Ginger/Ginger/Actions/ActionEditPage.xaml.cs Outdated Show resolved Hide resolved
Ginger/Ginger/Actions/ActionEditPage.xaml.cs Outdated Show resolved Hide resolved
Ginger/Ginger/Actions/ActionEditPage.xaml.cs Outdated Show resolved Hide resolved
Ginger/Ginger/Actions/ActionEditPage.xaml.cs Outdated Show resolved Hide resolved
Copy link
Contributor

@Maheshkale447 Maheshkale447 left a comment

Choose a reason for hiding this comment

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

Please check comments by CodeRabbit and Codacy

Ginger/Ginger/Actions/ActionEditPage.xaml.cs Outdated Show resolved Hide resolved
Ginger/GingerCoreCommon/UserCofig/UserProfile.cs Outdated Show resolved Hide resolved
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 (1)
Ginger/Ginger/Actions/ActionEditPage.xaml.cs (1)

Line range hint 1090-1196: New method for handling column visibility preferences

The ColumnMultiSelectComboBox_ItemCheckBoxClick method is a good addition for handling user preferences for column visibility. It updates the grid view and persists the user's choices.

However, there are several areas for improvement:

  1. The method is quite long and handles multiple responsibilities. Consider breaking it down into smaller, more focused methods.

  2. The string concatenation for columnPreferences could be replaced with a more robust approach, such as using a List<string> and joining it at the end.

  3. The hardcoded strings for column names could be replaced with constants or enums to avoid potential typos and improve maintainability.

  4. The method doesn't handle the case where the sender is null, which could lead to a NullReferenceException.

Consider refactoring the method as follows:

  1. Extract the logic for updating customDynamicView.GridColsView into a separate method.
  2. Use a List<string> for building columnPreferences instead of string concatenation.
  3. Create an enum or constants for column names.
  4. Add null checks for the sender parameter.

Example refactoring:

private void ColumnMultiSelectComboBox_ItemCheckBoxClick(object? sender, EventArgs e)
{
    if (sender is not CheckBox checkBox)
    {
        return;
    }

    UpdateAllCheckboxesIfNeeded(checkBox);

    List<string> selectedColumns = new List<string>();
    UpdateGridViewAndPreferences(selectedColumns);

    WorkSpace.Instance.UserProfile.ActionOutputValueUserPreferences = string.Join(",", selectedColumns);

    UpdateSimulationColumns();
    UpdateGridView();
}

private void UpdateGridViewAndPreferences(List<string> selectedColumns)
{
    foreach (Node node in columnMultiSelectComboBox._nodeList)
    {
        if (node.IsSelected)
        {
            UpdateGridViewForColumn(node.Title);
            selectedColumns.Add(node.Title);
        }
    }
}

// Implement other extracted methods here...
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3daf78e and f25c1de.

Files selected for processing (2)
  • Ginger/Ginger/Actions/ActionEditPage.xaml.cs (5 hunks)
  • Ginger/GingerCoreCommon/UserCofig/UserProfile.cs (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • Ginger/GingerCoreCommon/UserCofig/UserProfile.cs
Additional comments not posted (2)
Ginger/Ginger/Actions/ActionEditPage.xaml.cs (2)

105-105: LGTM: New variable for column preferences

The addition of the columnPreferences variable is a good approach for storing user preferences related to column visibility. The nullable string type is appropriate for this purpose.


Line range hint 1-1196: Overall good implementation of column visibility feature with room for improvements

The changes in this file successfully implement a column visibility feature with user preferences. The new functionality allows users to customize their view of the action edit page, enhancing usability. The implementation is consistent throughout the file and integrates well with the existing codebase.

Key improvements include:

  1. Addition of the columnPreferences variable for storing user preferences.
  2. Implementation of the ColumnMultiSelectComboBox_ItemCheckBoxClick method for handling user interactions.
  3. Integration with WorkSpace.Instance.UserProfile.ActionOutputValueUserPreferences for persistent storage of preferences.

While the implementation is functional, there are opportunities for further improvement:

  1. Refactoring some of the longer methods into smaller, more focused functions.
  2. Enhancing error handling and null checks in some areas.
  3. Considering a more robust serialization format for storing preferences.
  4. Addressing the minor typo in the resource key "SimulatedlValueExpressionButton".

Overall, these changes provide a valuable feature enhancement to the Ginger automation framework's action editing capabilities.

Ginger/Ginger/Actions/ActionEditPage.xaml.cs Outdated Show resolved Hide resolved
Ginger/Ginger/Actions/ActionEditPage.xaml.cs Show resolved Hide resolved
@Maheshkale447 Maheshkale447 merged commit a8ae675 into Releases/Official-Release Sep 23, 2024
8 of 9 checks passed
@Maheshkale447 Maheshkale447 deleted the Feature/ActionOutputValuesGridUserPreferences branch September 23, 2024 08:19
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