Add benchmark workflow

[BrendanChou]

Changelist

• Automatically run benchmarks
• Just when files are updated in protocol/lib for now since most of the benchmarks going forwards will probably be in the protocol/lib folder.

Test Plan

• Ideally benchmarks also run on multiple architectures
  • Github doesn't support arm64 except in beta
  • This could also be done using some service to self-host the runners

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

  • Introduced a GitHub Actions workflow for benchmarking protocols, providing automated performance testing on pull requests and specific branches.

• Improvements

  • Enhanced benchmark target with additional flags for more comprehensive benchmarking.
  • Improved command in the check-sample-pregenesis-up-to-date target for better accuracy.

• Tests

  • Added a new benchmark test for the BigRatMulPpm function to ensure its performance is consistently monitored.

[coderabbitai]

Walkthrough

The recent updates enhance benchmarking capabilities for the protocol directory. A new benchmark function, BenchmarkBigRatMulPpm, has been added to test the BigRatMulPpm function. The Makefile has been updated to include additional flags for running benchmarks and a minor command adjustment. Additionally, a new GitHub Actions workflow, protocol-benchmark.yml, has been introduced to automate benchmarking on pull requests and specific branches, ensuring performance consistency and facilitating comparison with previous benchmark data.

Changes

File	Change Summary
protocol/Makefile	Updated benchmark target with additional flags; modified check-sample-pregenesis-up-to-date command.
protocol/lib/big_math_test.go	Added BenchmarkBigRatMulPpm function for benchmarking BigRatMulPpm.
.github/workflows/protocol-benchmark.yml	Introduced GitHub Actions workflow for automated benchmarking on PRs and specific branches.

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[coderabbitai]

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 fe545e2 and 253bd4d.

Files selected for processing (1)

• protocol/Makefile (2 hunks)

Files skipped from review due to trivial changes (1)

• protocol/Makefile

[coderabbitai]

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 253bd4d and 7c6f6e6.

Files selected for processing (1)

• protocol/Makefile (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• protocol/Makefile

[coderabbitai]

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 dab2c4a and b086d32.

Files selected for processing (2)

• .github/workflows/protocol-benchmark.yml (1 hunks)
• protocol/Makefile (2 hunks)

Files skipped from review as they are similar to previous changes (2)

• .github/workflows/protocol-benchmark.yml
• protocol/Makefile

[coderabbitai]

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 b086d32 and 67ca6a7.

Files selected for processing (1)

• .github/workflows/protocol-benchmark.yml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/protocol-benchmark.yml

[coderabbitai]

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 67ca6a7 and f7d2679.

Files selected for processing (1)

• .github/workflows/protocol-benchmark.yml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/protocol-benchmark.yml

[coderabbitai]

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 f7d2679 and 1d46838.

Files selected for processing (1)

• .github/workflows/protocol-benchmark.yml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/protocol-benchmark.yml