Skip to content

🧹 chore: Refactor EnvVar middleware#3513

Merged
ReneWerner87 merged 2 commits intomainfrom
codex/2025-06-10-01-34-29
Jun 10, 2025
Merged

🧹 chore: Refactor EnvVar middleware#3513
ReneWerner87 merged 2 commits intomainfrom
codex/2025-06-10-01-34-29

Conversation

@gaby
Copy link
Member

@gaby gaby commented Jun 10, 2025

Summary:

  • Prevent exposure of environment variables when using the EnvVar middleware with default settings.
  • Update tests to reflect the new behavior.
  • Document that the default configuration no longer exports all environment variables.

Copilot AI review requested due to automatic review settings June 10, 2025 01:34
@gaby gaby requested a review from a team as a code owner June 10, 2025 01:34
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 10, 2025

"""

Walkthrough

The EnvVar middleware has been updated to remove the ExcludeVars configuration option. Now, environment variables are only exported if explicitly listed in ExportVars. Documentation and tests have been revised to reflect this breaking change, ensuring that no environment variables are exported by default.

Changes

File(s) Change Summary
middleware/envvar/envvar.go Removed ExcludeVars from Config, eliminated related logic, and now exports no variables by default.
middleware/envvar/envvar_test.go Removed tests for ExcludeVars, updated tests to expect no variables exported by default.
docs/middleware/envvar.md Updated documentation to clarify default behavior and removed references to ExcludeVars.
docs/whats_new.md Documented the removal of ExcludeVars as a breaking change and updated migration instructions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Middleware
    participant Env

    User->>Middleware: Request environment variables
    alt ExportVars is empty
        Middleware-->>User: Return empty set
    else ExportVars specified
        Middleware->>Env: Fetch specified variables
        Env-->>Middleware: Return variable values
        Middleware-->>User: Return specified variables
    end
Loading

Poem

🐇
The EnvVar fields have changed today,
ExcludeVars has hopped away.
Now only those you name with care,
Will in your exports hop and share.
No secrets leap without a call—
Explicit lists, or none at all!
🌱
"""


📜 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 c61f6ec and 67442ce.

📒 Files selected for processing (1)
  • middleware/envvar/envvar.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • middleware/envvar/envvar.go
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: Analyse
  • GitHub Check: lint
  • GitHub Check: unit (1.24.x, macos-13)
  • GitHub Check: unit (1.24.x, ubuntu-latest)
  • GitHub Check: unit (1.24.x, windows-latest)
  • GitHub Check: unit (1.24.x, macos-latest)
  • GitHub Check: Compare
  • GitHub Check: repeated
  • GitHub Check: govulncheck-check
✨ 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.

@gaby gaby changed the title Fix envvar default to avoid leaking secrets 🧹 chore: Refactor envvar middleware Jun 10, 2025
Copy link
Contributor

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 changes the EnvVar middleware default behavior to return no variables unless explicitly exported, removes the old ExcludeVars option, updates tests to expect no leakage of environment variables by default, and updates documentation accordingly.

  • Remove ExcludeVars from code and docs
  • Make newEnvVar return an empty set on default Config
  • Update tests and docs to reflect that no env vars are exported by default

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
middleware/envvar/envvar.go Dropped ExcludeVars logic and ensure no env vars are returned by default
middleware/envvar/envvar_test.go Updated tests to assert absence of vars when no ExportVars set
docs/whats_new.md Documented removal of ExcludeVars and new ExportVars-only model
docs/middleware/envvar.md Clarified default behavior (no exports) and removed ExcludeVars references
Comments suppressed due to low confidence (2)

middleware/envvar/envvar.go:11

  • [nitpick] The doc comment is missing a verb; consider changing to // ExportVars specifies the environment variables that should be exported for clarity.
// ExportVars specifies the environment variables that should export

docs/middleware/envvar.md:62

  • The JSON response uses the field vars, not ExportVars. Update this table row to reflect the actual vars property name.
| ExportVars  | `map[string]string` | ExportVars specifies the environment variables that should be exported. | `nil` |

@codecov
Copy link

codecov bot commented Jun 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.87%. Comparing base (f00e355) to head (67442ce).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3513      +/-   ##
==========================================
- Coverage   83.88%   83.87%   -0.01%     
==========================================
  Files         120      120              
  Lines       12278    12275       -3     
==========================================
- Hits        10299    10296       -3     
  Misses       1555     1555              
  Partials      424      424              
Flag Coverage Δ
unittests 83.87% <100.00%> (-0.01%) ⬇️

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 added this to v3 Jun 10, 2025
@gaby gaby added this to the v3 milestone Jun 10, 2025
@gaby gaby changed the title 🧹 chore: Refactor envvar middleware 🧹 chore: Refactor EnvVar middleware Jun 10, 2025
@ReneWerner87 ReneWerner87 merged commit 3a60cf7 into main Jun 10, 2025
14 checks passed
@github-project-automation github-project-automation bot moved this to Done in v3 Jun 10, 2025
@gaby gaby deleted the codex/2025-06-10-01-34-29 branch June 10, 2025 10:58
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