Skip to content

[WIP] IEP-1510: User reported issue on ESP-IDF Manager logging added #1204

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

alirana01
Copy link
Collaborator

@alirana01 alirana01 commented Apr 22, 2025

Description

Please include a summary of the change and which issue is fixed.

Fixes # (IEP-XXX)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

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

Dependent components impacted by this PR:

  • Component 1
  • Component 2

Checklist

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

Summary by CodeRabbit

  • Chores
    • Updated the product and feature version numbers from 3.3.0 to 3.3.1.
  • Other
    • Improved internal logging for tool configuration file paths (no impact on end-user functionality).

@alirana01 alirana01 self-assigned this Apr 22, 2025
Copy link

coderabbitai bot commented Apr 22, 2025

Walkthrough

This update introduces two new logging statements within the toolSetConfigFilePath() method in the ManageEspIdfVersionsHandler class to provide additional runtime information. The version numbers in both the feature definition (feature.xml) and the product configuration (idf.product) have been incremented from 3.3.0 to 3.3.1, reflecting a minor version update. No changes were made to the logic, exported entities, or the structure of the codebase beyond these updates.

Changes

File(s) Change Summary
bundles/com.espressif.idf.ui/src/com/espressif.idf/ui/tools/ManageEspIdfVersionsHandler.java Added two logging statements to the toolSetConfigFilePath() method for enhanced diagnostics.
features/com.espressif.idf.feature/feature.xml Updated the feature version from 3.3.0.qualifier to 3.3.1.qualifier.
releng/com.espressif.idf.product/idf.product Updated the product version from 3.3.0 to 3.3.1 and added a blank line before <plugins>.

Poem

In the warren of code, a version hops high,
From 3.3.0 to 3.3.1, watch it fly!
With logs now sprinkled for insight so bright,
The handler’s path is clear in the night.
A gentle nudge, a tidy tweak,
This rabbit’s release is sleek and chic!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

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 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

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

71-71: Appropriate logging for tool set configuration file path.

This logging statement captures the complete configuration file path, which is valuable for troubleshooting path-related issues. The spelling of "configuraion" contains a typo that should be corrected.

-		Logger.log("Tool Set configuraion file Path: " + stringBuilder.toString());
+		Logger.log("Tool Set configuration file Path: " + stringBuilder.toString());
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b9c4315 and bfa9b6c.

📒 Files selected for processing (3)
  • bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ManageEspIdfVersionsHandler.java (1 hunks)
  • features/com.espressif.idf.feature/feature.xml (1 hunks)
  • releng/com.espressif.idf.product/idf.product (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ManageEspIdfVersionsHandler.java (1)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/logging/Logger.java (1)
  • Logger (21-137)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (4)
releng/com.espressif.idf.product/idf.product (2)

4-4: Version number incremented appropriately.

The product version has been properly updated from 3.3.0 to 3.3.1, which aligns with the version update in the feature.xml file.


51-51: Whitespace formatting looks good.

The blank line added before the <plugins> element improves readability by separating logical sections.

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

68-68: Appropriate logging for workspace path.

This logging statement helps diagnose issues by recording the workspace path during the tool set configuration process. This addresses the user-reported issue mentioned in the PR objectives regarding ESP-IDF Manager logging.

features/com.espressif.idf.feature/feature.xml (1)

5-5: Version number incremented appropriately.

The feature version has been properly updated from 3.3.0.qualifier to 3.3.1.qualifier, maintaining consistency with the product version update.

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.

1 participant