Compare commits

..

7 Commits

Author SHA1 Message Date
415fcf58ce Release 2.20.0rc4 2026-02-21 12:52:51 +02:00
17a2d6362c style: replace """ with " for single line strings 2026-02-21 12:51:58 +02:00
e6275de4ed fix: handle class overrides for retry polices correctly
Previous implementation didn't work as intended because there was still
override in init. Current implementation instead of playing with
guessing separates default and instance setttings. Also update test
cases to handle this scenario correctly
2026-02-21 12:40:11 +02:00
4d009cba6d Release 2.20.0rc3 2026-02-20 20:56:05 +02:00
f6defbf90d fix: rollback samesite option to Lax, because of broken OAuth 2026-02-20 20:54:37 +02:00
c4fefa6071 Release 2.20.0rc2 2026-02-20 16:30:37 +02:00
b0f1828ae7 feat: add retry policy 2026-02-20 16:24:14 +02:00
18 changed files with 1650 additions and 1536 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -97,6 +97,15 @@ 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.0rc1
pkgver=2.20.0rc4
pkgrel=1
pkgdesc="ArcH linux ReposItory MANager"
arch=('any')

View File

@@ -23,6 +23,14 @@ 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\-18" "ahriman 2.20.0rc1" "ArcH linux ReposItory MANager"
.TH AHRIMAN "1" "2026\-02\-21" "ahriman 2.20.0rc4" "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.0rc1"
__version__ = "2.20.0rc4"

View File

@@ -251,7 +251,7 @@ class Setup(Handler):
content = f"PACKAGER='{packager}'\n"
if makeflags_jobs:
content += """MAKEFLAGS="-j$(nproc)"\n"""
content += "MAKEFLAGS=\"-j$(nproc)\"\n"
uid, _ = paths.root_owner
home_dir = Path(getpwuid(uid).pw_dir)

View File

@@ -69,8 +69,8 @@ class OAuth(Mapping):
Returns:
str: login control as html code to insert
"""
return f"""<a class="nav-link" href="/api/v1/login" title="login via OAuth2"><i class="bi bi-{
self.icon}"></i> login</a>"""
return f"<a class=\"nav-link\" href=\"/api/v1/login\" title=\"login via OAuth2\"><i class=\"bi bi-{
self.icon}\"></i> login</a>"
@staticmethod
def get_provider(name: str) -> type[aioauth_client.OAuth2Client]:

View File

@@ -97,6 +97,26 @@ 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 start(self, session: requests.Session) -> None:
def on_session_creation(self, session: requests.Session) -> None:
"""
method which will be called on session creation

View File

@@ -22,7 +22,7 @@ import sys
from functools import cached_property
from requests.adapters import BaseAdapter, HTTPAdapter
from typing import Any, IO, Literal
from typing import Any, ClassVar, IO, Literal
from urllib3.util.retry import Retry
from ahriman import __version__
@@ -39,11 +39,19 @@ class SyncHttpClient(LazyLogging):
wrapper around requests library to reduce boilerplate
Attributes:
DEFAULT_MAX_RETRIES(int): (class attribute) default maximum amount of retries
DEFAULT_RETRY_BACKOFF(float): (class attribute) default retry exponential backoff
DEFAULT_TIMEOUT(int | None): (class attribute) default HTTP request timeout in seconds
auth(tuple[str, str] | None): HTTP basic auth object if set
retry(Retry): retry policy of the HTTP client
suppress_errors(bool): suppress logging of request errors
timeout(int | None): HTTP request timeout in seconds
"""
DEFAULT_MAX_RETRIES: ClassVar[int] = 0
DEFAULT_RETRY_BACKOFF: ClassVar[float] = 0.0
DEFAULT_TIMEOUT: ClassVar[int | None] = 30
def __init__(self, configuration: Configuration | None = None, section: str | None = None, *,
suppress_errors: bool = False) -> None:
"""
@@ -52,26 +60,19 @@ 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)
"""
if configuration is None:
configuration = Configuration() # dummy configuration
if section is None:
section = configuration.default_section
configuration = configuration or Configuration() # dummy configuration
section = section or 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
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),
self.timeout = configuration.getint(section, "timeout", fallback=self.DEFAULT_TIMEOUT)
self.retry = SyncHttpClient.retry_policy(
max_retries=configuration.getint(section, "max_retries", fallback=self.DEFAULT_MAX_RETRIES),
retry_backoff=configuration.getfloat(section, "retry_backoff", fallback=self.DEFAULT_RETRY_BACKOFF),
)
@cached_property
@@ -92,7 +93,7 @@ class SyncHttpClient(LazyLogging):
f"{requests.utils.default_user_agent()} " \
f"python/{python_version}"
self.start(session)
self.on_session_creation(session)
return session
@@ -110,6 +111,27 @@ 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
@@ -117,10 +139,9 @@ class SyncHttpClient(LazyLogging):
Returns:
dict[str, BaseAdapter]: map of protocol and adapter used for this protocol
"""
adapter = HTTPAdapter(max_retries=self.retry)
return {
"http://": adapter,
"https://": adapter,
"http://": HTTPAdapter(max_retries=self.retry),
"https://": HTTPAdapter(max_retries=self.retry),
}
def make_request(self, method: Literal["DELETE", "GET", "HEAD", "POST", "PUT"], url: str, *,
@@ -171,7 +192,7 @@ class SyncHttpClient(LazyLogging):
self.logger.exception("could not perform http request")
raise
def start(self, session: requests.Session) -> None:
def on_session_creation(self, session: requests.Session) -> None:
"""
method which will be called on session creation

