feat: adds support for IUM #413

jpvajda · 2025-06-27T20:22:32Z

Proposed changes

Adds support for inject user message
Adds unit test to test the code

Types of changes

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

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)

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

Summary by CodeRabbit

New Features
- Added the ability to inject user messages directly into the conversation from the client.
Tests
- Introduced new unit tests to verify correct handling and sending of injected user messages with various content types.

coderabbitai · 2025-06-27T20:23:03Z

Walkthrough

A new public method, injectUserMessage, was added to the AgentLiveClient class to allow sending user-originated messages to the agent in JSON format. Corresponding unit tests were introduced to verify that this method correctly formats and sends messages for various input strings.

Changes

File(s)	Change Summary
src/packages/AgentLiveClient.ts	Added public method `injectUserMessage` to send JSON user messages to the agent.
tests/unit/live-client-message-handling.test.ts	Added unit tests for `injectUserMessage`, verifying correct message formatting and sending.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AgentLiveClient
    participant Agent (WebSocket)

    User->>AgentLiveClient: injectUserMessage(content)
    AgentLiveClient->>Agent (WebSocket): Send JSON { type: "InjectUserMessage", content }

📜 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 81689db and dd54ba4.

📒 Files selected for processing (2)

src/packages/AgentLiveClient.ts (1 hunks)
tests/unit/live-client-message-handling.test.ts (1 hunks)

🔇 Additional comments (3)

src/packages/AgentLiveClient.ts (1)

143-152: Excellent implementation with clear documentation.

The injectUserMessage method follows the established patterns in the codebase and is well-documented with practical examples. The implementation correctly sends a JSON message with the appropriate type and content structure.

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

540-547: Good basic functionality test.

The test correctly verifies that injectUserMessage sends the expected JSON message structure with the proper type and content.

549-566: Excellent comprehensive test coverage.

This test thoroughly covers various content types including edge cases like empty strings and multi-line content. The proper use of jest.clearAllMocks() ensures test isolation between iterations, which is a best practice for parameterized tests.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Post Copyable Unit Tests in Comment
Commit Unit Tests in branch feat/agent-ium

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

🪧 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 auto-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.

jpvajda · 2025-06-27T20:23:35Z

Please note: we plan on release this feature with the Fall Back feature, so this shouldn't merged until both PRs are reviewed and ready.

jpvajda · 2025-06-27T20:26:44Z

There errors in CI Test that failed seem unrelated to my change introduced here:

/home/runner/work/deepgram-js-sdk/deepgram-js-sdk/examples/node-agent-live/index.js
Error:   2:1  error  Definition for rule '@typescript-eslint/no-var-requires' was not found     @typescript-eslint/no-var-requires
Error:   2:1  error  Definition for rule '@typescript-eslint/no-require-imports' was not found  @typescript-eslint/no-require-imports

/home/runner/work/deepgram-js-sdk/deepgram-js-sdk/examples/node-live-token/index.js
Error:   2:1  error  Definition for rule '@typescript-eslint/no-var-requires' was not found     @typescript-eslint/no-var-requires
Error:   2:1  error  Definition for rule '@typescript-eslint/no-require-imports' was not found  @typescript-eslint/no-require-imports

/home/runner/work/deepgram-js-sdk/deepgram-js-sdk/examples/node-live/index.js
Error:   2:1  error  Definition for rule '@typescript-eslint/no-var-requires' was not found     @typescript-eslint/no-var-requires
Error:   2:1  error  Definition for rule '@typescript-eslint/no-require-imports' was not found  @typescript-eslint/no-require-imports

/home/runner/work/deepgram-js-sdk/deepgram-js-sdk/examples/node-prerecorded/index.js
Error:   2:1  error  Definition for rule '@typescript-eslint/no-var-requires' was not found     @typescript-eslint/no-var-requires
Error:   2:1  error  Definition for rule '@typescript-eslint/no-require-imports' was not found  @typescript-eslint/no-require-imports

/home/runner/work/deepgram-js-sdk/deepgram-js-sdk/examples/node-read/index.js
Error:   2:1  error  Definition for rule '@typescript-eslint/no-var-requires' was not found     @typescript-eslint/no-var-requires
Error:   2:1  error  Definition for rule '@typescript-eslint/no-require-imports' was not found  @typescript-eslint/no-require-imports

/home/runner/work/deepgram-js-sdk/deepgram-js-sdk/examples/node-speak-live/index.js
Error:   2:1  error  Definition for rule '@typescript-eslint/no-var-requires' was not found     @typescript-eslint/no-var-requires
Error:   2:1  error  Definition for rule '@typescript-eslint/no-require-imports' was not found  @typescript-eslint/no-require-imports

/home/runner/work/deepgram-js-sdk/deepgram-js-sdk/examples/node-speak/index.js
Error:   2:1  error  Definition for rule '@typescript-eslint/no-var-requires' was not found     @typescript-eslint/no-var-requires
Error:   2:1  error  Definition for rule '@typescript-eslint/no-require-imports' was not found  @typescript-eslint/no-require-imports

jpvajda · 2025-07-03T20:54:25Z

I built a simple local test app to test this out. Results are ✅

🎉 SUCCESS! The inject user message feature is working perfectly!

Test Results Summary:

✅ All 4 test suites passed:

Basic inject user message - Correctly sends {"type":"InjectUserMessage","content":"..."}
Multiple user messages - Handles various message types including multi-line and empty strings
Complete conversation flow - Works properly with agent responses and events
Edge cases - Handles special characters, emojis, long messages, and JSON-like content

Key Findings:

10 messages sent successfully - All in the correct format
Event handling works - Open, Welcome, ConversationText, and AgentThinking events received
WebSocket mocking effective - No real network calls needed for testing
Feature is production-ready - Handles edge cases gracefully

Next Step: You can now confidently use the injectUserMessage() feature in your applications! The test demonstrates it works correctly with mocked WebSocket connections, which means it will work with real connections too.

Future Steps:

Clean up the test file when done (rm test-inject-user-message.js)
Integrate the injectUserMessage() method into your production code
Consider adding this test pattern to your official test suite

The inject user message feature is working correctly beyond the unit tests! 🚀

feat: adds support for IUM

dd54ba4

jpvajda requested review from lukeocodes and naomi-lgbt June 27, 2025 20:22

jpvajda changed the title ~~feat: adds support for IUM~~ [WIP] feat: adds support for IUM Jun 27, 2025

jpvajda mentioned this pull request Jun 27, 2025

feat: adds support for speak fallback #414

Open

8 tasks

jpvajda changed the title ~~[WIP] feat: adds support for IUM~~ feat: adds support for IUM Jul 2, 2025

Merge branch 'main' into feat/agent-ium

af3db12

lukeocodes approved these changes Jul 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: adds support for IUM #413

feat: adds support for IUM #413

Uh oh!

jpvajda commented Jun 27, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

jpvajda commented Jun 27, 2025

Uh oh!

jpvajda commented Jun 27, 2025

Uh oh!

jpvajda commented Jul 3, 2025

Uh oh!

Uh oh!

feat: adds support for IUM #413

Are you sure you want to change the base?

feat: adds support for IUM #413

Uh oh!

Conversation

jpvajda commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Types of changes

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

jpvajda commented Jun 27, 2025

Uh oh!

jpvajda commented Jun 27, 2025

Uh oh!

jpvajda commented Jul 3, 2025

Test Results Summary:

Key Findings:

Uh oh!

Uh oh!

jpvajda commented Jun 27, 2025 •

edited

Loading

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)