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

fix: panic on single letter query param zhttp #101

Merged
merged 1 commit into from
Feb 20, 2025

Conversation

Oudwins
Copy link
Owner

@Oudwins Oudwins commented Feb 20, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Improved data handling to prevent unexpected errors when processing short inputs.
  • New Features

    • Enhanced HTTP request processing with support for an additional query parameter, ensuring more robust and reliable data validation.

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Walkthrough

The pull request updates the safe extraction of data in the Get method of the urlDataProvider to ensure the key has a sufficient length before slicing. In addition, the test suite is modified by adding a new query parameter "q=test" to the request, updating the corresponding User struct with a new field Q, and extending the schema definition. These changes enhance robustness during key retrieval and extend test coverage by validating the new query parameter.

Changes

File Change Summary
zhttp/zhttp.go Modified the urlDataProvider.Get method to add a length check before slicing the key for "[]", preventing potential out-of-range errors.
zhttp/zhttp_test.go Updated TestRequestParams by adding query parameter q=test, introducing a new Q field in the User struct, updating the schema, and asserting the new value.

Sequence Diagram(s)

sequenceDiagram
    participant T as TestRequestParams
    participant D as urlDataProvider.Get
    participant U as UserStruct Mapper

    T->>D: Call Get(key: "q")
    D->>D: Check if len(key) > 2 and key ends with "[]"
    D-->>T: Return parameter value ("test")
    T->>U: Map returned data to User struct (field Q)
    U-->>T: User with Q = "test"
    T->>T: Assert Q equals "test"
Loading

Poem

Oh, what a hop and skip today,
I tweaked the code in a clever way.
Keys now checked with care so neat,
Query “q=test” adds a rhythmic beat.
With a twitch of my whiskers and a joyful cheer,
This bunny loves changes—code is clear!
🐰✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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. (Beta)
  • @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.

@Oudwins
Copy link
Owner Author

Oudwins commented Feb 20, 2025

This addresses #96

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
zhttp/zhttp_test.go (1)

75-75: Consider using consistent struct tags.

The struct uses param tags for other fields but zog for the new field Q. Consider using consistent tags across all fields.

-       Q         string   `zog:"q"`
+       Q         string   `param:"q"`
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9460ea2 and e8f36e9.

📒 Files selected for processing (2)
  • zhttp/zhttp.go (1 hunks)
  • zhttp/zhttp_test.go (4 hunks)
🔇 Additional comments (2)
zhttp/zhttp.go (1)

56-56: LGTM! Good fix for the panic issue.

The added length check prevents index out of range panic for short keys while maintaining the original array detection logic.

zhttp/zhttp_test.go (1)

59-59: LGTM! Good test coverage for the fix.

The test properly validates the handling of single letter query parameters through:

  1. Adding a single letter query param 'q'
  2. Validating its parsing and schema validation
  3. Ensuring correct value propagation

Also applies to: 75-75, 87-87, 101-101

@Oudwins Oudwins merged commit cd8d172 into master Feb 20, 2025
9 checks passed
@Oudwins Oudwins deleted the fix/single-letter-values-panic branch February 20, 2025 19:54
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