Update WebSocket Listen Reconnect Example

[davidvonthenen]

Proposed changes

This updates the Listen WS example to add more color to what is going on. It was also missing from the Developer Solution file for some reason.

Types of changes

What types of changes does your code introduce to the community .NET SDK?
Put an x in the boxes that apply

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

Further comments

NA

Summary by CodeRabbit

• New Features

  • Introduced a new project for handling reconnections: reconnect_same_object.
  • Added a corresponding test project: ReconnectStreaming.

• Improvements

  • Enhanced WebSocket client instantiation for better flexibility and future enhancements.
  • Updated logic to support multiple reconnections to the WebSocket client, improving session handling.

• Bug Fixes

  • Adjusted project dependencies to include necessary references for new functionalities.

[coderabbitai]

Warning

Rate limit exceeded

@dvonthenen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 0 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between dff557d and 6811cd2.

Walkthrough

The pull request introduces several modifications to the Deepgram.Dev.sln solution file, including the addition of two new projects: reconnect_same_object and its corresponding test project ReconnectStreaming. Additionally, the instantiation logic for the ListenWebSocketClient in the Program.cs file has been updated to utilize a factory method. The Program.cs in the reconnect_same_object tests has undergone significant restructuring to support multiple reconnections to the WebSocket client. Lastly, the ReconnectStreaming.csproj file has been updated to include a reference to the Deepgram.Microphone project.

Changes

File Path	Change Summary
Deepgram.Dev.sln	Added projects: reconnect_same_object and ReconnectStreaming. Updated global sections to include these projects.
examples/speech-to-text/websocket/microphone/Program.cs	Updated instantiation of ListenWebSocketClient to use ClientFactory.CreateListenWebSocketClient.
tests/edge_cases/reconnect_same_object/Program.cs	Restructured connection logic to support multiple WebSocket client instances in a loop. Updated instantiation to use ClientFactory.CreateListenWebSocketClient.
tests/edge_cases/reconnect_same_object/ReconnectStreaming.csproj	Added project reference to Deepgram.Microphone.

Possibly related PRs

• Improve WebSocketMessage Buffer Length Handling #337: The changes in the WebSocketMessage class constructor and property directly relate to the handling of WebSocket messages, which may be relevant for the new ReconnectStreaming project that involves WebSocket connections.

Suggested reviewers

• jpvajda
• SandraRodgers
• naomi-lgbt
• lukeocodes

---

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

[coderabbitai]

Actionable comments posted: 6

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7125208 and dff557d.

📒 Files selected for processing (4)

• Deepgram.Dev.sln (3 hunks)
• examples/speech-to-text/websocket/microphone/Program.cs (1 hunks)
• tests/edge_cases/reconnect_same_object/Program.cs (2 hunks)
• tests/edge_cases/reconnect_same_object/ReconnectStreaming.csproj (1 hunks)

🔇 Additional comments (5)

tests/edge_cases/reconnect_same_object/ReconnectStreaming.csproj (1)

11-11: LGTM! Verify project structure for the new reference.

The addition of the Deepgram.Microphone.csproj reference aligns with the PR objectives and is likely necessary for the WebSocket Listen Reconnect Example functionality.

Please run the following script to verify the project structure and ensure the referenced project exists:

✅ Verification successful

Project reference verified successfully.

The Deepgram.Microphone.csproj file exists in the specified location.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of the Deepgram.Microphone.csproj file

# Test: Check if the Deepgram.Microphone.csproj file exists
# Expect: The file should exist in the specified location
fd -p "Deepgram.Microphone/Deepgram.Microphone.csproj" --max-depth 4

Length of output: 115

Deepgram.Dev.sln (4)

168-171: New project addition looks good.

The new "ReconnectStreaming" project has been properly added to the solution under the "reconnect_same_object" folder. This structure is consistent with other test projects in the solution.

---

310-313: Project configuration is correct.

The configuration for the new "ReconnectStreaming" project has been properly set up with both Debug and Release configurations. This is consistent with other projects in the solution.

---

393-394: Nested project structure is appropriate.

The new "ReconnectStreaming" project is correctly nested under the "reconnect_same_object" folder within the "edge_cases" category. This structure is logical and consistent with the organization of other test projects in the solution.

---

168-171: Overall, the changes to the solution file are well-structured and consistent.

The addition of the new "ReconnectStreaming" project, its configuration, and its placement within the solution structure have been implemented correctly. These changes align with the existing patterns in the solution file and follow best practices for organizing test projects.

Also applies to: 310-313, 393-394