indexer: remove logs from default sink

[jaipaljadeja]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces a new JSON configuration for the @apibara/indexer package, specifying a "prerelease" type and removing logging from specific methods in the DefaultSink class. The logging functionality has been disabled in the invalidateOnRestart, invalidate, and finalize methods without altering their signatures. The changes are categorized as a minor patch update.

Changes

File Path	Change Summary
change/@apibara-indexer-cd0b7206-2b02-4573-9b98-d6fb848cf4e4.json	Added new JSON configuration for @apibara/indexer with fields for type, comment, packageName, email, and dependentChangeType.
packages/indexer/src/sink.ts	Removed logging functionality from invalidateOnRestart, invalidate, and finalize methods in DefaultSink.

Possibly related PRs

• indexer: update drizzle and drizzle sink #107: Introduces a new JSON file for the @apibara/indexer package, similar to the main PR.
• indexer: rename pgTable to pgIndexerTable #110: Involves a new JSON file that specifies a prerelease version for the @apibara/indexer.
• feat: add invalidation and finalize method implementations for sinks #118: Adds implementations for the invalidate and finalize methods in sinks, related to changes in the DefaultSink class.
• indexer: reconnect indexer on internal stream errors #121: Introduces a reconnect mechanism for the indexer, potentially relating to error handling improvements.

Suggested reviewers

• fracek

🐇 In the code, I hop and play,
With JSON fields to brighten the day.
Logging's gone, a cleaner scene,
In the indexer, all is keen!
A patch so small, yet brings delight,
Let's code and jump, from morn till night! 🌟

---

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

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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/indexer/src/sink.ts (1)

35-35: Consider adding method documentation

While the empty implementation is correct, it would be helpful to add JSDoc comments explaining that this is an intentionally empty implementation for a minimal default sink.

+  /** Empty implementation for the default sink. Override this method to add custom finalization logic. */
   async finalize(cursor?: Cursor) {}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 534a10a and a8f034b.

📒 Files selected for processing (2)

• change/@apibara-indexer-cd0b7206-2b02-4573-9b98-d6fb848cf4e4.json (1 hunks)
• packages/indexer/src/sink.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• change/@apibara-indexer-cd0b7206-2b02-4573-9b98-d6fb848cf4e4.json

🔇 Additional comments (3)

packages/indexer/src/sink.ts (3)

31-31: LGTM: Empty implementation aligns with PR objectives

The removal of logging from this method is consistent with the goal of providing a minimal default sink implementation.

---

33-33: LGTM: Empty implementation aligns with PR objectives

The removal of logging from this method is consistent with the goal of providing a minimal default sink implementation.

---

31-35: Verify documentation updates

With the removal of logging from the default sink, we should ensure that the documentation is updated to reflect this change and guide users who might need logging functionality.