View File

@@ -21,6 +21,7 @@ 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
@@ -73,9 +74,24 @@ 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.DEFAULT_MAX_RETRIES = configuration.getint("aur", "max_retries", fallback=0)
AUR.DEFAULT_RETRY_BACKOFF = configuration.getfloat("aur", "retry_backoff", fallback=0.0)
AUR.DEFAULT_TIMEOUT = configuration.getint("aur", "timeout", fallback=30)
def _set_context(self) -> None:
"""
create context variables and set their values

View File

@@ -375,7 +375,7 @@ class Package(LazyLogging):
Returns:
str: print-friendly string
"""
details = "" if self.is_single_package else f""" ({" ".join(sorted(self.packages.keys()))})"""
details = "" if self.is_single_package else f" ({" ".join(sorted(self.packages.keys()))})"
return f"{self.base}{details}"
def vercmp(self, version: str) -> int:

View File

@@ -147,7 +147,7 @@ class PkgbuildPatch:
"""
if "$" in source:
# copy from library method with double quotes instead
return f"""\"{source.replace("\"", "'\"'")}\""""
return f"\"{source.replace("\"", "'\"'")}\""
# otherwise just return normal call
return shlex.quote(source)
@@ -195,13 +195,13 @@ class PkgbuildPatch:
"""
if isinstance(self.value, list): # list like
value = " ".join(map(self.quote, self.value))
return f"""{self.key}=({value})"""
return f"{self.key}=({value})"
if self.is_plain_diff: # no additional logic for plain diffs
return self.value
# we suppose that function values are only supported in string-like values
if self.is_function:
return f"{self.key} {self.value}" # no quoting enabled here
return f"""{self.key}={self.quote(self.value)}"""
return f"{self.key}={self.quote(self.value)}"
def substitute(self, variables: dict[str, str]) -> str | list[str]:
"""

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="Strict",
samesite="Lax",
)
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_start(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
def test_on_session_creation(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
"""
must log in user on start
"""
@@ -42,17 +42,17 @@ def test_start(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixt
}
session = requests.Session()
ahriman_client.start(session)
ahriman_client.on_session_creation(session)
requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), json=payload, session=session)
def test_start_failed(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
def test_on_session_creation_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.start(requests.Session())
ahriman_client.on_session_creation(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.start(requests.Session())
ahriman_client.on_session_creation(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.start(requests.Session())
ahriman_client.on_session_creation(requests.Session())
requests_mock.assert_not_called()

View File

@@ -4,6 +4,7 @@ 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
@@ -37,11 +38,29 @@ def test_session(mocker: MockerFixture) -> None:
"""
must generate valid session
"""
start_mock = mocker.patch("ahriman.core.http.sync_http_client.SyncHttpClient.start")
on_session_creation_mock = mocker.patch("ahriman.core.http.sync_http_client.SyncHttpClient.on_session_creation")
session = SyncHttpClient().session
assert "User-Agent" in session.headers
start_mock.assert_called_once_with(pytest.helpers.anyvar(int))
on_session_creation_mock.assert_called_once_with(pytest.helpers.anyvar(int))
def test_retry_policy() -> None:
"""
must set retry policy
"""
SyncHttpClient.DEFAULT_MAX_RETRIES = 1
SyncHttpClient.DEFAULT_RETRY_BACKOFF = 2.0
AUR.DEFAULT_MAX_RETRIES = 3
AUR.DEFAULT_RETRY_BACKOFF = 4.0
client = SyncHttpClient()
assert client.retry.connect == 1
assert client.retry.backoff_factor == 2.0
aur = AUR()
assert aur.retry.connect == 3
assert aur.retry.backoff_factor == 4.0
def test_exception_response_text() -> None:
@@ -68,11 +87,11 @@ def test_adapters() -> None:
must create adapters with retry policy
"""
client = SyncHttpClient()
adapers = client.adapters()
adapters = client.adapters()
assert "http://" in adapers
assert "https://" in adapers
assert all(adapter.max_retries == client.retry for adapter in adapers.values())
assert "http://" in adapters
assert "https://" in adapters
assert all(adapter.max_retries == client.retry for adapter in adapters.values())
def test_make_request(mocker: MockerFixture) -> None:
@@ -175,9 +194,9 @@ def test_make_request_session() -> None:
stream=None, auth=None, timeout=client.timeout)
def test_start() -> None:
def test_on_session_creation() -> None:
"""
must do nothing on start
"""
client = SyncHttpClient()
client.start(client.session)
client.on_session_creation(client.session)

View File

@@ -2,6 +2,7 @@ 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
@@ -13,13 +14,28 @@ 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)
aur = AUR()
assert aur.timeout == 42
assert aur.retry.connect == 10
def test_set_context(configuration: Configuration, database: SQLite, mocker: MockerFixture) -> None:
"""
must set context variables