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

IEP-1385 ESP-IDF:MenuConfig: feature uses any sdkconfig file if multiple projects open. #1096

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

sigmaaa
Copy link
Collaborator

@sigmaaa sigmaaa commented Dec 11, 2024

Description

Providing selected project in the project explorer instead of a first open project with SDK config

Fixes # (IEP-1385)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How has this been tested?

Create two projects -> build one of them -> Try to use menu config command on the project without sdkconfig -> error expected

Test Configuration:

  • ESP-IDF Version:
  • OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

  • sdkconfig

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • New Features

    • Enhanced project selection process in the SDK configuration editor.
  • Bug Fixes

    • Improved reliability of project retrieval by directly accessing the selected project in the explorer.

Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request involve modifications to the OpenSdkConfigEditor class within the com.espressif.idf.sdk.config.ui package. The primary alteration is the removal of the getCurrentProject() method, which previously retrieved the current project by iterating through all open projects. This method has been replaced with a direct call to EclipseUtil.getSelectedProjectInExplorer(), streamlining the process of obtaining the selected project while maintaining existing error handling and control flow.

Changes

File Change Summary
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/OpenSdkConfigEditor.java Removed the getCurrentProject() method; replaced with a direct call to EclipseUtil.getSelectedProjectInExplorer().

Possibly related PRs

Suggested reviewers

  • AndriiFilippov
  • kolipakakondal

🐰 In the code, we hop and play,
A simpler path has come our way.
No more searching through the maze,
Just one call, it surely pays!
With each change, we leap and cheer,
For cleaner code is finally here! 🐇✨


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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 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

@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: 0

🧹 Outside diff range and nitpick comments (1)
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/OpenSdkConfigEditor.java (1)

25-25: Add null check for project selection

The change correctly uses the selected project instead of searching through all projects, which fixes IEP-1385. However, we should add a null check to handle cases where no project is selected in the Project Explorer.

Consider adding a null check:

-		IProject project = EclipseUtil.getSelectedProjectInExplorer();
+		IProject project = EclipseUtil.getSelectedProjectInExplorer();
+		if (project == null) {
+			MessageDialog.openError(HandlerUtil.getActiveShell(event), 
+				Messages.SDKConfigurationFileNotFound_Title,
+				"Please select a project in the Project Explorer");
+			return null;
+		}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ccf28a5 and 1c5cd7c.

📒 Files selected for processing (1)
  • bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/OpenSdkConfigEditor.java (3 hunks)
🔇 Additional comments (2)
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/OpenSdkConfigEditor.java (2)

14-15: LGTM: Required import for the new project selection approach


Line range hint 33-36: Verify consistency of error handling messages

The error handling looks good, but let's verify if the message constants are consistently used across the codebase.

✅ Verification successful

Error handling follows consistent patterns across the codebase

The verification shows that:

  • The error message constants are properly defined in Messages.java and localized in messages.properties
  • The error dialog pattern MessageDialog.openError is consistently used across the codebase with similar structure:
    • Using appropriate shell context
    • Following title + message pattern
    • Leveraging the Messages class for localization
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for usage of these specific message constants and similar error handling patterns
rg -A 2 "SDKConfigurationFileNotFound_Title|SDKConfigFileNotFound_ErrorMessage" 

# Look for similar MessageDialog.openError patterns
ast-grep --pattern 'MessageDialog.openError($$$)'

Length of output: 4234

@AndriiFilippov
Copy link
Collaborator

@sigmaaa hi !

Tested under:
OS - Mac arm64 / Windows 11

do see error message ✅
now every project use particular sdk ✅
LGTM 👍

@alirana01 please, review

Copy link
Collaborator

@kolipakakondal kolipakakondal left a comment

Choose a reason for hiding this comment

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

LGTM

@kolipakakondal kolipakakondal merged commit 0e2151b into master Dec 13, 2024
5 of 6 checks passed
@kolipakakondal kolipakakondal deleted the IEP-1385 branch December 13, 2024 07:50
@kolipakakondal kolipakakondal added this to the v3.2.0 milestone Dec 13, 2024
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.

3 participants