Exception Handling and Examples for Expected Failures

[dvonthenen]

Addresses issue: https://github.com/deepgram/deepgram-dotnet-sdk/issues/252

This was the stress test to throw as many exceptions and to test edge cases as best as I could. In these scenarios, I found a few issues.

Changes include:

• In AbstractRestClient just better logging of the exceptions based on log levels
• In LiveClient, this is where I found a couple of issues went it came to cancelling. These changes include:
  • Connect() and Stop() Each get their own CancelToken to be used for only that operation. That is the token that is passed into the function. That token is optional and a default will be used to timeout those operations in 5 seconds.
  • The internal CancelToken is only used for cancelling out of threads for thread management. I initially try to see if I could compact these two into a single token, but that proves to be "janky" and unpredictable. KISS.
  • Fixes exception logging similar to that of AbstractRestClient.
• Implemented the ability to disable Logging
• Cleaned up some examples for Demo purposes.

Summary by CodeRabbit

• New Features
  • Added new projects for handling different scenarios such as trigger cancellation, bad host detection, and WebSocket management.
  • Introduced a default timeout for connect/disconnect operations to improve reliability.
  • Implemented a new logging level to allow disabling logs, enhancing user control over application verbosity.
• Improvements
  • Enhanced logging statements across the application for better clarity and debugging.
  • Improved exception handling messages to include more detailed information.
  • Updated WebSocket closure logic for more robust connection management.
• Documentation
  • Added examples and tests showcasing the usage of the SDK for microphone streaming and handling specific failure scenarios.
• Bug Fixes
  • Corrected project reference paths to resolve file path issues in test projects.

[coderabbitai[bot]]

Walkthrough

The updates across the solution primarily focus on enhancing logging, exception handling, and token management for various components, including REST clients, WebSocket connections, and the microphone streaming example. New projects have been introduced, reflecting a broader test coverage for expected failures and new functionalities. Adjustments in project paths and references aim to streamline the solution structure. The addition of a Disable log level and specific timeout constants further refine the operational parameters and debugging capabilities.

Changes

File(s)	Summary
Deepgram.Dev.sln, .../exercise_timeout/ExerciseTimeout.csproj	Adjustments in project declarations and paths, including new projects and relocations.
Deepgram/Abstractions/AbstractRestClient.cs, Deepgram/Clients/Live/v1/Client.cs, examples/streaming/microphone/Program.cs	Enhanced logging, method signature clarity, and exception handling. Adjustments in token usage and logging levels.
Deepgram/Clients/Live/v1/Constants.cs, Deepgram/Logger/Constants.cs	Introduction of DefaultConnectTimeout constant and Disable log level.
Deepgram/Logger/Log.cs	Handling for Disable log level to log fatal events to the console.
tests/expected_failures/rest/bad_host/BadHost.csproj, tests/expected_failures/rest/trigger_cancel/TriggerCancel.csproj	New .NET project files targeting net6.0, including references and features.
tests/expected_failures/rest/bad_host/Program.cs, tests/expected_failures/rest/trigger_cancel/Program.cs, tests/expected_failures/websocket/exercise_timeout/Program.cs	Functionality introductions for transcription and logging adjustments, including handling exceptions and cancellation.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

---

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 a review. This is useful when automatic reviews are disabled for the repository. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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/coderabbit-overrides.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.