Missing options of api_key and pid2kill are causing crashes #1601

rhatdan · 2025-06-25T10:27:18Z

Also add debug information to chat.

Summary by Sourcery

Guard against missing api_key and pid2kill options to prevent crashes and enhance the chat module with debug logging.

Bug Fixes:

Guard against missing api_key and pid2kill arguments to avoid attribute errors and crashes

Enhancements:

Add debug logging of chat request URL, payload, headers, and request object
Log TimeoutException details at debug level in chat loop

sourcery-ai · 2025-06-25T10:27:25Z

Reviewer's Guide

This PR adds defensive attribute checks for missing CLI options (api_key, pid2kill) to prevent crashes and integrates debug logging around HTTP request construction and timeout exception handling in ramalama/chat.py.

Class diagram for updated attribute checks and logging in chat module

classDiagram
    class ChatShell {
        +args
        +_make_request_data()
        +_req()
        +kills()
    }
    class logger
    ChatShell --> logger : uses for debug logging
    ChatShell : +_make_request_data() now checks hasattr(args, "api_key")
    ChatShell : +kills() now checks hasattr(args, "pid2kill")
    ChatShell : +_make_request_data() logs request data and headers
    ChatShell : +_req() logs TimeoutException

File-Level Changes

Change	Details	Files
Defensive argument existence checks to avoid crashes	Guard api_key access with hasattr and non-empty check Guard pid2kill access with hasattr and non-zero check	`ramalama/chat.py`
Added debug logging for request flow and errors	Import logger from ramalama.logger Log URL, JSON payload, and headers before sending Log the constructed urllib request object Log TimeoutException details	`ramalama/chat.py`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

gemini-code-assist

Summary of Changes

Hello @rhatdan, 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!

This pull request focuses on improving the robustness and debuggability of the chat functionality. It addresses potential crashes by adding checks for the presence of optional arguments and significantly enhances logging to provide more insight into network requests and exception handling.

Highlights

Crash Prevention: Implemented defensive checks using hasattr for api_key and pid2kill attributes before accessing them. This prevents potential AttributeError crashes in _make_request_data and kills methods when these optional arguments are not provided.
Debugging Improvements: Enhanced debug logging within the chat module. This includes logging details of the urllib request (URL, JSON data, headers, and the request object itself) and capturing the specific TimeoutException message for better diagnostic capabilities.

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.

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

sourcery-ai

Hey @rhatdan - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `ramalama/chat.py:117` </location>
<code_context>

             headers["Authorization"] = f"Bearer {self.args.api_key}"

+        logger.debug(self.url, json_data, headers)
         request = urllib.request.Request(self.url, data=json_data, headers=headers, method="POST")
+        logger.debug(request)
</code_context>

<issue_to_address>
Consider redacting sensitive information from debug logs.

Logging headers with sensitive fields like API keys can expose confidential data. Please redact or mask such fields before logging.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        logger.debug(self.url, json_data, headers)
=======
        # Redact sensitive information in headers before logging
        redacted_headers = headers.copy()
        if "Authorization" in redacted_headers:
            auth_value = redacted_headers["Authorization"]
            if auth_value.startswith("Bearer "):
                # Mask all but last 4 characters of the API key
                api_key = auth_value[len("Bearer "):]
                masked_api_key = "*" * (len(api_key) - 4) + api_key[-4:] if len(api_key) > 4 else "****"
                redacted_headers["Authorization"] = f"Bearer {masked_api_key}"
        logger.debug(self.url, json_data, redacted_headers)
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

sourcery-ai · 2025-06-25T10:28:06Z

ramalama/chat.py

            if len(self.args.api_key) < 20:
                print("Warning: Provided API key is invalid.")

            headers["Authorization"] = f"Bearer {self.args.api_key}"

+        logger.debug(self.url, json_data, headers)


🚨 suggestion (security): Consider redacting sensitive information from debug logs.

Logging headers with sensitive fields like API keys can expose confidential data. Please redact or mask such fields before logging.

Suggested change

logger.debug(self.url, json_data, headers)

# Redact sensitive information in headers before logging

