# Copyright (C) 2020-2024 The Software Heritage developers
# 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
from __future__ import annotations
import copy
from dataclasses import dataclass
import logging
from typing import Any, Dict, Generic, Iterable, Iterator, List, Optional, Set, TypeVar
from urllib.parse import urlparse
import attr
import requests
from tenacity.before_sleep import before_sleep_log
from swh.core.config import load_from_envvar
from swh.core.github.utils import GitHubSession
from swh.core.retry import http_retry
from swh.core.utils import grouper
from swh.scheduler import get_scheduler, model
from swh.scheduler.interface import SchedulerInterface
from swh.scheduler.utils import utcnow
from . import USER_AGENT_TEMPLATE
from .utils import is_valid_origin_url
logger = logging.getLogger(__name__)
[docs]
@dataclass
class ListerStats:
pages: int = 0
origins: int = 0
def __add__(self, other: ListerStats) -> ListerStats:
return self.__class__(self.pages + other.pages, self.origins + other.origins)
def __iadd__(self, other: ListerStats):
self.pages += other.pages
self.origins += other.origins
[docs]
def dict(self) -> Dict[str, int]:
return {"pages": self.pages, "origins": self.origins}
StateType = TypeVar("StateType")
PageType = TypeVar("PageType")
BackendStateType = Dict[str, Any]
CredentialsType = Optional[Dict[str, Dict[str, List[Dict[str, str]]]]]
[docs]
class Lister(Generic[StateType, PageType]):
"""The base class for a Software Heritage lister.
A lister scrapes a page by page list of origins from an upstream (a forge, the API
of a package manager, ...), and massages the results of that scrape into a list of
origins that are recorded by the scheduler backend.
The main loop of the lister, :meth:`run`, basically revolves around the
:meth:`get_pages` iterator, which sets up the lister state, then yields the scrape
results page by page. The :meth:`get_origins_from_page` method converts the pages
into a list of :class:`model.ListedOrigin`, sent to the scheduler at every page. The
:meth:`commit_page` method can be used to update the lister state after a page of
origins has been recorded in the scheduler backend.
The :func:`finalize` method is called at lister teardown (whether the run has
been successful or not) to update the local :attr:`state` object before it's sent to
the database. This method must set the :attr:`updated` attribute if an updated
state needs to be sent to the scheduler backend. This method can call
:func:`get_state_from_scheduler` to refresh and merge the lister state from the
scheduler before it's finalized (and potentially minimize the risk of race
conditions between concurrent runs of the lister).
The state of the lister is serialized and deserialized from the dict stored in the
scheduler backend, using the :meth:`state_from_dict` and :meth:`state_to_dict`
methods.
Args:
scheduler: the instance of the Scheduler being used to register the
origins listed by this lister
url: a URL representing this lister, e.g. the API's base URL
instance: the instance name, to uniquely identify this lister instance,
if not provided the URL network location will be used
credentials: dictionary of credentials for all listers. The first level
identifies the :attr:`LISTER_NAME`, the second level the lister
:attr:`instance`. The final level is a list of dicts containing the
expected credentials for the given instance of that lister.
max_pages: the maximum number of pages listed in a full listing operation
max_origins_per_page: the maximum number of origins processed per page
enable_origins: whether the created origins should be enabled or not
record_batch_size: maximum number of records to flush to the scheduler at once.
Generic types:
- *StateType*: concrete lister type; should usually be a :class:`dataclass` for
stricter typing
- *PageType*: type of scrape results; can usually be a :class:`requests.Response`,
or a :class:`dict`
"""
LISTER_NAME: str = ""
github_session: Optional[GitHubSession] = None
def __init__(
self,
scheduler: SchedulerInterface,
url: Optional[str] = None,
instance: Optional[str] = None,
credentials: CredentialsType = None,
max_origins_per_page: Optional[int] = None,
max_pages: Optional[int] = None,
enable_origins: bool = True,
with_github_session: bool = False,
record_batch_size: int = 1000,
first_visits_queue_prefix: Optional[str] = None,
):
if not self.LISTER_NAME:
raise ValueError("Must set the LISTER_NAME attribute on Lister classes")
self.url: str
# lister can be instantiated using directly their 'url' (the default behavior)
# or derive their url through an 'instance' (their domain's root path) parameter
if url is not None:
# direct url instantiation
self.url = url
elif url is None and instance is not None:
# Allow instantiation through their instance parameter (domain's root path)
# (e.g. "gitlab.com", "git.garbaye.fr", ...)
self.url = self.build_url(instance)
else:
raise ValueError(
"Either 'url' or 'instance' parameter should be provided for listing."
)
if instance is not None:
self.instance = instance
else:
self.instance = urlparse(self.url).netloc
self.first_visits_queue_prefix = first_visits_queue_prefix
self.scheduler = scheduler
if not credentials:
credentials = {}
self.credentials = list(
credentials.get(self.LISTER_NAME, {}).get(self.instance, [])
)
# store the initial state of the lister
self.state = self.get_state_from_scheduler()
self.updated = False
self.session = requests.Session()
# Declare the USER_AGENT is more sysadm-friendly for the forge we list
self.session.headers.update(
{"User-Agent": USER_AGENT_TEMPLATE % self.LISTER_NAME}
)
self.github_session: Optional[GitHubSession] = (
GitHubSession(
credentials=credentials.get("github", {}).get("github", []),
user_agent=str(self.session.headers["User-Agent"]),
)
if with_github_session
else None
)
self.recorded_origins: Set[str] = set()
self.max_pages = max_pages
self.max_origins_per_page = max_origins_per_page
self.enable_origins = enable_origins
self.record_batch_size = record_batch_size
[docs]
def build_url(self, instance: str) -> str:
"""Optionally build the forge url to list. When the url is not provided in the
constructor, this method is called. This should compute the actual url to use to
list the forge.
This is particularly useful for forges which uses an api. This simplifies the
cli calls to use. They should then only provide the instance (its domain).
For example:
- gitlab: https://{instance}/api/v4
- gitea: https://{instance}/api/v1
- ...
"""
scheme = urlparse(instance).scheme
if scheme:
raise ValueError("Instance should only be a net location.")
return f"https://{instance}"
[docs]
@http_retry(before_sleep=before_sleep_log(logger, logging.WARNING))
def http_request(self, url: str, method="GET", **kwargs) -> requests.Response:
logger.debug("Fetching URL %s with params %s", url, kwargs.get("params"))
response = self.session.request(method, url, **kwargs)
if response.status_code not in (200, 304):
logger.warning(
"Unexpected HTTP status code %s on %s: %s",
response.status_code,
response.url,
response.content,
)
response.raise_for_status()
return response
[docs]
def run(self) -> ListerStats:
"""Run the lister.
Returns:
A counter with the number of pages and origins seen for this run
of the lister.
"""
full_stats = ListerStats()
self.recorded_origins = set()
try:
for page in self.get_pages():
full_stats.pages += 1
origins = []
for origin in self.get_origins_from_page(page):
origins.append(origin)
if (
self.max_origins_per_page
and len(origins) == self.max_origins_per_page
):
logger.info(
"Max origins per page set to %s and reached, "
"aborting page processing",
self.max_origins_per_page,
)
break
if not self.enable_origins:
logger.info(
"Disabling origins before sending them to the scheduler"
)
origins = [attr.evolve(origin, enabled=False) for origin in origins]
sent_origins = self.send_origins(origins)
self.recorded_origins.update(sent_origins)
full_stats.origins = len(self.recorded_origins)
self.commit_page(page)
if self.max_pages and full_stats.pages >= self.max_pages:
logger.info("Reached page limit of %s, terminating", self.max_pages)
break
finally:
self.finalize()
self.set_state_in_scheduler(with_listing_finished_date=True)
return full_stats
[docs]
def get_state_from_scheduler(self) -> StateType:
"""Update the state in the current instance from the state in the scheduler backend.
This updates :attr:`lister_obj`, and returns its (deserialized) current state,
to allow for comparison with the local state.
Returns:
the state retrieved from the scheduler backend
"""
self.lister_obj = self.scheduler.get_or_create_lister(
name=self.LISTER_NAME,
instance_name=self.instance,
first_visits_queue_prefix=self.first_visits_queue_prefix,
)
return self.state_from_dict(copy.deepcopy(self.lister_obj.current_state))
[docs]
def set_state_in_scheduler(
self, with_listing_finished_date: bool = False, force_state: bool = False
) -> None:
"""Update the state in the scheduler backend from the state of the current
instance.
Args:
with_listing_finished_date: Update the ``last_listing_finished_at`` column
value for the lister in scheduler database if set to const:`True`.
force_state: Update lister state even when lister has ``updated`` attribute
set to :const:`False`, this is useful for tests
Raises:
swh.scheduler.exc.StaleData: in case of a race condition between
concurrent listers (from :meth:`swh.scheduler.Scheduler.update_lister`).
"""
if self.updated or force_state:
self.lister_obj.current_state = self.state_to_dict(self.state)
if with_listing_finished_date:
self.lister_obj.last_listing_finished_at = utcnow()
self.lister_obj = self.scheduler.update_lister(self.lister_obj)
# State management to/from the scheduler
[docs]
def state_from_dict(self, d: BackendStateType) -> StateType:
"""Convert the state stored in the scheduler backend (as a dict),
to the concrete StateType for this lister."""
raise NotImplementedError
[docs]
def state_to_dict(self, state: StateType) -> BackendStateType:
"""Convert the StateType for this lister to its serialization as dict for
storage in the scheduler.
Values must be JSON-compatible as that's what the backend database expects.
"""
raise NotImplementedError
[docs]
def finalize(self) -> None:
"""Custom hook to finalize the lister state before returning from the main loop.
This method must set :attr:`updated` if the lister has done some work.
If relevant, this method can use :meth`get_state_from_scheduler` to merge the
current lister state with the one from the scheduler backend, reducing the risk
of race conditions if we're running concurrent listings.
This method is called in a `finally` block, which means it will also run when
the lister fails.
"""
pass
# Actual listing logic
[docs]
def get_pages(self) -> Iterator[PageType]:
"""Retrieve a list of pages of listed results. This is the main loop of the lister.
Returns:
an iterator of raw pages fetched from the platform currently being listed.
"""
raise NotImplementedError
[docs]
def get_origins_from_page(self, page: PageType) -> Iterator[model.ListedOrigin]:
"""Extract a list of :class:`model.ListedOrigin` from a raw page of results.
Args:
page: a single page of results
Returns:
an iterator for the origins present on the given page of results
"""
raise NotImplementedError
[docs]
def commit_page(self, page: PageType) -> None:
"""Custom hook called after the current page has been committed in the scheduler
backend.
This method can be used to update the state after a page of origins has been
successfully recorded in the scheduler backend. If the new state should be
recorded at the point the lister completes, the :attr:`updated` attribute must
be set.
"""
pass
[docs]
def send_origins(self, origins: Iterable[model.ListedOrigin]) -> List[str]:
"""Record the stream of valid :class:`model.ListedOrigin` in the scheduler.
This will filter out invalid urls prior to record origins to the scheduler.
Returns:
the list of origin URLs recorded in scheduler database
"""
recorded_origins: List[str] = []
for origins in grouper(origins, n=self.record_batch_size):
valid_origins = []
for origin in origins:
if is_valid_origin_url(origin.url):
valid_origins.append(origin)
else:
logger.warning("Skipping invalid origin: %s", origin.url)
logger.debug("Record valid %s origins in the scheduler", len(valid_origins))
ret = self.scheduler.record_listed_origins(valid_origins)
recorded_origins.extend(origin.url for origin in ret)
return recorded_origins
[docs]
@classmethod
def from_config(cls, scheduler: Dict[str, Any], **config: Any):
"""Instantiate a lister from a configuration dict.
This is basically a backwards-compatibility shim for the CLI.
Args:
scheduler: instantiation config for the scheduler
config: the configuration dict for the lister, with the following keys:
- credentials (optional): credentials list for the scheduler
- any other kwargs passed to the lister.
Returns:
the instantiated lister
"""
# Drop the legacy config keys which aren't used for this generation of listers.
for legacy_key in ("storage", "lister", "celery"):
config.pop(legacy_key, None)
# Instantiate the scheduler
scheduler_instance = get_scheduler(**scheduler)
return cls(scheduler=scheduler_instance, **config)
[docs]
@classmethod
def from_configfile(cls, **kwargs: Any):
"""Instantiate a lister from the configuration loaded from the
SWH_CONFIG_FILENAME envvar, with potential extra keyword arguments
if their value is not None.
Args:
kwargs: kwargs passed to the lister instantiation
"""
config = dict(load_from_envvar())
config.update({k: v for k, v in kwargs.items() if v is not None})
return cls.from_config(**config)
[docs]
class StatelessLister(Lister[None, PageType], Generic[PageType]):
[docs]
def state_from_dict(self, d: BackendStateType) -> None:
"""Always return empty state"""
return None
[docs]
def state_to_dict(self, state: None) -> BackendStateType:
"""Always set empty state"""
return {}
