protocol: make client options configurable

[fracek]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

A new JSON file for the @apibara/protocol package has been added, indicating a prerelease version with configurable client options. The packages/protocol/src/client.ts file has been modified to define a new type, CreateClientOptions, which consolidates various client configuration properties. The createClient function has been updated to accept this new options parameter, enhancing the flexibility of client creation by allowing optional properties for credentials and channel options.

Changes

File Path	Change Summary
change/@apibara-protocol-5cbc4329-6566-4faf-a04d-bdd739e1cca4.json	New JSON file added with metadata indicating a prerelease version and configurable client options.
packages/protocol/src/client.ts	Introduced CreateClientOptions type, updated createClient function to accept options parameter, and modified related function calls for improved client configuration.

Poem

In the meadow where options bloom,
A new client dances, dispelling gloom.
With choices aplenty, it hops with glee,
Configurable paths, as bright as can be!
So let’s cheer for the changes, a joyful spree! 🐇✨

---

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 (2)

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

49-55: LGTM: Well-structured CreateClientOptions type.

The new CreateClientOptions type is well-defined and includes all necessary options for flexible client configuration. It aligns well with the existing codebase style.

Consider adding a brief JSDoc comment to describe the purpose of this type, for improved code documentation:

/**
 * Options for creating a DNA client.
 */
export type CreateClientOptions = {
  // ... existing code
};

---

63-72: LGTM: Correct implementation of new options in createClient.

The changes correctly implement the use of the new CreateClientOptions type in both createChannel and grpcCreateClient function calls. The use of optional chaining is appropriate.

For consistency, consider using optional chaining for all option properties:

const channel = createChannel(
  streamUrl,
  options?.credentials,
  options?.channelOptions
);

const client: proto.stream.DnaStreamClient = grpcCreateClient(
  proto.stream.DnaStreamDefinition,
  channel,
  options?.defaultCallOptions
);

This change makes the code more consistent in how it handles potentially undefined properties.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2ee8cc1 and 4c3b209.

📒 Files selected for processing (2)

• change/@apibara-protocol-5cbc4329-6566-4faf-a04d-bdd739e1cca4.json (1 hunks)
• packages/protocol/src/client.ts (2 hunks)

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

• change/@apibara-protocol-5cbc4329-6566-4faf-a04d-bdd739e1cca4.json

🧰 Additional context used

🔇 Additional comments (3)

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

3-4: LGTM: New imports added correctly.

The new imports for ChannelCredentials and ChannelOptions are correctly added and necessary for the new CreateClientOptions type.

---

61-61: LGTM: Improved createClient function signature.

The function signature update simplifies the API by using the new CreateClientOptions type. The default empty object for options maintains backward compatibility, which is a good practice.

---

Line range hint 1-156: Overall: Well-implemented changes to improve client configuration flexibility.

The introduction of the CreateClientOptions type and the updates to the createClient function significantly enhance the API's flexibility and maintainability. The changes are well-implemented and consistent with the existing codebase style. Minor suggestions for documentation and consistency have been provided in the individual comments.