Skip to content

Log context of openapi validation crash#6448

Merged
agourlay merged 1 commit intodevfrom
log-context-unexpected-openapi-validation-crash
Apr 28, 2025
Merged

Log context of openapi validation crash#6448
agourlay merged 1 commit intodevfrom
log-context-unexpected-openapi-validation-crash

Conversation

@agourlay
Copy link
Copy Markdown
Member

We had recently a weird integration error that was difficult to diagnose when running the openapi tests.

This PR backports some of the debug logging that helped to resolve the problem in order to move faster next time.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 28, 2025

📝 Walkthrough

Walkthrough

The request_with_validation function in the test helpers was updated to include timing of HTTP requests and enhanced error reporting for response validation failures. A timer was introduced to measure the duration of each HTTP request. The response validation step is now wrapped in a try-except block that specifically catches CheckFailed exceptions. If a validation failure occurs, a comprehensive warning message is generated, detailing the reason for failure, response status code, headers, body content (or noting if the body is empty), the elapsed request time, and the full request details such as method, URL, query parameters, headers, and body. This warning is logged before the exception is re-raised. The function's signature and its normal execution flow for successful requests remain unchanged. No modifications were made to the declarations of exported or public entities.

✨ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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
Copy Markdown
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 (2)
tests/openapi/helpers/helpers.py (2)

3-3: Remove unused import.

The warning function is imported from the logging module but never used in the code. Instead, warnings.warn is used for logging messages.

-from logging import warning
🧰 Tools
🪛 Ruff (0.8.2)

3-3: logging.warning imported but unused

Remove unused import: logging.warning

(F401)


94-115: Robust error handling with comprehensive context logging.

The try-except block effectively captures validation failures and constructs a detailed error message with all relevant context. This implementation aligns perfectly with the PR's objective to improve troubleshooting by providing better context around OpenAPI validation crashes.

However, the warnings.warn() call should include a stacklevel parameter to ensure the warning is attributed to the correct source in the stack trace.

-        warnings.warn(msg)
+        warnings.warn(msg, stacklevel=2)
🧰 Tools
🪛 Ruff (0.8.2)

113-113: No explicit stacklevel keyword argument found

(B028)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ce39fa3 and 5957efa.

📒 Files selected for processing (1)
  • tests/openapi/helpers/helpers.py (2 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
tests/openapi/helpers/helpers.py

3-3: logging.warning imported but unused

Remove unused import: logging.warning

(F401)


113-113: No explicit stacklevel keyword argument found

(B028)

⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: test-snapshot-operations-s3-minio
  • GitHub Check: test-shard-snapshot-api-s3-minio
  • GitHub Check: test-low-resources
  • GitHub Check: Basic TLS/HTTPS tests
  • GitHub Check: test-consistency
  • GitHub Check: test-consensus-compose
  • GitHub Check: rust-tests (macos-latest)
  • GitHub Check: integration-tests-consensus
  • GitHub Check: rust-tests (windows-latest)
  • GitHub Check: integration-tests
  • GitHub Check: rust-tests (ubuntu-latest)
  • GitHub Check: storage-compat-test
  • GitHub Check: lint
🔇 Additional comments (2)
tests/openapi/helpers/helpers.py (2)

2-2: Well-implemented imports for enhanced logging functionality.

The added imports for time module and CheckFailed exception are correctly implemented and necessary for the added timing measurements and exception handling.

Also applies to: 8-8


86-86: Effective timing implementation for performance tracking.

Good addition of timing measurement around the HTTP request. This will help identify slow requests during troubleshooting.

Also applies to: 93-93

@agourlay agourlay merged commit 1552409 into dev Apr 28, 2025
17 checks passed
@agourlay agourlay deleted the log-context-unexpected-openapi-validation-crash branch April 28, 2025 11:55
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.

2 participants