Skip to content

🧹 chore: Add missing CSRF token extractor tests #3527

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 18, 2025

Conversation

gaby
Copy link
Member

@gaby gaby commented Jun 18, 2025

Summary

  • add tests for missing CSRF token extractors

@Copilot Copilot AI review requested due to automatic review settings June 18, 2025 03:19
@gaby gaby requested a review from a team as a code owner June 18, 2025 03:19
@gaby gaby added the codex label Jun 18, 2025 — with ChatGPT Connector
Copy link
Contributor

coderabbitai bot commented Jun 18, 2025

Walkthrough

A new test file was added to the middleware/csrf package, introducing a unit test that checks the behavior of CSRF token extractor functions when the token is missing from parameters, cookies, forms, and query strings. The test verifies that the correct errors are returned for each missing token scenario.

Changes

File(s) Change Summary
middleware/csrf/extractors_test.go Added unit test Test_Extractors_Missing to verify CSRF extractors' error handling for missing tokens.

Suggested labels

🧹 Updates, v3

Suggested reviewers

  • sixcolors

Poem

A rabbit hopped through CSRF land,
Testing extractors with a steady hand.
No tokens found, errors returned,
For missing crumbs, the lesson learned.
With every check, the code grows strong—
Fiber's security hops along! 🐇✨

✨ 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 enhances the test suite for the CSRF middleware by introducing specific tests for scenarios where CSRF tokens are absent. This improves the reliability and error handling of the token extraction mechanisms by explicitly verifying their behavior when tokens are not found.

Highlights

  • Test Coverage: Added new unit tests to verify the behavior of CSRF token extractors (FromParam, FromCookie, FromForm, FromQuery) when the expected token is not present in the request context.
  • Error Handling Consistency: Ensured that the correct ErrMissingParam, ErrMissingCookie, ErrMissingForm, and ErrMissingQuery errors are returned by the respective extractors when the token is missing, improving consistency and robustness in error reporting.
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

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds new tests to validate that the CSRF token extractors correctly handle cases when tokens are missing. The changes include testing missing token extraction for parameters, cookies, form data, and queries.

Comments suppressed due to low confidence (1)

middleware/csrf/extractors_test.go:20

  • Consider adding tests for successful token extraction cases to complement the missing extractor tests and ensure full coverage of extractor behavior.
	token, err := FromParam("csrf")(ctx)

@gaby gaby changed the title Add missing extractor tests 🧹 chore: Add missing extractor tests Jun 18, 2025
@gaby gaby changed the title 🧹 chore: Add missing extractor tests 🧹 chore: Add missing CSRF token extractor tests Jun 18, 2025
@gaby gaby changed the title 🧹 chore: Add missing CSRF token extractor tests 🧹chore: Add missing CSRF token extractor tests Jun 18, 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 adds tests for missing CSRF token extractors, covering parameter, cookie, form, and query string scenarios. A suggestion is made to refactor the tests into a table-driven format for better maintainability.

@gaby gaby changed the title 🧹chore: Add missing CSRF token extractor tests 🧹 chore: Add missing CSRF token extractor tests Jun 18, 2025
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a35c5d2 and 9487c19.

📒 Files selected for processing (1)
  • middleware/csrf/extractors_test.go (1 hunks)
🔇 Additional comments (1)
middleware/csrf/extractors_test.go (1)

15-18: Explicitly set request method & content‐type before exercising the form extractor

FromForm internally relies on ctx.FormValue, which only parses the body for methods such as POST/PUT/PATCH and when the content‐type is either application/x-www-form-urlencoded or multipart/form-data.
With the current context (no method, no headers, empty body) the extractor may short-circuit early, meaning the test passes for the wrong reason.

 app := fiber.New()
 ctx := app.AcquireCtx(&fasthttp.RequestCtx{})
+// Ensure the request looks like a typical form submission
+ctx.Request().Header.SetMethod(fasthttp.MethodPost)
+ctx.Request().Header.SetContentType("application/x-www-form-urlencoded")
 defer app.ReleaseCtx(ctx)

@gaby
Copy link
Member Author

gaby commented Jun 18, 2025

For some reason the workflows didn't trigger.

@ReneWerner87 ReneWerner87 merged commit 528462d into main Jun 18, 2025
2 checks passed
@gaby gaby deleted the codex/2025-06-18-03-19-24 branch June 19, 2025 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants