Skip to content

Conversation

@jaipaljadeja
Copy link
Member

  • removes header: "always" filter
  • adds chain specific filters
  • smol refactor

@coderabbitai
Copy link

coderabbitai bot commented May 3, 2025

📝 Walkthrough

Walkthrough

This update introduces a new prerelease metadata JSON file for the "apibara" package, documenting a patch-level change related to the CLI create template. Additionally, the CLI's template generation logic is adjusted to streamline how the indexer ID is accessed and to make the filter configuration chain-specific, removing a generic header filter in favor of more precise filters for Ethereum and Starknet chains. No public APIs or exported entities are altered; the changes are internal to the template generation logic.

Changes

File(s) Change Summary
change/apibara-655744e6-c51d-4d42-aacc-99cc9f04026c.json Added prerelease metadata file for "apibara" package, documenting a patch update to the CLI create template.
packages/cli/src/create/templates.ts Refactored template logic: removed redundant indexerId assignment, made filter configuration chain-specific.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant TemplateGenerator

    User->>CLI: Run create command
    CLI->>TemplateGenerator: Generate indexer template
    TemplateGenerator->>TemplateGenerator: Access runtimeConfig["indexerId"]
    TemplateGenerator->>TemplateGenerator: Set filter property based on chain (Ethereum: logs, Starknet: events)
    TemplateGenerator-->>CLI: Return configured template
    CLI-->>User: Output generated template
Loading

Possibly related PRs

Poem

In the warren where templates grow,
A rabbit tweaks the way filters flow.
Ethereum logs, Starknet events,
No more headers—just chain intents!
With prerelease notes tucked in a file,
The CLI hops ahead in style.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 523afc8 and 1bfd29e.

📒 Files selected for processing (2)
  • change/apibara-655744e6-c51d-4d42-aacc-99cc9f04026c.json (1 hunks)
  • packages/cli/src/create/templates.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (3)
packages/cli/src/create/templates.ts (2)

90-90: Direct access to indexer configuration is a cleaner approach

The change to directly access runtimeConfig["${indexerId}"] simplifies the code by using string interpolation instead of an intermediate variable, making the code more straightforward.


112-112: Good implementation of chain-specific filtering

This change appropriately applies different filter settings based on the chain type:

  • For Ethereum: logs: []
  • For Starknet: events: []

Removing the generic header: "always" filter in favor of these chain-specific filters provides more precise and relevant filtering options for each blockchain type.

change/apibara-655744e6-c51d-4d42-aacc-99cc9f04026c.json (1)

1-7: Appropriate change metadata for patch release

The prerelease metadata file correctly documents this as a patch-level change, which is appropriate since the modifications only affect the internal template generation logic and don't change any public APIs or exported entities.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@jaipaljadeja jaipaljadeja requested a review from fracek May 3, 2025 15:30
@fracek fracek merged commit 849eb6c into apibara:main May 3, 2025
2 checks passed
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.

2 participants