🐛 Add HTTP_X_FORWARDED_FOR to weblog

[akrherz]

No description provided.

[gemini-code-assist]

Hello @akrherz, I'm Gemini Code Assist¹! 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!

Summary of Changes

This pull request addresses a bug by adding the HTTP_X_FORWARDED_FOR header to the weblog table. This allows tracking the original client IP address when requests pass through a proxy or load balancer. The change involves modifying the SQL query used to insert data into the weblog table and updating the dictionary of values passed to the query.

Highlights

• Bug fix: The pull request fixes a bug where the HTTP_X_FORWARDED_FOR header was not being logged in the weblog table.
• Feature enhancement: The pull request enhances the weblog by including the HTTP_X_FORWARDED_FOR header, providing more comprehensive client IP address tracking.

Changelog

• src/pyiem/webutil.py
  • Modified the SQL query to include the x_forwarded_for column in the weblog table (lines 212-214).
  • Updated the dictionary passed to the SQL query to include the HTTP_X_FORWARDED_FOR value (line 222).

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.

---

Did you know?

The concept of using X-Forwarded-For header is not standardized by IETF, but it is a de-facto standard widely supported by web servers and load balancers.

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

[gemini-code-assist]

Code Review

The pull request adds the HTTP_X_FORWARDED_FOR header to the weblog table, which is useful for tracking the original client IP address when requests pass through proxies. The change is straightforward and seems correct.

Merge Readiness

The code change is a simple addition and appears correct. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging. Given the low-risk nature of this change, it seems reasonable to merge after another review.

[deepsource-io]

Here's the code health analysis summary for commits e88de75..82e584b. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Python	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.52%. Comparing base (e88de75) to head (82e584b).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1032   +/-   ##
=======================================
  Coverage   98.52%   98.52%           
=======================================
  Files          85       85           
  Lines       10185    10185           
=======================================
  Hits        10035    10035           
  Misses        150      150           

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