Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support empty params for websocket endpoint #2111

Merged
merged 3 commits into from
Aug 20, 2024
Merged

Support empty params for websocket endpoint #2111

merged 3 commits into from
Aug 20, 2024

Conversation

dydxwill
Copy link
Contributor

@dydxwill dydxwill commented Aug 20, 2024

Changelist

Support empty params for websocket endpoint

Test Plan

Dev env

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Added a new branch trigger for the workflow to enhance CI/CD flexibility.
  • Bug Fixes

    • Improved robustness of functions by adding checks for empty query parameters, preventing errors from empty inputs.

@dydxwill dydxwill requested a review from a team as a code owner August 20, 2024 16:36
Copy link
Contributor

coderabbitai bot commented Aug 20, 2024

Walkthrough

The recent changes streamline a GitHub Actions workflow by adding a new branch trigger while removing several Docker image build and push jobs. Additionally, improvements have been made to the error handling in the websocket_server.go file, ensuring robust processing of empty query parameters. These updates reflect a shift toward a more centralized deployment strategy and enhanced code reliability.

Changes

File Change Summary
.github/workflows/protocol-build-and-push.yml Added a trigger for the wl/fix_parse branch; removed jobs for multiple Docker environments.
protocol/streaming/ws/websocket_server.go Modified parseSubaccountIds and parseClobPairIds functions to handle empty query parameters.

Poem

In the fields of code, where rabbits play,
Changes hop in, brightening the day.
Branches now trigger with a gentle cheer,
Robust parsing awaits, bringing no fear.
With each little tweak, our systems grow,
Hooray for the changes, let the progress flow! 🐇✨


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 4dfe799 and 12cdcf5.

Files selected for processing (2)
  • .github/workflows/protocol-build-and-push.yml (2 hunks)
  • protocol/streaming/ws/websocket_server.go (2 hunks)
Additional comments not posted (4)
.github/workflows/protocol-build-and-push.yml (2)

6-6: Branch Trigger Addition: Ensure alignment with workflow goals.

The addition of the branch wl/fix_parse to the trigger list allows the workflow to run on this branch. Ensure that this aligns with the intended CI/CD strategy and that the branch is actively used for development or fixes.


6-6: Review the impact of job removals on deployment strategy.

The removal of Docker image build and push jobs for various environments suggests a shift in deployment strategy. Ensure that these changes are intentional and that alternative deployment mechanisms are in place to handle these environments.

protocol/streaming/ws/websocket_server.go (2)

106-108: Robust handling of empty subaccountIds.

The check for an empty subaccountIds parameter ensures that the function returns an empty slice, preventing errors from processing empty input. This change enhances the function's robustness.


134-136: Robust handling of empty clobPairIds.

The check for an empty clobPairIds parameter ensures that the function returns an empty slice, preventing errors from processing empty input. This change enhances the function's robustness.

@dydxwill dydxwill merged commit 4a77b29 into main Aug 20, 2024
21 checks passed
@dydxwill dydxwill deleted the wl/fix_parse branch August 20, 2024 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants