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

🧹 chore: Add parallel benchmark for Next() #3259

Merged
merged 2 commits into from
Dec 21, 2024
Merged

🧹 chore: Add parallel benchmark for Next() #3259

merged 2 commits into from
Dec 21, 2024

Conversation

gaby
Copy link
Member

@gaby gaby commented Dec 21, 2024

Description

  • Add b.RunParallel() version of the Next() benchmark.

Results:

ubuntu@ubuntu:~/Desktop/git/fiber$ go test -benchmem -run=^$ -bench ^Benchmark_Router_Next_Default_Parallel$ github.com/gofiber/fiber/v2 -count=10
goos: linux
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: AMD Ryzen 7 7800X3D 8-Core Processor           
Benchmark_Router_Next_Default_Parallel-4   	143252916	         9.433 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	145309903	         8.137 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	146474128	         8.073 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	146365718	         8.013 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	148128357	         8.101 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	123850269	         8.106 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	146204302	         8.759 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	145994517	         8.156 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	146355158	         8.048 ns/op	       0 B/op	       0 allocs/op
Benchmark_Router_Next_Default_Parallel-4   	147689376	         8.131 ns/op	       0 B/op	       0 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	20.460s

@gaby gaby requested a review from a team as a code owner December 21, 2024 02:08
@gaby gaby requested review from sixcolors, ReneWerner87 and efectn and removed request for a team December 21, 2024 02:08
Copy link
Contributor

coderabbitai bot commented Dec 21, 2024

Walkthrough

The pull request introduces a new benchmark test function in the router_test.go file to evaluate the router's performance under parallel execution. The benchmark specifically tests the handler for a GET request to the root path ("/") using multiple concurrent goroutines. This addition aims to provide insights into the router's performance characteristics when handling parallel requests, without modifying any existing test functionality.

Changes

File Change Summary
router_test.go Added Benchmark_Router_Next_Default_Parallel benchmark function to test router performance in parallel execution

Sequence Diagram

sequenceDiagram
    participant Benchmark as Benchmark Runner
    participant Router as Router Handler
    participant Test as Test Goroutines

    Benchmark->>Test: Create Parallel Goroutines
    loop Each Goroutine
        Test->>Router: Send GET Request to "/"
        Router-->>Test: Return nil
    end
    Benchmark-->>Benchmark: Measure Performance
Loading

Poem

🐰 Parallel paths, a router's might,
Goroutines dancing, testing speed so bright
Benchmarks racing, metrics take flight
Performance measured, code running light
A rabbit's quest for speed's pure delight! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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.

@gaby gaby changed the title Add parallel benchmark for Next() 🧹 chore: Add parallel benchmark for Next() Dec 21, 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

🧹 Nitpick comments (1)
router_test.go (1)

910-912: Add assertions to verify handler behavior

While benchmarks primarily measure performance, it's good practice to include basic assertions to ensure the handler behaves correctly under parallel execution.

 for pb.Next() {
     h(fctx)
+    // Verify response status code
+    if fctx.Response.StatusCode() != StatusOK {
+        b.Errorf("Expected status code %d, got %d", StatusOK, fctx.Response.StatusCode())
+    }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9ff17d and 327d195.

📒 Files selected for processing (1)
  • router_test.go (1 hunks)
🔇 Additional comments (1)
router_test.go (1)

894-914: LGTM! Well-structured parallel benchmark implementation

The parallel benchmark implementation is well-structured and follows Go's testing conventions:

  1. Uses b.RunParallel correctly for concurrent execution
  2. Reports allocations with b.ReportAllocs()
  3. Properly manages benchmark timing with b.ResetTimer()
  4. Minimal test case that focuses on the core functionality

router_test.go Show resolved Hide resolved
@ReneWerner87 ReneWerner87 merged commit 47be681 into v2 Dec 21, 2024
28 checks passed
@ReneWerner87 ReneWerner87 added this to the Next Release milestone Dec 21, 2024
@gaby gaby deleted the add-bench branch December 22, 2024 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants