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

Fix snapshot bool #2078

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Fix snapshot bool #2078

merged 1 commit into from
Aug 12, 2024

Conversation

dydxwill
Copy link
Contributor

@dydxwill dydxwill commented Aug 12, 2024

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

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

    • Enhanced CI/CD pipeline for building and pushing Docker images across multiple development and staging environments.
    • Improved subaccount update functionality with new parameters for conditional processing.
  • Bug Fixes

    • Adjusted logic for retrieving subaccount updates to improve accuracy and flexibility.
  • Documentation

    • Updated method signatures reflecting the new parameters for better clarity in functionality.

Copy link
Contributor

coderabbitai bot commented Aug 12, 2024

Walkthrough

The recent modifications enhance the CI/CD pipeline for building and pushing Docker images across various development and staging environments. New jobs for different environments have been established in the GitHub Actions workflow, while significant updates to the GetStreamSubaccountUpdate method introduce additional parameters that increase flexibility in managing subaccount updates and control flow across relevant functions.

Changes

Files/Paths Change Summary
.github/workflows/protocol-build-and-push.yml Added multiple jobs for different environments (dev, dev3, dev4, dev5, staging) to build and push Docker images, each with tailored configurations.
protocol/x/clob/keeper/keeper.go Modified InitializeNewStreams to include an additional boolean argument in the call to GetStreamSubaccountUpdate, enhancing subaccount update retrieval.
protocol/x/clob/keeper/process_operations.go Updated ProcessProposerOperations to call GetStreamSubaccountUpdate with an additional boolean argument, changing how subaccount updates are processed.
protocol/x/clob/types/expected_keepers.go Added snapshot parameter of type bool to GetStreamSubaccountUpdate in the SubaccountsKeeper interface, allowing for conditional processing.
protocol/x/subaccounts/keeper/subaccount.go Altered GetStreamSubaccountUpdate to accept a new snapshot parameter, allowing dynamic control over snapshot behavior in its output.
protocol/x/subaccounts/types/types.go Introduced snapshot parameter of type bool to GetStreamSubaccountUpdate in the SubaccountsKeeper interface, enhancing its functionality.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Docker
    participant ECR

    Developer->>GitHub Actions: Push Code
    GitHub Actions->>Docker: Build Image
    Docker-->>GitHub Actions: Image Built
    GitHub Actions->>ECR: Push Image
    ECR-->>GitHub Actions: Image Pushed
    GitHub Actions-->>Developer: Build & Push Complete
Loading

🐇 In a land where code takes flight,
🐇 New jobs were born, what a delight!
🐇 With parameters added, oh so spry,
🐇 Subaccounts dance, they leap and fly.
🐇 CI/CD magic, hopping along,
🐇 In the forest of code, we're stronger, not wrong! 🌟


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.

@dydxwill dydxwill merged commit 6e5673e into main Aug 12, 2024
17 checks passed
@dydxwill dydxwill deleted the wl/sn_dep branch August 12, 2024 21:16
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 4bc25b8 and fa47c90.

Files selected for processing (6)
  • .github/workflows/protocol-build-and-push.yml (2 hunks)
  • protocol/x/clob/keeper/keeper.go (1 hunks)
  • protocol/x/clob/keeper/process_operations.go (1 hunks)
  • protocol/x/clob/types/expected_keepers.go (1 hunks)
  • protocol/x/subaccounts/keeper/subaccount.go (2 hunks)
  • protocol/x/subaccounts/types/types.go (1 hunks)
Additional comments not posted (10)
protocol/x/subaccounts/types/types.go (1)

68-68: LGTM! But verify the method usage in the codebase.

The code changes are approved.

However, ensure that all implementations and calls to GetStreamSubaccountUpdate match the new signature.

Verification successful

Verification Successful: Method Usage Matches New Signature

The method GetStreamSubaccountUpdate is consistently used across the codebase with the updated signature. All implementations and calls align with the changes made.

  • Function Definitions:

    • protocol/x/subaccounts/types/types.go
    • protocol/x/subaccounts/keeper/subaccount.go
    • protocol/x/clob/types/expected_keepers.go
  • Function Calls:

    • protocol/x/clob/keeper/keeper.go
    • protocol/x/clob/keeper/process_operations.go
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all implementations and calls to `GetStreamSubaccountUpdate` match the new signature.

# Test: Search for the method usage. Expect: Only occurrences of the new signature.
ast-grep --lang go --pattern $'func ($_ SubaccountsKeeper) GetStreamSubaccountUpdate($_, $_, $_) $_'

Length of output: 101


Script:

#!/bin/bash
# Description: Search for the definition and calls of `GetStreamSubaccountUpdate` in the codebase.

# Search for the function definition with any signature.
ast-grep --lang go --pattern 'func ($_ SubaccountsKeeper) GetStreamSubaccountUpdate($$$) $_'

