IEP-1516: Automatic update to IDE with filewatcher #1210

alirana01 · 2025-04-28T12:20:21Z

Description

We can update the IDE environment if there is a change to the eim json file. We will update the IDE only when there is one entry in json file. For multiple we will open the ESP-IDF Manager

Fixes # (IEP-1516)

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)

How has this been tested?

Try to make changes to eim_idf.json file the IDE should be able to capture that and show a proper message to user to update their environment for only one entry it will update automatically for multiple ones we will launch ESP-IDF Manager.

Test Configuration:

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

Checklist

PR Self Reviewed
Applied Code formatting
Verified on all platforms - Windows,Linux and macOS

coderabbitai · 2025-04-28T12:20:27Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

alirana01

Self Review

sigmaaa

from the code perspective LGTM

kolipakakondal

LGTM. it would be great if we can incorpate the feedback.

kolipakakondal · 2025-04-28T12:48:58Z

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties

@@ -7,6 +7,6 @@ EspIdfManagerReloadBtnToolTip=Reload from disk
 IDFToolsHandler_ToolsManagerConsole=Espressif IDF Tools Console
 IDFGuideLinkLabel_Text=Select the version of ESP-IDF you want to use. Click the radio button in Active column next to the version you want. For help in choosing the correct version, visit <a>ESP-IDF Version Guide</a>.
 EimJsonChangedMsgTitle=ESP-IDF Installation Changed
-EimJsonChangedMsgDetail=It looks like the ESP-IDF tools are modified. The Espressif IDE cannot guarantee the consistency. Kindly refresh the installation via ESP-IDF Manager.
+EimJsonChangedMsgDetail=It looks like the ESP-IDF tools are modified. The Espressif IDE cannot guarantee the consistency. Do you want to refresh installation?


Can we maintain a positive tone in this message(especially this -The Espressif IDE cannot guarantee the consistency)?

It seems the ESP-IDF tools have been modified. To maintain consistency, we recommend refreshing your installation. Would you like to proceed with the update?

kolipakakondal · 2025-04-28T12:51:15Z

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/watcher/EimJsonUiChangeHandler.java

