IEP-1530 IDF console cleared when GDB starts

[sigmaaa]

Description

When the GDB client is started, the IDF process console output is cleared. This results in the removal of OpenOCD startup messages, which are often essential for understanding initialization status, connection issues, or board-specific output.

Check the video before the fix:

https://github.com/user-attachments/assets/0458c69e-225d-4c76-abee-bfc93c2f4899

And after the fix:

https://github.com/user-attachments/assets/4c72cc77-4e62-4dac-b2bb-16748e672521

Note: The current implementation has a drawback: when users start only GDB clients without OpenOCD, the console will not be cleared on each start. However, I believe this case is rare and not critical, as it's still possible to clear the console manually.

Fixes # (IEP-1530)

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)

How has this been tested?

• run debug

Test Configuration:

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

Dependent components impacted by this PR:

• Idf process console

Checklist

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

Summary by CodeRabbit

• Bug Fixes
  • The console will now only be cleared at the start of OpenOCD processes, preventing unnecessary clearing for other processes.

[coderabbitai[bot]]

Walkthrough

The update changes how the console is cleared during the initialization of the StreamListener class. Now, the console will only be cleared if the process label includes the substring "openocd", rather than clearing the console for all processes.

Changes

File(s)	Change Summary
bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/process/StreamListener.java	Restricts console clearing in the constructor to only occur when the process label contains "openocd".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StreamListener
    participant Console

    User ->> StreamListener: Instantiate with process label
    StreamListener ->> StreamListener: Check if label contains "openocd"
    alt Label contains "openocd"
        StreamListener ->> Console: Clear console
    else Label does not contain "openocd"
        StreamListener -->> Console: Do nothing
    end

Suggested reviewers

• AndriiFilippov
• alirana01
• kolipakakondal

Poem

In the warren of code where the streams do flow,
Only "openocd" can clear the console’s glow.
No more sweeping for every new guest,
Just a tidy-up when debugging’s addressed.
🐇✨

[!TIP]

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3e7c6793e4f506dd2ba28fc783799304e14a4f85 and d70b515e799ef3feafc3a565a75a3993c05cfea1.

📒 Files selected for processing (1)

• bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/process/StreamListener.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: build_macos
• GitHub Check: build

🔇 Additional comments (1)

bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/process/StreamListener.java (1)

54-59:

✅ Verification successful

Looks good! This change appropriately addresses the issue.

The modification correctly implements the intended behavior by only clearing the console when OpenOCD starts, preserving important output when GDB clients connect. This selective clearing approach effectively solves the issue described in the PR without breaking existing functionality.

For future maintenance, consider verifying that all OpenOCD process labels consistently contain the "openocd" substring. If process naming conventions change in the future, this condition might need adjustment.

---

🏁 Script executed:

#!/bin/bash
# Check for any existing process creation code that might use OpenOCD
# but with different naming patterns

rg -i "process.*openocd" --type java
rg -i "label.*openocd" --type java

Length of output: 1604

---

Selective OpenOCD console clearing verified

Looks good! I’ve confirmed that all existing OpenOCD‐related processes use the lowercase "openocd" substring in their labels, so this check will reliably clear the console only when OpenOCD starts:

• bundles/com.espressif.idf.debug.gdbjtag.openocd/src/.../Launch.java: label passed to DebugPlugin.newProcess includes "openocd".
• bundles/com.espressif.idf.debug.gdbjtag.openocd/src/.../StreamListener.java: uses iProcess.getLabel().contains("openocd").

No further changes are needed. For future maintenance, if process naming conventions evolve, just update this substring check accordingly.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.