redacted_headers = headers.copy()

if "Authorization" in redacted_headers:

auth_value = redacted_headers["Authorization"]

if auth_value.startswith("Bearer "):

# Mask all but last 4 characters of the API key

api_key = auth_value[len("Bearer "):]

masked_api_key = "*" * (len(api_key) - 4) + api_key[-4:] if len(api_key) > 4 else "****"

redacted_headers["Authorization"] = f"Bearer {masked_api_key}"

logger.debug(self.url, json_data, redacted_headers)

gemini-code-assist

Code Review

This pull request effectively addresses potential crashes by adding guards for missing api_key and pid2kill attributes. The addition of debug logging is also a valuable enhancement for troubleshooting.

My review includes suggestions to:

Use getattr for more idiomatic and concise attribute checking.
Improve the format of debug log messages for better readability.
Remove a redundant and uninformative log statement.

These changes will help improve the code's maintainability and the utility of the new debug logs. Overall, great work on improving the robustness of the chat functionality.

gemini-code-assist · 2025-06-25T10:28:41Z

ramalama/chat.py

@@ -107,13 +108,15 @@ def _make_request_data(self):
            "Content-Type": "application/json",
        }

-        if self.args.api_key:
+        if hasattr(self.args, "api_key") and self.args.api_key:


While using hasattr correctly prevents the AttributeError, a more idiomatic and concise way to achieve this in Python is to use getattr with a default value. This avoids the need for two separate checks (for existence and then for truthiness).

Suggested change

if hasattr(self.args, "api_key") and self.args.api_key:

if getattr(self.args, "api_key", None):

ramalama/chat.py

gemini-code-assist · 2025-06-25T10:28:42Z

ramalama/chat.py

        request = urllib.request.Request(self.url, data=json_data, headers=headers, method="POST")
+        logger.debug(request)


Logging the urllib.request.Request object directly with logger.debug(request) is not very informative, as it will likely only output the object's type and memory address (e.g., <urllib.request.Request object at ...>). The essential information (URL, data, headers) is already being logged on line 117. This log statement appears to be redundant and can be removed.

ramalama/chat.py

Also add debug information to chat. Signed-off-by: Daniel J Walsh <[email protected]>

rhatdan requested review from ericcurtin, bmahabirbu, maxamillion, swarajpande5, jhjaggars, cgruver, slp and engelmi as code owners June 25, 2025 10:27

gemini-code-assist bot reviewed Jun 25, 2025

View reviewed changes

sourcery-ai bot approved these changes Jun 25, 2025

View reviewed changes

gemini-code-assist bot reviewed Jun 25, 2025

View reviewed changes

Missing options of api_key and pid2kill are causing crashes

951246f

Also add debug information to chat. Signed-off-by: Daniel J Walsh <[email protected]>

rhatdan force-pushed the chat branch from 3c9062c to 951246f Compare June 25, 2025 10:46

ericcurtin approved these changes Jun 25, 2025

View reviewed changes

ericcurtin merged commit 82d04a7 into containers:main Jun 25, 2025
20 of 21 checks passed

ericcurtin mentioned this pull request Jun 25, 2025

Check if api key exists first #1604

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Missing options of api_key and pid2kill are causing crashes #1601

Missing options of api_key and pid2kill are causing crashes #1601

Uh oh!

rhatdan commented Jun 25, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jun 25, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

sourcery-ai bot left a comment

Uh oh!

sourcery-ai bot Jun 25, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Jun 25, 2025

Uh oh!

Uh oh!

gemini-code-assist bot Jun 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

	if hasattr(self.args, "api_key") and self.args.api_key:
	if getattr(self.args, "api_key", None):

		request = urllib.request.Request(self.url, data=json_data, headers=headers, method="POST")
		logger.debug(request)

Missing options of api_key and pid2kill are causing crashes #1601

Missing options of api_key and pid2kill are causing crashes #1601

Uh oh!

Conversation

rhatdan commented Jun 25, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Class diagram for updated attribute checks and logging in chat module

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gemini-code-assist bot Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rhatdan commented Jun 25, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 25, 2025 •

edited

Loading