refactor: Add audio export debug flag

[tphakala]

Add Realtime.Audio.Export.Debug flag to control audio buffer & export debug messages

[coderabbitai]

Walkthrough

The recent changes introduce a debug feature for audio export functionality. This involves modifications to configuration files and adding debug logging in the audio buffer processing. The Settings struct now includes a Debug field, allowing users to enable or disable debug messages for audio export.

Changes

Files	Change Summaries
internal/conf/config.go	Added Debug field to Export struct within Settings struct to enable audio export debug.
internal/conf/config.yaml	Added debug: false under export in realtime section to configure audio export debug.
internal/conf/defaults.go	Set default value for realtime.audio.export.debug to false.
internal/myaudio/audiobuffer.go	Imported config package and added debug logging based on conf.Setting().Realtime.Audio.Export.Debug.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Config
    participant AudioProcessor
    participant Logger

    User->>Config: Update config.yaml with debug: true
    Config->>AudioProcessor: Load settings
    AudioProcessor->>Logger: Check debug setting
    alt Debug enabled
        Logger->>AudioProcessor: Log debug info
    else Debug disabled
        Logger->>AudioProcessor: Skip debug logging
    end

Loading

Poem

In the code where changes flow,
Debugging lights begin to glow,
Settings tuned with careful thought,
Audio logs that now are caught.
Rabbits cheer with joyful might,
Debugging brings us pure delight!
🐰✨📜

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

• Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
• Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
• Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

• Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
• Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
• High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
• Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

---

Tip

Early Access Features

• gpt-4o model for chat

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

• 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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as 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 full the review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1aa3a01 and e541c71.

Files selected for processing (4)

• internal/conf/config.go (1 hunks)
• internal/conf/config.yaml (1 hunks)
• internal/conf/defaults.go (2 hunks)
• internal/myaudio/audiobuffer.go (4 hunks)

Files skipped from review due to trivial changes (1)

• internal/conf/config.yaml

Additional comments not posted (5)

internal/conf/defaults.go (1)

36-36: The addition of the default debug setting for audio export is correctly implemented.

internal/myaudio/audiobuffer.go (3)

67-69: Debug logging for buffer wrap-around is correctly implemented and will provide useful runtime information.

---

107-109: Debug logging for reading audio segments is well-placed and will help in troubleshooting and monitoring the buffer's behavior.

Also applies to: 114-116

---

127-129: The debug log for buffer fill status is a good addition for monitoring buffer readiness.

internal/conf/config.go (1)

52-52: The addition of the Debug field to the Export struct is correctly implemented and aligns with the PR's objectives.