use an unsecured websocket connection if http:// was specified

[jjmaldonis]

Proposed changes

The code currently only supports SSL-secured websocket connections, which means the SDK doesn't support testing self-hosted deployments when running on the self-hosted server itself (i.e. ws:// connections).

This change updates the code to use ws:// rather than wss:// when the user specifies http:// in their api_url.

Types of changes

What types of changes does your code introduce to the community Python 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

Tested!

Summary by CodeRabbit

• New Features
  • Enhanced WebSocket URL handling to support both secure (wss://) and non-secure (ws://) connections based on the provided base URL.

[coderabbitai]

Walkthrough

The recent modifications to the convert_to_websocket_url function enhance its ability to determine the appropriate WebSocket URL scheme based on the provided base_url. By introducing the use_ssl variable, which detects whether the base_url contains "http://", the function can dynamically select between secure ("wss://") and non-secure ("ws://") WebSocket connections. This change improves flexibility for handling different connection types.

Changes

Files	Change Summary
deepgram/clients/listen/v1/helpers.py	Modified convert_to_websocket_url to use a use_ssl variable for determining WebSocket URL scheme based on base_url, enhancing flexibility in connection handling.

---

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.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 78ec6d9 and 40b9d44.

Files selected for processing (1)

• deepgram/clients/listen/v1/helpers.py (1 hunks)

Additional comments not posted (1)

deepgram/clients/listen/v1/helpers.py (1)

40-49: Consider edge cases for URL handling.

The logic for determining the WebSocket scheme seems correct. However, consider verifying edge cases such as:

• URLs with mixed case schemes (e.g., "HTTP://example.com").
• URLs with additional path or query components.
• URLs that might already include "ws://" or "wss://".

These considerations ensure robustness across various inputs.

[dvonthenen]

Nice!