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

[feature] fibernewrelic add skip middleware next function. #1148

Merged
merged 3 commits into from
Jul 3, 2024

Conversation

amantinetti
Copy link
Contributor

@amantinetti amantinetti commented Jul 3, 2024

Add Next Function on config
Next defines a function to skip newrelic middleware when returned true.

Summary by CodeRabbit

  • New Features

    • Introduced a Next function in the configuration to allow skipping middleware based on a custom condition.
  • Bug Fixes

    • Updated ErrorStatusCodeHandler in the configuration to provide more flexibility in handling status codes.
  • Tests

    • Added new test cases to verify the behavior of the Next function in the middleware configuration.

@amantinetti amantinetti requested a review from a team as a code owner July 3, 2024 11:09
@amantinetti amantinetti requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team July 3, 2024 11:09
Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Walkthrough

The recent update introduces a new field, Next, to the Config struct in the Fiber New Relic middleware. This field is a function used to conditionally skip middleware execution based on custom logic. Corresponding changes have been made to the primary implementation and readme files, along with new test cases verifying the conditional execution logic.

Changes

File Change Summary
fibernewrelic/README.md Updated the Config section to include the new Next field, describing its type, purpose, and default value.
fibernewrelic/fiber.go Added the Next field to the Config struct and implemented conditional logic for skipping middleware execution if Next is provided and evaluates true.
fibernewrelic/fiber_test.go Added new test cases to validate the conditional execution provided by the Next field in the Fiber New Relic middleware.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant FiberApp
    participant NewRelicMiddleware
    participant NextHandler

    Client->>FiberApp: Send Request
    FiberApp->>NewRelicMiddleware: Pass to Middleware
    NewRelicMiddleware->>NewRelicMiddleware: Check `cfg.Next()`
    alt `cfg.Next()` is true
        NewRelicMiddleware->>NextHandler: Skip Middleware
    else `cfg.Next()` is false
        NewRelicMiddleware->>NewRelicMiddleware: Continue Middleware
    end
    NewRelicMiddleware->>FiberApp: Pass to Next Middleware/Handler
    FiberApp->>Client: Return Response
Loading

Poem

Fiber sped through lines now quick,
With a Next to pick or skip,
Routes and paths, it darted swift,
Middleware magic, code adrift.
Tests did prove, and changes sang,
🎉 In the realm where functions rang! 🚀

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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>.
    • 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 Configration 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.

@github-actions github-actions bot added the ✏️ Feature New feature or request label Jul 3, 2024
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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 484c131 and 8a7d971.

Files selected for processing (2)
  • fibernewrelic/README.md (1 hunks)
  • fibernewrelic/fiber.go (3 hunks)
Additional context used
Markdownlint
fibernewrelic/README.md

42-42: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

Additional comments not posted (4)
fibernewrelic/README.md (1)

32-41: LGTM!

The additions to the Config section are well-documented and align with the PR objectives.

fibernewrelic/fiber.go (3)

28-30: LGTM!

The addition of the Next property to the Config struct is clear and well-documented.


39-39: LGTM!

The default value for the Next property in ConfigDefault is correctly set to nil.


73-76: LGTM!

The conditional check for cfg.Next in the New function is correctly implemented.

fibernewrelic/README.md Show resolved Hide resolved
@ReneWerner87
Copy link
Member

@amantinetti could you add a testcase for the usage of this function

@amantinetti
Copy link
Contributor Author

@amantinetti could you add a testcase for the usage of this function

@ReneWerner87 Test cases are added :D

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8a7d971 and 6e643b2.

Files selected for processing (1)
  • fibernewrelic/fiber_test.go (1 hunks)
Additional comments not posted (2)
fibernewrelic/fiber_test.go (2)

276-306: Test case for skipping middleware execution looks good.

The test case ensures that the New Relic middleware is skipped when the Next function returns true.


308-338: Test case for continuing middleware execution looks good.

The test case ensures that the New Relic middleware continues execution when the Next function returns false.

@ReneWerner87 ReneWerner87 merged commit 2ca8b42 into gofiber:main Jul 3, 2024
51 of 59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✏️ Feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants