Compare commits

..

1 Commits

Author SHA1 Message Date
9ec566f095 feat: add retry policy 2026-02-20 02:49:32 +02:00
14 changed files with 1528 additions and 1635 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -97,15 +97,6 @@ libalpm and AUR related configuration. Group name can refer to architecture, e.g
* ``sync_files_database`` - download files database from mirror, boolean, required.
* ``use_ahriman_cache`` - use local pacman package cache instead of system one, boolean, required. With this option enabled you might want to refresh database periodically (available as additional flag for some subcommands). If set to ``no``, databases must be synchronized manually.
``aur`` group
-------------
Archlinux User Repository related configuration.
* ``max_retries`` - maximum amount of retries of HTTP requests, integer, optional, default ``0``.
* ``retry_backoff`` - retry exponential backoff, float, optional, default ``0.0``.
* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
``auth`` group
--------------

View File

@@ -2,7 +2,7 @@
pkgbase='ahriman'
pkgname=('ahriman' 'ahriman-core' 'ahriman-triggers' 'ahriman-web')
pkgver=2.20.0rc3
pkgver=2.20.0rc1
pkgrel=1
pkgdesc="ArcH linux ReposItory MANager"
arch=('any')

View File

@@ -23,14 +23,6 @@ sync_files_database = yes
; as additional option for some subcommands). If set to no, databases must be synchronized manually.
use_ahriman_cache = yes
[aur]
; Maximum amount of retries of HTTP requests.
max_retries = 3
; Retry exponential backoff.
retry_backoff = 1.0
; HTTP request timeout in seconds.
;timeout = 30
[build]
; List of additional flags passed to archbuild command.
;archbuild_flags =

View File

@@ -1,4 +1,4 @@
.TH AHRIMAN "1" "2026\-02\-20" "ahriman 2.20.0rc3" "ArcH linux ReposItory MANager"
.TH AHRIMAN "1" "2026\-02\-18" "ahriman 2.20.0rc1" "ArcH linux ReposItory MANager"
.SH NAME
ahriman \- ArcH linux ReposItory MANager
.SH SYNOPSIS

View File

@@ -17,4 +17,4 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
__version__ = "2.20.0rc3"
__version__ = "2.20.0rc1"

View File

