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

Upgrade slinky to 1.0.8 #2069

Merged
merged 3 commits into from
Aug 9, 2024
Merged

Upgrade slinky to 1.0.8 #2069

merged 3 commits into from
Aug 9, 2024

Conversation

chenyaoy
Copy link
Contributor

@chenyaoy chenyaoy commented Aug 9, 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 automation by adding triggers for the chenyao/upgrade-slinky-to-1.0.8 branch in multiple workflows.
  • Improvements

    • Updated the Dockerfile to use the latest Golang Alpine image, ensuring better performance and security.
    • Simplified the migratePricesToMarketMap function to improve efficiency by directly invoking methods without unnecessary handler initialization.
    • Streamlined the ConstructMarketMapFromParams function for better performance by removing the API handler instantiation.
  • Dependency Updates

    • Upgraded various dependencies in the go.mod file to their latest versions, ensuring compatibility and access to new features and improvements.

Copy link
Contributor

coderabbitai bot commented Aug 9, 2024

Walkthrough

This update introduces several enhancements to the CI/CD workflows, specifically adding a new branch trigger for the chenyao/upgrade-slinky-to-1.0.8 branch across multiple GitHub Actions. Additionally, the Dockerfile is updated to use a more recent Golang Alpine image, and significant simplifications are made to the code handling market parameter transformations by removing unnecessary API handler instantiations.

Changes

File Change Summary
.github/workflows/* Added a new branch trigger for chenyao/upgrade-slinky-to-1.0.8 in multiple workflow configurations.
protocol/Dockerfile Updated Golang Alpine image digest to 1.22.2-alpine.
protocol/app/upgrades/v6.0.0/upgrade.go Simplified migratePricesToMarketMap function by removing API handler instantiation, directly using dydx methods.
protocol/go.mod Updated various dependencies to their latest versions, including Go version from 1.22 to 1.22.2.
protocol/lib/marketmap/utils.go Removed API handler instantiation from ConstructMarketMapFromParams, simplifying the function to call dydx directly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHubActions
    participant CI/CD
    participant Docker
    participant dydx

    User->>GitHubActions: Push to chenyao/upgrade-slinky-to-1.0.8
    GitHubActions->>CI/CD: Trigger build-and-push
    CI/CD->>Docker: Build Docker image
    Docker->>dydx: Call ConvertMarketParamsToMarketMap
    dydx-->>CI/CD: Return market map
    CI/CD-->>GitHubActions: Push snapshot
    GitHubActions-->>User: Build complete
Loading

Poem

🐇 In the garden of code, we hop and play,
New branches bloom, brightening the way.
With cleaner paths and updates so fine,
We dance through scripts, oh how they shine!
Let’s cheer for the changes, let joy take flight,
A rabbit's delight in the code's sweet light! 🌼✨


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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 651bfbb and a099d78.

Files ignored due to path filters (1)
  • protocol/go.sum is excluded by !**/*.sum
Files selected for processing (7)
  • .github/workflows/indexer-build-and-push-dev-staging.yml (1 hunks)
  • .github/workflows/protocol-build-and-push-snapshot.yml (1 hunks)
  • .github/workflows/protocol-build-and-push.yml (1 hunks)
  • protocol/Dockerfile (1 hunks)
  • protocol/app/upgrades/v6.0.0/upgrade.go (3 hunks)
  • protocol/go.mod (8 hunks)
  • protocol/lib/marketmap/utils.go (2 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/protocol-build-and-push.yml
Additional comments not posted (6)
protocol/lib/marketmap/utils.go (1)

5-5: Simplification of market map construction logic.

The removal of the API handler instantiation in favor of directly calling dydx.ConvertMarketParamsToMarketMap simplifies the code. This change reduces potential points of failure and enhances maintainability. Ensure that this change does not impact any dependent components or functionality.

Also applies to: 25-25

.github/workflows/indexer-build-and-push-dev-staging.yml (1)

9-9: Addition of branch trigger for CI/CD workflow.

The addition of the chenyao/upgrade-slinky-to-1.0.8 branch trigger ensures that the CI/CD workflow is executed for this specific branch. This facilitates continuous integration for the upgrade task.

protocol/Dockerfile (1)

2-3: Update to Golang Alpine image digest.

The Dockerfile now uses a more recent Golang Alpine image digest. This update is crucial for incorporating the latest updates and security patches. Ensure that the new image version is compatible with the existing build and runtime requirements.

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

9-9: Branch trigger added for chenyao/upgrade-slinky-to-1.0.8.

The new branch trigger is correctly added, allowing the workflow to run when changes are pushed to this branch. Ensure that this branch is intended to trigger the workflow.

protocol/go.mod (2)

3-3: Go version updated to 1.22.2.

The Go version has been updated to a minor patch release. Ensure that this version is compatible with the rest of the codebase and any build systems in use.


Line range hint 10-71: Dependencies updated to latest versions.

Several dependencies have been updated. Ensure that these updates are compatible with the existing code and do not introduce breaking changes. Pay special attention to any major version changes.

Also applies to: 170-409

Comment on lines +78 to 80
mm, err := dydx.ConvertMarketParamsToMarketMap(mpr)
if err != nil {
panic(fmt.Sprintf("Couldn't convert markets %v", err))
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure error handling for ConvertMarketParamsToMarketMap.

The function dydx.ConvertMarketParamsToMarketMap is invoked, and its error is handled by panicking. Consider handling the error more gracefully to avoid crashing the application in production.

mm, err := dydx.ConvertMarketParamsToMarketMap(mpr)
if err != nil {
  // Log the error and decide on a recovery strategy
  sdkCtx.Logger().Error(fmt.Sprintf("Couldn't convert markets: %v", err))
  return
}

@@ -1,19 +1,17 @@
module github.com/dydxprotocol/v4-chain/protocol

go 1.22

toolchain go1.22.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Why does this get removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I set slinky version to v1.0.8 and ran go mod tidy and it made this change

@chenyaoy chenyaoy changed the title Chenyao/upgrade slinky to 1.0.8 Upgrade slinky to 1.0.8 Aug 9, 2024
@chenyaoy chenyaoy merged commit 697c276 into main Aug 9, 2024
18 checks passed
@chenyaoy chenyaoy deleted the chenyao/upgrade-slinky-to-1.0.8 branch August 9, 2024 15:23
@chenyaoy
Copy link
Contributor Author

chenyaoy commented Aug 9, 2024

@Mergifyio backport release/protocol/v6.x

Copy link
Contributor

mergify bot commented Aug 9, 2024

backport release/protocol/v6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Aug 9, 2024
(cherry picked from commit 697c276)

# Conflicts:
#	protocol/app/upgrades/v6.0.0/upgrade.go
@mergify mergify bot mentioned this pull request Aug 9, 2024
6 tasks
chenyaoy added a commit that referenced this pull request Aug 9, 2024
Co-authored-by: Chenyao Yu <[email protected]>
Co-authored-by: Vincent Chau <[email protected]>
@coderabbitai coderabbitai bot mentioned this pull request Dec 13, 2024
6 tasks
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.

3 participants