Remove Outer Ticker Loop - Dead Code

[davidvonthenen]

Proposed changes

Removing dead code for v1.4.0 as suggested here:
#244 (comment)

The change looks far more significant than it actually is. This deletes this section of code (https://github.com/deepgram/deepgram-go-sdk/blob/main/pkg/client/live/client.go#L301-L310) and then fixes the indentation which is why it looks like there are so many changes.

Also, removes emitting this error, for this error code, because it's actually an intended error:
https://github.com/deepgram/deepgram-go-sdk/blob/main/pkg/client/live/client.go#L346-L350

Adds a simple non-interactive example: examples/speak/stream/simple

Tested all examples and they appear to work as intented.

Types of changes

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

Summary by CodeRabbit

• New Features

  • Improved error handling and logging for websocket message reading.
  • Added constant for invalid WebSocket message type.

• Refactor

  • Restructured error handling in the listen method for better clarity and robustness.
  • Moved constants within the codebase for better organization and maintainability.

• Chores

  • Introduced a new method to handle message reading, enhancing code modularity.

[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 29 minutes and 22 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 03c264a and 4e87dbf.

Walkthrough

The recent updates involve significant restructuring and enhancements of error handling for the listen methods in both Client and StreamClient structs across different files. Constants related to retries and error conditions have been moved and updated, while new constants have been introduced to improve code clarity and management. The primary goal of these changes is to improve error handling and logging for websocket communications.

Changes

Files	Change Summary
pkg/client/live/client.go	Updated listen() method to improve error handling, removed ticker initialization, and refined message handling.
pkg/client/live/constants.go	Moved retry and back-off related constants to the end and introduced a new constant invalidWebSocketMsgType.
pkg/client/speak/client_stream.go	Refactored listen() method with enhanced error handling, added read() method, and improved logging mechanisms.
pkg/client/speak/constants.go	Relocated defaultDelayBetweenRetry to internal constants and added invalidWebSocketMsgType constant.

Sequence Diagram

New Flow for Client.listen() with Enhanced Error Handling

sequenceDiagram
    participant Client
    participant WebSocket
    participant CallbackHandler

    Client->>WebSocket: Open Connection
    loop Read Message
        WebSocket-->>Client: Message or Error
        alt Message Received
            Client->>CallbackHandler: Inspect Message and Invoke Callback
        else Error Occurred
            alt Graceful Close
                Client->>Client: Close Connection Gracefully
            else Fatal Error
                Client->>Client: Log and Handle Fatal Error
            else Specific Error Condition
                Client->>Client: Handle Specific Error
            end
        end
    end
    Client->>WebSocket: Close Connection

Loading

---

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

[coderabbitai]

Actionable comments posted: 6

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2c83727 and 03c264a.

Files selected for processing (4)

• pkg/client/live/client.go (1 hunks)
• pkg/client/live/constants.go (2 hunks)
• pkg/client/speak/client_stream.go (2 hunks)
• pkg/client/speak/constants.go (2 hunks)

Additional context used

Learnings (1)

pkg/client/speak/client_stream.go (1)

User: dvonthenen
PR: deepgram/deepgram-go-sdk#239
File: pkg/client/speak/client_stream.go:279-404
Timestamp: 2024-06-20T20:51:17.521Z
Learning: Defer refactoring of the `listen` method in the `StreamClient` class to prioritize stability, as per dvonthenen's request.

GitHub Check: Lint

pkg/client/live/constants.go

[failure] 53-53:
invalidWebSocketMsgType is unused (deadcode)

Additional comments not posted (3)

pkg/client/speak/constants.go (1)

51-51: Relocation of constant defaultDelayBetweenRetry.

The relocation of this constant is noted. Ensure that this change does not affect its usage across the project.

pkg/client/live/constants.go (1)

51-51: Relocation of constant defaultDelayBetweenRetry.

The relocation of this constant is noted. Ensure that this change does not affect its usage across the project.

pkg/client/speak/client_stream.go (1)

560-578: New method read added.

This method appears to be well-implemented for reading messages from a websocket. It correctly handles connection validation and error reporting. Ensure that this method is integrated properly in the places where message reading is required.