+		display.syncExec(() -> {
+			Shell shell = display.getActiveShell();
+			if (shell == null)
+			{
+				shell = new Shell(display);
+			}


Display.getDefault().getActiveShell() should work here considering that workbench has been already initilized, do you see any issue here?

You can also use EclipseUtil.getShell()

@kolipakakondal yes since the handler can be called from early startup class it causes NPE because the shell is not available at times

kolipakakondal · 2025-04-28T12:53:25Z

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/watcher/EimJsonUiChangeHandler.java

+			MessageBox messageBox = new MessageBox(shell, SWT.ICON_WARNING | SWT.YES | SWT.NO);
+			messageBox.setText(Messages.EimJsonChangedMsgTitle);
+			messageBox.setMessage(Messages.EimJsonChangedMsgDetail);
+			response[0] = messageBox.open();


Can we use MessageDialog over MessageBox? MessageDialogs are better, more modern, and JFace-based.

kolipakakondal · 2025-04-28T13:15:49Z

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/watcher/EimJsonUiChangeHandler.java

+		Display.getDefault().asyncExec(() -> {
+	        IWorkbenchWindow activeww = EclipseHandler.getActiveWorkbenchWindow();
+	        if (activeww != null && activeww.getActivePage() != null)
+	        {
+	            try
+	            {
+	                IDE.openEditor(activeww.getActivePage(), new EimEditorInput(eimJson),
+	                        ESPIDFManagerEditor.EDITOR_ID, true);
+	            }
+	            catch (PartInitException e)
+	            {
+	                Logger.log("Failed to open ESP-IDF Manager Editor.");
+	                Logger.log(e);
+	            }
+	        }
+	        else
+	        {
+	            Logger.log("Cannot open ESP-IDF Manager Editor. No active workbench window yet.");
+	        }
+	    });


Avoid nested blocks
If certain criteria doesn't match, verify and return immedialy

if (activeww == null || activeww.getActivePage() == null) { Logger.log("Cannot open ESP-IDF Manager Editor. No active workbench window or page."); return; }

alirana01

Self review after the code review comments resolution

kolipakakondal

LGTM

kolipakakondal · 2025-04-30T05:30:18Z

Hi @AndriiFilippov Please check

AndriiFilippov · 2025-05-19T11:15:52Z

@alirana01 hi!

Tested under:
OS - Windows 11
ESP-IDF: v5.4 / v5.3 / v5.2

The filewatcher been added only if tools\eim_idf.json exists. So, if user haven't used our eim installer before he runs IDE, the filewatcher won't be added without restart.

Reproduce:

delete your tools\eim_idf.json file -> run IDE -> run eim.installer and install ESP-IDF -> the installed version will appears in IDE Installation Manager -> but no filewatcher added. To add filewatcher - restart IDE.

AndriiFilippov · 2025-05-19T11:30:02Z

@alirana01 hi!

Tested under:
OS - Windows 11

During testing, I made a mistake by manually editing the eim_idf.json file (extra comma) and received an error in the Installation Manager. Perhaps we should consider providing a more informative error message in this case.

org.eclipse.core.runtime.AssertionFailedException: null argument:
	at org.eclipse.core.runtime.Assert.isNotNull(Assert.java:92)
	at org.eclipse.core.runtime.Assert.isNotNull(Assert.java:79)
	at org.eclipse.jface.viewers.StructuredViewer.assertElement

AndriiFilippov · 2025-05-19T18:37:34Z

@alirana01

Tested under:
OS - Windows 11

after changes to eim_idf.json the IDE react with pop up imessage:

but after any selection the message pop up again.

AndriiFilippov · 2025-05-21T09:21:57Z

@alirana01

OS - Windows 11

if I have 2 esp-idf installed (5.3 + 5.4), and for example using 5.4 as active. Then I deleted manually v5.3(inactive) from eim_idf.json -> then the info message ask to "refresh" installation but if I click yes

no tools re-installation happens

AndriiFilippov · 2025-05-21T09:25:47Z

@alirana01

OS - Windows 11

ESP-IDF Manager shell (window) does not update after changes to eim_idf.json file.
Example: have 1 esp-idf in eim_idf.json file -> install one more using eim_installer.exe -> after pop-up asking for "refreshing your installation" the ESP-IDF Manager window does not update values in table, you should close and re-open window to refresh table.

alirana01 self-assigned this Apr 28, 2025

alirana01 requested review from kolipakakondal and sigmaaa April 28, 2025 12:20

alirana01 commented Apr 28, 2025

View reviewed changes

sigmaaa reviewed Apr 28, 2025

View reviewed changes

kolipakakondal requested changes Apr 28, 2025

View reviewed changes

alirana01 requested a review from kolipakakondal April 28, 2025 13:53

alirana01 commented Apr 29, 2025

View reviewed changes

kolipakakondal approved these changes Apr 30, 2025

View reviewed changes

kolipakakondal requested a review from AndriiFilippov April 30, 2025 05:30

kolipakakondal added this to the v4.0.0 milestone May 6, 2025

alirana01 force-pushed the release/v4.0.0 branch from b1b5d82 to 290d1d8 Compare May 7, 2025 11:59

alirana01 added 4 commits May 7, 2025 14:01

automatic refresh added

fe6e4fb

message updated

d4e9a01

switched to message dialog

db78d3a

improved null checks

ca8552d

alirana01 force-pushed the IEP-1516 branch from 3d68a59 to ca8552d Compare May 7, 2025 12:01

IEP-1516: Automatic update to IDE with filewatcher #1210

Are you sure you want to change the base?

IEP-1516: Automatic update to IDE with filewatcher #1210

Uh oh!

Conversation

alirana01 commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How has this been tested?

Checklist

Uh oh!

coderabbitai bot commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

alirana01 left a comment

Choose a reason for hiding this comment

Uh oh!

sigmaaa left a comment

Choose a reason for hiding this comment

Uh oh!

kolipakakondal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alirana01 left a comment

Choose a reason for hiding this comment

Uh oh!

kolipakakondal left a comment

Choose a reason for hiding this comment

Uh oh!

kolipakakondal commented Apr 30, 2025

Uh oh!

AndriiFilippov commented May 19, 2025

Uh oh!

AndriiFilippov commented May 19, 2025

Uh oh!

AndriiFilippov commented May 19, 2025

Uh oh!

AndriiFilippov commented May 21, 2025

Uh oh!

AndriiFilippov commented May 21, 2025

Uh oh!

Uh oh!

alirana01 commented Apr 28, 2025 •

edited

Loading

coderabbitai bot commented Apr 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)