search

deepgram / deepgram-dotnet-sdk

.NET SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
28 stars 32 forks source link

Bonked `rc.1` + ImplementHTTP Webcast Example + Model Params When Null #271

Closed dvonthenen closed 4 months ago

dvonthenen commented 4 months ago

First thing, rc.1 is broken and it took me a few hours to figure out why. The why I am surprised that the compile didn't warn or flag a problem but instead it caused all REST calls to just timeout. I still don't know why the logging would cause the timeout, but I know that this is the root cause.

The root cause is that the Logger is a Singleton that doesn't normally get instantiated until the Library.Init is called; however, by placing this single log line in Deepgram/Utilities/QueryParameterUtil.cs will cause the Logger to get created because the utility class itself is a static class (this class and subsequently the logger get created on application start) seen here: https://github.com/deepgram/deepgram-dotnet-sdk/pull/271/files#diff-c64fc6a76bdff754827d325339cfe10b6649c111860869dc9831bcbbd4cc4f66L22

Why the logger would hold up the timer and the REST SendAsync call... I would need to think about it. Again, I know that this is the line causing the bonk on all REST calls in rc.1. So at least the problem is fixed.

Second, added an example for doing HTTP Webcast from BBC to LiveClient.

Third, this exposed some params that need to be null'able when certain options are not set. Particularly, in PreRecorded and Live Models.

coderabbitai[bot] commented 4 months ago

Walkthrough

The update introduces two new projects, enhances logging procedures, and adjusts properties in various models to support nullable values. Additionally, improvements are made to example applications, expanding functionality in the streaming example and refining the intent analysis program. These changes aim to enhance the flexibility, debuggability, and overall functionality of the Deepgram .NET SDK.

Changes

File Path Change Summary
Deepgram.Dev.sln Added "http" and "Streaming" projects with Debug and Release configurations.
.../HttpClientFactory.cs Enhanced logging by logging HttpClient ID before instance creation.
.../Live/v1/*.cs Updated multiple classes to allow nullable properties.
.../PreRecorded/v1/Topic.cs Modified Text property to allow nullable values.
.../Clients/*/Client.cs Enhanced logging by serializing schema objects for various operations.
examples/analyze/intent/Program.cs Improved logging, increased timeout, and updated method call in intent analysis example.
examples/prerecorded/file/Program.cs Updated libraries, HTTP handling, timeouts, and cancellation token usage in prerecorded example.
examples/streaming/http/Program.cs Added functionality for connecting to a live streaming service.
examples/streaming/http/Streaming.csproj New project file for streaming example, targeting .NET 6.0 with nullable reference types and project references.
Deepgram/Utilities/JsonSerializeOptions.cs Introduced JsonSerializeOptions class for default JSON serialization options.
Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between db50b7c2e12c869a41158dce1f465f3fd5b99007 and 47f31d49fda3b97ac3645e6887b27fe993434727.
Files selected for processing (22) * Deepgram.Dev.sln (3 hunks) * Deepgram/Abstractions/AbstractRestClient.cs (7 hunks) * Deepgram/Clients/Analyze/v1/Client.cs (4 hunks) * Deepgram/Clients/Live/v1/Client.cs (1 hunks) * Deepgram/Clients/Manage/v1/Client.cs (8 hunks) * Deepgram/Clients/OnPrem/v1/Client.cs (1 hunks) * Deepgram/Clients/PreRecorded/v1/Client.cs (4 hunks) * Deepgram/Clients/Speak/v1/Client.cs (3 hunks) * Deepgram/Factory/HttpClientFactory.cs (1 hunks) * Deepgram/Models/Live/v1/Alternative.cs (1 hunks) * Deepgram/Models/Live/v1/Channel.cs (1 hunks) * Deepgram/Models/Live/v1/Metadata.cs (1 hunks) * Deepgram/Models/Live/v1/ModelInfo.cs (1 hunks) * Deepgram/Models/Live/v1/ResultResponse.cs (1 hunks) * Deepgram/Models/Live/v1/Word.cs (1 hunks) * Deepgram/Models/PreRecorded/v1/Topic.cs (1 hunks) * Deepgram/Utilities/JsonSerializeOptions.cs (1 hunks) * Deepgram/Utilities/QueryParameterUtil.cs (1 hunks) * examples/analyze/intent/Program.cs (3 hunks) * examples/prerecorded/file/Program.cs (4 hunks) * examples/streaming/http/Program.cs (1 hunks) * examples/streaming/http/Streaming.csproj (1 hunks)
Files skipped from review as they are similar to previous changes (20) * Deepgram.Dev.sln * Deepgram/Abstractions/AbstractRestClient.cs * Deepgram/Clients/Analyze/v1/Client.cs * Deepgram/Clients/Live/v1/Client.cs * Deepgram/Clients/Manage/v1/Client.cs * Deepgram/Clients/OnPrem/v1/Client.cs * Deepgram/Clients/PreRecorded/v1/Client.cs * Deepgram/Clients/Speak/v1/Client.cs * Deepgram/Models/Live/v1/Alternative.cs * Deepgram/Models/Live/v1/Channel.cs * Deepgram/Models/Live/v1/Metadata.cs * Deepgram/Models/Live/v1/ModelInfo.cs * Deepgram/Models/Live/v1/ResultResponse.cs * Deepgram/Models/Live/v1/Word.cs * Deepgram/Models/PreRecorded/v1/Topic.cs * Deepgram/Utilities/JsonSerializeOptions.cs * examples/analyze/intent/Program.cs * examples/prerecorded/file/Program.cs * examples/streaming/http/Program.cs * examples/streaming/http/Streaming.csproj
Additional Context Used
GitHub Check Runs (4)
test (8.0.x) success (3)
Deepgram/Factory/HttpClientFactory.cs: [warning] 22-22: Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.
test (7.0.x) success (3)
Deepgram/Factory/HttpClientFactory.cs: [warning] 22-22: Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.
test (6.0.x) success (3)
Deepgram/Factory/HttpClientFactory.cs: [warning] 22-22: Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.
build success (4)
Deepgram/Factory/HttpClientFactory.cs: [warning] 22-22: Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'. --- Deepgram/Factory/HttpClientFactory.cs: [warning] 22-22: Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.
Additional comments not posted (2)
Deepgram/Factory/HttpClientFactory.cs (2)
`19-19`: Logging the HttpClient ID enhances traceability and debugging. The concerns about a possible null reference are addressed by the preceding check ensuring `httpId` is not null. --- `22-22`: The configuration of the HttpClient with retry policies and service provider setup is correctly implemented. The static analysis concerns about `httpId` being null are already mitigated by earlier code.
--- 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/schema.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.