Skip to content

♻️ Refactor: remove two string fields in DefaultCtx to save 32 bytes#3353

Merged
ReneWerner87 merged 5 commits intogofiber:mainfrom
ksw2000:reduce-defaultCtx
Mar 23, 2025
Merged

♻️ Refactor: remove two string fields in DefaultCtx to save 32 bytes#3353
ReneWerner87 merged 5 commits intogofiber:mainfrom
ksw2000:reduce-defaultCtx

Conversation

@ksw2000
Copy link
Member

@ksw2000 ksw2000 commented Mar 15, 2025

Description

In the default context, pathBuffer and detectionPathBuffer can be used as path and detectionPath directly. We can remove two string fields and save 32 bytes for each context.

goos: linux
goarch: amd64
pkg: github.com/gofiber/fiber/v3
cpu: AMD EPYC 9J14 96-Core Processor                
                                             │   old.txt   │              new.txt               │
                                             │   sec/op    │   sec/op     vs base               │
_Ctx_AcquireReleaseFlow/withoutRequestCtx-16   41.30n ± 1%   39.10n ± 0%  -5.33% (p=0.000 n=25)
_Ctx_AcquireReleaseFlow/withRequestCtx-16      530.8n ± 1%   518.7n ± 1%  -2.28% (p=0.000 n=25)
geomean                                        148.1n        142.4n       -3.82%

                                             │   old.txt    │                new.txt                │
                                             │     B/op     │     B/op      vs base                 │
_Ctx_AcquireReleaseFlow/withoutRequestCtx-16     3.000 ± 0%     3.000 ± 0%       ~ (p=1.000 n=25) ¹
_Ctx_AcquireReleaseFlow/withRequestCtx-16      1.532Ki ± 0%   1.532Ki ± 0%       ~ (p=1.000 n=25) ¹
geomean                                          68.61          68.61       +0.00%
¹ all samples are equal

                                             │  old.txt   │               new.txt               │
                                             │ allocs/op  │ allocs/op   vs base                 │
_Ctx_AcquireReleaseFlow/withoutRequestCtx-16   1.000 ± 0%   1.000 ± 0%       ~ (p=1.000 n=25) ¹
_Ctx_AcquireReleaseFlow/withRequestCtx-16      5.000 ± 0%   5.000 ± 0%       ~ (p=1.000 n=25) ¹
geomean                                        2.236        2.236       +0.00%
¹ all samples are equal

Type of change

  • Enhancement (improvement to existing features and functionality)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 15, 2025 •
edited
Loading

Walkthrough

This pull request refactors the handling of HTTP paths by updating the DefaultCtx struct in ctx.go and modifying the invocation of the match function in router.go. The DefaultCtx struct eliminates buffer fields for paths, replacing them with byte slices and making corresponding adjustments in its methods. In router.go, the parameters passed to the match function are now wrapped in utils.UnsafeString, indicating a conversion to a potentially unsafe string format.

Changes

File(s) Changes Summary
ctx.go - Removed pathBuffer and detectionPathBuffer fields.
- Added path and detectionPath as []byte.
- Updated Path, configDependentPaths, and getDetectionPath methods to utilize the new fields and handle string conversion correctly.
router.go - Adjusted the next method in the App struct to pass c.detectionPath and c.path to the match function using utils.UnsafeString.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant Ctx as DefaultCtx
    participant Utils
    participant Match as match()

    App->>Ctx: Process request context
    Ctx-->>App: Return modified path via getString()
    App->>Utils: Convert c.detectionPath to UnsafeString
    App->>Utils: Convert c.path to UnsafeString
    App->>Match: Call match(UnsafeString(detectionPath), UnsafeString(path))
Loading

Poem

I am a rabbit, quick and spry,
Hop-ping through code under the sky.
Buffers are gone; bytes now lead the way,
Paths are trimmed and pave a clearer day.
With every change, I dance and sing,
Celebrating code evolution with a joyful spring! 🐇

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 18be6c1 and b0cd1d1.

