efectn commented 3 days ago

Description

Replace internal/schema with https://github.com/gofiber/schema which is fork of gorilla/schema.

Also closes https://github.com/gofiber/fiber/pull/2699 as gorilla recently added default tag support.

Changes introduced

[x] Benchmarks: Describe any performance benchmarks and improvements related to the changes.
[x] Documentation Update: Detail the updates made to the documentation and links to the changed files.
[ ] Changelog/What's New: Include a summary of the additions for the upcoming release notes.
[ ] Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
[x] API Alignment with Express: Explain how the changes align with the Express API.
[x] API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
[x] Examples: Provide examples demonstrating the new features or changes in action.

Type of change

[x] Enhancement (improvement to existing features and functionality)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

[ ] Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
[ ] Conducted a self-review of the code and provided comments for complex or critical parts.
[ ] Updated the documentation in the /docs/ directory for Fiber's documentation.
[ ] Added or updated unit tests to validate the effectiveness of the changes or new features.
[ ] Ensured that new and existing unit tests pass locally with the changes.
[ ] Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
[ ] Aimed for optimal performance with minimal allocations in the new code.
[ ] Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

coderabbitai[bot] commented 3 days ago

Walkthrough

The changes encompass enhancements to the Fiber framework's binding functionalities, including the introduction of default values for query parameters, headers, and cookies. The import paths for the schema package have been updated, transitioning from internal to public access. Several files related to schema processing, such as caching, encoding, and decoding, have been removed, streamlining the framework. Documentation has been expanded to include examples of the new default field capabilities, ensuring clarity for developers.

Changes

File(s)	Change Summary
`bind_test.go`	Added `Default` and `Defaults` fields to `Query2` and `Header2` structs; expanded tests for binding logic with default values.
`binder/mapping.go`, `error.go`, `error_test.go`	Updated import path for the `schema` package from internal to public; no changes in functionality.
`docs/api/bind.md`	Expanded documentation to include a new section on "Default Fields" with examples of default values.
`internal/schema/*`	Removed multiple files related to caching, encoding, and decoding, including associated types and methods.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Fiber
    participant Schema

    Client->>Fiber: Send request with parameters
    Fiber->>Schema: Decode parameters into struct
    Schema->>Fiber: Return populated struct
    Fiber->>Client: Respond with processed data

🐇 "In the meadow where bunnies play,
New defaults have come to stay.
With headers and queries, oh what a treat,
Binding made simple, oh so neat!
Hopping along, we celebrate,
Fiber's enhancements, truly great!" 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 3 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.50%. Comparing base (44cd700) to head (54778a2).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #3152 +/- ## ========================================== + Coverage 80.09% 82.50% +2.40% ========================================== Files 117 113 -4 Lines 9043 8465 -578 ========================================== - Hits 7243 6984 -259 + Misses 1365 1081 -284 + Partials 435 400 -35 ``` | [Flag](https://app.codecov.io/gh/gofiber/fiber/pull/3152/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofiber) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/gofiber/fiber/pull/3152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofiber) | `82.50% <ø> (+2.40%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofiber#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

gaby commented 3 days ago

@efectn Did you add the changes we had here to gofiber/schema?

efectn commented 1 day ago