Skip to content

Fix: Improve error handling in cache manager #3597

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

AhmedOmani
Copy link

Description

This PR improves error handling in the cache middleware by properly handling errors from storage operation.

Changes Made

  • Fixed error handling in getRaw() method for both storage and memory opearions.
  • Fixed error handling in set() method for storage operations.
  • Fixed error handling in setRaw() method for storage operations.
  • Fixed error handling in del() method for storage operations.
  • Removed //nolint:errcheck suppressions and added proper error handling approach.

Testing

  • All existing tests pass

Type of Change

  • Code quality improvment

@AhmedOmani AhmedOmani requested a review from a team as a code owner July 18, 2025 20:34
Copy link

welcome bot commented Jul 18, 2025

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Contributor

coderabbitai bot commented Jul 18, 2025

Walkthrough

This change updates the cache manager to explicitly handle errors from storage operations within its internal methods. Error values are now captured and checked after storage interactions, replacing previously ignored errors and removing linter suppression comments, while maintaining the original behavior of not acting on these errors.

Changes

File(s) Change Summary
middleware/cache/manager.go Added explicit error handling for storage operations in getRaw, set, setRaw, and del. Removed nolint:errcheck comments. Improved type assertion safety for in-memory cache case. No changes to public APIs.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant CacheManager
    participant Storage

    Caller->>CacheManager: getRaw(key)
    CacheManager->>Storage: Get(key)
    Storage-->>CacheManager: value, err
    alt err != nil
        CacheManager-->>Caller: return nil
    else
        CacheManager-->>Caller: return value
    end

    Caller->>CacheManager: setRaw(key, value)
    CacheManager->>Storage: Set(key, value, expiry)
    Storage-->>CacheManager: err
    alt err != nil
        Note right of CacheManager: (error handling placeholder)
    end
Loading

Possibly related PRs

Suggested reviewers

  • ReneWerner87
  • gaby

Poem

A bunny hops through code so neat,
Catching errors at its feet.
No more hiding, none ignored,
Each mistake is now explored.
With every hop, the cache grows wise—
A safer warren, no surprise!
🐇✨


📜 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 0e16569 and 2c29da3.

📒 Files selected for processing (1)
  • middleware/cache/manager.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • middleware/cache/manager.go
✨ 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 @AhmedOmani, 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 the robustness and code quality of the cache middleware by implementing proper error handling for storage operations. It addresses previously suppressed linter warnings by explicitly checking and handling errors returned from cache storage interactions, ensuring a more reliable caching mechanism.

Highlights

  • Error Handling Improvement: Implemented explicit error checking for cache storage operations within the getRaw, set, setRaw, and del methods of the cache manager.
  • Code Quality: Removed all //nolint:errcheck suppressions, replacing them with proper error handling logic, thereby improving code maintainability and adherence to best practices.
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

@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: 0

🧹 Nitpick comments (3)
middleware/cache/manager.go (3)

120-124: Good error handling structure with room for improvement.

The explicit error handling is well-structured and maintains backward compatibility. The comments clearly explain the intention to ignore errors gracefully.

Consider adding actual logging for debugging purposes:

 if setErr := m.storage.Set(key, raw, exp); setErr != nil {
-    // Log or handle storage set error gracefully
-    // For now, we'll just ignore it as the original code did
-    // but without the linter suppression
+    // Log storage set error for debugging
+    // TODO: Add proper logging when logger is available
 }

136-140: Consistent error handling approach.

The error handling follows the same well-structured pattern as the set() method, maintaining consistency across the codebase.

Same suggestion applies here - consider adding logging for debugging:

 if err := m.storage.Set(key, raw, exp); err != nil {
-    // Log or handle storage set error gracefully
-    // For now, we'll just ignore it as the original code did
-    // but without the linter suppression
+    // Log storage set error for debugging
+    // TODO: Add proper logging when logger is available
 }

149-153: Consistent error handling across all storage operations.

The error handling maintains the same well-structured pattern as other methods, ensuring consistency across all storage operations. For delete operations, ignoring errors gracefully is often the correct approach in cache systems.

Consider the same logging improvement for consistency:

 if err := m.storage.Delete(key); err != nil {
-    // Log or handle storage delete error gracefully
-    // For now, we'll just ignore it as the original code did
-    // but without the linter suppression
+    // Log storage delete error for debugging
+    // TODO: Add proper logging when logger is available
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d584286 and 0e16569.

📒 Files selected for processing (1)
  • middleware/cache/manager.go (4 hunks)
🔇 Additional comments (1)
middleware/cache/manager.go (1)

102-111: Excellent error handling improvements!

The explicit error handling for storage operations is well-implemented:

  • Storage errors are properly checked and handled by returning nil (cache miss)
  • Safe type assertion prevents potential panics in memory storage case
  • Removes linter suppression while maintaining appropriate cache semantics

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 improves error handling in the cache manager. Consider adding logging for the caught errors to improve observability and diagnose issues with the underlying storage.

Comment on lines 120 to 124
if setErr := m.storage.Set(key, raw, exp); setErr != nil {
// Log or handle storage set error gracefully
// For now, we'll just ignore it as the original code did
// but without the linter suppression
}
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Log the error to provide visibility into potential issues with the cache storage backend.

if setErr := m.storage.Set(key, raw, exp); setErr != nil {
	log.Errorf("cache: failed to set key %s: %v", key, setErr)
}

Copy link

codecov bot commented Jul 19, 2025

Codecov Report

Attention: Patch coverage is 8.33333% with 22 lines in your changes missing coverage. Please review.

Project coverage is 90.83%. Comparing base (d584286) to head (2c29da3).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
middleware/cache/manager.go 8.33% 19 Missing and 3 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3597      +/-   ##
==========================================
- Coverage   90.97%   90.83%   -0.15%     
==========================================
  Files         111      111              
  Lines       11208    11225      +17     
==========================================
- Hits        10197    10196       -1     
- Misses        759      777      +18     
  Partials      252      252              
Flag Coverage Δ
unittests 90.83% <8.33%> (-0.15%) ⬇️

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.

@gaby
Copy link
Member

gaby commented Jul 19, 2025

@AhmedOmani Can't have empty blocks of code, the nolint has to be readded

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants