Skip to content

[Chore] Log errors from cf-api for better debugging #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Jun 12, 2025
Merged

[Chore] Log errors from cf-api for better debugging #283

merged 7 commits into from
Jun 12, 2025

Conversation

@mohammedahmed18
Copy link
Contributor

@mohammedahmed18 mohammedahmed18 commented Jun 4, 2025 •
edited by github-actions bot
Loading

PR Type

Bug fix, Enhancement

Description

  • Wrap API calls in try/except for HTTPError

  • Log JSON or string error messages from API

  • Use response.raise_for_status on requests

  • Simplify GitHub app install check logic

Changes walkthrough 📝

Relevant files
Error handling
cfapi.py
Enhance error handling and logging                                             

codeflash/api/cfapi.py

  • Wrapped requests in try/except for HTTP errors
  • Applied response.raise_for_status to catch failures
  • Parsed and logged JSON or plain text errors
  • Simplified is_github_app_installed_on_repo return
    		• +24/-11 
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    •

    @github-actions
    Copy link

    github-actions bot commented Jun 4, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Narrow Exception Catch

    Only HTTPError is caught in make_cfapi_request, so other RequestExceptions (e.g., timeouts or connection errors) will propagate uncaught. Consider catching broader exceptions like RequestException.

     
    try:
    if method.upper() == "POST":
        json_payload = json.dumps(payload, indent=None, default=pydantic_encoder)
        cfapi_headers["Content-Type"] = "application/json"
        response = requests.post(url, data=json_payload, headers=cfapi_headers, timeout=60)
    else:
        response = requests.get(url, headers=cfapi_headers, timeout=60)
    response.raise_for_status()
    return response  # noqa: TRY300
    Strict Response Check

    is_github_app_installed_on_repo uses strict equality on response.text to "true", which may fail if the API returns extra whitespace or formatting. Consider normalizing the response text (e.g., strip(), lower()) before comparison.

     
    return response.ok and response.text == "true"

    @github-actions
    Copy link

    github-actions bot commented Jun 4, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Broaden exception handling

    Broaden the exception catch to include all request-related errors and capture the
    exception instance. This ensures connection issues and timeouts are also logged
    instead of slipping through.

    codeflash/api/cfapi.py [56]

    -except requests.exceptions.HTTPError:
+except requests.exceptions.RequestException as e:
    Suggestion importance[1-10]: 8

    __

    Why: Using RequestException catches all request-related errors (e.g., timeouts, connection issues) and capturing the exception instance ensures proper logging and avoids uncaught cases.

    		Medium
    General
    Log HTTP status code

    Include the HTTP status code in the error log to aid debugging and quickly identify
    the type of failure.

    codeflash/api/cfapi.py [68]

    -logger.error(f"Error making request to Codeflash API: {error_message}")
+logger.error(f"Error making request to Codeflash API (status {response.status_code}): {error_message}")
    Suggestion importance[1-10]: 6

    __

    Why: Including response.status_code in the error log provides valuable context for debugging API failures without altering logic.

    		Low
    Log failure in install check

    Restore logging on failure to help diagnose why the GitHub App check is false by
    logging status and response text.

    codeflash/api/cfapi.py [183]

    -return response.ok and response.text == "true"
+if not (response.ok and response.text == "true"):
+    logger.error(f"GitHub App installation check failed: {response.status_code} - {response.text}")
+    return False
+return True
    Suggestion importance[1-10]: 6

    __

    Why: Reintroducing logging on failure helps diagnose why the GitHub App check returns false while preserving the boolean return semantics.

    		Low

    Saga4
    Saga4 reviewed Jun 5, 2025
    View reviewed changes
    codeflash/api/cfapi.py
    else:
    response = requests.get(url, headers=cfapi_headers, timeout=60)
    response.raise_for_status()
    return response # noqa: TRY300
    Copy link
    Contributor

    @Saga4 Saga4 Jun 5, 2025

    Choose a reason for hiding this comment

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

    Q: whats noqa?

    Copy link
    Contributor Author

    @mohammedahmed18 mohammedahmed18 Jun 5, 2025

    Choose a reason for hiding this comment

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

    it's for ignoring ruff linter for this line.

    Saga4
    Saga4 reviewed Jun 5, 2025
    View reviewed changes
    codeflash/api/cfapi.py
    response = requests.post(url, data=json_payload, headers=cfapi_headers, timeout=60)
    else:
    response = requests.get(url, headers=cfapi_headers, timeout=60)
    response.raise_for_status()
    Copy link
    Contributor

    @Saga4 Saga4 Jun 5, 2025

    Choose a reason for hiding this comment

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

    This is good.

    Saga4
    Saga4 previously approved these changes Jun 5, 2025
    View reviewed changes
    @mohammedahmed18 mohammedahmed18 force-pushed the chore/handle-json-and-string-errors-from-cfapi branch from d71de84 to 57d700b Compare June 5, 2025 18:16
    @Saga4 Saga4 merged commit c4901a4 into main Jun 12, 2025
    16 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @Saga4 Saga4 Saga4 approved these changes

    @aseembits93 aseembits93 Awaiting requested review from aseembits93

    Assignees

    No one assigned

    Labels

    Review effort 3/5

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @mohammedahmed18 @Saga4