@@ -97,26 +97,6 @@ CONFIGURATION_SCHEMA: ConfigurationSchema = {
},
},
},
"aur": {
"type": "dict",
"schema": {
"max_retries": {
"type": "integer",
"coerce": "integer",
"min": 0,
},
"retry_backoff": {
"type": "float",
"coerce": "float",
"min": 0,
},
"timeout": {
"type": "integer",
"coerce": "integer",
"min": 0,
},
},
},
"auth": {
"type": "dict",
"schema": {

View File

@@ -60,7 +60,7 @@ class SyncAhrimanClient(SyncHttpClient):
return adapters
def on_session_creation(self, session: requests.Session) -> None:
def start(self, session: requests.Session) -> None:
"""
method which will be called on session creation

View File

@@ -40,14 +40,10 @@ class SyncHttpClient(LazyLogging):
Attributes:
auth(tuple[str, str] | None): HTTP basic auth object if set
retry(Retry): retry policy of the HTTP client. Disabled by default
suppress_errors(bool): suppress logging of request errors
timeout(int | None): HTTP request timeout in seconds
"""
retry: Retry = Retry()
timeout: int | None = None
def __init__(self, configuration: Configuration | None = None, section: str | None = None, *,
suppress_errors: bool = False) -> None:
"""
@@ -56,19 +52,26 @@ class SyncHttpClient(LazyLogging):
section(str | None, optional): settings section name (Default value = None)
suppress_errors(bool, optional): suppress logging of request errors (Default value = False)
"""
configuration = configuration or Configuration() # dummy configuration
section = section or configuration.default_section
if configuration is None:
configuration = Configuration() # dummy configuration
if section is None:
section = configuration.default_section
username = configuration.get(section, "username", fallback=None)
password = configuration.get(section, "password", fallback=None)
self.auth = (username, password) if username and password else None
self.timeout: int | None = configuration.getint(section, "timeout", fallback=30)
self.suppress_errors = suppress_errors
self.timeout = configuration.getint(section, "timeout", fallback=30)
self.retry = SyncHttpClient.retry_policy(
max_retries=configuration.getint(section, "max_retries", fallback=0),
retry_backoff=configuration.getfloat(section, "retry_backoff", fallback=0.0),
retries = configuration.getint(section, "max_retries", fallback=0)
self.retry = Retry(
total=retries,
connect=retries,
read=retries,
status=retries,
status_forcelist=[429, 500, 502, 503, 504],
backoff_factor=configuration.getfloat(section, "retry_backoff", fallback=0.0),
)
@cached_property
@@ -89,7 +92,7 @@ class SyncHttpClient(LazyLogging):
f"{requests.utils.default_user_agent()} " \
f"python/{python_version}"
self.on_session_creation(session)
self.start(session)
return session
@@ -107,27 +110,6 @@ class SyncHttpClient(LazyLogging):
result: str = exception.response.text if exception.response is not None else ""
return result
@staticmethod
def retry_policy(max_retries: int = 0, retry_backoff: float = 0.0) -> Retry:
"""
build retry policy for class
Args:
max_retries(int, optional): maximum amount of retries allowed (Default value = 0)
retry_backoff(float, optional): retry exponential backoff (Default value = 0.0)
Returns:
Retry: built retry policy
"""
return Retry(
total=max_retries,
connect=max_retries,
read=max_retries,
status=max_retries,
status_forcelist=[429, 500, 502, 503, 504],
backoff_factor=retry_backoff,
)
def adapters(self) -> dict[str, BaseAdapter]:
"""
get registered adapters
@@ -135,9 +117,10 @@ class SyncHttpClient(LazyLogging):
Returns:
dict[str, BaseAdapter]: map of protocol and adapter used for this protocol
"""
adapter = HTTPAdapter(max_retries=self.retry)
return {
"http://": HTTPAdapter(max_retries=self.retry),
"https://": HTTPAdapter(max_retries=self.retry),
"http://": adapter,
"https://": adapter,
}
def make_request(self, method: Literal["DELETE", "GET", "HEAD", "POST", "PUT"], url: str, *,
@@ -188,7 +171,7 @@ class SyncHttpClient(LazyLogging):
self.logger.exception("could not perform http request")
raise
def on_session_creation(self, session: requests.Session) -> None:
def start(self, session: requests.Session) -> None:
"""
method which will be called on session creation

View File

@@ -21,7 +21,6 @@ from typing import Self
from ahriman.core import _Context, context
from ahriman.core.alpm.pacman import Pacman
from ahriman.core.alpm.remote import AUR
from ahriman.core.configuration import Configuration
from ahriman.core.database import SQLite
from ahriman.core.repository.executor import Executor
@@ -74,26 +73,9 @@ class Repository(Executor, UpdateHandler):
"""
instance = cls(repository_id, configuration, database,
report=report, refresh_pacman_database=refresh_pacman_database)
instance._set_globals(configuration)
instance._set_context()
return instance
@staticmethod
def _set_globals(configuration: Configuration) -> None:
"""
set global settings based on configuration via class attributes
Args:
configuration(Configuration): configuration instance
"""
AUR.timeout = configuration.getint("aur", "timeout", fallback=30)
AUR.retry = AUR.retry_policy(
max_retries=configuration.getint("aur", "max_retries", fallback=0),
retry_backoff=configuration.getfloat("aur", "retry_backoff", fallback=0.0),
)
def _set_context(self) -> None:
"""
create context variables and set their values

View File

@@ -154,7 +154,7 @@ def setup_auth(application: Application, configuration: Configuration, validator
cookie_name="AHRIMAN",
max_age=validator.max_age,
httponly=True,
samesite="Lax",
samesite="Strict",
)
setup_session(application, storage)

View File

@@ -30,7 +30,7 @@ def test_login_url(ahriman_client: SyncAhrimanClient) -> None:
assert ahriman_client._login_url().endswith("/api/v1/login")
def test_on_session_creation(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
def test_start(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
"""
must log in user on start
"""
@@ -42,17 +42,17 @@ def test_on_session_creation(ahriman_client: SyncAhrimanClient, user: User, mock
}
session = requests.Session()
ahriman_client.on_session_creation(session)
ahriman_client.start(session)
requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), json=payload, session=session)
def test_on_session_creation_failed(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
def test_start_failed(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
"""
must suppress any exception happened during session start
"""
ahriman_client.user = user
mocker.patch("requests.Session.request", side_effect=Exception)
ahriman_client.on_session_creation(requests.Session())
ahriman_client.start(requests.Session())
def test_start_failed_http_error(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
@@ -61,7 +61,7 @@ def test_start_failed_http_error(ahriman_client: SyncAhrimanClient, user: User,
"""
ahriman_client.user = user
mocker.patch("requests.Session.request", side_effect=requests.HTTPError)
ahriman_client.on_session_creation(requests.Session())
ahriman_client.start(requests.Session())
def test_start_skip(ahriman_client: SyncAhrimanClient, mocker: MockerFixture) -> None:
@@ -69,5 +69,5 @@ def test_start_skip(ahriman_client: SyncAhrimanClient, mocker: MockerFixture) ->
must skip login if no user set
"""
requests_mock = mocker.patch("requests.Session.request")
ahriman_client.on_session_creation(requests.Session())
ahriman_client.start(requests.Session())
requests_mock.assert_not_called()

View File

@@ -4,7 +4,6 @@ import requests
from pytest_mock import MockerFixture
from unittest.mock import MagicMock, call as MockCall
from ahriman.core.alpm.remote import AUR
from ahriman.core.configuration import Configuration
from ahriman.core.http import SyncHttpClient
@@ -38,25 +37,11 @@ def test_session(mocker: MockerFixture) -> None:
"""
must generate valid session
"""
on_session_creation_mock = mocker.patch("ahriman.core.http.sync_http_client.SyncHttpClient.on_session_creation")
start_mock = mocker.patch("ahriman.core.http.sync_http_client.SyncHttpClient.start")
session = SyncHttpClient().session
assert "User-Agent" in session.headers
on_session_creation_mock.assert_called_once_with(pytest.helpers.anyvar(int))
def test_retry_policy() -> None:
"""
must set retry policy
"""
SyncHttpClient.retry = SyncHttpClient.retry_policy(1, 2.0)
AUR.retry = AUR.retry_policy(3, 4.0)
assert SyncHttpClient.retry.connect == 1
assert SyncHttpClient.retry.backoff_factor == 2.0
assert AUR.retry.connect == 3
assert AUR.retry.backoff_factor == 4.0
start_mock.assert_called_once_with(pytest.helpers.anyvar(int))
def test_exception_response_text() -> None:
@@ -83,11 +68,11 @@ def test_adapters() -> None:
must create adapters with retry policy
"""
client = SyncHttpClient()
adapters = client.adapters()
adapers = client.adapters()
assert "http://" in adapters
assert "https://" in adapters
assert all(adapter.max_retries == client.retry for adapter in adapters.values())
assert "http://" in adapers
assert "https://" in adapers
assert all(adapter.max_retries == client.retry for adapter in adapers.values())
def test_make_request(mocker: MockerFixture) -> None:
@@ -190,9 +175,9 @@ def test_make_request_session() -> None:
stream=None, auth=None, timeout=client.timeout)
def test_on_session_creation() -> None:
def test_start() -> None:
"""
must do nothing on start
"""
client = SyncHttpClient()
client.on_session_creation(client.session)
client.start(client.session)

View File

@@ -2,7 +2,6 @@ from pytest_mock import MockerFixture
from unittest.mock import call as MockCall
from ahriman.core.alpm.pacman import Pacman
from ahriman.core.alpm.remote import AUR
from ahriman.core.configuration import Configuration
from ahriman.core.database import SQLite
from ahriman.core.repository import Repository
@@ -14,27 +13,13 @@ def test_load(configuration: Configuration, database: SQLite, mocker: MockerFixt
"""
must correctly load instance
"""
globals_mock = mocker.patch("ahriman.core.repository.Repository._set_globals")
context_mock = mocker.patch("ahriman.core.repository.Repository._set_context")
_, repository_id = configuration.check_loaded()
Repository.load(repository_id, configuration, database, report=False)
globals_mock.assert_called_once_with(configuration)
context_mock.assert_called_once_with()
def test_set_globals(configuration: Configuration) -> None:
"""
must correctly set globals
"""
configuration.set_option("aur", "timeout", "42")
configuration.set_option("aur", "max_retries", "10")
Repository._set_globals(configuration)
assert AUR.timeout == 42
assert AUR.retry.connect == 10
def test_set_context(configuration: Configuration, database: SQLite, mocker: MockerFixture) -> None:
"""
must set context variables