indexer: fix reconnect on internal server errors

[jaipaljadeja]

Earlier, we had a reconnect logic for only ClientError instance, which wouldn't work for ServerError. So added a check for the same. Now indexer will reconnect on both ClientError and ServerError with status INTERNAL.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce two new JSON files for the @apibara/indexer and @apibara/protocol packages. These files define prerelease patch updates with metadata and comments regarding fixes for reconnection on internal server errors. In addition, the error handling in the runWithReconnect function in the indexer package is enhanced by differentiating between ClientError and ServerError, updating log messages, and initiating a reconnection attempt. The protocol client module is updated to export the newly supported ServerError from the "nice-grpc" package.

Changes

File(s)	Summary
change/@apibara-indexer-*.json, change/@apibara-protocol-*.json	Added new JSON files to define prerelease patch versions with reconnection fix metadata for internal server errors.
packages/indexer/src/indexer.ts	Enhanced error handling in runWithReconnect: now checks for both ClientError and ServerError, updates log messages dynamically, and triggers a reconnection attempt.
packages/protocol/src/client.ts	Updated export statement to include ServerError from "nice-grpc" alongside other entities.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Requester
    participant Indexer as runWithReconnect
    participant Logger as Consola

    Caller->>Indexer: Initiate operation
    alt Error Occurs (ClientError/ServerError)
        Indexer->>Indexer: Check error type (isServerError?)
        Indexer->>Logger: Log "Internal [server/client] error: <message>"
        Indexer->>Logger: Log "Reconnecting..."
        Indexer->>Caller: Attempt reconnection
    else No Error
        Indexer->>Caller: Return successful response
    end

Loading

Possibly related PRs

• cli: remove esbuild plugin from rollup config #142: Introduced a JSON update for the @apibara/indexer package, specifying a prerelease version addressing reconnection issues.
• indexer: reconnect indexer on internal stream errors #121: Enhanced error handling and reconnection logic for the indexer by distinguishing between client and server errors.

Poem

I'm a rabbit coding on a sunny day,
Hopping through patches in a bouncy way.
New JSON files dance in the night,
With error checks that shine so bright.
Logging and reconnecting on the fly,
CodeRabbit smiles as the changes hop by!
🐇

---

📜 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 44cedbc and f0c7b47.

📒 Files selected for processing (4)

• change/@apibara-indexer-6840c283-48ae-4a3f-a3e7-706e002bd6a1.json (1 hunks)
• change/@apibara-protocol-aa5f0bd5-4da3-47e9-997b-32940c921233.json (1 hunks)
• packages/indexer/src/indexer.ts (2 hunks)
• packages/protocol/src/client.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

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

packages/protocol/src/client.ts (3)

• ClientError (19-19)
• ServerError (19-19)
• Status (19-19)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test

🔇 Additional comments (5)

change/@apibara-indexer-6840c283-48ae-4a3f-a3e7-706e002bd6a1.json (1)

1-7: LGTM: Appropriate changelog entry for the indexer package.

The JSON file correctly documents the patch-level change and describes the fix for reconnection on internal server errors, aligning with the PR objectives.

change/@apibara-protocol-aa5f0bd5-4da3-47e9-997b-32940c921233.json (1)

1-7: LGTM: Appropriate changelog entry for the protocol package.

The JSON file correctly documents the patch-level change and describes the fix for reconnection on internal server errors, which is necessary because the protocol package is now exporting the ServerError type.

packages/protocol/src/client.ts (1)

19-19: Adding ServerError export enables better error handling.

The update to export ServerError from "nice-grpc" is necessary to support the enhanced error handling in the indexer. This change allows the indexer to correctly identify and handle server-side errors.

packages/indexer/src/indexer.ts (2)

8-8: LGTM: Required import added for enhanced error handling.

Adding the ServerError import is necessary for the new error handling logic later in the file.

---

183-195: Well-implemented fix for handling internal server errors.

The enhanced error handling now properly checks for both ClientError and ServerError instances, with appropriate logging that distinguishes between server and client errors. This addresses the PR objective of reconnecting on internal server errors.

The code correctly:

1. Checks if the error is either a ClientError or ServerError
2. Sets a flag to distinguish server errors from client errors
3. Updates the error message to reflect the error type
4. Adds clear logging when attempting to reconnect

✨ 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

• 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.