Differential D8160 Diff 29470 swh/lister/gogs/lister.py

Changeset View

Standalone View

View Options

swh/lister/gogs/lister.py

This file was added.

ardumontUnsubmitted

Done

# See the AUTHORS file at the top-level directory of this distribution

ardumont:

# See the AUTHORS file at the top-level directory of this distribution

# License: GNU General Public License version 3, or any later version

# See top-level LICENSE file for more information

import logging

import random

from typing import Any, Dict, Iterator, List, Optional

from urllib.parse import urljoin

import iso8601

import requests

from tenacity.before_sleep import before_sleep_log

from swh.lister.utils import throttling_retry

from swh.scheduler.interface import SchedulerInterface

from swh.scheduler.model import ListedOrigin

from .. import USER_AGENT

from ..pattern import CredentialsType, StatelessLister

logger = logging.getLogger(__name__)

# Aliasing the page results returned by `get_pages` method from the lister.

ardumontUnsubmitted

Done

logger = logging.getLogger(__name__)

- # Aliasing the page results returned by `get_pages` method from the lister.

+ # Aliasing page results returned by `GogsLister.get_pages` method

GogsListerPage = List[Dict[str, Any]]

ardumont:

GogsListerPage = List[Dict[str, Any]]

class GogsLister(StatelessLister[GogsListerPage]):

"""List origins from the Gogs

Gogs API documentation: https://github.com/gogs/docs-api

The API is protected behind authentication so credentials/API tokens

are mandatory. It does pagination and the next page can be accessed

by simply incrementing the 'page' url query parameter. The default

value for page size ('limit') is 10 but the maximum allowed value is 50.

ardumontUnsubmitted

Done

Please reword the pagination part to match the 'Link>next' header implementation you are now using.

ardumont: Please reword the pagination part to match the 'Link>next' header implementation you are now…

"""

LISTER_NAME = "gogs"

VISIT_TYPE = "git"

REPO_LIST_PATH = "repos/search"

def __init__(

self,

scheduler: SchedulerInterface,

url: str,

instance: Optional[str] = None,

api_token: Optional[str] = None,

page_size: int = 50,

credentials: CredentialsType = None,

super().__init__(

scheduler=scheduler,

credentials=credentials,

url=url,

instance=instance,

)

self.query_params = {

"limit": page_size,

"page": 1,

}

self.api_token = api_token

if self.api_token is None:

if len(self.credentials) > 0:

cred = random.choice(self.credentials)

username = cred.get("username")

self.api_token = cred["password"]

logger.warning(

"Using authentication credentials from user %s", username or "???"

)

else:

raise ValueError("No credentials or API token provided")

self.max_page_limit = 2

self.session = requests.Session()

self.session.headers.update(

{

"Accept": "application/json",

"User-Agent": USER_AGENT,

"Authorization": f"token {self.api_token}",

}

)

@throttling_retry(before_sleep=before_sleep_log(logger, logging.WARNING))

def page_request(self, url, params) -> requests.Response:

logger.debug("Fetching URL %s with params %s", url, params)

response = self.session.get(url, params=params)

if response.status_code != 200:

logger.warning(

"Unexpected HTTP status code %s on %s: %s",

response.status_code,

response.url,

response.content,

)

response.raise_for_status()

return response

def get_pages(self) -> Iterator[GogsListerPage]:

# base with trailing slash, path without leading slash for urljoin

url = urljoin(self.url, self.REPO_LIST_PATH)

page_number = 1

while True:

params = {**self.query_params, "page": page_number}

page = self.page_request(url, params).json().get("data", [])

if len(page) == 0:

break

page_number += 1

ardumontUnsubmitted

Done

Can you please check whether the response has some pagination link inside?

It seems the documentation mentions it [1]
It'd be best to use pagination link instead of crafting the next page ourselves.
It will be more resilient over time.
And we even have some listers which lift this [2] ;).

[1] https://github.com/gogs/docs-api#link-header

[2] https://forge.softwareheritage.org/source/swh-lister/browse/master/swh/lister/gitea/lister.py$116-128

ardumont: Can you please check whether the response has some pagination link inside? It seems the…

yield page

def get_origins_from_page(self, page: GogsListerPage) -> Iterator[ListedOrigin]:

"""Convert a page of Gogs repositories into a list of ListedOrigins"""

assert self.lister_obj.id is not None

for repo in page:

last_update = iso8601.parse_date(repo["updated_at"])

yield ListedOrigin(

lister_id=self.lister_obj.id,

visit_type=self.VISIT_TYPE,

url=repo["clone_url"],

last_update=last_update,

)