feat(schema): indexing API

[aaronc]

Description

This PR demonstrates the API for registering #20532 indexers, initialization indexers via app.toml configuration, and integrating the indexer manager into baseapp and simapp.

Implementation code is mainly excluded from this PR so that we can focus reviews on the proposed API and configuration structure.

---

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

• New Features

  • Introduced a built-in indexer for enhanced data indexing and retrieval.

• Documentation

  • Added a comprehensive README for the Indexer Framework explaining how to define and configure indexers.

• Tests

  • Added tests for module decoder resolution and indexer registration functionalities to ensure reliability and correctness.

• Chores

  • Updated dependencies in go.mod for the new indexing and schema features.

[coderabbitai]

Warning

Rate limit exceeded

@aaronc has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 20 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 86ec5bd and 199d06b.

Walkthrough

Walkthrough

This update introduces a comprehensive indexer framework into the baseapp layer to manage and configure indexing operations efficiently. Key changes include new imports to support indexing, the introduction of an EnableIndexer method, a listenerWrapper for managing block and commit events, and updates to testing and module decoding. Simultaneously, the simapp layer adapts to integrate this indexer framework conditionally based on application options, ensuring backward compatibility with legacy streaming services.

Changes

Files / Packages	Change Summary
baseapp/streaming.go	Added imports related to indexing, introduced the EnableIndexer method, and a new type listenerWrapper with methods to listen to block finalization and commit events.
go.mod	Added a new dependency cosmossdk.io/schema v0.0.0 and replaced the module mapping for cosmossdk.io/schema to ./schema.
schema/decoding/resolver.go	Introduced the DecoderResolver interface and ModuleSetDecoderResolver function to handle module decoders.
schema/decoding/resolver_test.go	Added tests for the ModuleSetDecoderResolver, focusing on iteration, lookup, and error handling.
schema/decoding/sync.go	Added a new interface SyncSource that enables indexers to start indexing modules with pre-existing state.
schema/indexer/README.md	Introduced documentation for the Indexer Framework, explaining how to define, integrate, and configure indexers.
schema/indexer/indexer.go	Added Config, InitFunc, InitParams, and InitResult types for the initialization and configuration of indexers.
schema/indexer/manager.go	Introduced the ManagerOptions and ManagerConfig structs, along with the StartManager function to initialize the indexer manager.
schema/indexer/registry.go	Added a registry for managing indexer types and introduced the Register function to associate indexer types with initialization functions.
schema/indexer/registry_test.go	Added a test for the Register function, checking indexer registration, existence, and error handling.
schema/logutil/logger.go	Defined the Logger interface for logging at different levels and implemented the NoopLogger type.
simapp/app_di.go	Updated the NewSimApp function to declare appModules, conditionally enable the indexer framework, and handle indexer options, falling back to legacy streaming services if not enabled.
simapp/go.mod	Added a new indirect dependency cosmossdk.io/schema v0.0.0 and updated the module replacement to point to ../schema.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BaseApp
    participant Indexer
    participant Modules

    User->>BaseApp: Start application with indexer options
    BaseApp->>Indexer: Initialize indexer with provided options
    Indexer->>Modules: Resolve and register module decoders
    Modules->>Indexer: Provide module codecs
    Indexer->>BaseApp: Indexer setup complete
    BaseApp->>User: Application up and running with indexing

    Note over BaseApp, Indexer: Handling block and commit events
    BaseApp->>Indexer: Notify on block finalization
    Indexer->>BaseApp: Process and store indexing data
    BaseApp->>Indexer: Notify on commit event
    Indexer->>BaseApp: Store commit data

Loading

Possibly related issues

• EPIC: Separate all SDK modules into standalone go modules #11899: This issue aims to separate all SDK modules into standalone go modules, which aligns with the enhancements to make modules decoupled and manageable through frameworks like the one introduced in the schema package.

---

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

[aaronc]

I had to add a bunch of go.mod replaces which we should be able to get rid of after this is merged and tagged