# Search for calls to the function to verify usage.
rg 'GetStreamSubaccountUpdate' -A 3

Length of output: 1575

protocol/x/clob/types/expected_keepers.go (1)

43-43: LGTM! But verify the method usage in the codebase.

The code changes are approved.

However, ensure that all implementations and calls to GetStreamSubaccountUpdate match the new signature.

Verification successful

Method usage verified: All implementations and calls to GetStreamSubaccountUpdate match the new signature (ctx sdk.Context, id SubaccountId, snapshot bool). No discrepancies found.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all implementations and calls to `GetStreamSubaccountUpdate` match the new signature.

# Test: Search for the method usage. Expect: Only occurrences of the new signature.
ast-grep --lang go --pattern $'func ($_ SubaccountsKeeper) GetStreamSubaccountUpdate($_, $_, $_) $_'

Length of output: 101


Script:

#!/bin/bash
# Description: Search for all occurrences of `GetStreamSubaccountUpdate` to verify its usage and signature.

# Search for the method definition and calls to `GetStreamSubaccountUpdate`.
rg 'GetStreamSubaccountUpdate' -A 5

Length of output: 2150

.github/workflows/protocol-build-and-push.yml (5)

83-117: Ensure consistency in AWS credentials configuration.

The build-and-push-dev3 job is configured correctly. Ensure that similar configurations are consistently applied across all other jobs to avoid misconfigurations.


119-153: Ensure consistency in AWS credentials configuration.

The build-and-push-dev4 job is configured correctly. Ensure that similar configurations are consistently applied across all other jobs to avoid misconfigurations.


155-189: Ensure consistency in AWS credentials configuration.

The build-and-push-dev5 job is configured correctly. Ensure that similar configurations are consistently applied across all other jobs to avoid misconfigurations.


191-225: Ensure consistency in AWS credentials configuration.

The build-and-push-staging job is configured correctly. Ensure that similar configurations are consistently applied across all other jobs to avoid misconfigurations.


11-45: Ensure consistency in AWS credentials configuration.

The build-and-push-dev job is configured correctly. Ensure that similar configurations are consistently applied across all other jobs to avoid misconfigurations.

Verification successful

AWS Credentials Configuration is Consistent Across Workflows

The AWS credentials configuration is consistent across the workflow files, with variations only due to different environments (e.g., DEV, STAGING, MAINNET), which is standard practice.

  • .github/workflows/protocol-build-and-push.yml
  • .github/workflows/protocol-build-and-push-testnet.yml
  • .github/workflows/protocol-build-and-push-snapshot.yml
  • .github/workflows/protocol-build-and-push-mainnet.yml
  • .github/workflows/deploy-to-dev.yml

These variations do not indicate misconfiguration but reflect different deployment targets.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify consistency in AWS credentials configuration across all jobs.

# Test: Search for AWS credentials configuration in the workflow file. Expect: Consistency across all jobs.
rg --type yaml $'aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_VALIDATOR_$_ }}\naws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_VALIDATOR_$_ }}\naws-region: us-east-2'

Length of output: 605


Script:

#!/bin/bash
# Description: Verify consistency in AWS credentials configuration across all jobs.

# Test: Search for AWS credentials configuration in the workflow file. Expect: Consistency across all jobs.
rg --type yaml 'aws-access-key-id:.*AWS_ACCESS_KEY_ID_VALIDATOR' -A 2

Length of output: 71


Script:

#!/bin/bash
# Description: Verify consistency in AWS credentials configuration across all workflow files.

# Test: Search for AWS credentials configuration across all YAML files in the .github/workflows directory.
rg 'aws-access-key-id:.*AWS_ACCESS_KEY_ID_VALIDATOR' -A 2 .github/workflows/

Length of output: 6523

protocol/x/clob/keeper/keeper.go (1)

270-270: Verify the impact of the new boolean parameter.

The addition of the true boolean parameter to the GetStreamSubaccountUpdate method call suggests a change in its behavior. Ensure that this change aligns with the intended functionality and verify its impact on the overall logic.

protocol/x/subaccounts/keeper/subaccount.go (1)

Line range hint 138-160: Ensure correct usage of the new snapshot parameter.

The introduction of the snapshot boolean parameter enhances control over the Snapshot field in the StreamSubaccountUpdate struct. Verify that the parameter is correctly utilized and that its addition aligns with the intended functionality.

protocol/x/clob/keeper/process_operations.go (1)

104-104: Verify the impact of the new boolean parameter.

The addition of the false boolean parameter to the GetStreamSubaccountUpdate method call suggests a change in its behavior. Ensure that this change aligns with the intended functionality and verify its impact on the overall logic.

jonfung-dydx pushed a commit that referenced this pull request Aug 15, 2024
jonfung-dydx pushed a commit that referenced this pull request Sep 17, 2024
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