🧹 chore: Improve Performance of Fiber Router #3261

gaby · 2024-12-21T20:14:44Z

Description

Micro performance improvements for the Fiber Router.

Improvements to RemoveEscapeChar()

After:

ubuntu@ubuntu:~/Desktop/git/fiber$ go test -benchmem -run=^$ -bench ^Benchmark_Utils_RemoveEscapeChar$ github.com/gofiber/fiber/v3 -count=4
goos: linux
goarch: amd64
pkg: github.com/gofiber/fiber/v3
cpu: AMD Ryzen 7 7800X3D 8-Core Processor           
Benchmark_Utils_RemoveEscapeChar-4   	48737022	        21.87 ns/op	      16 B/op	       1 allocs/op
Benchmark_Utils_RemoveEscapeChar-4   	51360970	        21.88 ns/op	      16 B/op	       1 allocs/op
Benchmark_Utils_RemoveEscapeChar-4   	53682570	        21.97 ns/op	      16 B/op	       1 allocs/op
Benchmark_Utils_RemoveEscapeChar-4   	45811604	        21.91 ns/op	      16 B/op	       1 allocs/op
PASS
ok  	github.com/gofiber/fiber/v3	4.494s

Before:

ubuntu@ubuntu:~/Desktop/git/fiber$ go test -benchmem -run=^$ -bench ^Benchmark_Utils_RemoveEscapeChar$ github.com/gofiber/fiber/v3 -count=4
goos: linux
goarch: amd64
pkg: github.com/gofiber/fiber/v3
cpu: AMD Ryzen 7 7800X3D 8-Core Processor           
Benchmark_Utils_RemoveEscapeChar-4   	34108017	        33.72 ns/op	      16 B/op	       1 allocs/op
Benchmark_Utils_RemoveEscapeChar-4   	31172214	        33.48 ns/op	      16 B/op	       1 allocs/op
Benchmark_Utils_RemoveEscapeChar-4   	34733971	        33.61 ns/op	      16 B/op	       1 allocs/op
Benchmark_Utils_RemoveEscapeChar-4   	34788264	        33.87 ns/op	      16 B/op	       1 allocs/op
PASS
ok  	github.com/gofiber/fiber/v3	4.707s

Router Improvements

TBD (Coming soon)

Type of change

Performance improvement (non-breaking change which improves efficiency)

coderabbitai · 2024-12-21T20:14:50Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.

codecov · 2024-12-21T20:16:11Z

Codecov Report

Attention: Patch coverage is 98.18182% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.72%. Comparing base (1c9b6ce) to head (23e90c0).

Files with missing lines	Patch %	Lines
router.go	97.87%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3261      +/-   ##
==========================================
- Coverage   82.72%   82.72%   -0.01%     
==========================================
  Files         115      115              
  Lines       11365    11363       -2     
==========================================
- Hits         9402     9400       -2     
  Misses       1557     1557              
  Partials      406      406

Flag	Coverage Δ
unittests	`82.72% <98.18%> (-0.01%)`	⬇️

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.

gaby · 2024-12-21T20:17:31Z

path.go

@@ -620,10 +620,16 @@ func GetTrimmedParam(param string) string {

 // RemoveEscapeChar remove escape characters
 func RemoveEscapeChar(word string) string {
-	if strings.IndexByte(word, escapeChar) != -1 {


This change alone saves 12ns/op

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.50.

Benchmark suite	Current: `23e90c0`	Previous: `1c9b6ce`	Ratio
`Benchmark_RoutePatternMatch//api/:param/fixedEnd_	not_match	_/api/abc/def/fixedEnd - allocs/op`	`14` allocs/op
`BenchmarkAppendMsgitem-4_middleware_csrf - MB/s`	`3159.86` MB/s	`1615.48` MB/s	`1.96`
`BenchmarkAppendMsgstorageManager - MB/s`	`3221.65` MB/s	`1612.35` MB/s	`2.00`
`BenchmarkAppendMsgdata - MB/s`	`3225.24` MB/s	`1612.94` MB/s	`2.00`

This comment was automatically generated by workflow using github-action-benchmark.

gaby added 3 commits December 20, 2024 21:00

Initial improvements

6152f31

Update test

6e1836e

Improve RemoveEscapeChar performance

23e90c0

gaby added 🧹 Updates v3 labels Dec 21, 2024

gaby commented Dec 21, 2024

View reviewed changes

github-actions bot reviewed Dec 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🧹 chore: Improve Performance of Fiber Router #3261

🧹 chore: Improve Performance of Fiber Router #3261

gaby commented Dec 21, 2024

coderabbitai bot commented Dec 21, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Dec 21, 2024

gaby Dec 21, 2024

github-actions bot left a comment

🧹 chore: Improve Performance of Fiber Router #3261

Are you sure you want to change the base?

🧹 chore: Improve Performance of Fiber Router #3261

Conversation

gaby commented Dec 21, 2024

Description

Improvements to RemoveEscapeChar()

After:

Before:

Router Improvements

Type of change

coderabbitai bot commented Dec 21, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Dec 21, 2024

Codecov Report

gaby Dec 21, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

CodeRabbit Configuration File (`.coderabbit.yaml`)