Refactor sdk package structure

[dvonthenen]

Proposed changes

Addresses: #242

Ahead of the TTS WS release, we temporarily placed the TTS WS implementation at pkg/api/speak-stream and pkg/client/speak-stream in this PR: #239 to avoid a naming collision between the REST and WebSocket implementation. This PR puts the package in a more thought-out and permanent location before we release the feature.

This looks like a lot, but I tried to commit git mv so that it can keep track of these changes easier. In most cases, it seems to have done a decent job. In other cases, it seems to have not done so well. The overwhelming majority of the other changes include fixing things with static checks, moving things, and so on.

pkg/client Changes

Because the clients were NOT versioned, this enabled the process to do that. To demonstrate the approach for clients on this PR, the following changes were made to the clients.

The way it was before:

pkg
+-- client
       +-- analyze
              +-- client.go
              +-- (other files like constants, etc)
       +-- prerecorded
              +-- client.go
              +-- (other files like constants, etc)
       +-- live
              +-- client.go
              +-- (other files like constants, etc)
       ...

The files were moved into a pkg/client/<type>/v1 folder and the pkg/client/<type> created backward-compatible links to artifacts in these new v1 folders.

pkg
+-- client
       +-- analyze
              +-- v1
              +-- client.go (reference/pointer to v1 folder)
                     +-- [MOVED] client.go
                     +-- [MOVED]  (other files like constants, etc)
       +-- listen
             +-- client.go (reference/pointer to v1 folder)
             +-- v1
                    +-- rest
                          +-- [MOVED] client.go
                          +-- [MOVED]  (other files like constants, etc)
                    +-- websocket
                          +-- [MOVED] client.go
                          +-- [MOVED]  (other files like constants, etc)
       +-- prerecorded
              +-- [DEPRECATED] legacy.go (reference/pointer to listen/v1/rest)
       +-- live
              +-- [DEPRECATED] legacy.go (reference/pointer to listen/v1/websocket)
       ...

pkg/api Changes

The pkg/api were versioned, but we need to change the apis so that speak makes a lot more sense. We don't want a speak and speak-stream API package. The implementation of TTS WS was done purposely so that this change could be made easily. These changes then follow the client in a similar fashion.

The way it was before:

pkg
+-- api
      ...
       +-- prerecorded / v1
              +-- interfaces/
              +-- client.go
              +-- (other files like constants, etc)
       +-- live / v1
              +-- interfaces/
              +-- client.go
              +-- (other files like constants, etc)
       ...

The files were moved into a pkg/api/<type>v1 folder and the pkg/client/<type> created backward-compatible links to artifacts in these new v1 folders.

pkg
+-- api
       +-- listen
             +-- v1
                    +-- rest
                          +-- interfaces/
                          +-- [MOVED] client.go
                          +-- [MOVED]  (other files like constants, etc)
                    +-- websocket
                          +-- interfaces/
                          +-- [MOVED] client.go
                          +-- [MOVED]  (other files like constants, etc)
       +-- prerecorded / v1
              +-- [DEPRECATED] legacy.go (reference/pointer to listen/v1/rest)
       +-- live / v1
              +-- [DEPRECATED] legacy.go (reference/pointer to listen/v1/websocket)
       ...

The README was updated to keep the idea of Live/Stream and PreRecorded, but when it goes out to code, it maps to listen/rest and listen/websocket. The same is true for speak.

The users' code should remain unchanged, but now hint that there are deprecated packages in use to be removed at the next major release. This is what it will look like in the IDE/editor by way of a strikethrough (picture below) and this warning in the deprecated packages:

// *********** WARNING ***********
// This package provides <package functionality>...
//
// Deprecated: This package is deprecated. Use the <this new> package instead. This will be removed in a future release.
//
// This package is frozen and no new functionality will be added.
// *********** WARNING ***********

Any examples with the name new-RENAME (for example: examples/text-to-speech/rest/file-new-RENAME/hello-world/main.go) is using the new package names as to demonstrate the deprecated and new ways can both coexist.

Other notable changes:

• PackageVersion was placed on all API and Client packages
• internal package names (these aren't exposed to the end-user), we changed to better match the new structure. Example: live -> listenv1ws.

TODOs:

• I intentionally did not change any of the examples other than renaming the folders to demonstrate the backward compatibility of these changes. In a follow-up PR, I will change all the examples to be implement without using these deprecated package references so people are set on the right path on how to use the packages in this repo.

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

[coderabbitai]

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

60 files out of 129 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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.