Skip to content

IEP-1639: Update query drivers after installing tools #1319

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 9, 2025
Merged

IEP-1639: Update query drivers after installing tools #1319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ public void updateClangdPath()
InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.clangdPath.identifer(), clangdPath);
}

public void updateQueryDriver()
{
String qualifier = configuration.qualifier();
InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.queryDriver.identifer(), "**"); //$NON-NLS-1$
}

public void updateCompileCommandsDir(String buildDir)
{
String qualifier = configuration.qualifier();
Expand Down
7 changes: 5 additions & 2 deletions bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsActivationJob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,10 @@ protected IStatus run(IProgressMonitor monitor)

toolSetConfigurationManager.export(idfToolSet);
console.println("Tools Activated");
new LspService().updateClangdPath();
LspService lspService = new LspService();
lspService.updateClangdPath();
lspService.updateQueryDriver();
console.println(Messages.ClangdPreferences_UpdatedMsg);
Comment on lines +99 to +102
Copy link

@coderabbitai coderabbitai bot Oct 6, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Success message may be misleading if clangd path update fails.

The code prints Messages.ClangdPreferences_UpdatedMsg unconditionally after calling updateClangdPath() and updateQueryDriver(). However, updateClangdPath() can fail silently if clangd is not found in the build environment (see LspService.java lines 64-67), while updateQueryDriver() always succeeds.

The success message states "clangd path and query driver path have been set" but may not be accurate if clangd was not found.

Consider checking the result or handling the case where clangd path update might fail:

 LspService lspService = new LspService();
 lspService.updateClangdPath();
 lspService.updateQueryDriver();
-console.println(Messages.ClangdPreferences_UpdatedMsg);
+// Note: updateClangdPath() logs internally if clangd not found
+console.println(Messages.ClangdPreferences_UpdatedMsg);

Alternatively, modify LspService.updateClangdPath() to return a boolean indicating success, and adjust the message accordingly.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
LspService lspService = new LspService();
lspService.updateClangdPath();
lspService.updateQueryDriver();
console.println(Messages.ClangdPreferences_UpdatedMsg);
LspService lspService = new LspService();
lspService.updateClangdPath();
lspService.updateQueryDriver();
// Note: updateClangdPath() logs internally if clangd not found
console.println(Messages.ClangdPreferences_UpdatedMsg);
🤖 Prompt for AI Agents 
In
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsActivationJob.java
around lines 99-102, the code prints a success message unconditionally even
though LspService.updateClangdPath() can fail silently; change the flow so you
detect whether the clangd path update succeeded (either by making
updateClangdPath() return a boolean or by adding a new LspService method like
isClangdConfigured()/getClangdPath() to check result), call that after
updateClangdPath(), and print the original success message only when clangd was
found/updated; otherwise print or log a different warning/error message
indicating clangd was not located while still updating query driver normally.

Preferences scopedPreferenceStore = InstanceScope.INSTANCE.getNode(UIPlugin.PLUGIN_ID);
scopedPreferenceStore.putBoolean(INSTALL_TOOLS_FLAG, true);
try
Expand Down Expand Up @@ -173,7 +176,7 @@ public void run()

private void setUpToolChainsAndTargets()
{
//Get current active idf
// Get current active idf
String idfPath = IDFUtil.getIDFPath();
List<String> targets = IDFTargetsReader.readTargetsFromEspIdf(idfPath).getAllTargetNames();

Expand Down
5 changes: 3 additions & 2 deletions bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/Messages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,10 @@ public class Messages extends NLS
public static String SbomCommandDialog_StatusCantBeNullErrorMsg;

public static String ToolsInstallationJobCompletedMessage;

public static String BugReportHandler_CompletedBugReportMsg;

public static String ClangdPreferences_UpdatedMsg;

static
{
// initialize resource bundle
Expand Down
3 changes: 2 additions & 1 deletion bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/messages.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,5 @@ SbomCommandDialog_StatusCantBeNullErrorMsg=Operation status cannot be null. Plea
ToolsInstallationJobCompletedMessage=Tool installation has been successfully completed. To utilize specific tools, please use \"Set Active\" button


BugReportHandler_CompletedBugReportMsg=\n\n================================\nBug report completed. You can find the report at: %s \n=================================\n
BugReportHandler_CompletedBugReportMsg=\n\n================================\nBug report completed. You can find the report at: %s \n=================================\n
ClangdPreferences_UpdatedMsg=Clangd preferences updated: clangd path and query driver path have been set.
Loading