Organize Deprecated Code

[davidvonthenen]

Proposed changes

While working on the Agent API, I realized it would be good to organize the deprecated code so that it is easier to read and it's clear (by placing the code into a deprecated.go filename) that the code in those files should not be used.

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

NA

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a new deprecation strategy for several client packages, guiding users towards the updated listen package.

• Bug Fixes

  • Removed deprecated functions and aliases to streamline API usage.

• Documentation

  • Updated documentation across various packages to indicate deprecated status and provide migration paths for users.

• Chores

  • Cleaned up configuration settings for linters to improve code quality and maintainability.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve updates to the configuration of linters in the .golangci.yaml file, the removal of deprecated functions and aliases in various client files, and the introduction of new deprecated files to guide users toward updated implementations. The deprecated.go files in several packages provide backward compatibility while indicating that certain functionalities will be removed in future releases. Additionally, specific paths for deprecated files were updated, reflecting a shift in how deprecated code is categorized.

Changes

File Path	Change Summary
.golangci.yaml	- Added exported rule with severity error under revive. - Updated dupl, funlen, goconst, gocritic, gocyclo, goimports, govet, and misspell linter settings. - Changed paths from legacy.go to deprecated.go for exclusions.
pkg/client/listen/client.go	- Removed deprecated WebSocket and REST client functions and aliases.
pkg/client/listen/deprecated.go	- Introduced deprecated functions and type aliases for WebSocket and REST clients, redirecting to newer implementations.
pkg/client/live/deprecated.go	- Marked the entire package as deprecated, with warnings and aliases for the Client type directing users to the listen package.
pkg/client/prerecorded/deprecated.go	- Marked the package as deprecated with warnings in the documentation for functions.
pkg/client/speak/client.go	- Removed deprecated Client type alias and methods.
pkg/client/speak/deprecated.go	- Introduced deprecated functionality with type aliases and methods, guiding users to new implementations.

Suggested reviewers

• lukeocodes
• naomi-lgbt
• jpvajda

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.