feat: [#515] Input* methods of http.Request support retrieve data from query and route

[hwbrzzl]

📑 Description

Closes goravel/goravel#515

Summary by CodeRabbit

• New Features

  • Improved handling of input values for HTTP requests, ensuring consistent default values are returned when inputs are missing.

• Bug Fixes

  • Enhanced robustness in input retrieval methods, addressing issues with empty and default values.

• Tests

  • Updated test cases to reflect changes in input handling and default value logic, improving reliability of request processing tests.

✅ Checks

• Added test cases for my code

[coderabbitai]

Walkthrough

The changes in this pull request involve significant modifications to the ContextRequest struct and its associated methods in context_request.go, enhancing the retrieval and handling of query and route parameters. The Input, InputArray, and InputMap methods have been refactored to include existence checks and improved handling of default values. The related test cases in context_request_test.go have also been updated to reflect these changes, ensuring that default values are returned appropriately when inputs are missing.

Changes

File	Change Summary
context_request.go	Refactored Input, InputArray, and InputMap methods for better parameter retrieval and default value handling. Added existence checks for query and route parameters.
context_request_test.go	Updated test methods (TestInput_Empty, TestInput_Default, TestInputArray_Empty, TestInputMap_Empty) to reflect changes in default value handling and input retrieval.

Assessment against linked issues

Objective	Addressed	Explanation
Support retrieval of data from query and route (515)	✅

---

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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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.

[devhaozi]

Sort it

[hwbrzzl]

Thanks, done.

[devhaozi]

And test failed

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

context_request.go (1)

298-317: Consider adding documentation for the precedence order.

The implementation is solid and handles array inputs well. Consider adding a comment documenting the precedence order (httpBody -> query -> route -> default) to help future maintainers.

+// InputArray retrieves an array value from the request in the following order:
+// 1. HTTP body
+// 2. Query parameters
+// 3. Route parameters (comma-separated)
+// 4. Default value
 func (r *ContextRequest) InputArray(key string, defaultValue ...[]string) []string {

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d4ef1ca and 46517cb.

📒 Files selected for processing (2)

• context_request.go (2 hunks)
• context_request_test.go (5 hunks)

🔇 Additional comments (6)

context_request.go (3)

281-293: LGTM! Well-structured input retrieval implementation.

The implementation properly handles the precedence order and includes appropriate existence checks for query and route parameters.

---

325-333: LGTM! Consistent with array handling approach.

The implementation maintains consistency with InputArray by returning empty maps instead of nil, which is a good practice for avoiding nil pointer dereferences.

---

281-333: Verify test failures mentioned in PR comments.

The implementation looks solid, but there are reported test failures that need to be addressed.

context_request_test.go (3)

655-662: LGTM! Good test coverage for empty string handling.

The test properly verifies that empty strings are preserved rather than being replaced by default values.

---

Line range hint 675-685: LGTM! Proper verification of default value handling.

The test effectively verifies that default values are returned when no input is provided.

---

Line range hint 791-803: LGTM! Comprehensive testing of empty collection handling.

The tests properly verify that empty arrays and maps are handled correctly, maintaining consistency with the implementation's approach of avoiding nil returns.

Also applies to: 901-909