Skip to content

🐛 bug: Fix static/favicon middlewares file descriptor leaks #3579

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
Jul 14, 2025

Conversation

gaby
Copy link
Member

@gaby gaby commented Jul 14, 2025

Summary

  • close file descriptor in isFile helper
  • close favicon file handle when read from filesystem

Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

Walkthrough

The changes introduce deferred file closing in two middleware components to ensure that file handles are properly released after opening files. This update adds defer file.Close() statements immediately after successful file opens, with explicit comments to ignore any errors from closing. No other logic or public interfaces are altered.

Changes

File(s) Change Summary
middleware/favicon/favicon.go Added deferred file close after opening favicon file; ignore close errors.
middleware/static/static.go Added deferred file close in both branches of isFile; ignore close errors.

Suggested reviewers

  • sixcolors
  • efectn
  • ReneWerner87

Poem

A file was opened, a handle set free,
Deferred closure now, as tidy as can be.
In static and favicon, the rabbit did hop,
Ensuring no leaks, not a single drop.
With every close, the code feels light—
Bugs and leaks now out of sight! 🐇✨


📜 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 8f02e01 and a7f7203.

📒 Files selected for processing (2)
  • middleware/favicon/favicon.go (1 hunks)
  • middleware/static/static.go (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: sixcolors
PR: gofiber/fiber#3016
File: middleware/session/session.go:272-293
Timestamp: 2024-10-02T15:16:39.868Z
Learning: In the `middleware/session/session.go` file, the `saveSession()` method returns either `nil` or an error, so additional error wrapping in the `Save()` method is unnecessary.
Learnt from: sixcolors
PR: gofiber/fiber#3016
File: middleware/session/session.go:272-293
Timestamp: 2024-10-08T19:06:06.583Z
Learning: In the `middleware/session/session.go` file, the `saveSession()` method returns either `nil` or an error, so additional error wrapping in the `Save()` method is unnecessary.
Learnt from: sixcolors
PR: gofiber/fiber#3016
File: middleware/session/middleware_test.go:400-407
Timestamp: 2024-09-25T17:09:03.756Z
Learning: In the `Test_Session_Next` function in `middleware/session/middleware_test.go`, the variable `doNext` is properly synchronized with the `muNext` mutex for both read and write access.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: repeated
  • GitHub Check: Compare
🔇 Additional comments (1)
middleware/favicon/favicon.go (1)

104-106: LGTM! Proper resource management implementation.

The deferred file closing is correctly placed immediately after the successful file open and follows Go best practices for resource cleanup. The anonymous function appropriately ignores the Close() error, which is standard for cleanup operations.

✨ 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 @gaby, 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 resource management by fixing static file descriptor leaks in the favicon and static middleware components. It ensures that file handles are properly closed after use, preventing resource exhaustion and enhancing the overall stability of the application.

Highlights

  • File Descriptor Management: Ensured proper closing of the file descriptor for the favicon file in middleware/favicon/favicon.go by adding a defer f.Close() call after opening the file.
  • File Descriptor Management: Addressed potential file descriptor leaks in the isFile helper function within middleware/static/static.go by introducing defer file.Close() calls for both fs.FS.Open and os.Open paths.
  • Code Quality: Suppressed linter warnings for intentionally ignored Close() errors using //nolint:errcheck in both favicon.go and static.go, clarifying the design choice.
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.

@gaby gaby changed the title Fix static file descriptor leak 🐛 bug: Fix static file descriptor leak Jul 14, 2025
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 addresses file descriptor leaks in the favicon and static middleware by ensuring files are closed after use. There are some opportunities to refactor the code in middleware/static/static.go to reduce duplication.

@gaby gaby changed the title 🐛 bug: Fix static file descriptor leak 🐛 bug: Fix static/favicon middlewares file descriptor leaks Jul 14, 2025
@gaby gaby added this to v3 Jul 14, 2025
@gaby gaby added this to the v3 milestone Jul 14, 2025
@gaby gaby moved this to In Progress in v3 Jul 14, 2025
Copy link

codecov bot commented Jul 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.96%. Comparing base (77540e2) to head (a7f7203).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3579      +/-   ##
==========================================
+ Coverage   90.91%   90.96%   +0.04%     
==========================================
  Files         110      111       +1     
  Lines       11067    11124      +57     
==========================================
+ Hits        10062    10119      +57     
  Misses        753      753              
  Partials      252      252              
Flag Coverage Δ
unittests 90.96% <100.00%> (+0.04%) ⬆️

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 gaby marked this pull request as ready for review July 14, 2025 13:00
@gaby gaby requested a review from a team as a code owner July 14, 2025 13:00
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

⚠️ 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: a7f7203 Previous: 8f02e01 Ratio
Benchmark_GenericParseTypeBytes/benchmark_genericParseTypeBytes#01 34.22 ns/op 8 B/op 1 allocs/op 20.01 ns/op 8 B/op 1 allocs/op 1.71
Benchmark_GenericParseTypeBytes/benchmark_genericParseTypeBytes#01 - ns/op 34.22 ns/op 20.01 ns/op 1.71

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

@ReneWerner87 ReneWerner87 merged commit c1e9ae3 into main Jul 14, 2025
14 of 15 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in v3 Jul 14, 2025
@gaby gaby deleted the 2025-07-14-12-58-12 branch July 14, 2025 13:34
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