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-1345: Fix for refreshing the manager after installation #1098

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

alirana01
Copy link
Collaborator

@alirana01 alirana01 commented Dec 16, 2024

Description

ESP-IDF Manager: refresh page after tools installed.

Fixes # (IEP-1345)

Type of change

Please delete options that are not relevant.

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

How has this been tested?

Please use the esp-idf.json from the offline installer in the root directory of the ide to test this and verify the tools installation normally as well

Test Configuration:

  • ESP-IDF Version: any
  • OS (Windows,Linux and macOS): windows primarily for offline (all others OS should be fine as well)

Checklist

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

Summary by CodeRabbit

  • New Features

    • Introduced a singleton pattern for the ESPIDFMainTablePage, ensuring a single instance is used throughout the application.
    • Enhanced job management in the startup process with a new job listener for better state change notifications.
  • Bug Fixes

    • Improved error handling in the UI refresh logic to prevent null pointer exceptions.
  • Refactor

    • Updated instantiation method for ESPIDFMainTablePage to utilize a singleton instance rather than creating new instances.

@alirana01 alirana01 self-assigned this Dec 16, 2024
Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request introduces modifications to the ESP-IDF UI plugin, focusing on implementing a singleton pattern for the ESPIDFMainTablePage and enhancing job management in the InitializeToolsStartup class. The changes involve adding a job listener to track tool activation jobs, modifying how the ESPIDFMainTablePage is instantiated, and improving error handling in the UI refresh logic. The primary goal appears to be creating a more robust and centralized approach to managing UI components and job tracking.

Changes

File Change Summary
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/InitializeToolsStartup.java - Added imports for ToolsActivationJobListener and ESPIDFMainTablePage
- Updated earlyStartup() to create and add a job change listener
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/ESPIDFManagerEditor.java - Modified createPartControl() to use ESPIDFMainTablePage.getInstance() instead of direct constructor
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java - Implemented singleton pattern with private constructor and getInstance() method
- Added null check in refreshEditorUI()
- Improved removeAllButton initialization and state management

Sequence Diagram

sequenceDiagram
    participant Startup as InitializeToolsStartup
    participant Job as ToolsActivationJob
    participant Listener as ToolsActivationJobListener
    participant Page as ESPIDFMainTablePage

    Startup->>Job: Create Job
    Startup->>Listener: Create Listener
    Startup->>Job: Add Job Change Listener
    Job-->>Listener: Notify Job State Changes
    Listener->>Page: Update UI or Trigger Refresh
Loading

Possibly related PRs

Suggested reviewers

  • kolipakakondal
  • AndriiFilippov
  • sigmaaa

Poem

🐰 A Rabbit's Ode to Singleton Design

In UI's realm, a page now stands alone,
One instance to rule, a singleton's throne
Jobs tracked with care, listeners in sight
Refactored code, oh what a delight!
ESP-IDF's magic, now clean and bright 🔧


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. (Beta)
  • @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
Collaborator Author

@alirana01 alirana01 left a comment

Choose a reason for hiding this comment

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

Self Review

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

🧹 Nitpick comments (1)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java (1)

Line range hint 275-284: Consider extracting button state management logic

The removeAllButton state management logic is duplicated in createIdfTable and refreshEditorUI methods.

Consider extracting the logic into a private method:

+private void updateRemoveAllButtonState() {
+    if (idfToolSets == null || idfToolSets.isEmpty()) {
+        removeAllButton.setEnabled(false);
+    } else {
+        removeAllButton.setEnabled(true);
+    }
+}

Then replace the duplicate code in both methods with:

-if (idfToolSets == null || idfToolSets.isEmpty()) {
-    removeAllButton.setEnabled(false);
-} else {
-    removeAllButton.setEnabled(true);
-}
+updateRemoveAllButtonState();

Also applies to: 141-150

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aea1ba2 and 53eefa1.

📒 Files selected for processing (3)
  • bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/InitializeToolsStartup.java (2 hunks)
  • bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/ESPIDFManagerEditor.java (1 hunks)
  • bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java (2 hunks)
🔇 Additional comments (4)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/ESPIDFManagerEditor.java (1)

56-57: LGTM: Proper usage of singleton pattern

The change correctly uses the singleton pattern to maintain a single instance of ESPIDFMainTablePage across the application.

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/InitializeToolsStartup.java (1)

185-186: LGTM: Proper implementation of job listener

The changes correctly implement job state tracking by:

  1. Creating a job listener with the singleton instance of ESPIDFMainTablePage
  2. Adding the listener to track tool activation job state changes

This implementation ensures proper UI refresh after tool installation.

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java (2)

70-84: LGTM: Clean singleton pattern implementation

The singleton pattern is correctly implemented with:

  • Private static instance
  • Private constructor
  • Public static getInstance() method

100-101: LGTM: Proper null check added

The null check for container prevents potential NullPointerException if refreshEditorUI is called before the UI is created.

Copy link
Collaborator

@sigmaaa sigmaaa left a comment

Choose a reason for hiding this comment

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

LGTM! @AndriiFilippov please check

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 added this to the v3.2.0 milestone Dec 17, 2024
@AndriiFilippov
Copy link
Collaborator

@alirana01 hi !

Tested :

OS - Windows 11

ESP-IDF Manager shell refreshed after tools installation - tools are displayed ✅

LGTM 👍

@AndriiFilippov AndriiFilippov merged commit 7fd0ad9 into master Dec 18, 2024
2 of 5 checks passed
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.

4 participants