Log error when refresh token fails

[simonc56]

Refresh token can fail with error 400 or error 401 for many reasons, not only invalid refresh_token.
If refresh fails, an error should be logged.
And response body provides useful information.

Example in PlexTraktSync

Before PR:

INFO     OAuth token has expired, refreshing now...
CRITICAL Error running sync command: Trakt authentication error: Unauthorized - OAuth must be provided

After PR:

INFO     OAuth token has expired, refreshing now...
ERROR    401 - Unable to refresh expired OAuth token (invalid_client) Client authentication failed due to unknown
         client, no client authentication included, or unsupported authentication method.
CRITICAL Error running sync command: Trakt authentication error: Unauthorized - OAuth must be provided

INFO     OAuth token has expired, refreshing now...
ERROR    400 - Unable to refresh expired OAuth token (invalid_grant) The provided authorization grant is invalid,
         expired, revoked, does not match the redirection URI used in the authorization request, or was issued to
         another client.
CRITICAL Error running sync command: Trakt authentication error: Unauthorized - OAuth must be provided

See :

• OAuth token not persisting after some time Taxel/PlexTraktSync#2268

[coderabbitai]

Walkthrough

The exception handling in the refresh_token method of the TokenAuth class within trakt/api.py was updated to catch both OAuthException and BadRequestException. The error logging was enhanced to provide more detailed diagnostic information, including error messages and HTTP status codes.

Changes

File(s)	Change Summary
trakt/api.py	Expanded exception handling in refresh_token to include BadRequestException and improved error logging with detailed messages including HTTP status, error, and description.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant TokenAuth
    participant TraktAPI

    Client->>TokenAuth: refresh_token()
    TokenAuth->>TraktAPI: Request new token with refresh token
    alt Success
        TraktAPI-->>TokenAuth: Return new token
        TokenAuth-->>Client: Return new token
    else OAuthException or BadRequestException
        TraktAPI-->>TokenAuth: Raise exception with error details
        TokenAuth->>TokenAuth: Log error with status, error, description
        TokenAuth-->>Client: Return None (early exit)
    end

Loading

Possibly related PRs

• Fix: Add max retries to token refresh #60: Both PRs modify the refresh_token method in the TokenAuth class within trakt/api.py to improve error handling during token refresh, with the main PR enhancing exception logging and the retrieved PR adding retry limits.

Poem

A token refresh, a cautious hop,
Now catches errors that before would drop.
With logs more clear and messages bright,
Troubles are spotted in the darkest night.
🐇✨
Code hops ahead, with errors in sight!

---

📜 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 c6eee75 and ee7dd4f.

📒 Files selected for processing (1)

• trakt/api.py (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• trakt/api.py

⏰ 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). (1)

• GitHub Check: Python 3.11

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

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

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.

[Copilot]

Pull Request Overview

The PR enhances the refresh_token method to log detailed error information when token refreshes fail with HTTP 400 or 401.

• Import BadRequestException alongside existing exceptions.
• Expand the exception handler to catch both OAuthException and BadRequestException.
• Log the HTTP status, error code, and description at the error level.

Comments suppressed due to low confidence (1)

trakt/api.py:252

• This new error-logging branch isn't covered by existing tests. Add unit tests simulating 400 and 401 refresh failures to assert that logger.error is invoked with the proper HTTP code and error details.

        except (OAuthException, BadRequestException) as e:

[simonc56]

@glensc automatic tests are not launched due to deprecated ubuntu-20.04 image in test workflow.

[glensc]

@simonc56 fixed CI:

• CI: Switch ubuntu-20.04 with ubuntu-22.04 runner for test workflow #82