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

WIP: ADR 073: Built-in Indexer Implementation #20547

Closed
wants to merge 208 commits into from
Closed

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Jun 5, 2024

Description

This PR will stay in draft and includes the WIP implementation of #20532 so that people can take a look if they're interested. Once specific pieces are ready, they'll be broken out into smaller standalone PRs.


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

Copy link
Contributor

coderabbitai bot commented Jun 5, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. 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.


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

indexer/base/engine.go Fixed Show fixed Hide fixed
collections/indexing.go Fixed Show fixed Hide fixed
buf := new(strings.Builder)
var params []interface{}
if exists {
params, err = tm.UpdateSql(buf, key, value)

Check warning

Code scanning / CodeQL

Useless assignment to local variable Warning

This definition of err is never used.
if exists {
params, err = tm.UpdateSql(buf, key, value)
} else {
params, err = tm.InsertSql(buf, key, value)

Check warning

Code scanning / CodeQL

Useless assignment to local variable Warning

This definition of err is never used.
indexer/postgres/testing/app/main.go Fixed Show fixed Hide fixed
if err != nil {
return err
}
case schema.Bech32AddressKind:

Check warning

Code scanning / CodeQL

Directly using the bech32 constants Warning

Directly using the bech32 constants instead of the configuration values
indexer/postgres/params.go Fixed Show fixed Hide fixed
Comment on lines +35 to +63
for indexerName, factory := range indexerRegistry {
indexerOpts, ok := opts.Options[indexerName]
if !ok {
continue
}

if opts.Logger != nil {
opts.Logger.Info(fmt.Sprintf("Starting Indexer %s", indexerName), "options", indexerOpts)
}

optsMap, ok := indexerOpts.(map[string]interface{})
if !ok {
return appdata.Listener{}, fmt.Errorf("invalid indexer options type %T for %s, expected a map", indexerOpts, indexerName)
}

indexer, err := factory(optsMap, resources)
if err != nil {
return appdata.Listener{}, fmt.Errorf("failed to create indexer %s: %w", indexerName, err)
}

res, err := indexer.Initialize(ctx, InitializationData{})
if err != nil {
return appdata.Listener{}, fmt.Errorf("failed to initialize indexer %s: %w", indexerName, err)
}

indexers = append(indexers, res.Listener)

// TODO handle last block persisted
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
Comment on lines +26 to +32
go func() {
<-ctx.Done()
err := i.db.Close()
if err != nil {
panic(fmt.Sprintf("failed to close database: %v", err))
}
}()

Check notice

Code scanning / CodeQL

Spawning a Go routine Note

Spawning a Go routine may be a possible source of non-determinism
Comment on lines +7 to +35
go func() {
var err error
for {
select {
case packet := <-packetChan:
if err != nil {
// if we have an error, don't process any more packets
// and return the error and finish when it's time to commit
if _, ok := packet.(CommitData); ok {
commitChan <- err
return
}
} else {
// process the packet
err = listener.SendPacket(packet)
// if it's a commit
if _, ok := packet.(CommitData); ok {
commitChan <- err
if err != nil {
return
}
}
}

case <-doneChan:
return
}
}
}()

Check notice

Code scanning / CodeQL

Spawning a Go routine Note

Spawning a Go routine may be a possible source of non-determinism
@github-actions github-actions bot removed the C:Store label Jul 2, 2024
}

param = int64(t)
} else if field.Kind == schema.Bech32AddressKind {

Check warning

Code scanning / CodeQL

Directly using the bech32 constants Warning

Directly using the bech32 constants instead of the configuration values
Copy link
Contributor

github-actions bot commented Aug 5, 2024

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the Stale label Aug 5, 2024
@github-actions github-actions bot closed this Aug 10, 2024
@tac0turtle tac0turtle deleted the aaronc/indexer-wip branch December 18, 2024 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant