Skip to content

♻️ refactor: Rename benchmark cases - #4383

Merged
ReneWerner87 merged 1 commit into
gofiber:mainfrom
alexandear-org:test/rename-path-benchmark
May 29, 2026
Merged

ReneWerner87 merged 1 commit into
gofiber:mainfrom
alexandear-org:test/rename-path-benchmark

Conversation

@alexandear

Copy link
Copy Markdown
Contributor

Description

Currently, the Benchmark Markdown table is broken for the Benchmark_Path_matchParams and Benchmark_RoutePatternMatch benchmarks (e.g., see https://github.com/gofiber/fiber/actions/runs/26518416331):

image

It's because of the | used in the test names that is interpreted as the table border in the Markdown. This PR replaces | with _ to fix that.

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.
  • Documentation Update: Detail the updates made to the documentation and links to the changed files.
  • Changelog/What's New: Include a summary of the additions for the upcoming release notes.
  • Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
  • API Alignment with Express: Explain how the changes align with the Express API.
  • API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
  • Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to existing features and functionality)
  • Documentation update (changes to documentation)
  • Performance improvement (non-breaking change which improves efficiency)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

  • 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.

Copilot AI review requested due to automatic review settings May 29, 2026 13:35
@alexandear
alexandear requested a review from a team as a code owner May 29, 2026 13:35
@coderabbitai

coderabbitai Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Two benchmark subtest names in path_test.go are updated to use underscore separators instead of pipe separators. The changes affect Benchmark_Path_matchParams and Benchmark_RoutePatternMatch naming conventions only.

Changes

Benchmark subtest naming

Layer / File(s) Summary
Benchmark subtest name formatting
path_test.go
Subtest names in Benchmark_Path_matchParams (line 358) and Benchmark_RoutePatternMatch (line 391) updated from pipe-delimited (`"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

🧹 Updates, v3, codex

Suggested reviewers

  • sixcolors
  • efectn
  • ReneWerner87

Poem

🐰 A dash becomes a line so clean,
Underscore flow, a benchmark's sheen,
Two tests rename with gentle ease,
Path-matching names now sure to please! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title 'refactor: Rename benchmark cases' is partially related but misleading—the actual purpose is fixing broken Markdown table rendering by replacing pipe characters with underscores, not general refactoring. Consider a more accurate title like 'test: rename benchmark cases to fix Markdown table' or 'test: replace pipe with underscore in benchmark names to fix Markdown rendering'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description provides clear context about the problem (broken Markdown table due to pipe characters), explains the solution (replacing pipe with underscore), and completes the required template sections appropriately.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ReneWerner87 ReneWerner87 added this to v3 May 29, 2026
@ReneWerner87 ReneWerner87 added this to the v3 milestone May 29, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the benchmark subtest names in path_test.go by replacing spaces and pipe characters with underscores, which improves compatibility with test runners and command-line tools. There are no review comments, and I have no additional feedback to provide.

@codecov

codecov Bot commented May 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.34%. Comparing base (f0752ce) to head (26b8bd0).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4383      +/-   ##
==========================================
- Coverage   91.38%   91.34%   -0.05%     
==========================================
  Files         132      132              
  Lines       13108    13108              
==========================================
- Hits        11979    11973       -6     
- Misses        711      716       +5     
- Partials      418      419       +1     
Flag Coverage Δ
unittests 91.34% <ø> (-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.

@ReneWerner87

Copy link
Copy Markdown
Member

thx

@gaby gaby changed the title 🚨 test: rename benchmark cases to fix Markdown table ♻️ refactor: Rename benchmark cases May 29, 2026
@ReneWerner87
ReneWerner87 merged commit 0534345 into gofiber:main May 29, 2026
20 checks passed
@github-project-automation github-project-automation Bot moved this to Done in v3 May 29, 2026
@alexandear
alexandear deleted the test/rename-path-benchmark branch May 29, 2026 13:56
@ReneWerner87 ReneWerner87 modified the milestones: v3, v3.4.0 Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants