Use TOKEN_REFRESH_MARGIN constant

[glensc]

Add improvements from coderabbit:

• Reduce access_token refresh margin delay from 2 days to 10 minutes #76

[coderabbitai]

Walkthrough

This change introduces a new constant, TOKEN_REFRESH_MARGIN, in the TokenAuth class of trakt/api.py to define a 10-minute margin before token expiration. The validate_token method now checks if the remaining time until token expiry exceeds this margin. A debug log statement has been added to record when the token is near expiration, potentially triggering a refresh. The method's docstring has also been updated to explain this margin, causing an indirect effect on the refresh_token method.

Changes

File	Summary of Changes
trakt/api.py	- Added TOKEN_REFRESH_MARGIN constant (timedelta(minutes=10)) in TokenAuth. - Modified validate_token to validate the token using the new margin. - Expanded the docstring and added a debug log for near-expiry tokens.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant T as TokenAuth
    participant R as Refresh Token Service

    C->>T: Request token validation
    T->>T: Check token expiry against TOKEN_REFRESH_MARGIN
    alt Token nearing expiration
        T->>T: Log near-expiry warning
        T->>R: Trigger refresh_token
    else Token valid
        T->>C: Return valid token
    end

Loading

Possibly related PRs

• Fix: Set max retries to 1 #61: Introduces a new constant and modifies the validate_token method in the TokenAuth class, related to token management logic.
• Reduce access_token refresh margin delay from 2 days to 10 minutes #76: Adjusts the token validity check in TokenAuth with a similar 10-minute margin.
• Fix: Add max retries to token refresh #60: Updates the token management logic in TokenAuth, aligning with the modifications introduced here.

Poem

I'm a hopping rabbit, so full of cheer,
Watching tokens refresh when the end is near.
A margin of ten, a tweak so neat,
Logging the process with a rhythmic beat.
With every code hop, the system's pure delight,
In the realm of tokens, we dance through the night!
🐇💻

---

📜 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 6b5aac2 and 35084a7.

📒 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

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • 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. (Beta)
• @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.