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(core/event): make core/event as a type alias of schema/appdata #21719

Merged
merged 11 commits into from
Sep 16, 2024

Conversation

cool-develope
Copy link
Contributor

@cool-develope cool-develope commented Sep 13, 2024

Description

Closes: #21312


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

  • Refactor

    • Simplified event-related data structures by utilizing existing types from the appdata package, enhancing maintainability and consistency.
  • Chores

    • Updated dependency management by adding a new requirement for cosmossdk.io/schema at version v0.2.0 and retracting an incompatible version.
    • Revised README to reflect the project's current dependency status, now indicating a single dependency on the schema package.

@cool-develope cool-develope requested a review from a team as a code owner September 13, 2024 16:11
Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

Walkthrough

The changes involve a refactoring of event-related data structures in the core/event/event.go file, replacing custom implementations with types from the appdata package. This includes redefining the Attribute, Events, and Event types to utilize existing structures, along with modifications to the NewAttribute, NewEvents, and NewEvent functions. Additionally, the go.mod file is updated to include a new dependency on cosmossdk.io/schema at version v0.2.0 and retracts an earlier version that was incompatible. The README file has been updated to reflect the project's current dependency status.

Changes

File Change Summary
core/event/event.go Refactored event data structures to use appdata types; modified constructors for Attribute, Events, and Event to align with new implementations.
core/go.mod Added dependency for cosmossdk.io/schema v0.2.0 and retracted v0.12.0 due to compatibility issues.
core/README.md Updated dependency status description to indicate the project now has a single dependency on the schema package.

Assessment against linked issues

Objective Addressed Explanation
Adopt cosmossdk.io/schema/appdata events in core/app (#[21312])
Improve event model flexibility and performance (#[21312])
Allow for native JSON event model and storage (#[21312]) The current changes do not implement JSON storage.

Possibly related PRs

Suggested labels

C:schema, C:x/params


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>, 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 generate interesting stats about this repository and render them as a table.
    -- @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.

This comment has been minimized.

Copy link
Member

@aaronc aaronc left a comment

Choose a reason for hiding this comment

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

LGTM but I want to check if other people are fine with adding a dependency of core on schema

@julienrbrt
Copy link
Member

LGTM but I want to check if other people are fine with adding a dependency of core on schema

Personally I am fine with it, as long as schema stays 0 dep.
We should update the README of core saying that it should only import schema.

@julienrbrt
Copy link
Member

@cool-develope could you update point 7 as well: https://github.com/cosmos/cosmos-sdk/tree/875e3aa504ffde50b0a24294188fc5173427cfce/core#cosmos-sdk-core ?

core/README.md Outdated Show resolved Hide resolved
@cool-develope cool-develope added this pull request to the merge queue Sep 16, 2024
Merged via the queue into main with commit 7856d22 Sep 16, 2024
71 checks passed
@cool-develope cool-develope deleted the core/event_mod branch September 16, 2024 22:24
@coderabbitai coderabbitai bot mentioned this pull request Sep 17, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Consider using schema/appdata event model in core/app
4 participants