import os # Added for environment variable access import time from urllib.parse import urlencode from typing import List, Tuple, Union, Optional import asyncio import json # Added for JSON handling import structlog http_client = None from nvchecker.api import ( VersionResult, Entry, AsyncCache, KeyManager, HTTPError, session, RichResult, GetVersionError, ) http_client = None logger = structlog.get_logger(logger_name=__name__) ALLOW_REQUEST = None RATE_LIMITED_ERROR = False GITHUB_GRAPHQL_URL = 'https://api.%s/graphql' async def execute_github_query(host: str, owner: str, reponame: str, token: str) -> dict: """ Execute GraphQL query against GitHub API and return the response data. Centralizes error handling and query execution. """ global http_client # Initialize the HTTP client if not already done if http_client is None: if asyncio.iscoroutine(session): http_client = await session http_client = session headers = { 'Authorization': f'bearer {token}', 'Content-Type': 'application/json', } query_vars = QUERY_GITHUB.replace("$owner", owner).replace("$name", reponame) async with http_client.post( GITHUB_GRAPHQL_URL % host, headers=headers, json={'query': query_vars} ) as res: j = await res.json() if 'errors' in j: raise GetVersionError(f"GitHub API error: {j['errors']}") return j['data']['repository'] def get_github_token(conf: Entry, host: str, keymanager: KeyManager) -> Optional[str]: """Get GitHub token from config, keymanager, or environment.""" token = conf.get('token') if token is None: token = keymanager.get_key(host.lower(), 'github') if token is None: token = os.environ.get('GITHUB_TOKEN') return token async def get_version(name, conf, **kwargs): global RATE_LIMITED_ERROR, ALLOW_REQUEST global http_client # Initialize the HTTP client if not already done if http_client is None: if asyncio.iscoroutine(session): http_client = await session http_client = session if RATE_LIMITED_ERROR: raise RuntimeError('rate limited') if ALLOW_REQUEST is None: ALLOW_REQUEST = asyncio.Event() ALLOW_REQUEST.set() for _ in range(2): # retry once try: await ALLOW_REQUEST.wait() return await get_version_real(name, conf, **kwargs) except HTTPError as e: if e.code in [403, 429]: if n := check_ratelimit(e, name): ALLOW_REQUEST.clear() await asyncio.sleep(n+1) ALLOW_REQUEST.set() continue RATE_LIMITED_ERROR = True raise QUERY_GITHUB = """ query { rateLimit { limit remaining resetAt } repository(owner: "$name", name: "$owner") { # Default branch commits defaultBranchRef { target { ... on Commit { history(first: 1) { totalCount edges { node { oid committedDate } } } } } } # All tags refs(refPrefix: "refs/tags/", first: 1, orderBy: { field: TAG_COMMIT_DATE, direction: DESC}) { edges { node { name target { ... on Commit { oid url } } } } } # All releases (filter pre-releases in your application logic) releases(first: 100, orderBy: { field: CREATED_AT, direction: DESC }) { totalCount edges { node { name url tagName isPrerelease isLatest createdAt } } pageInfo { hasNextPage endCursor } } } } """ async def get_latest_tag(key: Tuple[str, str, str, str]) -> RichResult: host, repo, query, token = key owner, reponame = repo.split('/') if not token: raise GetVersionError('token is required for latest tag query') repo_data = await execute_github_query(host, owner, reponame, token) refs = repo_data['refs']['edges'] version = refs[0]['node']['name'] revision = refs[0]['node']['target']['oid'] return RichResult( version=version, gitref=f"refs/tags/{version}", revision=revision, url=f'https://github.com/{repo}/releases/tag/{version}', ) async def get_latest_release_with_prereleases(key: Tuple[str, str, str, str]) -> RichResult: host, repo, token, use_release_name = key owner, reponame = repo.split('/') if not token: raise GetVersionError('token is required for latest release query') repo_data = await execute_github_query(host, owner, reponame, token) releases = repo_data['releases']['edges'] if not releases: raise GetVersionError('no release found') latest_release = releases[0]['node'] tag_name = latest_release['tagName'] version = latest_release['name'] if use_release_name else tag_name return RichResult( version=version, gitref=f"refs/tags/{tag_name}", revision=latest_release['target']['oid'], url=latest_release['url'], ) async def get_version_real( name: str, conf: Entry, *, cache: AsyncCache, keymanager: KeyManager, **kwargs, ) -> VersionResult: repo = conf['github'] owner, reponame = repo.split('/') host = conf.get('host', "github.com") token = get_github_token(conf, host, keymanager) use_latest_tag = conf.get('use_latest_tag', False) if use_latest_tag: if not token: raise GetVersionError('token not given but it is required') query = conf.get('query', '') return await cache.get((host, repo, query, token), get_latest_tag) repo_data = await execute_github_query(host, owner, reponame, token) use_max_tag = conf.get('use_max_tag', False) if use_max_tag: refs = repo_data['refs']['edges'] tags: List[Union[str, RichResult]] = [ RichResult( version=ref['node']['name'], gitref=f"refs/tags/{ref['node']['name']}", revision=ref['node']['target']['oid'], url=f'https://github.com/{repo}/releases/tag/{ref["node"]["name"]}', ) for ref in refs ] if not tags: raise GetVersionError('No tag found in upstream repository.') return tags use_latest_release = conf.get('use_latest_release', False) if use_latest_release: releases = repo_data['releases']['edges'] if not releases: raise GetVersionError('No release found in upstream repository.') latest_release = releases[0]['node'] use_release_name = conf.get('use_release_name', False) version = latest_release['name'] if use_release_name else latest_release['tagName'] return RichResult( version=version, gitref=f"refs/tags/{latest_release['tagName']}", url=latest_release['url'], ) else: commit = repo_data['defaultBranchRef']['target']['history']['edges'][0]['node'] return RichResult( version=commit['committedDate'].rstrip('Z').replace('-', '').replace(':', '').replace('T', '.'), revision=commit['oid'], url=f'https://github.com/{repo}/commit/{commit["oid"]}', ) def check_ratelimit(exc: HTTPError, name: str) -> Optional[int]: res = exc.response if not res: raise exc if v := res.headers.get('retry-after'): n = int(v) logger.warning('retry-after', n=n) return n # default -1 is used to re-raise the exception n = int(res.headers.get('X-RateLimit-Remaining', -1)) if n == 0: reset = int(res.headers.get('X-RateLimit-Reset')) logger.error(f'rate limited, resetting at {time.ctime(reset)}. ' 'Or get an API token to increase the allowance if not yet', name = name, reset = reset) return None raise exc