📒 Files selected for processing (1)
  • ctx.go (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • ctx.go

Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

🪧 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 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
Copy link

codecov bot commented Mar 15, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.73%. Comparing base (e947e03) to head (8796387).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #3353      +/-   ##
==========================================
+ Coverage   83.68%   83.73%   +0.05%     
==========================================
  Files         118      118              
  Lines       11728    11722       -6     
==========================================
+ Hits         9814     9816       +2     
+ Misses       1486     1480       -6     
+ Partials      428      426       -2
Flag Coverage Δ
unittests 83.73% <100.00%> (+0.05%) ⬆️

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ksw2000 ksw2000 marked this pull request as ready for review March 15, 2025 08:38
@ksw2000 ksw2000 requested a review from a team as a code owner March 15, 2025 08:38
@ksw2000 ksw2000 requested review from ReneWerner87, efectn, gaby and sixcolors and removed request for a team March 15, 2025 08:38
gaby
gaby reviewed Mar 17, 2025
View reviewed changes
Copy link
Member

@gaby gaby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one comment.

sixcolors
sixcolors reviewed Mar 17, 2025
View reviewed changes
@ReneWerner87
Copy link
Member

ReneWerner87 commented Mar 18, 2025

I will check it later today and probably merge

ReneWerner87
ReneWerner87 reviewed Mar 19, 2025
View reviewed changes
@ReneWerner87
Copy link
Member

ReneWerner87 commented Mar 19, 2025

I am still unsure, at that time the additional buffers were necessary to reduce the allocations and preserve the original
can we find the case from back then and check it again?

@ksw2000
Copy link
Member Author

ksw2000 commented Mar 20, 2025

I am still unsure, at that time the additional buffers were necessary to reduce the allocations and preserve the original can we find the case from back then and check it again?

I reduce the two string fields in the defautCtx and keep the original two buffers. I think the c.detectionPath and c.path can be saved by []byte in the sturct. They can be lazy converted to the string until the user calls c.Path() or c.detectPath().

@ReneWerner87
Copy link
Member

ReneWerner87 commented Mar 20, 2025

I am still unsure, at that time the additional buffers were necessary to reduce the allocations and preserve the original can we find the case from back then and check it again?

I reduce the two string fields in the defautCtx and keep the original two buffers. I think the c.detectionPath and c.path can be saved by []byte in the sturct. They can be lazy converted to the string until the user calls c.Path() or c.detectPath().

yes already understood, just want to make sure that we don't have any performance losses(more allocs) or that the strings are not changed by the referencing

I will test this by hand
then merge, have to make sure again, because there was a case back then

@ksw2000 ksw2000 requested a review from ReneWerner87 March 21, 2025 15:53
@ReneWerner87
Copy link
Member

ReneWerner87 commented Mar 23, 2025

really good work, I checked everything again and we also have tests for the cases where I suspected that something could still go wrong

https://github.com/ksw2000/fiber/blob/395c8fafa96719cfcce808876c4b11914ca34efc/app_test.go#L500

thanks for your work and patience

@ReneWerner87 ReneWerner87 added this to v3 Mar 23, 2025
@ReneWerner87 ReneWerner87 added this to the v3 milestone Mar 23, 2025
@ReneWerner87 ReneWerner87 merged commit ef40c04 into gofiber:main Mar 23, 2025
25 of 27 checks passed
@github-project-automation github-project-automation bot moved this to Done in v3 Mar 23, 2025
@ksw2000 ksw2000 changed the title ♻️ Refactor: reduce DefaultCtx from 768 bytes to 736 bytes ♻️ Refactor: remove two string fields in DefaultCtx to save 32 bytes Mar 25, 2025
@coderabbitai coderabbitai bot mentioned this pull request Aug 22, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Sep 3, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 4, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Dec 25, 2025
Merged
9 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jan 31, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sixcolors sixcolors sixcolors left review comments

@gaby gaby gaby approved these changes

@ReneWerner87 ReneWerner87 ReneWerner87 approved these changes

@efectn efectn Awaiting requested review from efectn efectn is a code owner automatically assigned from gofiber/maintainers

Assignees

No one assigned

Labels

⚡️ Performance v3

Projects

v3
Status: Done

Milestone

v3.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@ksw2000 @ReneWerner87 @gaby @sixcolors