Skip to content

Use TOKEN_REFRESH_MARGIN constant #77

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

Merged
glensc merged 4 commits into from
Feb 16, 2025
Merged

Use TOKEN_REFRESH_MARGIN constant #77

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be02e9e
Use TOKEN_REFRESH_MARGIN constant
glensc Feb 16, 2025
b42c7d3
Update validate_token doc
glensc Feb 16, 2025
6b5aac2
Log expiring message
glensc Feb 16, 2025
35084a7
Ensure timedelta is calculated on each request
glensc Feb 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions trakt/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,9 @@ class TokenAuth(AuthBase):
#: How many times to attempt token auth refresh before failing
MAX_RETRIES = 1

# Time margin before token expiry when refresh should be triggered
TOKEN_REFRESH_MARGIN = {'minutes': 10}

logger = logging.getLogger(__name__)

def __init__(self, client: HttpClient, config: AuthConfig):
Expand Down Expand Up @@ -210,13 +213,20 @@ def get_token(self):
]

def validate_token(self):
"""Check if current OAuth token has not expired"""
"""Check if current OAuth token has not expired

The token is considered valid if it expires in more than TOKEN_REFRESH_MARGIN
(default: 10 minutes). This margin ensures the token doesn't expire during
critical operations while also maximizing the token's useful lifetime.
"""

current = datetime.now(tz=timezone.utc)
expires_at = datetime.fromtimestamp(self.config.OAUTH_EXPIRES_AT, tz=timezone.utc)
if expires_at - current > timedelta(minutes=10):
margin = expires_at - current
if margin > timedelta(**self.TOKEN_REFRESH_MARGIN):
self.OAUTH_TOKEN_VALID = True
else:
self.logger.debug("Token expires in %s, refreshing (margin: %s)", margin, self.TOKEN_REFRESH_MARGIN)
self.refresh_token()

def refresh_token(self):
Expand Down
Loading