Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Aug 19, 2025

Description

LCORE-464: fix potential None reference handling

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement

Related Tickets & Documents

  • Related Issue #LCORE-464

Summary by CodeRabbit

  • Bug Fixes
    • Prevented intermittent errors when responses lack expected content; the app now logs a warning and returns an empty reply while preserving the conversation ID to avoid crashes and blocked interactions.
    • Added defensive handling for incomplete responses to improve stability and ensure smoother, more predictable behavior for users.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

Warning

Rate limit exceeded

@tisnik has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 3 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 1db7738 and b6485e8.

📒 Files selected for processing (1)
  • tests/unit/app/endpoints/test_query.py (1 hunks)

Walkthrough

Adds defensive checks in retrieve_response to avoid accessing a missing response.output_message.content: returns (conversation_id, content) when present; otherwise logs a warning and returns (conversation_id, "") as a fallback. Function signature now includes a return type annotation and expanded pylint suppression.

Changes

Cohort / File(s) Summary of Changes
Query response handling
src/app/endpoints/query.py
Added guards for missing response.output_message and its content; logs a warning and returns an empty-string fallback with conversation_id when absent. Updated function signature to return tuple[str, str] and expanded pylint disable to include too-many-branches.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Caller
  participant retrieve_response
  participant Logger

  Caller->>retrieve_response: call with client, model_id, query_request, token, mcp_headers
  alt response.output_message and content present
    retrieve_response-->>Caller: (conversation_id, output_message.content)
  else missing output_message or content
    retrieve_response->>Logger: warn("output_message or content missing")
    retrieve_response-->>Caller: (conversation_id, "")
  end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I twitch my whiskers, check each nest,
If words are gone, I do my best.
A warning soft, an empty string—
Conversation hops on, I sing. 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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

@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: 0

🧹 Nitpick comments (1)
src/app/endpoints/query.py (1)

495-499: Remove type ignores and make content extraction more robust

Avoid the type: ignore by using getattr and handle non-str content safely. Also enrich the warning with conversation_id for easier triage.

Apply this diff:

-    if response is not None and response.output_message is not None:  # type: ignore[union-attr]
-        return str(response.output_message.content), conversation_id  # type: ignore[union-attr]
-
-    logger.warning("Response does not contain any message to be returned")
-    return "", conversation_id  # fallback
+    output_message = getattr(response, "output_message", None)
+    if output_message is not None:
+        content = getattr(output_message, "content", None)
+        if content is not None:
+            return (content if isinstance(content, str) else str(content)), conversation_id
+    logger.warning(
+        "Response lacks output_message.content (conversation_id=%s)",
+        conversation_id,
+    )
+    return "", conversation_id  # fallback
📜 Review details

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

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b51226d and df5012a.

📒 Files selected for processing (1)
  • src/app/endpoints/query.py (1 hunks)
⏰ 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: build-pr
  • GitHub Check: e2e_tests
🔇 Additional comments (2)
src/app/endpoints/query.py (2)

495-497: Good defensive check prevents None dereference

The null-guard on response/output_message eliminates a crash path and aligns with the PR objective.


498-499: Confirm API behavior: empty string vs. error/metric

Returning an empty string may mask upstream issues and be indistinguishable from a legitimate empty model output. Do we want to:

  • increment a failure/empty-output metric here, or
  • return a 502/500 to surface upstream issues?

If current behavior is intentional, consider documenting it in retrieve_response’s docstring.

@tisnik tisnik force-pushed the lcore-464-fix-potential-none-reference-handling branch from df5012a to 7b0bdf2 Compare August 19, 2025 08:56
@tisnik tisnik force-pushed the lcore-464-fix-potential-none-reference-handling branch from 7b0bdf2 to 1db7738 Compare August 19, 2025 08:59
@tisnik
Copy link
Contributor Author

tisnik commented Aug 19, 2025

@CodeRabbit fullreview

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

@tisnik I'll conduct a full review of all changes in this PR addressing the potential None reference handling bug fix.

✅ Actions performed

Full review triggered.

@tisnik
Copy link
Contributor Author

tisnik commented Aug 19, 2025

@coderabbitai generate unit tests

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

An unexpected error occurred during Unit Test Generation.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

✅ Actions performed

Unit Test Generation started...

@tisnik tisnik merged commit da067bc into lightspeed-core:main Aug 19, 2025
18 of 19 checks passed
@keitwb keitwb mentioned this pull request Aug 19, 2025
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant