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

chore: prepare core 1.0.0-alpha.1 #21564

Merged
merged 4 commits into from
Sep 9, 2024
Merged

chore: prepare core 1.0.0-alpha.1 #21564

merged 4 commits into from
Sep 9, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 5, 2024

Description

Prepares core 1.0.0-alpha.1

Closes: #21176

We still miss 1 thing before core v1 rc, namely:

In order to make easier integration, we should release an alpha ASAP.


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

Summary by CodeRabbit

  • New Features

    • Introduced version v1.0.0-alpha.1 for the Cosmos SDK, marking a new alpha release.
    • Added registry.AminoRegistrar for improved type management in the amino codec.
    • Introduced registry.InterfaceRegistrar to enhance modularity and extensibility.
    • Added new message handling hooks: PreMsgHandler and PostMsgHandler.
    • Implemented an alternative MsgHandler for gRPC handlers.
  • Documentation

    • Enhanced documentation in the store package to clarify its API and interchangeability of store implementations.

@julienrbrt julienrbrt requested a review from a team as a code owner September 5, 2024 12:59
Copy link
Contributor

coderabbitai bot commented Sep 5, 2024

Walkthrough

Walkthrough

The recent changes introduce version v1.0.0-alpha.1 of the Cosmos SDK, which includes new features and enhancements focused on module registration and versioning. Key additions are registry.AminoRegistrar and registry.InterfaceRegistrar for improved type and interface management. The Iterator type alias for KVStore is also introduced, along with new message handling hooks and transaction services. Additionally, documentation has been improved in the core/store package to clarify its functionality. These updates aim to enhance the SDK's modularity and extensibility for developers.

Changes

Files Change Summary
core/CHANGELOG.md Added registry.AminoRegistrar, registry.InterfaceRegistrar, and Iterator type alias. Commented out appmodule.HasServices. Introduced new message handling hooks and transaction services.
core/store/doc.go Added documentation comments clarifying that the package provides a basic API for modules to interact with key-value stores and includes interfaces for store implementations.

Sequence Diagram(s)

sequenceDiagram
    participant Module
    participant AminoRegistrar
    participant InterfaceRegistrar
    participant KVStore

    Module->>AminoRegistrar: Register types
    AminoRegistrar-->>Module: Types registered

    Module->>InterfaceRegistrar: Interact with interface
    InterfaceRegistrar-->>Module: Interface interaction successful

    Module->>KVStore: Use Iterator
    KVStore-->>Module: Key-value interaction
Loading

Possibly related issues

  • Core v1 API Review #21176: The changes in this PR contribute to the review of the core v1 API, specifically through the addition of new registrars and improved documentation, aligning with the goal of ensuring good APIs for the upcoming alpha release.

Possibly related PRs

  • fix(stf/branch/memiter): Fix Iter validity #21556: The changes in this PR involve modifications to the store.Iterator, which is directly related to the Iterator type alias introduced in the main PR, indicating a connection in how iterators are managed within the Cosmos SDK.
  • refactor(core): re-add handlers #21575: This PR enhances the message handling system and includes changes to the MsgRouter and QueryRouter interfaces, which may relate to the overall improvements in modularity and extensibility mentioned in the main PR's updates on registry.InterfaceRegistrar.

Suggested labels

C:server/v2, C:schema, C:indexer/postgres, C:x/gov

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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 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.

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.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a57b254 and 10d9d26.

Files selected for processing (1)
  • core/CHANGELOG.md (2 hunks)
Additional context used
Path-based instructions (1)
core/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (1)
core/CHANGELOG.md (1)

Line range hint 39-63: Review of Changelog Entries

The changelog entries from lines 39 to 63 are well-structured and follow the guiding principles outlined at the beginning of the file. Each entry is linked to a specific GitHub issue or pull request, which is good practice for traceability. Here are some specific observations and suggestions:

  1. Versioning and Links:

    • The version tag [v1.0.0-alpha.1] is correctly formatted and linked. This ensures users can easily access the release notes.
  2. Features Section:

    • The entries are clear and concise, each focusing on a specific change or addition. The use of GitHub issue links for each entry is consistent and helpful for further exploration.
  3. Grammar and Spelling:

    • The text is free from grammatical errors and spelling mistakes, which is crucial for professional documentation.
  4. Content Accuracy and Completeness:

    • The content aligns well with the PR summary and AI-generated summary, indicating that the changelog accurately reflects the changes made in this version.
  5. Suggested Improvements:

    • While the current format is clear, consider adding a brief description or context for each entry to enhance understanding without needing to click through to the issues.

Overall, the changelog entries are well-prepared and serve their purpose effectively.

@julienrbrt julienrbrt marked this pull request as draft September 5, 2024 14:55
@julienrbrt
Copy link
Member Author

moving core/store things before

@julienrbrt julienrbrt closed this Sep 5, 2024
@julienrbrt julienrbrt deleted the julien/prepare-core-100 branch September 5, 2024 15:30
@julienrbrt julienrbrt restored the julien/prepare-core-100 branch September 6, 2024 11:08
@julienrbrt julienrbrt reopened this Sep 6, 2024
@@ -1,3 +1,5 @@
// Package store provides a basic API for modules to interact with kv-stores
// independently of any implementation of that functionality.
// Additionally, it provides a set of interfaces for store implementations to
Copy link
Member Author

Choose a reason for hiding this comment

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

I tried to move it, but I eventually didn't like that we ended up with two store packages, and this one imprting to the server one.
I'd rather extend the scope of this package instead, tbh. What do you think @aaronc?

@julienrbrt julienrbrt marked this pull request as ready for review September 6, 2024 11:10
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.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 10d9d26 and 8515abd.

Files selected for processing (1)
  • core/store/doc.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • core/store/doc.go

@julienrbrt julienrbrt added this pull request to the merge queue Sep 9, 2024
Merged via the queue into main with commit bf98b56 Sep 9, 2024
77 of 78 checks passed
@julienrbrt julienrbrt deleted the julien/prepare-core-100 branch September 9, 2024 09:54
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.

Core v1 API Review
4 participants