fix: make IDE error log visible in generated bug report - #1493
Open
kolipakakondal wants to merge 1 commit into
Open
fix: make IDE error log visible in generated bug report#1493kolipakakondal wants to merge 1 commit into
kolipakakondal wants to merge 1 commit into
Conversation
Rename Eclipse's hidden .log to ide_error_log.log when packaging so Finder and other file managers show it in the report.
📝 WalkthroughWalkthroughBug report generation now renames hidden IDE metadata log files with an ChangesIDE log naming
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@bundles/com.espressif.idf.core/src/com/espressif/idf/core/bug/BugReportGenerator.java`:
- Around line 194-200: Update getReportLogFileName to ensure the generated
report filename is unique when the destination already exists, including
collisions between the renamed hidden .log file and an existing visible
ide_error_log.log. Preserve the current naming behavior when no collision
occurs, and add a test covering both source files being copied into a single
report.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 2cd7c5d2-8122-409b-bc40-720e85566c9c
📒 Files selected for processing (2)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/bug/BugReportGenerator.javatests/com.espressif.idf.core.test/src/com/espressif/idf/core/bug/test/BugReportGeneratorTest.java
Comment on lines
+194
to
+200
| public static String getReportLogFileName(String metadataFileName) | ||
| { | ||
| if (metadataFileName.startsWith(".")) //$NON-NLS-1$ | ||
| { | ||
| return IDE_LOG_REPORT_NAME_PREFIX + metadataFileName; | ||
| } | ||
| return metadataFileName; |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect the destination-conflict behavior of FileUtil.copyFile.
fd 'FileUtil.java' . -x sh -c '
echo "=== $1 ==="
rg -n -C 8 "\bcopyFile\s*\(" "$1"
' sh {}
# Find existing tests and filename-copy call sites.
rg -n -C 5 'getReportLogFileName|copyFile\(|ide_error_log\.log' \
bundles testsRepository: espressif/idf-eclipse-plugin
Length of output: 10041
Prevent report filename collisions.
.log is renamed to ide_error_log.log, but a visible ide_error_log.log uses the same destination path. Use a unique report name when the destination already exists. Add a test that copies both source files into one report.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@bundles/com.espressif.idf.core/src/com/espressif/idf/core/bug/BugReportGenerator.java`
around lines 194 - 200, Update getReportLogFileName to ensure the generated
report filename is unique when the destination already exists, including
collisions between the renamed hidden .log file and an existing visible
ide_error_log.log. Preserve the current naming behavior when no collision
occurs, and add a test covering both source files being copied into a single
report.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rename Eclipse's hidden .log to ide_error_log.log when packaging so Finder and other file managers show it in the report.
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.
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 Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit
Bug Fixes
.logfilename, making them easier to identify and open.Tests