Skip to content

♻️ refact(state): Use GetState to reduce duplicate code #3542

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

Merged
merged 1 commit into from
Jun 23, 2025

Conversation

ksw2000
Copy link
Member

@ksw2000 ksw2000 commented Jun 23, 2025

Description

Use GetState to reduce duplicate code.

Besides, fix inconsistent comment for GetXXX

Type of change

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

Copy link
Contributor

coderabbitai bot commented Jun 23, 2025

Walkthrough

The changes refactor the typed getter methods of the State struct to use a generic helper function, GetState[T], for value retrieval and type assertion. This centralizes the logic for type assertions, reduces code duplication, and updates related comments. No public API or behavioral changes were introduced.

Changes

Files Change Summary
state.go Refactored all typed getter methods to delegate to a generic GetState[T] helper; updated comments.

Suggested reviewers

  • sixcolors
  • ReneWerner87

Poem

A rabbit hopped through fields of code,
Refactoring getters on its road.
With generics now the work is neat,
Centralized logic—what a treat!
No more repeats, just one clear way,
To fetch your state, hip-hip-hooray!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a258661 and 4283986.

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

137-139: Delegate GetString to generic GetState
This change centralizes the string retrieval logic via GetState[string], eliminating inline type assertions and preserving existing behavior.


143-145: Delegate GetInt to generic GetState
The integer getter now reuses GetState[int], maintaining correctness while reducing code duplication.


149-151: Delegate GetBool to generic GetState
Using GetState[bool] here consolidates the boolean retrieval and assertion logic in one place.


155-157: Delegate GetFloat64 to generic GetState
Refactored to GetState[float64] to streamline the float64 getter.


161-163: Delegate GetUint to generic GetState
Replaced inline logic with GetState[uint] for consistency across typed getters.


167-169: Delegate GetInt8 to generic GetState
Now using GetState[int8], reducing boilerplate in the int8 getter.


173-175: Delegate GetInt16 to generic GetState
Centralizes the int16 assertion via GetState[int16], behavior unchanged.


179-181: Delegate GetInt32 to generic GetState
Reuses GetState[int32] to remove duplicate assertion code.


185-187: Delegate GetInt64 to generic GetState
Switching to GetState[int64] keeps the method concise and uniform.


191-193: Delegate GetUint8 to generic GetState
Now delegating to GetState[uint8] for type-safe retrieval.


197-199: Delegate GetUint16 to generic GetState
Uses GetState[uint16] to unify typed getter implementations.


203-205: Delegate GetUint32 to generic GetState
Consolidated into GetState[uint32], removing redundant inline code.


209-211: Delegate GetUint64 to generic GetState
Refactored to call GetState[uint64], preserving behavior and reducing duplication.


215-217: Delegate GetUintptr to generic GetState
This change leverages GetState[uintptr] for consistency across pointer-sized getters.


221-223: Delegate GetFloat32 to generic GetState
Switches to GetState[float32] to centralize float32 assertions.


227-229: Delegate GetComplex64 to generic GetState
Now uses GetState[complex64] to remove inline assertion code.


233-235: Delegate GetComplex128 to generic GetState
Refactored to GetState[complex128] to maintain uniformity among typed getters.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link
Contributor

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

Choose a reason for hiding this comment

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

Summary of Changes

Hello @ksw2000, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving code consistency and reducing duplication within the State management system. By introducing a generic GetState function, the repetitive boilerplate code across numerous type-specific getter methods has been eliminated, leading to a more streamlined and maintainable codebase. Additionally, comments have been updated for better accuracy.

Highlights

  • Code Refactoring: The core logic for retrieving type-specific values from the State object has been centralized. All GetXXX methods (e.g., GetString, GetInt, GetBool, etc.) now delegate their operations to a generic GetState helper function, significantly reducing code duplication.
  • Code Consistency: Inconsistent comments for several GetXXX methods have been corrected to accurately reflect their return types, improving the clarity and consistency of the API documentation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

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

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 refactors the state getter methods to use a generic GetState function, which reduces code duplication and improves maintainability. The correction of inconsistent comments is also a valuable fix. One minor suggestion improves consistency in the function signatures.

Copy link

codecov bot commented Jun 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.64%. Comparing base (a258661) to head (4283986).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3542      +/-   ##
==========================================
- Coverage   90.71%   90.64%   -0.08%     
==========================================
  Files         110      110              
  Lines       10954    10869      -85     
==========================================
- Hits         9937     9852      -85     
  Misses        767      767              
  Partials      250      250              
Flag Coverage Δ
unittests 90.64% <100.00%> (-0.08%) ⬇️

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 June 23, 2025 14:48
@ksw2000 ksw2000 requested a review from a team as a code owner June 23, 2025 14:48
@ReneWerner87 ReneWerner87 added this to v3 Jun 23, 2025
@ReneWerner87 ReneWerner87 added this to the v3 milestone Jun 23, 2025
@ReneWerner87 ReneWerner87 merged commit 0ebe65d into gofiber:main Jun 23, 2025
15 checks passed
@github-project-automation github-project-automation bot moved this to Done in v3 Jun 23, 2025
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.

2 participants