swagger icon indicating copy to clipboard operation
swagger copied to clipboard

Update gofiber compability from v2 to v3

Open adrieljss opened this issue 1 year ago • 2 comments

Here are the changes:

  • v3 drops support for the file system middleware, it is now changed to the Static Middleware. (Specified Here).
  • v3 Handler callbacks now needs non-pointer as parameter (*fiber.Ctx -> fiber.Ctx)
  • Changed redirection code. (Specified Here).

Might be breaking changes since v3 only supports Go 1.23+ (Specified Here)

Summary by CodeRabbit

  • New Features

    • Upgraded to the latest version of the Fiber framework, enhancing performance and compatibility.
  • Bug Fixes

    • Improved readability and functionality of redirect handling in the application.
  • Documentation

    • Updated test cases to ensure they align with the new framework, maintaining validation of Swagger API endpoints.

adrieljss avatar Dec 07 '24 11:12 adrieljss

Walkthrough

The changes in this pull request involve upgrading the gofiber/fiber package from version 2 to version 3. This upgrade includes modifications to middleware, specifically replacing the filesystem middleware with static middleware. Additionally, function signatures have been updated to accept fiber.Ctx instead of *fiber.Ctx. The error handling for template parsing remains unchanged, but the redirect handling has been improved for readability. The swagger_test.go file has also been updated to reflect the new import for the Fiber package, ensuring that existing tests continue to function correctly.

Changes

File Change Summary
swagger.go Upgraded from gofiber/fiber/v2 to gofiber/fiber/v3, replaced filesystem middleware with static, updated function signatures to accept fiber.Ctx, improved redirect handling.
swagger_test.go Updated import from gofiber/fiber/v2 to gofiber/fiber/v3, no structural changes to test functions, maintained existing logic.

Possibly related PRs

  • gofiber/fiber#3181: Updates documentation to reflect significant changes in Fiber v3, including method signature updates related to context handling.
  • gofiber/fiber#3193: Improves naming conventions for context-related functions, directly relating to context management changes in this PR.
  • gofiber/fiber#3226: Establishes Go version 1.23 as the minimum required version, relevant due to the upgrade to Fiber v3 necessitating compatibility with newer Go versions.

Poem

🐇 In the land of code where fibers weave,
A hop to version three, we believe!
Static files now dance in the light,
Redirects are clearer, oh what a sight!
With tests still strong, they leap and bound,
In the garden of code, new joys abound! 🌼


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>, 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 or @coderabbitai title 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.

coderabbitai[bot] avatar Dec 07 '24 11:12 coderabbitai[bot]

Thx for your work

ReneWerner87 avatar Dec 07 '24 11:12 ReneWerner87