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

feat(server/v2/stf): delayed marshalling of typed event (partial backport #22684) #22751

Merged
merged 2 commits into from
Dec 4, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Dec 4, 2024

Description

Closes: #21312

As discussed yesterday in indexer sync, improve typed event performance in state machine by not marshalling/unmarshalling their data.

Stf:

Set event marshalling in Data()

Cometbft server:

  • add app.toml comet config to disable event (for when you want to only rely on event indexing from the indexer)
  • use Data otherwise to recreate kv events.

  • set index-abci-events: marshal all but comet indexes only those abci events
  • leave index-abci-events empty: marshal all and comet indexes everything
  • set disable abci events: comet don't event get any event and obviously do not index them (marshal nothing)
  • set disable-index-abci-events: marshal all, cometbft index nothing

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:

  • confirmed ! in the type prefix if API or client breaking change

  • targeted the correct branch (see PR Targeting)

  • provided a link to the relevant issue or specification

  • reviewed "Files changed" and left comments if necessary

  • included the necessary unit and integration tests

  • added a changelog entry to CHANGELOG.md

  • updated the relevant documentation or specification, including comments for documenting Go code

  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Release Notes

  • New Features

    • Added new configuration options for event indexing, including index-abci-events, disable-index-abci-events, and disable-abci-events.
    • Introduced granular control over event handling through updated configuration settings.
  • Bug Fixes

    • Improved flexibility in event handling based on new configuration options.
  • Refactor

    • Streamlined event emission logic by integrating conversion directly into the Emit method.
    • Renamed variables for consistency and clarity regarding ABCI events.
    • Updated event handling methods to utilize new configuration structure for enhanced control.
  • Chores

    • Cleaned up unused imports and reorganized configuration file for better clarity.

This is an automatic backport of pull request #22684 done by [Mergify](https://mergify.com).

(cherry picked from commit 7fa2356)

# Conflicts:
#	server/v2/stf/core_event_service.go
@mergify mergify bot requested a review from a team as a code owner December 4, 2024 10:26
@mergify mergify bot added the conflicts label Dec 4, 2024
Copy link
Contributor Author

mergify bot commented Dec 4, 2024

Cherry-pick of 7fa2356 has failed:

On branch mergify/bp/release/v0.52.x/pr-22684
Your branch is up to date with 'origin/release/v0.52.x'.

You are currently cherry-picking commit 7fa2356c0.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   server/v2/cometbft/abci.go
	modified:   server/v2/cometbft/config.go
	modified:   server/v2/cometbft/query.go
	modified:   server/v2/cometbft/server.go
	modified:   server/v2/cometbft/utils.go
	modified:   tools/confix/data/v2-app.toml
	modified:   tools/confix/migrations.go

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   server/v2/stf/core_event_service.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Copy link
Contributor

coderabbitai bot commented Dec 4, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

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


🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added C:Confix Issues and PR related to Confix C:server/v2 Issues related to server/v2 C:server/v2 stf C:server/v2 cometbft labels Dec 4, 2024
Copy link
Contributor

github-actions bot commented Dec 4, 2024

@mergify[bot] your pull request is missing a changelog!

@julienrbrt julienrbrt changed the title feat(server/v2/stf): delayed marshalling of typed event (backport #22684) feat(server/v2/stf): delayed marshalling of typed event (partial backport #22684) Dec 4, 2024
@julienrbrt julienrbrt merged commit 4c5632c into release/v0.52.x Dec 4, 2024
70 of 72 checks passed
@julienrbrt julienrbrt deleted the mergify/bp/release/v0.52.x/pr-22684 branch December 4, 2024 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Confix Issues and PR related to Confix C:server/v2 cometbft C:server/v2 Issues related to server/v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant