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.

Sign up for GitHub

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

Jump to bottom

feat: Generate default indexer configs on osmosisd init #8436

Merged
merged 2 commits into from
Jun 24, 2024
Merged

feat: Generate default indexer configs on osmosisd init #8436

merged 2 commits into from
Jun 24, 2024

Conversation

cryptomatictrader
Copy link
Contributor

With this PR, on "osmosisd init", config group for indexer "osmosis-indexer" and its default, corresponding attributes will be added to app.toml

@cryptomatictrader cryptomatictrader added the A:backport/v25.x backport patches to v25.x branch label Jun 24, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 24, 2024 •
edited
Loading

Walkthrough

The recent updates to the osmosis project include fixing a bug in reading the osmosis-sqs value in the osmosis-indexer configuration, along with the addition of a default indexer configuration in the osmosisd init command. These changes also involve including new import statements and adding an IndexerConfig field in the CustomAppConfig struct, enabling the integration of Osmosis Indexer settings within the configuration template.

Changes

File Change Summary
CHANGELOG.md Added bug fix for osmosis-sqs value reading in osmosis-indexer config and indexer config addition on osmosisd init.
cmd/osmosisd/cmd/root.go Added import for indexer, included IndexerConfig field in CustomAppConfig, and updated the configuration template for Osmosis Indexer settings.
Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 725afda and 1bdc9ef.

Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • cmd/osmosisd/cmd/root.go (4 hunks)
Additional context used
Markdownlint
CHANGELOG.md

1094-1094: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1106-1106: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1115-1115: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1120-1120: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1172-1172: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

433-433: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading

696-696: null (MD034, no-bare-urls)
Bare URL used

754-754: null (MD034, no-bare-urls)
Bare URL used

1335-1335: null (MD042, no-empty-links)
No empty links

Additional comments not posted (2)
cmd/osmosisd/cmd/root.go (2)

31-31: Import statement added for indexer package.

This change aligns with the PR's objective to integrate the indexer during the osmosisd initialization process. Ensure that the versioning (v25) matches the project's current requirements and dependencies.

639-640: Addition of IndexerConfig to CustomAppConfig.

This addition is crucial for enabling the indexer functionality within the application. It's important to ensure that the IndexerConfig is properly utilized throughout the application, especially in functions that initialize or configure the application.

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

@cryptomatictrader cryptomatictrader added the V:state/compatible/backport State machine compatible PR, should be backported label Jun 24, 2024
@cryptomatictrader cryptomatictrader requested a review from p0mvn June 24, 2024 04:06
coderabbitai[bot]
coderabbitai bot reviewed Jun 24, 2024
View reviewed changes
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: 1

Outside diff range and nitpick comments (1)
cmd/osmosisd/cmd/root.go (1)

704-729: Configuration template updates for Osmosis Indexer.

The template correctly defines several configuration options for the indexer, such as is-enabled, gcp-project-id, and various topic ids. It's important to ensure these configurations are well-documented and that default values are appropriate for a secure and efficient operation.

Consider adding detailed documentation in the app.toml file or the project's documentation to explain these configuration options to end-users or developers.

p0mvn
p0mvn approved these changes Jun 24, 2024
View reviewed changes
Copy link
Member

@p0mvn p0mvn left a comment

Choose a reason for hiding this comment

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

utACK. Thank you!

@cryptomatictrader cryptomatictrader merged commit 399ed2b into main Jun 24, 2024
1 check passed
@cryptomatictrader cryptomatictrader deleted the calvin/generate_default_indexer_config branch June 24, 2024 04:32
mergify bot pushed a commit that referenced this pull request Jun 24, 2024
@cryptomatictrader @mergify
feat: Generate default indexer configs on osmosisd init (#8436)
cbcb934 
* Generate default indexer configs on osmosisd init

* Update CHANGELOG.md

---------

Co-authored-by: Calvin <calvin@osmosis.team>
(cherry picked from commit 399ed2b)
@mergify mergify bot mentioned this pull request Jun 24, 2024
Merged
p0mvn pushed a commit that referenced this pull request Jun 25, 2024
@mergify @cryptomatictrader
feat: Generate default indexer configs on osmosisd init (backport #8436…
b1327db 
…) (#8437)

* feat: Generate default indexer configs on osmosisd init (#8436)

* Generate default indexer configs on osmosisd init

* Update CHANGELOG.md

---------

Co-authored-by: Calvin <calvin@osmosis.team>
(cherry picked from commit 399ed2b)

* Fixed missing DefaultConfig

---------

Co-authored-by: Calvin <1727450+cryptomatictrader@users.noreply.github.com>
Co-authored-by: Calvin <calvin@osmosis.team>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@p0mvn p0mvn p0mvn approved these changes

Assignees
No one assigned
Labels
A:backport/v25.x backport patches to v25.x branch V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cryptomatictrader @p0mvn