search

espressif / idf-eclipse-plugin

Espressif-IDE (based on Eclipse CDT) for ESP-IDF CMake based projects 4.x and above
Eclipse Public License 2.0
302 stars 121 forks source link

IEP-1262 Changing the configuration should also change the mode #993

Closed sigmaaa closed 2 months ago

sigmaaa commented 3 months ago

Description

Now, when we change the configuration it automatically sets the mode to Run/Debug accordingly

Fixes # (IEP-1262)

Type of change

Please delete options that are not relevant.

How has this been tested?

Test Configuration:

Dependent components impacted by this PR:

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes enhance launch handling, refactor code for improved readability, and update methods for better consistency and efficiency. Key modifications include adding imports, introducing and updating methods, and improving implementations in multiple files.

Changes

Files Change Summaries
.../idf/ui/LaunchBarListener.java Added imports for Optional, Stream, ILaunchManager, and ILaunchMode. Introduced setMode method. Updated activeLaunchDescriptorChanged method.
...idf/ui/handlers/RunActionHandler.java Refactored execute method. Added imports, removed SelectLaunchConfigDialog import. Introduced runActionBasedOnDescCount and setLaunchBarWithFirstAppropriateDescriptor methods. Streamlined findSuitableDescNames and showMessage.
...ui/dialogs/DeleteResourceWizard.java Modified several method signatures. Added braces for code blocks. Adjusted spacing. Enhanced method implementations in addUserInputPages, DeleteResourcesRefactoringConfigurationPage inner class, createControl, updateListOfProjects, computeNestedProjects, performFinish, and deleteRelatedConfigurations methods.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant IDE
    participant LaunchBarListener
    participant ILaunchManager

    User->>IDE: Change active launch configuration
    IDE->>LaunchBarListener: Notify activeLaunchDescriptorChanged
    LaunchBarListener->>ILaunchManager: Retrieve specific launch mode
    ILaunchManager-->>LaunchBarListener: Return the retrieved mode
    LaunchBarListener-->>IDE: Update the launch mode
sequenceDiagram
    participant User
    participant IDE
    participant RunActionHandler

    User->>IDE: Execute a run action
    IDE->>RunActionHandler: Trigger execute method
    RunActionHandler->>RunActionHandler: Determine descriptor count
    alt Single descriptor
        RunActionHandler->>RunActionHandler: setLaunchBarWithFirstAppropriateDescriptor
    else Multiple descriptors
        RunActionHandler->>RunActionHandler: runActionBasedOnDescCount
    end
    RunActionHandler-->>IDE: Complete execution

Poem

In the codebase deep and bright,
Changes come to make it light,
Launch modes now set with skill,
Run actions tailored, such a thrill!
Pacing through the wizard's maze,
Braces, spacing, all amaze!
With these tweaks, our code shall rise,
To greater heights beneath the skies! 🌟🐰

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
AndriiFilippov commented 2 months ago

@sigmaaa hi ! Tested under: OS - Windows 10

change the configuration it automatically sets the mode to Run/Debug accordingly ✔️ LGTM 👍

kolipakakondal commented 2 months ago

Follow-up behavior - Would you also like to handle the case where changing the mode (Run to Debug and vice versa) updates the launch configuration in the dropdown menu? I understand we currently handle this during launch with a pop-up, but if there's only one configuration, we could simply switch it and eliminate the pop-up choice for the user.

Jul-04-2024 12-18-57

sigmaaa commented 2 months ago

Follow-up behavior - Would you also like to handle the case where changing the mode (Run to Debug and vice versa) updates the launch configuration in the dropdown menu? I understand we currently handle this during launch with a pop-up, but if there's only one configuration, we could simply switch it and eliminate the pop-up choice for the user.

Jul-04-2024 12-18-57 Jul-04-2024 12-18-57

Hi @kolipakakondal,

thanks for the review. Implemented in the latest PR

kolipakakondal commented 2 months ago

thanks for the review. Implemented in the latest PR

Hi @sigmaaa I could still see the same issue where changing the mode is not changing the configuration. Can you please check. Jul-10-2024 08-28-59

@AndriiFilippov fyi.

sigmaaa commented 2 months ago

thanks for the review. Implemented in the latest PR

Hi @sigmaaa I could still see the same issue where changing the mode is not changing the configuration. Can you please check. Jul-10-2024 08-28-59 Jul-10-2024 08-28-59

@AndriiFilippov fyi.

Hi @kolipakakondal, this is the expected behavior for this PR since the goal of this PR was to change the mode based on the configuration, not vice versa. To change the configuration, click run or debug with the wrong configuration. Changing the configuration based on the mode automatically causes bugs and not consistent behavior, because changing the configuration causes changing the mode, so if we change the configuration based on the mode it could cause an infinite loop. Removing listeners didn't help to remove bugs completely. Check this PR where I tried to implement similar behaviour https://github.com/espressif/idf-eclipse-plugin/pull/806. We can revisit this PR and try to implement it again, however, we considered the logic in this PR as a good alternative. From the user's perspective, the current behavior looks like this: The user has a launch configuration selected and he wants to debug the project, so he selects mode to the debug and sees the button "Debug" -> At this point he can click it and the configuration will be changed to the debug, so the debug action will be performed

kolipakakondal commented 2 months ago

Hi @sigmaaa I'm happy if you would like to revist the existing PR on this problem and fix this issue.