gofiber / contrib

🧬 Repository for third party middlewares with dependencies
https://docs.gofiber.io/contrib/
MIT License
226 stars 119 forks source link

upgrade otelfiber to fiber v3 #1163

Open heisGarvit opened 3 months ago

heisGarvit commented 3 months ago

PR contains upgrade of otelfiber to v3 for compatibility with fiber v3

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The otelfiber package has been updated to support Fiber v3, requiring changes to function signatures and import paths. Notably, context handling has shifted from pointer receivers to value receivers, affecting middleware implementations. Compatibility with Go has also been updated from version 1.19 to 1.21. Overall, these changes enhance functionality and align with the latest versions of both the Fiber framework and OpenTelemetry conventions.

Changes

Files Change Summary
otelfiber/README.md Updated usage and compatibility notes; changed function signatures from pointer to value type.
otelfiber/config.go Modified function signatures to accept fiber.Ctx instead of *fiber.Ctx; updated options.
otelfiber/doc.go Changed import path to otelfiber/v3.
otelfiber/example/server.go Updated import paths; changed context parameter types; updated service name for tracing.
otelfiber/fiber.go Revised import paths; adjusted context handling in middleware functions.
otelfiber/otelfiber_test/fiber_test.go Updated import paths; changed context parameter types in tests; increased test timeout.
otelfiber/semconv.go Updated functions to use fiber.Ctx; modified method calls for HTTP scheme retrieval.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Middleware

    Client->>Server: Request
    Server->>Middleware: Pass context
    Middleware-->>Server: Process context
    Server-->>Client: Response

🐰 In fields of green where changes bloom,
A hop of joy, dispelling gloom.
With Fiber's strength, we leap and play,
New paths to run, a brighter day!
Let's celebrate with hops and cheer,
For updates bring us ever near! 🌼


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 .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
gaby commented 3 months ago

@heisGarvit v3 is still in beta, middlewares will be upgraded once we are closer to release.

heisGarvit commented 3 months ago

@gaby is there any plan for beta release of v3 middleware? So that users of fiber v3 can use opentelemetry to track performance of upcoming release?