Fix DefaultTimeouts on REST and WS Operations

[davidvonthenen]

This just fixes the default timeout on REST operations to 30 seconds and WS connect/disconnect to 5 seconds.

[coderabbitai]

Walkthrough

This update introduces adjustments to timeout settings and method behavior within the Deepgram SDK. Notably, it reduces the default REST timeout for improved responsiveness and introduces a specific disconnect timeout. These changes enhance the SDK's efficiency and reliability in managing connections and disconnections, aligning with user expectations for quick and stable performance.

Changes

Files	Change Summary
.../Abstractions/Constants.cs	Reduced DefaultRESTTimeout from 5 minutes to 30 seconds.
.../Live/v1/Client.cs	Changed the Stop method's cancellation token timeout to use DefaultDisconnectTimeout.
.../Live/v1/Constants.cs	Introduced DefaultDisconnectTimeout with a value of 5000.

Possibly related issues

• A customer reported that it's not possible to set the HTTP Timeout at all now. #127: The reduction in DefaultRESTTimeout could potentially address Objective 6 by ensuring that the transcription process is less likely to be prematurely canceled due to a long timeout setting. This change, while not directly increasing the timeout to 300 seconds, shows an effort to fine-tune timeout settings for better SDK performance.

---

Recent Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c42fca3 and 0093ca8.

Files selected for processing (3)

• Deepgram/Abstractions/Constants.cs (1 hunks)
• Deepgram/Clients/Live/v1/Client.cs (1 hunks)
• Deepgram/Clients/Live/v1/Constants.cs (1 hunks)

Additional Context Used

Learnings (1)

Deepgram/Clients/Live/v1/Client.cs (1)

User: dvonthenen"
URL: https://github.com/deepgram/deepgram-dotnet-sdk/pull/264

Timestamp: 2024-04-05T14:08:43.729Z
Learning: The `Stop()` method in `Deepgram/Clients/Live/v1/Client.cs` is designed to handle scenarios where a `cancelToken` might not be provided or is already cancelled, by potentially creating a new token within the method itself for internal use. This design choice ensures that the method can proceed with its operations, particularly when the socket is open and certain actions need to be taken.

Additional comments not posted (3)

Deepgram/Abstractions/Constants.cs (1)

15-15: Reducing the DefaultRESTTimeout to 30 seconds is a significant change that could impact existing implementations. Ensure this change is well-documented and communicated in the release notes.

Deepgram/Clients/Live/v1/Constants.cs (1)

17-17: Adding DefaultDisconnectTimeout with a value of 5000 milliseconds is a good practice for managing WebSocket disconnects efficiently. Consider testing this value under various network conditions to ensure it's optimal.

Deepgram/Clients/Live/v1/Client.cs (1)

710-710: Changing the default cancellation token timeout value in the Stop method to DefaultDisconnectTimeout is logical and aligns with the PR objectives. Ensure to add tests to verify this behavior during disconnect operations.

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