v3: Update benchmarks for Logger Middleware

[gaby]

Description

• Add more benchmarks for the logger middleware
• Add parallel benchmarks for the logger middleware

Note: The logger middleware adds a significant amount of overhead compared to not using it:

Benchmark/NoMiddleware-8                       25532379           44.41 ns/op           0 B/op           0 allocs/op
Benchmark/DefaultFormat-8                       4304126           268.7 ns/op          16 B/op           2 allocs/op

Related to #3048

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

• Benchmarks: Describe any performance benchmarks and improvements related to the changes.

Type of change

• Code consistency (non-breaking change which improves code reliability and robustness)

[coderabbitai]

Walkthrough

The recent changes to middleware/logger/logger_test.go involve a comprehensive refactor of benchmarking functions. Key enhancements include improved request context setup and structured benchmarking configurations. The singular Benchmark_Logger function was replaced with multiple b.Run calls for diverse scenarios, enhancing the overall performance testing framework for the Logger middleware in the fiber package.

Changes

File Path	Summary
middleware/logger/logger_test.go	Refactored benchmarkSetup, added benchmarkSetupParallel, and replaced Benchmark_Logger with multiple b.Run calls. Additionally, introduced Benchmark_Logger_Parallel to handle parallel benchmarks.

Sequence Diagram(s)

sequenceDiagram
    participant Tester
    participant BenchmarkSetup
    participant BenchmarkSetupParallel
    participant FiberApp
    participant LoggerMiddleware
    
    Note right of Tester: Refactored Benchmark Setup
    Tester->>BenchmarkSetup: Call with specific configurations
    
    Note right of Tester: Standard Benchmarking
    Tester->>LoggerMiddleware: Performance test using b.Run
    LoggerMiddleware-->>Tester: Returns benchmark results
    
    Note right of Tester: Parallel Benchmarking
    Tester->>BenchmarkSetupParallel: Call with specific configurations
    Tester->>LoggerMiddleware: Performance test using b.Run
    LoggerMiddleware-->>Tester: Returns parallel benchmark results

Loading

Poem

In lines of code, the changes gleam,
With b.Run calls, like a dream,
Logging benchmark's dance, refined,
Parallel paths, all aligned.
Fiber's flow, now tested true,
Benchmark's brilliance, shining through.
🐰✨

---

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
• Mastodon
• Reddit
• LinkedIn

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.94%. Comparing base (6108475) to head (b81267a).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3061      +/-   ##
==========================================
- Coverage   83.04%   82.94%   -0.10%     
==========================================
  Files         115      115              
  Lines        8315     8315              
==========================================
- Hits         6905     6897       -8     
- Misses       1077     1082       +5     
- Partials      333      336       +3     

Flag	Coverage Δ
unittests	82.94% <ø> (-0.10%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[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 6108475 and b81267a.

Files selected for processing (1)

• middleware/logger/logger_test.go (3 hunks)

Additional comments not posted (4)

middleware/logger/logger_test.go (4)

24-39: LGTM! Efficient benchmark setup.

The benchmarkSetup function is efficiently setting up the benchmark environment without introducing unnecessary overhead.

---

41-58: LGTM! Well-implemented parallel benchmark setup.

The benchmarkSetupParallel function correctly sets up the benchmark environment for parallel execution, ensuring accurate measurements.

---

647-800: LGTM! Improved benchmarking structure.

The refactoring of the Benchmark_Logger function into multiple b.Run calls enhances the structure and comprehensiveness of the benchmarking tests, allowing for better analysis of the results.

---

802-955: LGTM! Valuable addition of parallel benchmarks.

The Benchmark_Logger_Parallel function provides valuable insights into the performance of the logger middleware under concurrent load. The structure is clear, and the scenarios are well-defined.