[release-v3] Temporary Fix for v3 Timeouts

[davidvonthenen]

This supersedes this PR:
#179

I would have used that PR but there were Project Properties that needed to be updated beyond what was provided.

NOTE: This is going on the release-v3 branch and will tag a release from there.

Summary by CodeRabbit

Summary by CodeRabbit

• Chores

  • Updated project metadata including package ID, title, version, and authors.

• Bug Fixes

  • Implemented a temporary fix in the HTTP client utility to address a timeout control flow issue.

[davidvonthenen]

@coderabbitai review

[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 21 minutes and 7 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 e735bfa and 71588bc.

Walkthrough

The recent updates encompass changes to the overall Deepgram project, focusing on metadata adjustments in the Deepgram.csproj file and a bug fix in the HttpClientUtil.cs file within the Utilities namespace related to timeout settings.

Changes

File Path	Change Summary
Deepgram/Deepgram.csproj	Updated metadata: PackageId, Title, added Version, Authors; removed Company information.
.../Utilities/HttpClientUtil.cs	Implemented a bug fix in SetTimeOut method to adjust timeout value handling in HttpClient logic.
Deepgram.Tests/UtilitiesTests/HttpClientUtilTests.cs	Added namespaces: System, Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection. Added ExecuteAsync_NotExecutedWithinTimeout_ThrowsExecptionAsync method for testing timeout scenarios.

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>.
  • Generate unit-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a33a2b5 and dace961.

Files selected for processing (2)

• Deepgram/Deepgram.csproj (1 hunks)
• Deepgram/Utilities/HttpClientUtil.cs (1 hunks)

Additional comments: 2

Deepgram/Deepgram.csproj (2)

• 15-18: The updates to PackageId, Title, Version, and Authors in the project file are appropriate for reflecting the current state of the project and its versioning. However, ensure that the version number 3.4.1 accurately reflects the changes made in this release, especially considering this is a temporary fix for a known issue. It's also important to verify that these changes align with any versioning strategy or conventions the project follows.
• 19-19: The <Company /> tag is self-closing and appears to remove the company information from the project metadata. If this removal is intentional and aligns with the project's rebranding or organizational changes, this change is acceptable. However, ensure that this does not inadvertently affect any legal or attribution requirements that might rely on the company information being present in the project metadata.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e735bfa and 476f508.

Files selected for processing (2)

• Deepgram/Deepgram.csproj (1 hunks)
• Deepgram/Utilities/HttpClientUtil.cs (1 hunks)

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

• Deepgram/Deepgram.csproj
• Deepgram/Utilities/HttpClientUtil.cs

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e735bfa and ee5888a.

Files selected for processing (3)

• Deepgram.Tests/UtilitiesTests/HttpClientUtilTests.cs (2 hunks)
• Deepgram/Deepgram.csproj (1 hunks)
• Deepgram/Utilities/HttpClientUtil.cs (1 hunks)

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

• Deepgram/Deepgram.csproj
• Deepgram/Utilities/HttpClientUtil.cs

Additional comments: 2

Deepgram.Tests/UtilitiesTests/HttpClientUtilTests.cs (2)

• 1-1: Ensure the System namespace is used in this file. If not, consider removing it to keep the imports clean.
• 4-4: The Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection namespace seems unrelated to the test's functionality. Verify its necessity; if it's not used, remove it to avoid unnecessary dependencies.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e735bfa and 42c3449.

Files selected for processing (3)

• Deepgram.Tests/UtilitiesTests/HttpClientUtilTests.cs (2 hunks)
• Deepgram/Deepgram.csproj (1 hunks)
• Deepgram/Utilities/HttpClientUtil.cs (1 hunks)

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

• Deepgram.Tests/UtilitiesTests/HttpClientUtilTests.cs
• Deepgram/Deepgram.csproj
• Deepgram/Utilities/HttpClientUtil.cs

[davidvonthenen]

Ok. So I have done a ton of analysis on this issue. The analysis here is correct but also has a ton of other consequences:
#127 (comment)

Immediate problems - as the above analysis points out, we can't re-create the client because all of the clients have pointers to the initial httpclient created when the clients were initialized. we need to remove the creation of the client in order to set the timeout of the original clients. this also means that the timeout value is shared among all clients

things to note - a single HttpClientUtil() object is not thread-safe; consequently neither is DeepgramClient. Setting the timeout value to multiple different values in multiple threads based on need (for example, uploading a large file) might inadvertently increase the timeouts for other requests. The same is true for smaller values... you might inadvertently (like for a simple get) decrease the timeout for operations needing more time in another thread. the take away, you must have a HttpClientUtil() per thread. To be on the safest side while using timeouts, you need to consider using a timeout value that is a high watermark value for all operations in a single thread when using a single DeepgramClient.

Calling an attempting to set the timeout multiple times (ie after the first initial GET/PUT/etc), will yield in an exception:

System.InvalidOperationException : This instance has already started one or more requests. Properties can only be modified before sending the first request.

Hence the need for the high watermark value (ie time for your longest operation) if a single DeepgramClient is used in each thread.