fix: diagnostics: ensure commands run with UTF-8 charset

[ljm42]

Summary by CodeRabbit

• New Features

  • Added enhanced error logging for command executions, including timestamps and detailed information in a diagnostics error log.

• Refactor

  • Improved internal formatting for better readability.
  • Updated command execution to capture and log errors without affecting existing output behavior.

[coderabbitai]

Walkthrough

The script in the diagnostics plugin was updated to enhance error handling and logging. A new log_error function was introduced to record error messages with timestamps and optional command context to a diagnostics error log file. The run function was modified to capture command exit codes and standard error output, and to invoke log_error when a command fails. The script now also requires the Wrappers.php file. These changes collectively improve the script's ability to log and track errors during command execution.

Changes

File(s)	Change Summary
emhttp/plugins/dynamix/scripts/diagnostics	Added log_error function for error logging; updated run to log errors on command failure and capture stderr; required Wrappers.php; minor reformatting of write function.

Sequence Diagram(s)

sequenceDiagram
    participant Script
    participant Wrappers
    participant System

    Script->>Wrappers: require 'Wrappers.php'
    Script->>System: run($cmd) with exec, capture stdout & stderr
    alt Command fails (non-zero exit code)
        Script->>Script: log_error(message, $cmd)
        Script->>File: Write error log entry with timestamp
    end
    Script->>Caller: Return command output

Loading

Possibly related PRs

• fix: diagnostics improvements #2163: Adds a log_error function and modifies the run function in the same diagnostics script to log errors and capture exit codes, indicating a direct code-level connection.

Poem

A bunny in diagnostics land,
Now logs each error with a careful hand.
When commands go astray,
Their troubles won’t stay—
The log records all, just as planned!
🐇📝

---

📜 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 664daff and fef99b9.

📒 Files selected for processing (1)

• emhttp/plugins/dynamix/scripts/diagnostics (2 hunks)

🔇 Additional comments (4)

emhttp/plugins/dynamix/scripts/diagnostics (4)

29-29: Added new dependency file.

The script now requires Wrappers.php, which adds additional functionality available to the script. This is a good practice for modular code organization.

---

48-52: Improved code structure with explicit braces.

The write function now uses explicit braces for the loop body, which improves code clarity and reduces the risk of logical errors when modifying the code in the future.

---

54-64: Well-implemented error logging function.

The new log_error function properly captures error messages with timestamps and optional command context, writing them to a dedicated log file. This significantly improves the ability to diagnose issues with command execution in the diagnostics script.

---

66-77:

Details

❓ Verification inconclusive

Enhanced command execution with UTF-8 charset and error logging.

The modified run function now:

1. Sets the LC_ALL=en_US.UTF-8 environment variable to ensure consistent UTF-8 output
2. Captures stderr output with 2>&1
3. Records the command exit code
4. Logs error messages when commands fail

This is a valuable improvement that will help diagnose issues when commands fail during diagnostics collection.

---

🏁 Script executed:

#!/bin/bash
# Verify that the en_US.UTF-8 locale is available on typical Unraid systems
# This checks if LC_ALL=en_US.UTF-8 is a valid setting

if locale -a | grep -q "en_US.UTF-8"; then
  echo "en_US.UTF-8 locale is available (expected)"
else
  echo "WARNING: en_US.UTF-8 locale not found"
  echo "Available locales:"
  locale -a
fi

Length of output: 372

---

Ensure UTF-8 locale is available on target systems

The updated run function correctly forces LC_ALL=en_US.UTF-8 for consistent UTF-8 output and adds error logging on non-zero exit codes. However, if the en_US.UTF-8 locale isn’t installed on Unraid or other target environments, this override could cause commands to fail.

Please verify that en_US.UTF-8 is available on your deployment systems or implement a fallback (for example, omitting the LC_ALL prefix when the locale is missing) to prevent unexpected failures.

---

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