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.

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

refactor(katana): fix feeder gateway types #2760

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Conversation

kariy
Copy link
Member

@kariy kariy commented Dec 3, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced API request handling with the ability to bypass rate limits using an API key.
    • Introduced new methods for fetching blocks and managing resource bounds in transactions.
    • Added new deserialization functions for handling hexadecimal and decimal numeric types.
  • Bug Fixes

    • Improved error handling for invalid header values during API requests.
  • Documentation

    • Added a new module for serialization utilities to streamline code organization.
  • Refactor

    • Updated transaction structures for better clarity and resource management.

Copy link

coderabbitai bot commented Dec 3, 2024

Walkthrough

Ohayo, sensei! This pull request introduces significant enhancements to the SequencerGateway client in client.rs, including new error handling for HTTP request headers and an optional API key for bypassing rate limits. It also adds a method for fetching blocks by ID or tag. Additionally, a new serde_utils module is created for improved deserialization of numeric types, while transaction-related structures are refined to better manage resource bounds and optional contract addresses. Overall, these changes improve functionality and structure across the codebase.

Changes

File Path Change Summary
crates/katana/feeder-gateway/src/client.rs - Added constant X_THROTTLING_BYPASS.
- Updated Error enum with InvalidHeaderValue.
- Renamed client to http_client in SequencerGateway.
- Added optional api_key field and method with_api_key.
- Modified send method to include API key in headers.
- Added get_block method.
crates/katana/feeder-gateway/src/types/mod.rs - Introduced new module serde_utils.
crates/katana/feeder-gateway/src/types/serde_utils.rs - Added functions for deserializing u64 and u128 from hexadecimal and decimal formats.
crates/katana/feeder-gateway/src/types/transaction.rs - Added ResourceBounds and ResourceBoundsMapping structs.
- Updated contract_address in RawDeployAccountTx to be optional.
- Refactored deserialization functions to serde_utils.

Possibly related PRs


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

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.

Copy link

@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 (2)
crates/katana/feeder-gateway/src/types/serde_utils.rs (2)

4-30: Refactor duplicated deserialization logic

Ohayo sensei, consider abstracting the common deserialization logic for u64 and u128 to reduce code duplication and enhance maintainability.

Also applies to: 32-58, 60-82, 84-106


1-106: Add unit tests for deserialization functions

Ohayo sensei, to ensure the correctness and robustness of these deserialization functions, please consider adding comprehensive unit tests.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 75c43a8 and 99e14da.

📒 Files selected for processing (4)
  • crates/katana/feeder-gateway/src/client.rs (9 hunks)
  • crates/katana/feeder-gateway/src/types/mod.rs (1 hunks)
  • crates/katana/feeder-gateway/src/types/serde_utils.rs (1 hunks)
  • crates/katana/feeder-gateway/src/types/transaction.rs (8 hunks)
✅ Files skipped from review due to trivial changes (1)
  • crates/katana/feeder-gateway/src/types/mod.rs
🔇 Additional comments (1)
crates/katana/feeder-gateway/src/types/transaction.rs (1)

136-136: Verify handling of missing contract_address in DeployAccountTx

Ohayo sensei, when contract_address is not provided, the code defaults it to a zero address using unwrap_or_default(). Please verify that this behavior is appropriate and that downstream components can handle a zero contract_address without issues.

Also applies to: 339-339, 360-360

Comment on lines +23 to +25
#[error("failed to parse header value '{value}'")]
InvalidHeaderValue { value: String },

Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Avoid leaking API keys in error messages

Ohayo sensei, including the API key in error messages may expose sensitive information. Please modify the error handling to prevent leaking the API key value.

Apply this diff to address the issue:

-    #[error("failed to parse header value '{value}'")]
-    InvalidHeaderValue { value: String },
+    #[error("failed to parse API key header value")]
+    InvalidHeaderValue,
-            .map_err(|_| Error::InvalidHeaderValue { value: key.to_string() })?;
+            .map_err(|_| Error::InvalidHeaderValue)?;

Also applies to: 152-155

Copy link

codecov bot commented Dec 3, 2024

Codecov Report

Attention: Patch coverage is 5.92593% with 127 lines in your changes missing coverage. Please review.

Project coverage is 54.63%. Comparing base (75c43a8) to head (99e14da).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...tes/katana/feeder-gateway/src/types/serde_utils.rs 0.00% 92 Missing ⚠️
...tes/katana/feeder-gateway/src/types/transaction.rs 0.00% 19 Missing ⚠️
crates/katana/feeder-gateway/src/client.rs 33.33% 16 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2760      +/-   ##
==========================================
- Coverage   54.69%   54.63%   -0.07%     
==========================================
  Files         427      428       +1     
  Lines       53918    54001      +83     
==========================================
+ Hits        29490    29501      +11     
- Misses      24428    24500      +72     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

1 participant