Skip to content

fix: omit error-check for 201 responses in async_call_api#391

Merged
ludeeus merged 4 commits intoludeeus:mainfrom
mbrisx:fix/omit-201-error-check
Apr 16, 2025
Merged

fix: omit error-check for 201 responses in async_call_api#391
ludeeus merged 4 commits intoludeeus:mainfrom
mbrisx:fix/omit-201-error-check

Conversation

@mbrisx
Copy link
Copy Markdown
Contributor

@mbrisx mbrisx commented Feb 18, 2025

Proposed change

This PR modifies the error-handling logic in the async_call_api method for REST API calls. GitHub sometimes returns a 201 (Created) status code along with a "message" field as part of a successful response. Since a 201 response always indicates success, this change omits the error-check for such responses, preventing false error raises. This fix applies to all REST API endpoints where a 201 status is expected.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass.
  • There is no commented out code in this PR.
  • The code has been formatted using Black (make lint)
  • Tests have been added to verify that the new code works.

@mbrisx mbrisx force-pushed the fix/omit-201-error-check branch from 7dacade to 80e18cb Compare February 19, 2025 08:37
Skip error-checking for responses with a 201 status code in async_call_api, preventing false error raises for successful REST operations.
@mbrisx mbrisx force-pushed the fix/omit-201-error-check branch from 80e18cb to 3a2c007 Compare February 19, 2025 08:40
@mbrisx mbrisx requested a review from ludeeus February 20, 2025 06:26
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 16, 2025

📝 Walkthrough

Walkthrough

The error handling logic in the API client was updated to consider the HTTP status code when processing responses containing a "message" field. Specifically, if the status code is 201 (Created), the client will no longer raise a GitHubException even if a "message" is present in the response. For all other status codes, the previous behavior of raising an exception when a "message" is detected remains unchanged. No changes were made to public interfaces or exported entities. Additionally, a new asynchronous test was added to verify this behavior.

Changes

File(s) Change Summary
aiogithubapi/client.py Updated error handling to suppress exceptions on 201 responses with a "message" field in the data.
tests/client/test_operation.py Added async test to confirm no exception is raised for 201 responses containing a "message" field.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GitHubAPI

    Client->>GitHubAPI: Send API request
    GitHubAPI-->>Client: Respond with status code and data

    alt Response contains "message"
        alt Status code is 201
            Client-->>Client: Do not raise exception
        else Status code is not 201
            Client-->>Client: Raise GitHubException
        end
    else No "message" in response
        Client-->>Client: Continue normal processing
    end
Loading

📜 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 df2d967 and 49ba7a7.

📒 Files selected for processing (1)
  • aiogithubapi/client.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • aiogithubapi/client.py
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Coverage

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 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
Owner

@ludeeus ludeeus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@ludeeus ludeeus merged commit 66174b8 into ludeeus:main Apr 16, 2025
6 checks passed
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