stack icon indicating copy to clipboard operation
stack copied to clipboard

fix(ledger): Decode parameters in the ledger

Open flemzord opened this issue 1 year ago • 1 comments

flemzord avatar Jul 22 '24 19:07 flemzord

Walkthrough

The recent updates enhance the handling of URL parameters, specifically the account address, in the ledger's API. By implementing URL unescaping, these changes improve the robustness and reliability of account operations, such as retrieving and managing metadata. Additionally, error handling has been strengthened to ensure proper processing of encoded characters.

Changes

Files Change Summary
components/ledger/internal/api/v1/controllers_accounts.go Introduced URL unescaping for the address parameter in getAccount, postAccountMetadata, and deleteAccountMetadata functions to improve address handling.
components/ledger/internal/api/v2/controllers_accounts.go Enhanced error handling and input processing with URL unescaping in account-related functions to ensure accurate validation and processing of addresses.
components/ledger/internal/api/v1/controllers_accounts_test.go Added TestGetAccountWithEncoded to validate account retrieval with URL-encoded addresses, ensuring correct handling and response.
components/ledger/internal/api/v2/controllers_accounts_test.go Introduced TestGetAccountWithEncoded to verify account retrieval functionality with encoded addresses, enhancing test coverage.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant LedgerStore

    Client->>API: GET /account/{address}
    API->>API: Unescape address
    API->>LedgerStore: NewGetAccountQuery(unescaped address)
    LedgerStore-->>API: Return Account Data
    API-->>Client: 200 OK, Account Data

🐰 In the garden, so bright and fair,
New changes flutter through the air.
Encoded paths now softly play,
Robust and sure, they light the way.
With every hop and joyful cheer,
Our ledger sings—no need to fear! 🌼


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

[!TIP]

Early access features: enabled

We are currently testing the following features in early access:

  • Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues on the discussion post.

coderabbitai[bot] avatar Jul 22 '24 19:07 coderabbitai[bot]