[feature] fibernewrelic add skip middleware next function. by amantinetti · Pull Request #1148 · gofiber/contrib

amantinetti · 2024-07-03T11:09:04Z

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.

coderabbitai · 2024-07-03T11:09:12Z

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

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.

coderabbitai

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.

ReneWerner87 · 2024-07-03T11:15:11Z

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

amantinetti · 2024-07-03T11:30:09Z

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

@ReneWerner87 Test cases are added :D

coderabbitai

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.

amantinetti added 2 commits July 3, 2024 07:02

add next middlewate option on fibernewrelic

918b52f

Update newrelic readme

8a7d971

amantinetti requested a review from a team as a code owner July 3, 2024 11:09

amantinetti requested review from ReneWerner87, efectn, gaby and sixcolors and removed request for a team July 3, 2024 11:09

github-actions Bot added the ✏️ Feature New feature or request label Jul 3, 2024

coderabbitai Bot reviewed Jul 3, 2024

View reviewed changes

Comment thread fibernewrelic/README.md

ReneWerner87 approved these changes Jul 3, 2024

View reviewed changes

add next test case in fibernewrelic

6e643b2

coderabbitai Bot reviewed Jul 3, 2024

View reviewed changes

ReneWerner87 merged commit 2ca8b42 into gofiber:main Jul 3, 2024

coderabbitai Bot mentioned this pull request May 22, 2026

feat: add Skip check after request handling to support downstream middleware context #1939

Merged

Navigation Menu

Uh oh!

Uh oh!

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

[feature] fibernewrelic add skip middleware next function.#1148
ReneWerner87 merged 3 commits into
gofiber:mainfrom
GoFirmex:main

amantinetti commented Jul 3, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 3, 2024 •

edited

Loading

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

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

ReneWerner87 commented Jul 3, 2024

Uh oh!

amantinetti commented Jul 3, 2024

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

amantinetti commented Jul 3, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

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

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ReneWerner87 commented Jul 3, 2024

Uh oh!

amantinetti commented Jul 3, 2024

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

amantinetti commented Jul 3, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 3, 2024 •

edited

Loading

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

CodeRabbit Configration File (`.coderabbit.yaml`)