fix: fixes mips_opt_out placement

[jpvajda]

PR Summary: Fix mips_opt_out Setting Location

TL;DR

Fixed incorrect placement of mips_opt_out setting from agent.mip_opt_out to top-level mips_opt_out to match API specification. Also corrected the naming from mip_opt_out to mips_opt_out (with 's').

What Changed

• Schema Structure: Moved mips_opt_out from nested agent object to top-level Settings object
• Property Name: Fixed inconsistent naming from mip_opt_out to mips_opt_out
• TypeScript Interface: Updated AgentLiveSchema interface to reflect correct structure
• Unit Tests: Updated test cases to validate the new top-level placement

Testing

• ✅ All Unit Tests Pass: 53 test suites, 232 tests passed
• ✅ Schema Testing Demo: Created and ran focused schema validation tests
• ✅ Regression Testing: Verified existing functionality remains intact
• ✅ Edge Cases: Tested with true, false, and omitted values

API Specification Compliance

• ✅ Before: agent.mip_opt_out (INCORRECT - nested under agent)
• ✅ After: mips_opt_out (CORRECT - top-level in Settings)
• ✅ Matches Spec: Now fully compliant with provided API specification
• ✅ Default Behavior: Maintains default: false as specified

Usage Example

// ✅ CORRECT (New)
const config = {
  type: "Settings",
  mips_opt_out: true,  // Top-level setting
  audio: { /* ... */ },
  agent: { /* ... */ }
};

// ❌ INCORRECT (Old) 
const config = {
  type: "Settings", 
  audio: { /* ... */ },
  agent: {
    mip_opt_out: true  // Wrong location
  }
};

Files Modified

1. src/lib/types/AgentLiveSchema.ts

   • Moved mips_opt_out from agent object to top-level interface
   • Updated JSDoc comments for correct placement

2. tests/unit/live-client-message-handling.test.ts

   • Updated test descriptions (mip_opt_out → mips_opt_out)
   • Modified test configurations to use top-level mips_opt_out
   • Maintained all existing test coverage

Quality Assurance

• ✅ Backward Compatibility: No breaking changes to existing API methods

• ✅ Type Safety: TypeScript interface correctly enforces new structure

• ✅ Test Coverage: 100% test coverage maintained for mips_opt_out functionality

• ✅ Code Standards: Follows existing codebase patterns and conventions

• ✅ Documentation: JSDoc comments updated to reflect correct usage

• Bugfix (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)

• Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• I have read the CONTRIBUTING doc
• I have lint'ed all of my code using repo standards
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Summary by CodeRabbit

• Refactor

  • Updated the opt-out property for the Deepgram Model Improvement Program to be at the top level of the configuration, renamed to mips_opt_out.

• Tests

  • Updated tests to reflect the new mips_opt_out property location and naming, ensuring correct behavior for all scenarios.

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1210890789996957

[coderabbitai]

Walkthrough

The AgentLiveSchema interface was updated by removing the mip_opt_out property from the nested agent object and introducing a new top-level property, mips_opt_out. Corresponding unit tests were updated to reflect this change, ensuring the property is now handled at the top level in configuration objects.

Changes

File(s)	Change Summary
src/lib/types/AgentLiveSchema.ts	Removed mip_opt_out from agent object; added mips_opt_out at the top level of interface.
tests/unit/live-client-message-handling.test.ts	Updated tests to use top-level mips_opt_out property; renamed related test descriptions.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite as Test Suite
    participant AgentLiveClient as AgentLiveClient
    participant Config as Config Object

    TestSuite->>Config: Create config with mips_opt_out at top level
    TestSuite->>AgentLiveClient: Initialize with config
    AgentLiveClient->>AgentLiveClient: Process config (read mips_opt_out)
    AgentLiveClient->>TestSuite: Send Settings message with mips_opt_out

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

• feat: adds support for agent mip_opt_out #421: Originally introduced the mip_opt_out property inside the nested agent object; this PR directly modifies that property by relocating and renaming it.

---

📜 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 8cc8dde and c835528.

📒 Files selected for processing (1)

• src/lib/types/AgentLiveSchema.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/lib/types/AgentLiveSchema.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Test Browser Builds

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/mips_opt_out

---

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 generate unit tests to generate unit tests 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.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.17%. Comparing base (76f9653) to head (c835528).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #425   +/-   ##
=======================================
  Coverage   75.17%   75.17%           
=======================================
  Files          26       26           
  Lines        1152     1152           
  Branches      292      292           
=======================================
  Hits          866      866           
  Misses        286      286           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.